Data Synchronization

Executes an existing data synchronization profile.

Execute DataSynchronization
Parameters(DataSynchronizationName, DataTransformationOperator,
DataTransformationValue, FileName, ValidateOnly, WaitForCompletion)
Values('CommaSync3', '*', '1.2345', '', 'false', 'true');

DataSynchronizationName—Name of the Data Synchronization profile to execute.

DataTransformationOperator—Valid values are:

  • None

  • '*' (Multiply)

  • '/' (Divide)

  • '+' (Add)

  • '-' (Subtract)

DataTransformationValue—Value to use in conjunction with the DataTransformationOperator to modify the data values.

FileName—If the synchronization uses an external source file for the source of the synchronization, the location of the external source file. The location must be a URL location to which the Web server has access. The file path should be “file://///<machine name>/<folder name>/<file name> ” if the file is on a remote computer, and “file:///C:/CvgCompLd_JobTtl.txt'” if the file is on a computer where the Data Synchronization service is running.

ValidateOnly—Validates the data synchronization without executing it.

WaitForCompletion—If set to true, the Batch Client waits for the job to finish. If set to false, the Batch Client submits the job and continues. Allowed values:

  • True

  • False

In addition to the above parameters, there are also data load option parameters. Data load option parameters are:

  • Dynamic

  • Retrieved from the registry

  • Parameter names differ based on the application type

  • All parameters are case sensitive, unlike the other parameters

  • All values are case sensitive

For Planning, there is one parameter: dataSyncLoadOptionHpMode. Allowed values:

  • ADD

  • SUBTRACT

  • OVERWRITE

For Essbase ASO, there is one parameter: dataSyncLoadOptionAsoMode. Allowed values:

  • ADD

  • SUBTRACT

  • OVERWRITE

For Essbase BSO, there is one parameter: dataSyncLoadOptionBsoMode. Allowed values:

  • ADD

  • SUBTRACT

  • OVERWRITE

For Planning, Essbase ASO, and Essbase BSO applications, the default value is OVERWRITE.

For Consolidation, there are two parameters:

  • dataSyncLoadOptionHfmMode—Allowed values:

    • merge

    • replace

    • accumulate

    The default value is merge.

  • dataSyncLoadOptionHfmAccummulateInFile—Allowed values:

    • True

    • False

    The default is false.

Note:

Profitability and Profitability - Detailed applications do not support data load options.