Opacc.Client.CLI 0.4.0

Opacc.Client.CLI

Command-line tool for the Opacc.Client library. Currently provides the scaffold command, which introspects a live Opacc instance and generates ready-to-use C# model classes.

Installation

Local (development)

Run directly from the project directory without installing:

cd opacc-client/Opacc.Client.CLI
dotnet run -- <command> [options]

The -- separator is required — everything after it is passed to the CLI, not to dotnet run.

Global .NET tool

dotnet pack
dotnet tool install --global --add-source ./nupkg Opacc.Client.CLI

Once installed, the tool is available as opacc:

opacc scaffold [options]

Commands

scaffold

Connects to an Opacc instance, reads all Business Object metadata via GetInfoBo and GetInfoBoAttr, and writes one .cs file per BO into the output directory.

Options

¹ The five connection options don't have to be passed on the command line. Each one falls back to configuration (see Connection configuration below), so once you've set them up you only run opacc scaffold -o ./Models. A missing value is only an error if it can't be found in any source.

Connection configuration

Rather than repeating --url, --client-id, --app-id, --user-id and --password on every call, the tool resolves each value from the following sources. Higher in the list wins, so a command-line flag always overrides configuration:

1. Command-line flag — --url, --password, …
2. Environment variable — Opacc__ServiceUrl, Opacc__DefaultPassword, … (double underscore = section separator)
3. User Secret — dotnet user-secrets set "Opacc:DefaultPassword" "…"
4. appsettings.json in the current working directory — an Opacc section

This mirrors how EF Core resolves a Name=… connection string from the startup project's configuration.

Put the non-secret values in appsettings.json next to where you run the tool:

{
  "Opacc": {
    "ServiceUrl": "https://opacc.example.com/OXAS_ServiceBus",
    "ClientId": "1",
    "ApplicationId": "MyApp",
    "DefaultUserId": "500"
  }
}

Keep the password out of source control — supply it per environment instead:

# Development (from the Opacc.Client.CLI project folder, or your own project):
dotnet user-secrets set "Opacc:DefaultPassword" "<pwd>"

# CI / one-off runs:
#   PowerShell:  $env:Opacc__DefaultPassword = "<pwd>"
#   bash:        export Opacc__DefaultPassword="<pwd>"

The config keys match the OpaccClientOptions property names (ServiceUrl, ClientId, ApplicationId, DefaultUserId, DefaultPassword) — the same Opacc section your application binds via services.AddOpaccClient(configuration.GetSection("Opacc")), so the CLI and your app can share one config file.

Namespace resolution

The namespace is determined in this order:

1. Explicit — --namespace Opacc.Client.Models is used as-is.
2. Automatic — the tool walks up from the output directory to find the nearest .csproj file.
   • Reads <RootNamespace> from that file, or falls back to the project filename without extension.
   • Appends the relative path from the project root to the output directory as additional segments.

Example:

.csproj   →  opacc-client/Opacc.Client/Opacc.Client.csproj
              RootNamespace = "Opacc.Client"
--output  →  opacc-client/Opacc.Client/Models
relative  →  Models
result    →  namespace Opacc.Client.Models;

The resolved namespace is printed before scaffolding begins so you can verify it before all files are written.

Examples

With connection details in appsettings.json + a user secret (recommended):

# one-time setup
dotnet user-secrets set "Opacc:DefaultPassword" "<pwd>"

# from then on — no credentials on the command line:
opacc scaffold --output "./Models"
opacc scaffold --output "./Models" --bo Addr --verbose

Scaffold a single BO for quick verification (all details on the command line):

dotnet run -- scaffold \
  --url "YourOpaccWebserviceUrl" \
  --client-id "1" \
  --app-id "MyApp" \
  --user-id "500" \
  --password "..." \
  --bo Addr \
  --output "./Models" \
  --verbose

Scaffold all BOs into the library's Models folder:

dotnet run -- scaffold \
  --url "YourOpaccWebserviceUrl" \
  --client-id "1" \
  --app-id "MyApp" \
  --user-id "500" \
  --password "..." \
  --output "C:/Projects/opacc-client/Opacc.Client/Models"

Override namespace explicitly:

dotnet run -- scaffold ... \
  --output "./out" \
  --namespace "MyCompany.Erp.Models"

Generated output

Each BO produces one file, e.g. Addr.cs:

using Opacc.Client.Attributes;
using Opacc.Client.Enums;

namespace Opacc.Client.Models;

[Bo("Addr")]
[BoIndex(1)]
public class Addr
{
    public int Number { get; set; }

    public string FullName { get; set; } = "";

    public string City { get; set; } = "";

    [BoProperty("Addr.SomeDate", OpaccDataType.Date)]
    public DateTime SomeDate { get; set; }

    /// <summary>Customer BoId reference</summary>
    [BoProperty("Addr.CustBoId")]
    public string CustBoId { get; set; } = "";
}

Attribute rules

Data type mapping

Numeric format "8.0" means 8 digits, 0 decimal places → int. Format "8.2" means 2 decimal places → decimal.

How it works internally

scaffold
  │
  ├── Biz.GetInfoBo()
  │     → returns all BO names (column: "Bo")
  │
  └── for each BO:
        Biz.GetInfoBoAttr(boName)
          → returns all attributes (columns: "BoAttr", "DataTypeCd", "Format", ...)
          → TypeMapper maps DataTypeCd + Format to C# type
          → ModelGenerator emits the .cs file

Both service calls go through IOpaccTransport.SendRawAsync, the same authenticated WCF session pool used by the main library. Sessions are created on first use and reused for the duration of the command.

Troubleshooting

namespace Models; instead of a proper namespace The tool could not find a .csproj above the output directory. Either move the output inside a project folder, or pass --namespace explicitly.

BO scaffolded with 0 attributes — skipped GetInfoBoAttr returned an empty response for that BO. This is normal for internal system BOs that have no accessible attributes.

FaultException on a specific attribute The generated model contains a property that no longer exists in this Opacc version. Remove the property or mark it with a custom ignore attribute. Run --verbose to see the raw attribute list and compare against your Opacc instance.

Unknown column names in verbose output The --verbose flag prints DataTypeCd/Format for each attribute. If these look unexpected, the OpaccInfoClient has a DumpColumns() helper you can call in code to print the raw response column names for diagnostics.