executeBurstDefinition

Executes a bursting definition that specifies the artifacts, POVs, and other settings required to run reports or books for more than one member of a single dimension for one data source.

Applies to

Narrative Reporting

Required Roles

  • Service Administrator
  • Power User
  • User
  • Viewer
Users with Power User, User, and Viewer must be assigned additional security through ACL

Usage

epmAutomate executeBurstDefinition ARTIFACT_NAME [prompt=LABEL:VALUE;VALUE] where:
  • ARTIFACT_NAME is the bursting definition path and name.
  • prompt=LABEL:VALUE;VALUE, optionally, specifies a prompt and one or more prompt values.

    Prompts are set up for books and reports with default values. You can use this optional parameter to override a prompt’s default value. Enter prompt values as a semicolon-separated string in the format prompt=LABEL:VALUE1;VALUE2;VALUEn. You can specify multiple prompts using this syntax; for example, prompt="Choose a reporting region:E01;E02" prompt="Select one or more Segments:BAS;HTAS" prompt="Select a Quarter:Q1"

    Do not set this value if you are executing burst definitions using default prompt values.

Examples

  • Burst execution using default values: epmAutomate executeBurstDefinition "library/Reports/Example BurstDef1"
  • Burst execution using custom prompt values: epmAutomate executeBurstDefinition "PromptsBook" prompt="Choose a reporting region:E01;E02" prompt="Select one or more Segments:BAS;HTAS" prompt="Select a Quarter:Q1"