Spectre cplaninfo Options

The Spectre command line cplaninfo sub-command displays the expected output of the cPlan. It has the following syntax:

spectre cplaninfo <filename> [options]

The <filename> points to an existing cPlan file. The <filename> can take various forms:

• If you set DI_PROJECT or pass --project as an argument, you can use a project path such as /cplans/sales.cplan. This format always uses forward slashes regardless of the operating system.
• If you do not set DI_PROJECT and do not pass --project as an argument, you can use a file system path. For example, use C:\di\project\sales\cplans\sales.cplan, or use sales.cplan if the current working directory is C:\di\project\sales\cplans.

For example:

spectre cplaninfo /cplans/sales.cplan

Enter spectre cplaninfo -h to display the syntax and options as shown in the following table.

Spectre cplaninfo Sub-command Options

Option	Description
--dataroot arg	Set the path to the DiveLine server dataroot. For example: spectre cplaninfo /cplans/sales.cplan --dataroot c:\di\solution\dl-dataroot Instead of using this option, you can set the DI_HOME environment variable. See Setting Environment Variables.
--project arg	Set the project name. For example: spectre cplaninfo /cplans/sales.cplan --project sales Instead of using this option, you can set the DI_PROJECT environment variable. See Setting Environment Variables.
-p [ --param ] name value	Set a parameter. For example: spectre cplaninfo /cplans/sales.cplan --param month 12 --param year 2015
--timing	Print timing information.
--properties	Print system and custom property values. For example: spectre cplaninfo /cplans/sales.cplan --properties
-q [ --quiet ]	Do not print program information. For example: spectre cplaninfo /cplans/sales.cplan --properties --quiet
--human-readable	Align columns in table output. This option is the default unless writing to a file. For example: spectre cplaninfo /cplans/sales.cplan --human-readable --metadata > sales-cplaninfo.txt NOTE: This option is intended for looking at small result sets—it is costly because of the layout required.
-u [ --username]	Set a username for situations where a cPlan is dependent on a username. For example: spectre cplaninfo /cplans/sales.cplan --username jsmith
Other modes (supply at most one):
-c [ --calcs ]	List the calculations provided by the cPlan. For example: spectre cplaninfo /cplans/sales.cplan --calcs Returns a list of existing calcs.
-m [ --metadata ]	Print the metadata table for the cPlan. For example: spectre cplaninfo /cplans/sales.cplan --metadata Returns the metadata for the cPlan.
-f [ --files ]	List files necessary to execute this cPlan. For example: spectre cplaninfo /cplans/sales.cplan --files Returns a list of required files.