topic Re: Automating project documentation generation. in Qlik Compose

Automating project documentation generation.

dpurdy66 — Fri, 14 Mar 2025 20:49:07 GMT

Is there a way to generate project documentation other than via the project menu? We would like to automatically generate new documentation when we deploy to production maybe using a rest call or via the composecli.

Re: Automating project documentation generation.

Nanda_Ravindra — Wed, 18 Jan 2023 19:27:49 GMT

@dpurdy66 You can use the composcli to generate the project document.

composecli Generate_project --project YOUR_PROJECT_NAME

For other available commands for generate_project you can run the below command:

composecli Generate_project --help

Thanks,

Nanda

Re: Automating project documentation generation.

dpurdy66 — Thu, 26 Jan 2023 14:34:43 GMT

The product help does not mention generating the project documentation. Also, I only want to generate the project documentation HTML file - not do all the stuff mentioned below.

ComposeCli.exe generate_project --project MyProject --stopIfDatamartsNeedRecreation

When the command is run, Compose will:

Validate the model.
Create any data warehouse tables that do not exist.
Validate the data warehouse.
Adjust the data warehouse if needed.

If an Adjust script is needed and --database_already_adjusted is included in the command, the script (DDL) will not be run as it is assumed that the user ran it manually.
Generate all data warehouse tasks.

If Compose encounters an error while generating a data warehouse task, it will skip the problematic task and continue with the remaining tasks.
Create, adjust and generate all data marts.

If the "Adjust" cannot be performed automatically and --stopIfDatamartsNeedRecreation is included in the command, the process will stop.