EPM Automate Program Documentation Report, How to create a report containing application logic

programDocumentationReport

Creates the Program Documentation Report containing Profitability and Cost Management application logic.

You can download the report to a local computer using the downloadFile command.

Applies to

Profitability and Cost Management

Required Roles

Service Administrator
Power User
User
Viewer

Usage

epmautomate
                programDocumentationReport APPLICATION_NAME
                     POV_NAME [fileName=FILE_NAME] [fileType=PDF|WORD|EXCEL|HTML]
                [useAlias=true|false] [skipFilters=true|false]
                stringDelimiter="DELIMITER"

where:

APPLICATION_NAME is the name of the Profitability and Cost Management application for which the Program Documentation Report is to be created.
POV_NAME is the name of the model POV in the application for which the report is to be generated.
fileName, optionally, is a unique name (including extension) for the report file. Default report file name is HPCMMLProgramDocumentationReport_APPLICATION_NAME_POV_NAME.pdf.
fileType, optionally, is the output file format. Default is PDF.
useAlias, optionally, specifies whether to print aliases in place of member names. Default is false.
skipFilters, optionally, specifies whether to ignore filters to speed up report generation for large models that have many rules that use filters. Default is false.
Setting this parameter to true skips the process of resolving each rule filter to determine the values for estimated source count, estimated destination count, and estimated target count in the report. Instead, the process uses the corresponding Level0 member counts. If this parameter value is set to false or not specified, the command resolves all the filters to generate more accurate counts.
stringDelimiter is the delimiter used in POV values. Delimiter must be enclosed in double quotation marks.

Examples

Create the report after resolving rules filters:
epmautomate programDocumentationReport BksML30 2024_Feb_Actual fileName=Feb-Actual.xls fileType=Excel useAlias=true stringDelimiter="_"
Create the report ignoring filters:
epmautomate programDocumentationReport BksML30 2024_Feb_Actual fileName=Feb-Actual.xls fileType=Excel useAlias=true skipFilters=true stringDelimiter="_"