Using a Job

You can use a job of type Clear POV that was created in the PCM Agent to supply predefined parameters for this command.

Any required parameter not saved in the job definition must be supplied on the command line, and any parameter in the job definition can be overridden on the command line.

Usage

epmAutomate clearDataByPointOfView [jobName=JOB_NAME] [povName=POV_NAME] [cubeName=CUBE_NAME] [PARAMETER=VALUE], where:
  • jobName=JOB_NAME is the name of the job that should be used to clear the data. Required if parameter values are not specified on the command line. Default is Clear POV
  • POV_NAME, optionally, is the name of a POV in the application. This parameter value is required if the specified job does not identify the POV to use to clear the data.
  • CUBE_NAME, optionally, is the name of the cube in which data is to be cleared. Default is PCM_CLC.
  • PARAMETER=VALUE indicates optional runtime parameters and their values. Specify as many parameter and value pairings as the process requires. Valid parameters and their values:
    • povDelimiter is the delimiter used in POV values. Default is :: (double Colon). This value must be enclosed in double quotation marks. Example: povDelimiter="_".

      Other than the default, only these delimiters are supported: _ (under score), # (hash), ~ (tilde), % (percentage), ; (semicolon), : (colon), - (dash).

    • clearInput=true|false specifies whether to clear input data. Default is false.
    • clearAllocatedValues=true|false specifies whether to clear allocated values. Default is false.
    • clearAdjustmentValues=true|false specifies whether to clear adjustment values. Default is false.

      Note:

      • Parameter values (true or false) must be in all lower case.
      • At least one of clearInput, clearAllocatedValues or clearAdjustmentValues parameters must be set to true.

Examples

  • Clear data using the settings in a job:

    epmAutomate clearDataByPointOfView jobName=clearData

  • Clear input data and allocated values from a POV using a job, overriding the cube name and using a custom POV delimiter:

    epmAutomate clearDataByPointOfView jobName=clearData povName=FY21_Jan_Actual_Working cubeName=PCM_REP povDelimiter="_" clearInput=true clearAllocatedValues=true