Portal

Hello,

Yes, this is possible: Semarchy xDI can automatically generate documentation for the mappings, processes, and metadata included in a package.

**How to generate it**

When building a package, either from Designer (right-click a mapping/process > Build/Run > Build > Package) or from the command line, set the includeDocumentation option to true:

buildPackage

 -mainProcessWorkspacePath "MyProject/Source Models/process_A.proc"

 -package "D:/Built Items/myPackage01.pck"

 -includeSources true

 -includeDocumentation true

(includeDocumentation actually defaults to true, but we recommend setting it explicitly so it's clear in your build scripts).

This embeds the documentation of the source metadata, processes, and mappings used to generate the package, directly inside the package file.

**How to access/view it**

Once the package includes documentation, you have two options:

1. View it directly in Semarchy xDI Analytics, where package documentation can be visualized once the package is imported.

2. Extract it to local files using the Designer CLI's extractPackageInfo command:

extractPackageInfo

 -package "D:/Built/Generated Packages/myPackage.pck"

 -extract documentation

 -outputFile "D:/Extract/documentationFolder/"

This extracts the documentation content into the specified output folder, so you can consult it outside of Analytics as well (for example, to share it or archive it separately).

Documentation reference:

https://www.semarchy.com/doc/semarchy-xdi/xdi/latest/Manage/designer-cli/commands.html

Let us know if you'd like help setting this up in your build process.

Best regards