Synopsis

fcli ssc report create [--delim=<delimiter>] [-f=<format>] -n=<reportName> [--notes=<notes>] --template=<reportTemplateNameOrId> [-p=PARAM=VALUE[,PARAM=VALUE…​]]…​ [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] [[--session=<sessionName>]] ] [--store=_variableName _ ] [--to-file=<outputFile>_]]

Description

Options

--delim=<delimiter>

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

-f, --format=<format>

Report format. Allowed values: xls, doc, pdf.

-n, --name=<reportName>

Name for the generated report.

--notes=<notes>

Notes for the generated report.

-p, --parameters=PARAM=VALUE[,PARAM=VALUE…​]

Report generation parameters, dependent on report template.

--template=<reportTemplateNameOrId>

The name or ID of the report template definition.

Session options

--session=<sessionName>

Name of the SSC session to use for executing this command. Default value: default.

Output options

-o, --output=format[=<options>]

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

--store=variableName[=<propertyNames>]

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

--to-file=<outputFile>

Write command output to the specified file instead of stdout.

Generic fcli options

--env-prefix=<envPrefix>

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

-h, --help

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

--log-file=<logFile>

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

--log-level=<logLevel>

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.