Oracle® Retail Predictive Application Server Cloud Edition Administration Guide Release 19.0 F25569-31 |
|
Previous |
Next |
This chapter describes an RPASCE utility called "rpac" (RPASCE Pluggable Automation Component). It can be used to perform various tests on an existing domain, based on a set of test cases contained in XML files.
This appendix contains the following sections:
The rpac utility is used to run highly customizable automated test suites for the RPASCE server. The XML-based framework allows rapid development of tests and ensures that test cases can be quickly copied across locations. The flexible XML schema allows the user to test a large number of RPASCE features, such as writing data to a domain, building a workbook, running custom menu options, and verifying the results.
The XML framework also introduces consistency, accuracy, and reproducibility in the test results. To reproduce a test case, all that is needed is the XML file and a copy of the domain.
Note that rpac operates directly against the domain itself and therefore does not test any Client/Server interactions.
The rpac utility is supported for use with Enterprise Edition deployments. RPAC tests are specified in XML-format text files and cover a range of RPASCE Domain and Workbook activities. In order to support the validation of a newly installed or patched environment, in the context of configured daily or weekly batch operations, RPAC for Cloud deployments is supported through new entries in the EE Batch task catalog. These tasks allow a pre-production domain to be set to a known state through a combination of hierarchy load and measure load files, and then can compare both Domain and Workbook measures to known values represented either directly in the test XML files or in data comparison files (similar to a measure data load file, but used only for comparison rather than for loading).
Three types of collateral files are involved in the RPAC testing process:
Input data file set: a group of hierarchy (.dat) and measure (.ovr, .clr, or .rpl) data files that should be loaded into the domain before any RPAC tests are run. Uploaded to FTP site in the rpac directory as input.tar.gz or input.zip.
Test file set: one or more .xml files where tests and test suites are defined using the available set of RPAC tags and attributes. Uploaded to FTP site in the rpac directory as tests.tar.gz or tests.zip.
Comparison data file set: an optional way to efficiently validate that one or more measures currently contain an expected set of values. Uploaded to the FTP site in the rpac directory as compare.tar.gz or compare.zip.
Each of these collateral file archives, once sent through the FTP interface, will be kept internally to be used every time an RPAC-enabled batch execution sequence is run. Updates to the collateral files can be sent to the FTP site before the next call of the initrpac batch task and will be brought into the active environment at that time. Note that when any of the collateral file archives is updated, the previous contents are entirely removed from the internal storage area, so the replacement archive file must be a complete set of files of that type. (This prevents stale test scripts or data files from being left in the environment.)
The two EE Batch tasks, initrpac and runrpac, are detailed in the batch task catalog in "Initialize Testing Environment: initrpac" and "Execute Automated Tests: runrpac" in the Implementation Guide. The initrpac task is expected to be run once, at the start of the RPAC-enabled batch exec sequence; the runrpac task can be called multiple times, including at separate points during the batch exec sequence, if needed. Here is an example batch execution sequence that shows how an existing weekly batch specification might be augmented with RPAC tests:
# Standard Weekly Batch Cycle weekly | unpack | weekly_sales.tar.gz~ftp weekly | hierload | prod~14~N weekly | hierload | loc~14~N weekly | measload | load_oo_list weekly | calc | batch_fcst weekly | autobuild | # RPAC-enhanced Batch Cyle validate | initrpac | validate | hierload | prod~14~N validate | hierload | loc~14~N validate | measload | load_oo_list validate | runrpac | RPAC_Domain_Tests~DomainTests.xml validate | calc | batch_fcst validate | runrpac | RPAC_Workbook_Tests~WorkbookTests.xml
The first section, labeled "weekly", represents a weekly batch sequence that might run at midnight every Saturday. Note that updated hierarchy and measure data files for the week are sent through FTP in an archive file named "weekly_sales.tar.gz" using the unpack task.
The second section shows how the weekly batch sequence has been augmented with RPAC tests and named "validate". Note that the unpack task from the weekly sequence has been left out, and in its place initrpac is called to place the test data input files into the domain. If new or updated RPAC test collateral files have been placed on the FTP server, they will be brought in at this point and used.
There are two sets of RPAC tests in this sequence, specified by the runrpac task entries. The first runs immediately after the hierarchy and measure files are loaded, and validates expected values in the domain. The second test set is executed after some further calculations have been run, and builds one or more workbooks, then validates values within them as well.
When RPAC-enabled batch sequences are run, the primary log file (available through the Online Administration dashboard as well as through the FTP log archive package) will show a brief summary of test results. Full test details and log files are available in the complete log archive package from the batch exec run, available in the FTP area once the execution has completed.
Note that the latest version of this guide specifies which RPAC features are available for Cloud deployments. Due to Cloud security constraints, some RPAC features, primarily the <SHELL> tag, have been disabled; however, inclusion of RPAC tests as a step in existing batch execution sequences should fully compensate for this restriction.
The structure of an rpac test script is defined by the following tags.
Table 14-1 Test Case Tags
Tag | Description |
---|---|
<testscript> |
The outermost tag for the test script. This tag contains one or more <testsuite> tags. |
<testsuite> |
This tag defines a suite of tests that are designed to run together. Each suite contains its own <setup>, <teardown>, <testcase>, and <workbook-operations> tags. This tag has a name attribute that can be used with the -suite command line attribute to specify which suites are executed in this run. |
<once> |
The once tag contains tag elements used to set up the environment once before the first test case is executed. It is a tag like setup, but only happens once at the start of a test suite. The once tag has been added to allow a set of measures to be backed up once during the run of the test suite. |
<finalize> |
The finalize tag contains tag elements used to restore the environment after the final test case is executed. |
<setup> |
This tag sets the preconditions that are common to all test cases. Operations inside this tag are run before every test case is executed. Example operations:
|
<teardown> |
This tag contains cleanup code that is run after all test cases. Operations inside this tag are run after every test case is executed. This is used to restore a domain or workbook to its default state to remove dependencies between independent test cases. Example operations:
|
<testcase> |
This tag is where the code to perform each test goes. It should perform operations, then use the assert tags to verify the results. The name of this tag is used in the output to log timing results and success/failure. Note: Code in the <setup> tag is executed prior to each test case, and code in the <teardown> tag is executed after each test case. |
The optional attribute role for tags testsuite, once, setup and teardown may be required for an rpac application being written for an RDM enable domain. The role assigned to the testsuite tag affects all test cases, and if no role is assigned to once, setup, and teardown, the role assigned to the testsuite tag will affect these tags as well. A role assigned to the once tag is applied to the tags contained in once, and if no role is assigned to setup and teardown, then this role will apply to these tags as well. A role assigned to the setup tag is applied to the tags contained in setup, and if no role is assigned to teardown, then this role will apply to teardown as well. A role assigned to the teardown tag only applies to the tags contain in teardown.
It is recommended that the teardown section restore the domain to its previous state. This removes dependencies between test cases and ensures consistency from one run to the next.
The tags once, setup, and teardown are unique. Only the first occurrence of each of these tags is used. These tags can appear in any order under the testsuite tag, and all of these tags are optional. The code contained in these tags is executed at a set point during the run of unit test code. However, for the tag testcase, the order of occurrence in the testsuite is the order of execution.
This section provides a sample XML file that contains some rpac tests that run against an MFP domain. This test illustrates how the setup and teardown methods work, as well as how to use the various workbook operations.
The first test case demonstrates building the workbook. The first step in this operation is to shell out to the wbmgr utility to clear out all existing workbooks. This step prevents the domain from growing after repeated operations, but you should only use this step in cases where you know that existing workbooks are not needed.
After that, the test verifies the preconditions of the test case. In this example, the test verifies the preconditions performed in the setup code by checking that the domain measure value is "true". After that, the test makes the wizard selections and builds the workbook. Once the workbook is built, an assertion verifies that the load rules correctly set the workbook value.
Once this test case is complete, the teardown code is executed, along with the setup code for the next test case. The test verifies that the teardown code correctly set the workbook's measure value to "false" and then issues a commit. Once the workbook is committed, the domain value is checked to see if it was properly updated. Once again, the teardown code is executed and the setup code is run at the beginning of the next test case.
For the third test case, the setup code should have initialized the domain value back to "true", and the workbook value back to "false". The test case verifies these operations, then performs a workbook refresh and verifies that the workbook value has been correctly set to "true".
After that, the workbook is closed and the test suite is complete.
Note: Because the teardown code modifies workbook data, the workbook close step cannot be encapsulated inside of a test case. If it was, the teardown code would try to modify a workbook that was no longer there and produce a failing result. |
<?xml version="1.0" encoding="UTF-8"?> <!--- Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved. File: wbtest.xml TestCase Description: - Once: Set the RPAS Today value - Setup: Set the domain's measure value to "true" - Teardown: Set the workbook's measure value to "false" - Finalize: Close the workbook - Test Build: Build a workbook and validate the load rule - Test Commit: Validate the commit rule - Test Refresh: Validate the refresh rule --> <testscript> <testsuite name="MFP RPAC Test 11" role="workbook"> <once> <rpas-today>20070101</rpas-today> <set-environment-variable name="MEAS" value="ipopappenbb"/> <set-environment-variable name="NKEY" value="h1_2007:100:1"/> </once> <finalize> <!-- Close the workbook --> <workbook-operations> <close/> </workbook-operations> </finalize> <!-- Setup executed at the beginning of every testcase --> <setup> <set-domain-measure name="[MEAS]" namedkeys="[NKEY]" value="true"/> </setup> <!-- Teardown executed at the end of every testcase --> <teardown> <edit-workbook-measure name="[MEAS]" namedkeys="[NKEY]" value="false"/> </teardown> <testcase name="Enable OP Approval Workbook: Build"> <!-- Verify pre-conditions are true --> <assert-domain-measure-value-eq name="[MEAS]" namedkeys="[NKEY]" value="true"/> <workbook-operations> <build template-name="EnableOp" label="Enable OP Approval" user="adm"> <!-- Make positions selection for the wizard page --> <wizard-page-settings id="wiz_EnableOpssn"> <set-tree-selections dim-name="ssn" rollup-name="ssn"> h1_2007 </set-tree-selections> </wizard-page-settings> <wizard-page-settings id="wiz_EnableOpdept"> <set-tree-selections dim-name="dept" rollup-name="dept"> 100 </set-tree-selections> </wizard-page-settings> <wizard-page-settings id="wiz_EnableOpchnl"> <set-tree-selections dim-name="chnl" rollup-name="chnl"> 1 </set-tree-selections> </wizard-page-settings> </build> </workbook-operations> <!-- Validate the load rule worked correctly --> <assert-workbook-measure-value-eq name="[MEAS]" namedkeys="[NKEY]" value="true"/> </testcase> <!-- Commit the workbook and assert the measure values in domain --> <testcase name="Enable OP Approval Workbook: Commit"> <assert-domain-measure-value-eq name="[MEAS]" namedkeys="[NKEY]" value="true"/> <assert-workbook-measure-value-eq name="[MEAS]" namedkeys="[NKEY]" value="false"/> <workbook-operations> <commit type ="now" template-name="EnableOp" user="adm"/> </workbook-operations> <!-- Validate the commit rule worked correctly --> <assert-domain-measure-value-eq name="[MEAS]" namedkeys="[NKEY]" value="false"/> </testcase> <!-- Refresh the workbook and assert measure values in workbook and domain --> <testcase name="Enable OP Approval Workbook: Refresh"> <assert-domain-measure-value-eq name="[MEAS]" namedkeys="[NKEY]" value="true"/> <assert-workbook-measure-value-eq name="[MEAS]" namedkeys="[NKEY]" value="false"/> <workbook-operations> <refresh user="adm"/> </workbook-operations> <!-- Validate the refresh rule worked correctly --> <assert-workbook-measure-value-eq name="[MEAS]" namedkeys="[NKEY]" value="true"/> </testcase> </testsuite> </testscript>
The rpac command now has a switch to create an HTML document of its tags and their usage. The HTML document "rpac.html" for RPAC is contained in the RPAS_HOME/doc/rpac directory.
When RPAC executes it prints the status of the current execution to the console. Once all the test cases are complete, the summary of test cases is stored in unittest.log and unittest.xml under the current directory. The content of this simple text file unittest.log for a working example will be:
ran 3 tests: 0 skips: 0 errors, 0 failures in 1 minute 9.92 seconds for RPAC (LDIP): RPAS_UT Tests
And for unittest.xml:
<unittest elapsedTime="1 minute 9.92 seconds" name="RPAC (LDIP): RPAS_UT Tests" os="Windows" runcount="3" timestamp="2018-11-16 11:17:29" version="18.0.002.00.001"> </unittest>
If something goes wrong the output for unittest.log will be:
ran 3 tests: 0 skips: 1 errors, 0 failures in 1 minute 9.20 seconds for RPAC (LDIP): RPAS_UT Tests Errors: TestName: MFP RPAC Test 11.Enable OP Approval Workbook: Commit Exception: TestCase got OciNamedException: Test/testcases/rpac.xml at line 19 for suite 'MFP RPAC Test 11'. throw at line 414 of file 'd:\usr\rpas\edgetrunk\rpas\11\libraries\rpassql\rpas\private\sqlsession.cpp' Location: 90 'testcases/rpac.xml'
And for unittest.xml:
<unittest elapsedTime="1 minute 9.20 seconds" name="RPAC (LDIP): RPAS_UT Tests" os="Windows" runcount="3" timestamp="2018-11-16 12:01:03" version="18.0.002.00.001"> <errorlist> <error> <testname>MFP RPAC Test 11.Enable OP Approval Workbook: Commit</testname> <exception>TestCase got OciNamedException: Test/testcases/rpac.xml at line 19 for suite 'MFP RPAC Test 11'. throw at line 414 of file 'd:\usr\rpas\edgetrunk\rpas\11\libraries\rpassql\rpas\private\sqlsession.cpp'</exception> <file>testcases/rpac.xml</file> <line>90</line> </error> </errorlist> </unittest>
This section provides schema details.
All HTML tags may contain attributes and values. RPAC does an initial processing of the attributes and tag value strings. This initial processing replaces any occurrence of the string enclosed with square brackets with the current variable matching the enclosed string. For example the string "Rpas Today is [RPAS_TODAY]" would be replace with "Rpas Today is 20180802" if either the process environmental variable "RPAS_TODAY" had the value of "20180802" or the RPAC tag "set-environment-variable" had been used to set the variable "RPAS_TODAY" to the value of "20180802".
There are seven environment variables internal to RPAC "[RPAC_DATA]", "[RPAC_WORK]", "[RPAC_DATE]", "[RPAC_TEST_SUITE]", "[RPAC_TEST_CASE]", "[WORKBOOK_NAME]", and "[SEGMENT_ID]". These internal environment variables cannot be change using the RPAC tag "set-environment-variable".
The internal environment variable "[RPAC_DATE]" always returns the current date/time as a string value. The format of the data time string can be changed using the RPAC tag "set-date-format". The default format is "%Y%m%d".
The internal environment variable "[RPAC_DATA]" is the location of the input directory known to RPAC.
The internal environment variable "[RPAC_WORK]" is the location of the output directory known to RPAC.
The internal environment variable "[RPAC_TEST_SUITE]" is name of the current test suite.
The internal environment variable "[RPAC_TEST_CASE]" is name of the current test case.
The internal environment variable "[WORKBOOK_NAME]" is name of the current workbook or blank if there is no current workbook.
The internal environment variable "[SEGMENT_ID]" is segment id of the last workbook build.
Since the environment variables "[WORKBOOK_NAME]", and "[SEGMENT_ID]" will be updated after workbook build the tag "set-environment-variable" can be used to copy these values into another variable.
This section provides details about the top-level parent tag.
The once tag contains tag elements used to set up the environment once before the first test case is executed. It is a tag like setup, but only happens once at the start of a test suite. The once tag has been added to allow a set of measures to be backed up once during the run of the test suite.
The finalize tag contains tag elements used to restore the environment after the final test case is executed.
The setup tag is used to set any preconditions that must be true prior to running each test case. These can include initializing measure values, setting the date, or running batch scripts to prepare the domain.
The teardown tag contains tag elements used to restore the environment to a default state after a test case is executed. This can include returning measures to their default values or running batch scripts to clean up the domain.
The log tag logs a message to the console. It has an optional attribute, msg, containing the message to be logged.
Here is the sample implementation of the above tags
<testscript> <testsuite name="MFP RPAC Test"> <setup> <!--- setup code -> </setup> <testcase name="Measure Analysis Workbook : build"> <!---testcase code -> </testcase > <teardown> <!--- teardown code -> </teardown> <finalize> <log msg="Do Finalize" /> </finalize> </testsuite> </testscript>
This section provides details about generic tags.
Logs a message to the console.
Attribute | Description | Category |
---|---|---|
msg | Message to be used in the failure text | Optional |
level | Level to log message at | Optional |
Fail creates a failure message.
Attribute | Description | Category |
---|---|---|
msg | Message to be used in the failure text | Optional |
Sets the key specs value of the named key.
Attribute | Description | Category |
---|---|---|
name | Key name | Required |
keyspec | Key value spec | Required |
Sets the RpasToday environment variable to the value of this tag. RPAS_TODAY tells RPASCE what day that it should think today is.
Sample usage:
<rpas-today>20070101</rpas-today>
Where: the date is given in yyyymmdd format.
The shell tag starts a shell process with the command provided as value of this tag.
Attribute | Description | Category |
---|---|---|
working-directory | Directory to use for shell; if not provided then the current working directory is used. | Optional |
check-status | Boolean to determine if a non-zero return status throws an exception. | Optional |
append-to-log | Boolean to determine if process should append to output log. | Optional |
is-shell | Boolean to indicate that the process is a shell. | Optional |
remove-output | Boolean to determine if output is erase if there is no error (defaults | Optional |
assert-status-equal | Assert return status equals provide value. | Optional |
assert-status-not-equal | Assert return status does not equal provide value. | Optional |
output-file | File to which shell command redirects its output. | Optional |
unique-file | Attribute to select a unique file name for logging process output. The value provided is the variable name to contain the unique file name generated. | Optional |
timer-file | String attribute. When present, the execution time of this process will be appended to the content of that file. | Optional |
Sample usage:
<shell check-status="true" is-shell="false">wbmgr -d [DOMAIN] -remove -all</shell>
Registers a measure with the provided properties.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
Intx | Base intersection | Required |
type | Type of measure | Required |
naval | NA value of the measure | Required |
defagg | Default aggregation | Required |
Sample usage:
<register-measure name="MeasureX" intx="WEEK_STR_DAY_" type="int" defagg="total" naval="0"/>
This section provides details about domain operation tags.
This section provides details about assertions.
Assert a dimension contains or does not contain a position name. Note that this tag is restricted to cloud deployments.
Attribute | Description | Category |
---|---|---|
name | Dimension name | Required |
posname | List of comma-separated position names | Required |
containflag | If flag is true, then position names are checked to see if they are contained in the dimension. | Required |
Sample usage:
<assert-dimension-contain name="DEPT" posname="dept1" containflag="true" />
Assert a dimension name exists. Note that this tag is restricted to cloud deployments.
Attribute | Description | Category |
---|---|---|
name | Dimension name | Required |
Sample usage:
<assert-dimension-exists name="DEPT" />
Assert a dimension size is between a minimum and a maximum value. Note that this tag is restricted to cloud deployments.
Attribute | Description | Category |
---|---|---|
name | Dimension name | Required |
min | Minimum value | Required |
maz | Maximum value | Required |
Sample usage:
<assert-dimension-size name="DEPT" min="8" max="32" />
Assert a domain measure exists.
Attribute | Description | Category |
---|---|---|
name | Dimension name | Required |
Sample usage:
<assert-domain-measure-exists name="r_ex_test" />
Assert a domain measure base intersection matches an expected value.
Attribute | Description | Category |
---|---|---|
name | Dimension name | Required |
intx | Intersection string to compare with | Required |
Sample usage:
<assert-domain-measure-intx name="r_ex_test" intx="str_sku_week"/>
Assert a domain measure value is equal to an expected value. This tag can be run in a number of ways:
Check against a loadmeasure file:
By specifying <path>, <start>, and <width>, you can validate that the contents of a measure are equal to the contents of a fixed-width loadmeasure file.
Check against specified positions:
By providing <keys> or <namedkeys>, you can verify that all of the positions in your specification are equal to the provided value. You can specify <keyint> to provide positions at an alternate rollup.
Check entire measure:
If you do not supply the <keys>, <namedkeys>, or <path> tag, then rpac will assert that every logical cell in the measure is equal to the value provided.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
keys | List of comma-separated position names | Optional |
namedkeys | List of comma-separated position names | Optional |
path | Path to load measure type file to compare with | Optional |
keyint | Intersection string | Optional |
value | Expected value | Optional |
start | Starting column of measure field | Optional |
width | Width of measure field | Optional |
intersection | The measure is accessed at the provided intersection base | Optional |
Sample usage (using keys):
<assert-domain-measure-value-eq name="bulylagtx" keyint="year" namedkeys=" 2007" value="Test1"/>
Sample usage (using path):
<assert-domain-measure-value-eq name="bulylagtx" path="loadmeas.dat" start="100" width="20" />
Sample usage (check all):
<assert-domain-measure-value-eq name="bulylagtx" value="Test1" />
Assert a domain measure value is greater than or equal to an expected value. This tag can be run in a number of ways:
Check against a loadmeasure file:
By specifying <path>, <start>, and <width>, you can validate that the contents of a measure are equal to the contents of a fixed-width loadmeasure file.
Check against specified positions:
By providing <keys> or <namedkeys>, you can verify that all of the positions in your specification are equal to the provided value. You can specify <keyint> to provide positions at an alternate rollup.
Check entire measure:
If you do not supply the <keys>, <namedkeys>, or <path> tag, then rpac will assert that every logical cell in the measure is equal to the value provided.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
keys | List of comma-separated position names | Optional |
namedkeys | List of comma-separated position names | Optional |
path | Path to load measure type file to compare with | Optional |
keyint | Intersection string | Optional |
value | Expected value | Optional |
start | Starting column of measure field | Optional |
width | Width of measure field | Optional |
intersection | The measure is accessed at the provided intersection base | Optional |
Sample usage (using keys):
<assert-domain-measure-value-ge name="bulylagtx" keyint="year" namedkeys=" 2007" value="Test1"/>
Sample usage (using path):
<assert-domain-measure-value-ge name="bulylagtx" path="loadmeas.dat" start="100" width="20" />
Sample usage (using intersection):
<assert-workbook-measure-value-eq name="drtybop1c" intersection="weekdeptstor" namedkeys="w02_2021:505:1000" value="66533.07"/>
Sample usage (check all):
<assert-domain-measure-value-ge name="bulylagtx" value="Test1" />
Assert a domain measure value is greater than a an expected value. This tag can be run in a number of ways:
Check against a loadmeasure file:
By specifying <path>, <start>, and <width>, you can validate that the contents of a measure are equal to the contents of a fixed-width loadmeasure file.
Check against specified positions:
By providing <keys> or <namedkeys>, you can verify that all of the positions in your specification are equal to the provided value. You can specify <keyint> to provide positions at an alternate rollup.
Check entire measure:
If you do not supply the <keys>, <namedkeys>, or <path> tag, then rpac will assert that every logical cell in the measure is equal to the value provided.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
keys | List of comma-separated position names | Optional |
namedkeys | List of comma-separated position names | Optional |
path | Path to load measure type file to compare with | Optional |
keyint | Intersection string | Optional |
value | Expected value | Optional |
start | Starting column of measure field | Optional |
width | Width of measure field | Optional |
intersection | The measure is accessed at the provided intersection base | Optional |
Sample usage (using keys):
<assert-domain-measure-value-gt name="bulylagtx" keyint="year" namedkeys=" 2007" value="Test1"/>
Sample usage (using path):
<assert-domain-measure-value-gt name="bulylagtx" path="loadmeas.dat" start="100" width="20" />
Sample usage (check all):
<assert-domain-measure-value-gt name="bulylagtx" value="Test1" />
Assert a domain measure value is less than or equal to an expected value. This tag can be run in a number of ways:
Check against a loadmeasure file:
By specifying <path>, <start>, and <width>, you can validate that the contents of a measure are equal to the contents of a fixed-width loadmeasure file.
Check against specified positions:
By providing <keys> or <namedkeys>, you can verify that all of the positions in your specification are equal to the provided value. You can specify <keyint> to provide
positions at an alternate rollup.
Check entire measure:
If you do not supply the <keys>, <namedkeys>, or <path> tag, then rpac will assert that every logical cell in the measure is equal to the value provided.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
keys | List of comma-separated position names | Optional |
namedkeys | List of comma-separated position names | Optional |
path | Path to load measure type file to compare with | Optional |
keyint | Intersection string | Optional |
value | Expected value | Optional |
start | Starting column of measure field | Optional |
width | Width of measure field | Optional |
intersection | The measure is accessed at the provided intersection base | Optional |
Sample usage (using keys):
<assert-domain-measure-value-le name="bulylagtx" keyint="year" namedkeys=" 2007" value="Test1"/>
Sample usage (using path):
<assert-domain-measure-value-le name="bulylagtx" path="loadmeas.dat" start="100" width="20" />
Sample usage (check all):
<assert-domain-measure-value-le name="bulylagtx" value="Test1" />
Assert a domain measure value is less than an expected value. This tag can be run in a number of ways:
Check against a loadmeasure file:
By specifying <path>, <start>, and <width>, you can validate that the contents of a
measure are equal to the contents of a fixed-width loadmeasure file.
Check against specified positions:
By providing <keys> or <namedkeys>, you can verify that all of the positions in your specification are equal to the provided value. You can specify <keyint> to provide positions at an alternate rollup.
Check entire measure:
If you do not supply the <keys>, <namedkeys>, or <path> tag, then rpac will assert that every logical cell in the measure is equal to the value provided.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
keys | List of comma-separated position names | Optional |
namedkeys | List of comma-separated position names | Optional |
path | Path to load measure type file to compare with | Optional |
keyint | Intersection string | Optional |
value | Expected value | Optional |
start | Starting column of measure field | Optional |
width | Width of measure field | Optional |
intersection | The measure is accessed at the provided intersection base | Optional |
Sample usage (using keys):
<assert-domain-measure-value-lt name="bulylagtx" keyint="year" namedkeys=" 2007" value="Test1"/>
Sample usage (using path):
<assert-domain-measure-value-lt name="bulylagtx" path="loadmeas.dat" start="100" width="20" />
Sample usage (check all):
<assert-domain-measure-value-lt name="bulylagtx" value="Test1" />
Assert a domain measure value is not equal to an expected value. This tag can be run in a number of ways:
Check against a loadmeasure file:
By specifying <path>, <start>, and <width>, you can validate that the contents of a measure are equal to the contents of a fixed-width loadmeasure file.
Check against specified positions:
By providing <keys> or <namedkeys>, you can verify that all of the positions in your
specification are equal to the provided value. You can specify <keyint> to provide positions at an alternate rollup.
Check entire measure:
If you do not supply the <keys>, <namedkeys>, or <path> tag, then rpac will assert that every logical cell in the measure is equal to the value provided.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
keys | List of comma-separated position names | Optional |
namedkeys | List of comma-separated position names | Optional |
path | Path to load measure type file to compare with | Optional |
keyint | Intersection string | Optional |
value | Expected value | Optional |
start | Starting column of measure field | Optional |
width | Width of measure field | Optional |
intersection | The measure is accessed at the provided intersection base | Optional |
Sample usage (using keys):
<assert-domain-measure-value-ne name="bulylagtx" keyint="year" namedkeys=" 2007" value="Test1"/>
Sample usage (using path):
<assert-domain-measure-value-ne name="bulylagtx" path="loadmeas.dat" start="100" width="20" />
Sample usage (check all):
<assert-domain-measure-value-ne name="bulylagtx" value="Test1" />
Assert a domain measure popcount matches an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
pop-count | Expected popcount | Required |
Sample usage:
<assert-domain-popcount-eq name=" Ipopappenbb" pop-count="100" />
Assert a domain measure is not populated.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
Sample usage:
<assert-domain-popcount-eq-zero name=" Ipopappenbb" />
Assert a domain measure is populated.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
Sample usage:
<assert-domain-popcount-ne-zero name=" Ipopappenbb" />
Assert the dimInfo bitsize or dimregistry bitsize value of a dimension. Note that this tag is restricted to cloud deployments.
Attribute | Description | Category |
---|---|---|
name | List of comma-separated dimension
names |
Required |
category | Bit Size Category (dimInfo or
dimRegistry) |
Required |
value | comma-separated Bit Size Values | Required |
Sample usage:
<assert-bitsize-value-eq name="week,skup," category="dimInfo" value="12,14" />
Assert the value for dimension registry version. Note that this tag is restricted to cloud deployments.
Attribute | Description | Category |
---|---|---|
value | Registry version | Required |
Sample usage:
<assert-dim-registry-version value="1" />
Assert the threshold value of the dimension.
Attribute | Description | Category |
---|---|---|
name | List of comma-separated dimension
names |
Required |
value | List of comma-separated threshold
values |
Required |
Sample usage:
<assert-reindex-threshold name="scls,week" value="25,103" />
Assert whether Diminfo Bitsize is equal to DimRegistry Bitsize.
Attribute | Description | Category |
---|---|---|
bitsize-flag | Returns true if a Bitsize mismatch occurs | Required |
name | Dimension name | Required |
Sample usage:
<assert-reindex-required name="week" bitsize-flag="false" />
Assert the status of reindex with the user input.
Attribute | Description | Category |
---|---|---|
flag | Flag to indicate whether reindexing Domain is in progress. | Required |
Sample usage:
<assert-reindex-in-progress flag="false" />
Set the current domain to either the master or a sub-domain.
Attribute | Description | Category |
---|---|---|
index | Domain index | Required |
Sample usage:
< set-current-domain index="0" />
Back up a list of measures.
Attribute | Description | Category |
---|---|---|
names | List of measure names | Required |
Sample usage:
<backup-domain-measures names="UTDyDst03U,UTDyDst05U,tdwpunelapbopb,bucpgmpp"/>
Restore a list of measures.
Attribute | Description | Category |
---|---|---|
names | List of measure names | Required |
Sample usage:
<restore-domain-measures names="UTDyDst03U,UTDyDst05U,tdwpunelapbopb,bucpgmpp"/>
Assert a hierarchy exists in domain or not.
Attribute | Description | Category |
---|---|---|
name | Hierarchy name | Required |
exists | If flag is true, then check if hierarchy exists in domain. | Required |
Sample usage:
<assert-domain-hier-exists name="clnd" exists="true"/>
Assert a domain is equal to another domain measure.
Asserts values of domain measures. The content of this tag can limit the comparison to a subset of the measure data. The format is DimName0:dim0pos0,dim0pos1,dim0pos3|DimName1:dim1pos0. This is the N number of dimension/positions lines with a vertical bar separator. Each dimension/position line has a dimension name followed by a colon separator and N position names with a comma separator between each name. This is an optional value.
Attribute | Description | Category |
---|---|---|
max-diffs | Maximum number of differences allow before stopping match (defaults to 32). | Optional |
output-file | Output file name containing list of differences. | Optional |
lhs-measure | LHS measure used for comparison. | Required |
rhs-measure | RHS measure used for comparison. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a domain measure is greater than or equal to another domain measure.
Asserts values of domain measures. The content of this tag can limit the comparison to a subset of the measure data. The format is DimName0:dim0pos0,dim0pos1,dim0pos3|DimName1:dim1pos0. This is the N number of dimension/positions lines with a vertical bar separator. Each dimension/position line has a dimension name followed by a colon separator and N position names with a comma separator between each name. This is an optional value.
Attribute | Description | Category |
---|---|---|
max-diffs | Maximum number of differences allow before stopping match (defaults to 32). | Optional |
output-file | Output file name containing list of differences. | Optional |
lhs-measure | LHS measure used for comparison. | Required |
rhs-measure | RHS measure used for comparison. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a domain measure is greater than another domain measure.
Asserts values of domain measures. The content of this tag can limit the comparison to a subset of the measure data. The format is DimName0:dim0pos0,dim0pos1,dim0pos3|DimName1:dim1pos0. This is the N number of dimension/positions lines with a vertical bar separator. Each dimension/position line has a dimension name followed by a colon separator and N position names with a comma separator between each name. This is an optional value.
Attribute | Description | Category |
---|---|---|
max-diffs | Maximum number of differences allow before stopping match (defaults to 32). | Optional |
output-file | Output file name containing list of differences. | Optional |
lhs-measure | LHS measure used for comparison. | Required |
rhs-measure | RHS measure used for comparison. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a domain measure is less than or equal to another domain measure.
Asserts values of domain measures. The content of this tag can limit the comparison to a subset of the measure data. The format is DimName0:dim0pos0,dim0pos1,dim0pos3|DimName1:dim1pos0. This is the N number of dimension/positions lines with a vertical bar separator. Each dimension/position line has a dimension name followed by a colon separator and N position names with a comma separator between each name. This is an optional value.
Attribute | Description | Category |
---|---|---|
max-diffs | Maximum number of differences allow before stopping match (defaults to 32). | Optional |
output-file | Output file name containing list of differences. | Optional |
lhs-measure | LHS measure used for comparison. | Required |
rhs-measure | RHS measure used for comparison. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a domain measure is less than another domain measure.
Asserts values of domain measures. The content of this tag can limit the comparison to a subset of the measure data. The format is DimName0:dim0pos0,dim0pos1,dim0pos3|DimName1:dim1pos0. This is the N number of dimension/position lines with a vertical bar separator. Each dimension/position line has a dimension name followed by a colon separator and N position names with a comma separator between each name. This is an optional value.
Attribute | Description | Category |
---|---|---|
max-diffs | Maximum number of differences allow before stopping match (defaults to 32). | Optional |
output-file | Output file name containing list of differences. | Optional |
lhs-measure | LHS measure used for comparison. | Required |
rhs-measure | RHS measure used for comparison. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a domain measure is not equal to another domain measure.
Asserts values of domain measures. The content of this tag can limit the comparison to a subset of the measure data. The format is DimName0:dim0pos0,dim0pos1,dim0pos3|DimName1:dim1pos0. This is the N number of dimension/position lines with a vertical bar separator. Each dimension/position line has a dimension name followed by a colon separator and N position names with a comma separator between each name. This is an optional value.
Attribute | Description | Category |
---|---|---|
max-diffs | Maximum number of differences allow before stopping match (defaults to 32). | Optional |
output-file | Output file name containing list of differences. | Optional |
lhs-measure | LHS measure used for comparison. | Required |
rhs-measure | RHS measure used for comparison. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a domain measure pop count is equal to an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name. | Required |
pop-count | Expected popcount. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a domain measure pop count is greater than or equal to an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name. | Required |
pop-count | Expected popcount. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a domain measure pop count is greater than an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name. | Required |
pop-count | Expected popcount. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a domain measure pop count is less than or equal to an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name. | Required |
pop-count | Expected popcount. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
This section provides details about domain data edit operations.
Clears all measures used in the following tags: <edit-workbook-measure>, <set-workbook-measure>, <set-domain-measure>.
This sets all the contents of these measures to the NA value.
Clear a domain measure of all data. This sets all the contents of this measure to its NA value.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
Sample usage:
<clear-domain-measure name="r_ex_pick_real" />
Clear a list of domain measures of all data.
Attribute | Description | Category |
---|---|---|
path | Path to a file containing a new-line delimited list of measures | Required |
Sample usage:
<clear-domain-measure-list path="measlist.txt" />
Execute an expression.
Attribute | Description | Category |
---|---|---|
expression | The expression to execute/calculate.
This is a full expression string, |
Optional |
incremental | True if this is to be an incremental
evaluation. |
Optional |
Sample usage:
<execute-expression expression="a = b+c" incremental="false" />
Set the value of a domain measure based on provided
attributes.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
keys | List of comma-separated position names | Optional |
namedkeys | List of comma-separated position names | Optional |
path | Path to load measure type file to compare with | Optional |
keyint | Intersection string | Optional |
value | Expected value | Optional |
start | Starting column of measure field | Optional |
width | Width of measure field | Optional |
incremental | True if evaluation is to be incremental | Optional |
Note: Note that for Date type measures, RPAC supports setting the array cell using either of the following two Date & Time formats - "%m/%d/%Y" or "%m/%d/%Y-%H:%M:%S" where m = 2 digit month, d = 2 digit date, Y = 4 digit year, H = 2 digit hour, M = 2 digit min, and S = 2 digit sec. |
Sample usage:
<set-domain-measure name="r_ex_pick_real" keyint="dept" keys="1" value="150" type="real" />
Sample usage (using keys):
<set-domain-measure name="meas1" keys="0-2:5" value="0.0" />
Sample usage (using keyint):
<set-domain-measure-value-ne name="meas2" namedkeys="chnl1:week1" value="02/24/2012" />
Sample usage (load-measure file):
<set-domain-measure name="meas1" path="loadMeas1.dat" start="100" width="20"/>
Sample usage (set all):
<set-domain-measure name="meas1" value="2"
Dump a measure to a text file.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
path | File path to text file to be used | Required |
noValues | Flag to disable dumping of cell values. | Optional |
Sample usage:
<dump-domain-measure name="utdydst03u" path="test3.txt" noValues="true"/>
This section provides details about workbook operation tags.
This section provides details about workbook wizard operations.
Builds workbook based on provided tag data.
Attribute | Description | Category |
---|---|---|
template-name | Template name | Required |
label | Label for workbook | Required |
user | User used to access workbook | Required |
Sample usage:
<build template-name="MeasureAnalysis" label="MEAS AN" user="adm">
Contains the settings for a wizard page.
Attribute | Description | Category |
---|---|---|
id | ID use to match up settings with wizard pages. For configured templates, this follows the pattern:
wiz_<wbt_name><base_dim> Example: For the EnableOp workbook, the wizard page that sets CHNL is: Fwiz_EnableOpchnl Note: For custom templates, obtain the name from the administrator. |
Required |
Sample usage:
<wizard-page-settings id="wiz_EnableOpchnl">
Sets the selection of a SingleHier Select control of a custom wizard page.
Attribute | Description | Category |
---|---|---|
control-name | Name of the control for a wizard page. This can be obtained from the template.cfg file. | Required |
dim-name | Name of the dimension containing the selection. | Required |
selection | Name of the position selected. | Required |
Sample usage:
<set-hier-selection control-name="loc_select" dim-name="chnl" selection="1" >
Sets the value for a Boolean control on a custom wizard page.
Attribute | Description | Category |
---|---|---|
control-name | Name of the control for a wizard page. This can be obtained from the configuration | Required |
selected | Set this to TRUE or FALSE | Required |
Sample usage:
<set-selected control-name="UseExtraMeasures" value="TRUE">
Sets the selection of a drop-down list control on a custom wizard page.
Attribute | Description | Category |
---|---|---|
control-name | Name of the control for a wizard page. This can be obtained from the configuration. | Required |
selection | Text for the selection operation. | Required |
Sample usage:
<set-selection control-name="ForecastLevel" value="2">
Sets the selections of a list box or tree control on a custom wizard page. This tag should contain a space-delimited list of the selections.
Attribute | Description | Category |
---|---|---|
control-name | Name of the control for a wizard page. This can be obtained from the configuration. | Required |
Sample usage:
<set-selections control-name="ExtraMeasures"> meas1 meas2 meas3 </set selections>
Sets the contents of an edit control on a custom wizard page.
Attribute | Description | Category |
---|---|---|
control-name | Name of the control for a wizard page | Required |
test | Text for the operation | Required |
Sample usage:
<set-text control-name="MyText" value="abc">
Sets the selections for a two-tree control on either a standard or custom wizard page.
Attribute | Description | Category |
---|---|---|
control-name | Name of the control. For two-tree controls, this should always be set to "tree1" | Required |
rollup-name | The highest level of the wizard page. | Required |
dim-name | Name of the dimension on which the selections are made. | Required |
Sample usage:
<set-tree-selections control-name="tree1" rollup-name="chnl" dim-name="str"> str1,str2,str3 </set-tree-selections>
This section provides details about workbook operations.
Does workbook calculations.
Attribute | Description | Category |
---|---|---|
template-name | Template name | Required |
label | Label for workbook | Required |
user | User used to access workbook | Required |
Sample usage:
<calc template-name="RptAdmin" label="Reporting Administration" user="adm"/
Checks for the existence of, or executes, a custom menu.
Attribute | Description | Category |
---|---|---|
template-name | Template name | Required |
label | Label for workbook | Required |
user | User used to access workbook | Required |
menu-label | Menu label for this custom menu. This can be obtained from the configuration | Required |
menu-exist | Set this to "true" to see if the menu item exists, or leave it blank to execute the custom menu. | Optional |
Sample usage:
<custom-menu template-name="BottomUp" label="Botup" user="adm" menu-label="menuItem83" menu-exist="true"/>
Does workbook refresh.
Attribute | Description | Category |
---|---|---|
template-name | Template name | Required |
label | Label for workbook | Required |
user | User used to access workbook | Required |
rule-group | Set this to use a rule group other than the default refresh group. | Optional |
Sample usage:
<refresh template-name="BottomUp" label="Botup" user="adm" rule-group="refresh_alt"/>
Does workbook close. Arguments may be provided for debug purposes.
Attribute | Description | Category |
---|---|---|
template-name | Template name | Optional |
label | Label for workbook | Optional |
user | User used to access workbook | Optional |
Sample usage:
<close template-name="BottomUp" label="Botup" user="adm"/>
Does workbook commit.
Note that this tag can only be used within the workbook-operatio tag.
Attribute | Description | Category |
---|---|---|
template-name | Template name. | Required |
user | User used to access workbook. | Required |
name | Name to use to refer to this commit ASAP. | Optional |
wait-for | Number of seconds to wait for the commit to complete. Defaults to 8 hours. RPAC will not wait if the value is zero. | Optional |
debug | True for waitForDebugger (defaults to false). | Optional |
Sample usage:
<commit type="now" template-name="BottomUp" label="Bottom Up MFP Refresh" user="adm" />
Rebuild current workbook.
Note that this tag can only be used within the workbook-operations tag.
Attribute | Description | Category |
---|---|---|
segment-id | Segment ID of workbook to rebuild. | Required |
output-file | File name for workbook operation to redirect its output. | Optional |
check-status | Boolean to determine if a non-zero return status will throw an exception (defaults to true). | Optional |
user | User used to access workbook. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Waits for a workbook commit ASAP to complete.
Note that this tag can only be used within the workbook-operations tag.
Attribute | Description | Category |
---|---|---|
name | Comma separated list of names to use to refer to named commit ASAP. | Required |
wait-for | Number of seconds to wait for. Defaults to 8 hours. | Optional |
debug | True for waitForDebugger (defaults to false). | Optional |
This section provides details about workbook assertions.
Asserts that the measures provided are visible (or not visible) on the window.
Attribute | Description | Category |
---|---|---|
name | Name of the window in the workbook configuration. User-generated windows cannot be used. | Required |
measure | Comma-separated list of measures names. | Optional |
containflag | If true, will check that measures provided are visible. If false, will check that the measures provided are not visible. | Optional |
Sample usage:
<assert-window-contain-measure name=" chnldeptssn__W" measures =" Ipopappenbb"/>
Asserts if a window exists in the current workbook.
Attribute | Description | Category |
---|---|---|
name | Window name of current workbook | Required |
Sample usage:
<assert-window-exists name="chnldeptssn__W" />
Asserts window intersection matches provided intersection.
Attribute | Description | Category |
---|---|---|
name | Window name of current workbook. | Required |
baseint | Intersection string to compare. Leave blank if checking for scalar. | Optional |
Sample usage:
<assert-window-intersection name="chnldeptssn__W" baseint"chnldeptssn_" />
Asserts if a window does not exist in the current workbook.
Attribute | Description | Category |
---|---|---|
name | Window name of current workbook | Required |
Sample usage:
<assert-window-not-exists name="chnldeptssn__W" />
Asserts a measure exists.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
Sample usage:
<assert-measure-exists name=" Ipopappenbb" />
Asserts a workbook measure base intersection matches an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
intx | Intersection string to compare with | Required |
Sample usage:
<assert-measure-intersection name=" Ipopappenbb" baseint"chnldeptssn_" />
Asserts that a workbook measure at the specified positions is equal to the provided value.
Display-only measures cannot be used with this assert tag.
Parent tag(s): testcase
Child tag(s): None
Attribute | Description | Category |
---|---|---|
keys | The keys to be used to compare measure values. Can be either indices or position names. Each dimension spec in the keys-spec is delimited by a ":". Multiple position ranges for a dimension can be specified by using "," as separators.
When using indices, a range of positions can also be used. Ex - "0-2:4-7,11-13:4" implies indices 0,1,2 for the first dimension, 4,5,6,7,11,12,13 for the second, and 4 for the third dimension of the measure. Note: Because indices are based on the workbook selections, they may not be consistent across all test cases. Care must be exercised to ensure that you are using the correct indices for your specific test case. |
Required |
namedkeys | Position names used to get keys of the measure array. Using indices instead of position names or positions that do not exist in the MeasureStore (Workbook) will be flagged as an error. Similar to "keys" above, but using position names only. | Optional |
path | Path of the flat file used for comparison against the Measure array. This looks like pointing to a pre-set environment variable. "path" cannot be used along with "keys" or "namedkeys". "path" is used only to compare the measure data against a pre-existing flat file. If none of "path","keys" and "namedkeys" are specified, the comparison occurs for all the keys in the measure array of the Measure Store (Workbook). | Optional |
start | The field start value. If this does not exist in the XML, the value will be taken from the measure's properties. Used in flat-file comparison. | Optional |
width | The field start value. If this does not exist in the XML, the value will be taken from the measure's properties. Used in flat-file comparison. | Optional |
value | The expected value of the measure. Comparison on equality. | Optional |
intersection | The measure is accessed at the provided intersection base | Optional |
Sample usage: (indices)
<assert-workbook-measure-value-eq name="drwppthrsclsp" keys="0-2" value="0.0" />
Sample usage (names):
<assert-workbook-measure-value-eq name="drwppthrsclsp" namedkeys="pos1,pos2,pos3" value="0.0" />
Asserts a workbook measure value at the specified positions is greater than or equal to the provided value.
Display-only measures cannot be used with this assert tag.
Attribute | Description | Category |
---|---|---|
keys | The keys to be used to compare measure values. Can be either indices or position names. Each dimension spec in the keys-spec is delimited by a ":". Multiple position ranges for a dimension can be specified by using "," as separators.
When using indices, a range of positions can also be used. Ex - "0-2:4-7,11-13:4" implies indices 0,1,2 for the first dimension, 4,5,6,7,11,12,13 for the second, and 4 for the third dimension of the measure. Note: Because indices are based on the workbook selections, they may not be consistent across all test cases. Care must be exercised to ensure that you are using the correct indices for your specific test case. |
Required |
namedkeys | Position names used to get keys of the measure array. Using indices instead of position names or positions that do not exist in the MeasureStore (Workbook) will be flagged as an error. Similar to "keys" above, but using position names only. | Optional |
path | Path of the flat file used for comparison against the Measure array. This looks like pointing to a pre-set environment variable. "path" cannot be used along with "keys" or "namedkeys". "path" is used only to compare the measure data against a pre-existing flat file. If none of "path","keys" and "namedkeys" are specified, the comparison occurs for all the keys in the measure array of the Measure Store (Workbook). | Optional |
start | The field start value. If this does not exist in the XML, the value is taken from the measure's properties. Used in flat-file comparison. | Optional |
width | The field start value. If this does not exist in the XML, the value is taken from the measure's properties. Used in a flat-file comparison. | Optional |
value | The expected value of the measure. Comparison on equality. | Optional |
intersection | The measure is accessed at the provided intersection base | Optional |
Sample usage (indices):
<assert-workbook-measure-value-ge name="drwppthrsclsp" keys="0-2" value="0.0" />
Sample usage (names):
<assert-workbook-measure-value-ge name="drwppthrsclsp" namedkeys="pos1,pos2,pos3" value="0.0" />
Asserts a workbook measure value is greater than a provided value.
Display-only measures cannot be used with this assert tag.
Attribute | Description | Category |
---|---|---|
keys | The keys to be used to compare measure values. Can be either indices, or position names. Each dimension spec in the keys-spec is de-limited by a ":". Multiple position ranges for a dimension can be specified by using "," as separators.
When using indices, a range of positions can also be used. Ex - "0-2:4-7,11-13:4" implies indices 0,1,2 for the first dimension, 4,5,6,7,11,12,13 for the second and 4 for the third dimension of the measure. Note: Because indices are based on the workbook selections, they may not be consistent across all test cases. Care must be exercised to ensure that you are using the correct indices for your specific test case. |
Required |
namedkeys | Position names used to get keys of the measure array. Using indices instead of position names or positions that do not exist in the MeasureStore (Workbook) will be flagged as an error. Similar to "keys" above, but using position names only. | Optional |
path | Path of the flat file used for comparison against the Measure array. This looks like pointing to a pre-set environment variable. "path" cannot be used along with "keys" or "namedkeys". "path" is used only to compare the measure data against a pre-existing Flat file. If none of "path","keys" and "namedkeys" are specified, the comparison occurs for all the keys in the measure array of the Measure Store (Workbook). | Optional |
start | The field start value. If this does not exist in the XML, the value is taken from the measure's properties. Used in a flat-file comparison. | Optional |
width | The field start value. If this does not exist in the XML, the value is taken from the measure's properties. Used in flat-file comparison. | Optional |
value | The expected value of the measure. Comparison on equality. | Optional |
intersection | The measure is accessed at the provided intersection base | Optional |
Sample usage (indices):
<assert-workbook-measure-value-gt name="drwppthrsclsp" keys="0-2" value="0.0" />
Sample usage (names):
<assert-workbook-measure-value-gt name="drwppthrsclsp" namedkeys="pos1,pos2,pos3" value="0.0" />
Asserts a workbook measure value is less than or equal to a provided value.
Display-only measures cannot be used with this assert tag.
Attribute | Description | Category |
---|---|---|
keys | The keys to be used to compare measure values. Can be either indices, or position names. Each dimension spec in the keys-spec is delimited by a ":". Multiple position ranges for a dimension can be specified by using "," as separators.
When using indices, a range of positions can also be used. Ex - "0-2:4-7,11-13:4" implies indices 0,1,2 for the first dimension, 4,5,6,7,11,12,13 for the second, and 4 for the third dimension of the measure. Note: Because indices are based on the workbook selections, they may not be consistent across all test cases. Care must be exercised to ensure that you are using the correct indices for your specific test case. |
Required |
namedkeys | Position names used to get keys of the measure array. Using indices instead of position names, or positions that do not exist in the MeasureStore (Workbook) will be flagged as an error. Similar to "keys" above, but using position names only. | Optional |
path | Path of the flat file used for comparison against the Measure array. This looks like pointing to a pre-set environment variable. "path" cannot be used along with "keys" or "namedkeys". "path" is used only when we want to compare the measure data against a pre-existing flat file. If none of "path","keys" and "namedkeys" are specified, the comparison occurs for all the keys in the measure array of the Measure Store (Workbook). | Optional |
start | The field start value. If this does not exist in the XML, the value is taken from the measure's properties. Used in a flat-file comparison. | Optional |
width | The field start value. If this does not exist in the XML, the value is taken from the measure's properties. Used in flat-file comparison. | Optional |
value | The expected value of the measure. Comparison on equality. | Optional |
intersection | The measure is accessed at the provided intersection base | Optional |
Sample usage (indices):
<assert-workbook-measure-value-le name="drwppthrsclsp" keys="0-2" value="0.0" />
Sample usage (names):
<assert-workbook-measure-value-le name="drwppthrsclsp" namedkeys="pos1,pos2,pos3" value="0.0" />
Asserts a workbook measure value is less than a provided value.
Display-only measures cannot be used with this assert tag.
Attribute | Description | Category |
---|---|---|
keys | The keys to be used to compare measure values. Can be either indices, or position names. Each dimension spec in the keys-spec is de-limited by a ":". Multiple position ranges for a dimension can be specified by using "," as separators.
When using indices, a range of positions can also be used. Ex - "0-2:4-7,11-13:4" implies indices 0,1,2 for the first dimension, 4,5,6,7,11,12,13 for the second, and 4 for the third dimension of the measure. Note: Because indices are based on the workbook selections, they may not be consistent across all test cases. Care must be exercised to ensure that you are using the correct indices for your specific test case. |
Required |
namedkeys | Position names used to get keys of the measure array. Using indices instead of position names, or positions that do not exist in the MeasureStore (Workbook) will be flagged as an error. Similar to "keys" above, but using position names only. | Optional |
path | Path of the flat file used for comparison against the Measure array. This looks like pointing to a pre-set environment variable. "path" cannot be used along with "keys" or "namedkeys". "path" is used only when we want to compare the measure data against a pre-existing flat file. If none of "path","keys" and "namedkeys" are specified, the comparison occurs for all the keys in the measure array of the Measure Store (Workbook). | Optional |
start | The field start value. If this does not exist in the XML, the value is taken from the measure's pProperties. Used in flat-file comparison. | Optional |
width | The field start value. If this does not exist in the XML, the value is taken from the measure's properties. Used in a flat-file comparison. | Optional |
value | The expected value of the measure. Comparison on equality. | Optional |
intersection | The measure is accessed at the provided intersection base | Optional |
Sample usage (indices):
<assert-workbook-measure-value-lt name="drwppthrsclsp" keys="0-2" value="0.0" />
Sample usage (names):
<assert-workbook-measure-value-lt name="drwppthrsclsp" namedkeys="pos1,pos2,pos3" value="0.0" />
Asserts a workbook measure value is not equal to a provided value.
Display-only measures cannot be used with this assert tag.
Attribute | Description | Category |
---|---|---|
keys | The keys to be used to compare measure values. Can be either indices, or position names. Each dimension spec in the keys-spec is de-limited by a ":". Multiple position ranges for a dimension can be specified by using "," as separators.
When using indices, a range of positions can also be used. Ex - "0-2:4-7,11-13:4" implies indices 0,1,2 for the first dimension, 4,5,6,7,11,12,13 for the second, and 4 for the third dimension of the measure. Note: Because indices are based on the workbook selections, they may not be consistent across all test cases. Care must be exercised to ensure that you are using the correct indices for your specific test case. |
Required |
namedkeys | Position names used to get keys of the measure array. Using indices instead of position names, or positions that do not exist in the MeasureStore (Workbook) will be flagged as an error. Similar to "keys" above, but using position names only. | Optional |
path | Path of the flat file used for comparison against the Measure array. This looks like pointing to a pre-set environment variable. "path" cannot be used along with "keys" or "namedkeys". "path" is used only to compare the measure data against a pre-existing flat file. If none of "path","keys" and "namedkeys" are specified, the comparison occurs for all the keys in the measure array of the Measure Store (Workbook). | Optional |
start | The field start value. If this does not exist in the XML, the value is taken from the measure's properties. Used in a flat-file comparison. | Optional |
width | The field start value. If this does not exist in the XML, the value is taken from the measure's properties. Used in flat-file comparison. | Optional |
value | The expected value of the measure. Comparison on equality. | Optional |
Sample usage (indices):
<assert-workbook-measure-value-ne name="drwppthrsclsp" keys="0-2" value="0.0" />
Sample usage (names):
<assert-workbook-measure-value-ne name="drwppthrsclsp" namedkeys="pos1,pos2,pos3" value="0.0" />
Asserts a workbook measure popcount matches an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
pop-count | Expected popcount | Required |
Sample usage:
<assert-workbook-popcount-eq name=" Ipopappenbb" pop-count="100" />
Asserts a workbook measure is not populated.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
Sample usage:
<assert-workbook-popcount-eq-zero name=" Ipopappenbb" />
Asserts a workbook measure is populated.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
Sample usage:
<assert-workbook-popcount-ne-zero name=" Ipopappenbb" />
Assert a workbook measure is equal to another workbook measure.
Asserts values of workbook measures. The content of this tag can limit the comparison to a subset of the measure data. The format is DimName0:dim0pos0,dim0pos1,dim0pos3|DimName1:dim1pos0. This is the N number of dimension/position lines with a vertical bar separator. Each dimension/position line has a dimension name followed by a colon separator and N position names with a comma separator between each name. This is an optional value.
Attribute | Description | Category |
---|---|---|
max-diffs | Maximum number of differences allowed before stopping match (defaults to 32). | Optional |
output-file | Output file name containing list of differences. | Optional |
lhs-measure | LHS measure used for comparison. | Required |
rhs-measure | RHS measure used for comparison. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a workbook measure is greater than or equal to another workbook measure.
Asserts values of workbook measures. The content of this tag can limit the comparison to a subset of the measure data. The format is DimName0:dim0pos0,dim0pos1,dim0pos3|DimName1:dim1pos0. This is the N number of dimension/position lines with a vertical bar separator. Each dimension/position line has a dimension name followed by a colon separator and N position names with a comma separator between each name. This is an optional value.
Attribute | Description | Category |
---|---|---|
max-diffs | Maximum number of differences allowed before stopping match (defaults to 32). | Optional |
output-file | Output file name containing list of differences. | Optional |
lhs-measure | LHS measure used for comparison. | Required |
rhs-measure | RHS measure used for comparison. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a workbook measure is greater than another workbook measure.
Asserts values of workbook measures. The content of this tag can limit the comparison to a subset of the measure data. The format is DimName0:dim0pos0,dim0pos1,dim0pos3|DimName1:dim1pos0. This is the N number of dimension/position lines with a vertical bar separator. Each dimension/position line has a dimension name followed by a colon separator and N position names with a comma separator between each name. This is an optional value.
Attribute | Description | Category |
---|---|---|
max-diffs | Maximum number of differences allowed before stopping match (defaults to 32). | Optional |
output-file | Output file name containing list of differences. | Optional |
lhs-measure | LHS measure used for comparison. | Required |
rhs-measure | RHS measure used for comparison. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a workbook measure is less than or equal to another workbook measure.
Asserts values of workbook measures. The content of this tag can limit the comparison to a subset of the measure data. The format is DimName0:dim0pos0,dim0pos1,dim0pos3|DimName1:dim1pos0. This is the N number of dimension/position lines with a vertical bar separator. Each dimension/position line has a dimension name followed by a colon separator and N position names with a comma separator between each name. This is an optional value.
Attribute | Description | Category |
---|---|---|
max-diffs | Maximum number of differences allowed before stopping match (defaults to 32). | Optional |
output-file | Output file name containing list of differences. | Optional |
lhs-measure | LHS measure used for comparison. | Required |
rhs-measure | RHS measure used for comparison. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a workbook measure is less than another workbook measure.
Asserts values of workbook measures. The content of this tag can limit the comparison to a subset of the measure data. The format is DimName0:dim0pos0,dim0pos1,dim0pos3|DimName1:dim1pos0. This is the N number of dimension/position lines with a vertical bar separator. Each dimension/position line has a dimension name followed by a colon separator and N position names with a comma separator between each name. This is an optional value.
Attribute | Description | Category |
---|---|---|
max-diffs | Maximum number of differences allowed before stopping match (defaults to 32). | Optional |
output-file | Output file name containing list of differences. | Optional |
lhs-measure | LHS measure used for comparison. | Required |
rhs-measure | RHS measure used for comparison. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a workbook measure is not equal to another workbook measure.
Asserts values of workbook measures. The content of this tag can limit the comparison to a subset of the measure data. The format is DimName0:dim0pos0,dim0pos1,dim0pos3|DimName1:dim1pos0. This is the N number of dimension/position lines with a vertical bar separator. Each dimension/position line has a dimension name followed by a colon separator and N position names with a comma separator between each name. This is an optional value.
Attribute | Description | Category |
---|---|---|
max-diffs | Maximum number of differences allowed before stopping match (defaults to 32). | Optional |
output-file | Output file name containing list of differences. | Optional |
lhs-measure | LHS measure used for comparison. | Required |
rhs-measure | RHS measure used for comparison. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a workbook measure pop count is equal to an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
pop-count | Expected popcount | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a workbook measure pop count is greater than or equal to an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
pop-count | Expected popcount | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a workbook measure pop count is greater than an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
pop-count | Expected popcount | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a workbook measure pop count is less than or equal to an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
pop-count | Expected popcount | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a workbook measure pop count is less than an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
pop-count | Expected popcount | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Assert a workbook measure pop count is not equal to an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
pop-count | Expected popcount | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Asserts the position rollup in workbook.
Note that this tag can only be used within the workbook-operations tag.
Attribute | Description | Category |
---|---|---|
rollup | Roll up. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
Asserts position label of a position in workbook.
Note that this tag can only be used within the workbook-operations tag.
Attribute | Description | Category |
---|---|---|
levelname | Level name | Required |
position | Position name | Required |
label | Position label | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
This section provides details about workbook data edit operations.
Clears a list of workbook measures of all data.
Attribute | Description | Category |
---|---|---|
path | Path to a file containing a new-line delimited list of measures | Required |
Sample usage:
<clear-workbook-list path="my_list.txt"/>
Clears a workbook measure of all data.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
Sample usage:
<clear-workbook-measure name=" Ipopappenbb/>
Edits the value of a workbook measure based on provided attributes. This tag closely models the action of editing a cell from the Client, as opposed to set-workbook-measure, which does a direct update of the workbook arrays.
Display-only measures cannot be edited with this tag.
This tag can be used in a variety of ways:
Set by loadmeasure file:By specifying <path>, <start>, and <width>, you can set the measure values according to a supplied loadmeasure file. This file must be in fixed-width format.
Set by positions:You can set individual positions by providing a <keys> tag. If you want, you can provide the list of positions at an aggregate level by specifying the intersection using the <keyint> tag.
Set everything:If you do not supply a <path> or <keys> tag, the entire measure will be set to the supplied value.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
keys | List of comma-separated position names | Optional |
namedkeys | List of comma-separated position names | Optional |
path | Path to load measure type file to compare with | Optional |
keyint | Intersection string | Optional |
value | Expected value | Optional |
start | Starting column of measure field | Optional |
width | Width of measure field | Optional |
Note: For Date type measures, RPAC supports setting the array cell using either of the following two Date & Time formats - "%m/%d/%Y" or "%m/%d/%Y-%H:%M:%S" where m = 2 digit month, d = 2 digit date, Y = 4 digit year, H = 2 digit hour, M = 2 digit min, and S = 2 digit sec. |
Sample usage (using keys):
<edit-workbook-measure name="meas1" keys="0-2:5" value="0.0" />
Sample usage (using keyint):
<assert-workbook-measure-value-ne name="meas2" namedkeys="chnl1:week1" value="02/24/2012" />
Sample usage (load-measure file):
<edit-workbook-measure name="meas1" path="loadMeas1.dat" start="100" width="20"/>
Sample usage (set all):
<edit-workbook-measure name="meas1" value="2"
Sets the value of a workbook measure based on provided attributes. Unlike edit-workbook-measure, this performs a direct change of the workbook data and does not update the change arrays unless told to do so. This can have an impact on the calculation cycle since bypassing the change arrays results in a full evaluation rather than incremental one.
This tag can be used in a variety of ways:
Set by loadmeasure file:By specifying <path>, <start>, and <width>, you can set the measure values according to a supplied loadmeasure file. This file must be in fixed-width format.
Set by positions:You can set individual positions by providing a <keys> tag. If you want, you can provide the list of positions at an aggregate level by specifying the intersection using the <keyint> tag.
Set everything:If you do not supply a <path> or <keys> tag, the entire measure will be set to the supplied value.
Attribute | Description | Category |
---|---|---|
name | Measure name | Required |
keys | List of comma-separated position names | Optional |
namedkeys | List of comma-separated position names | Optional |
path | Path to load measure type file to compare with | Optional |
keyint | Intersection string | Optional |
value | Expected value | Optional |
start | Starting column of measure field | Optional |
width | Width of measure field | Optional |
incremental | True if evaluation is to be incremental | Optional |
Note: For Date type measures, RPAC supports setting the array cell using either of the following two Date & Time formats - "%m/%d/%Y" or "%m/%d/%Y-%H:%M:%S" where m = 2 digit month, d = 2 digit date, Y = 4 digit year, H = 2 digit hour, M = 2 digit min, and S = 2 digit sec. |
Sample usage (using keys):
<set-workbook-measure name="meas1" keys="0-2:5" value="0.0" incremental="true"/>
Sample usage (using keyint):
<set-workbook-measure-value-ne name="meas2" namedkeys="chnl1:week1" value="02/24/2012" />
Sample usage (load-measure file):
<set-workbook-measure name="meas1" path="loadMeas1.dat" start="100" width="20"/>
Sample usage (set all):
<set-workbook-measure name="meas1" value="2"
Assert workbook measures have matching content.The content of this tag can limit the comparison to a sub-set of the measure data. The format is DimName0:dim0pos0,dim0pos1,dim0pos3|DimName1:dim1pos0. This is N number of dimension/positions lines with a vertical bar separator. Each dimension/position line has a dimension name followed by a colon separator and N position names with a comma separator between each name. This is an optional value.
Sample usage:
<testcase name="Workbook Measure match"> <assert-workbook-measures-match lhs-measure="r_ex_b" rhs-measure="r_ex_c"/> </testcase> <testcase name="Workbook Measure match with dim map"> <assert-workbook-measures-match lhs-measure="r_ex_b" rhs-measure="r_ex_c"> sku:sku_10000008|str:str1000 </assert-workbook-measures-match> </testcase>
Attribute | Description | Category |
---|---|---|
debug | True for waitForDebugger | Optional |
max-diffs | Maximum number of differences allowed before stopping match (defaults to 32) | Optional |
output-file | Output file name containing list of differences | Optional |
lhs-measure | LHS measure used for comparison | Required |
rhs-measure | RHS measure used for comparison | Required |
This section provides details about dynamic position maintenance tags. Note that rpac tests for DPM are restricted to cloud deployments.
This section provides details about assertions.
Assert if a position does not exist.
Attribute | Description | Category |
---|---|---|
levelname | Level name | Required |
position | Position name | Required |
label | Position label | Required |
lang | Language | Required |
Sample usage:
<assert-position-label levelname="clss" position="4000" label="4000 Casual" lang="english" />
Assert if a position does not exist.
Attribute | Description | Category |
---|---|---|
levelname | Level name | Required |
position | Position name | Required |
Sample usage:
<assert-position-not-exists levelname="clss" position="4000"/>
Assert if the given rollup is valid or not.
Attribute | Description | Category |
---|---|---|
rollup | The expected format for rollup is rollup =childLevel:childPosition, parentLevel:parentPosition | Required |
Sample usage:
<assert-position-rollup rollup="clss:4000,dept:101" />
Assert the status of a position. Status is 1 for formal, 2 for informal, 0 for placeholder, and -1 for deleted.
Attribute | Description | Category |
---|---|---|
levelname | Level name | Required |
position | Position name | Required |
status | Status | Required |
Sample usage:
<assert-position-status levelname="str" position="str_dpm0000020" status="2"/>
This section contains details about update informal position operations.
tag is the child tag of update-informal-position.
Attribute | Description | Category |
---|---|---|
lang | Language | Required |
Sample usage:
<dpmposinfo lang="english"> </dpmposinfo>
This is the child tag of dpmposinfo.
Attribute | Description | Category |
---|---|---|
levelname | Level name | Required |
position | Position name | Required |
isnewpos | Boolean value: True for new position and False for modify. | Required |
label | Position label | Optional |
oldposition | Old position name | Optional |
type | Integer value. Can be one of the following
0, REGULAR: one single position 1, MULTIPLE_PER_PARENT: multiple positions per parent dim 2, ONE_PER_CHILD: one position on rollup dim per child - 3, ONE_FOR_ALL_CHILDREN: one pos on rollup dim for all children 4, GEN_NAME_ONLY: only generating names/labels without applying changes |
Optional |
count | position count for MULTIPLE_PER_PARENT type | Optional |
Sample usage:
<update-informal-positions> <dpmposinfo lang="english"> <dpmposentry levelname="dstr" isnewpos="false" position="801" label="Pos label" oldposition="801" type="0" count="1"/> </dpmposinfo> </update-informal-positions>
Assert array has the csv values contained in this tag.
Attribute | Description | Category |
---|---|---|
debug | True for waitForDebugger | Optional |
array | db.array path of array to be accessed | Required |
Assert arrays have matching content. The content of this tag can limit the comparison to a sub-set of the array. The format is DimName0:dim0pos0,dim0pos1,dim0pos3|DimName1:dim1pos0. This is N number of dimension/position lines with a vertical bar separator. Each dimension/position line has a dimension name followed by a colon separator and N position names with a comma separator between each name. This is an optional value.
Sample usage:
<testcase name="Array Match test"> <assert-arrays-match lhs-array="[DB_PATH].r_ex_b%1" rhs-array="[DB_PATH].r_ex_c%1"/> </testcase> <testcase name="Array Match test with dim map"> <assert-arrays-match lhs-array="[DB_PATH].r_ex_b%1" rhs-array="[DB_PATH].r_ex_c%1"> week:w10_1998|str:str0102 </assert-arrays-match> </testcase>
Attribute | Description | Category |
---|---|---|
debug | True for waitForDebugger | Optional |
max-diffs | Maximum number of differences allowed before stopping match (defaults to 32) | Optional |
output-file | Output file name containing list of differences | Optional |
lhs-array | LHS db.array path to array used for comparison | Required |
rhs-array | RHS db.array path to array used for comparison | Required |
The following tags are currently restricted in the Cloud for RPASCE.
Table 14-2 RPAC Restricted Tags
RPAC Tag | Description |
---|---|
assert-bitsize-value-eq |
Assert the dimInfo bitsize or dimregistry bitsize value of a dimension is equal to the value provide |
assert-dim-registry-version |
Assert the value for dimension registry version |
assert-dimension-contain |
Assert a dimension contains or does not contain a position name |
assert-dimension-exists |
Assert a dimension name exists |
assert-dimension-size |
Assert a dimension size is between a minimum and a maximum value |
assert-fact-group |
Assert a fact exists or not in the fact group |
assert-fact-table |
Assert fact table exists or not |
assert-fact-value-eq |
Assert a fact value is equal to an expected value |
assert-fact-value-ge |
Assert a fact value is greater than or equal to an expected value |
assert-fact-value-gt |
Assert a fact value is greater than a an expected value |
assert-fact-value-le |
Assert a fact value is less than or equal to an expected value |
assert-fact-value-lt |
Assert a fact value is less than a an expected value |
assert-fact-value-ne |
Assert a fact value is not equal to an expected value |
assert-level-contain |
Assert a level contains or does not contain a position name |
assert-level-exists |
Assert a level exist in Rdm or not |
assert-position-label |
Asserts the Updated DPM label |
assert-position-not-exists |
Asserts the position does not exist |
assert-position-rollup |
Asserts the roll up for DPM data |
assert-position-status |
Asserts the status of DPM data |
assert-rdm-hier-exists |
Assert a hierarchy exist in Rdm or not |
assert-reindex-in-progress |
Asserts the status of reindex with the user input |
assert-reindex-required |
Assert whether Diminfo Bitsize is equal to DimRegistry Bitsize |
assert-reindex-threshold |
Assert the Threshold value of the dimension |
assert-rpas-user-eq |
Assert the user is equal to an expected value |
assert-rpas-user-ge |
Assert the user is greater than or equal to an expected value |
assert-rpas-user-gt |
Assert the user is greater than an expected value |
assert-rpas-user-le |
Assert the user is less than or equal to an expected value |
assert-rpas-user-lt |
Assert the user is less than an expected value |
assert-rpas-user-ne |
Assert the user is not equal to an expected value |
assert-sql-query-eq |
Assert the SQL query value is equal to an expected value |
assert-sql-query-ge |
Assert the SQL query value is greater than or equal to an expected value |
assert-sql-query-gt |
Assert the SQL query value is greater than an expected value |
assert-sql-query-le |
Assert the SQL query value is less than or equal to an expected value |
assert-sql-query-lt |
Assert the SQL query value is less than an expected value |
assert-sql-query-ne |
Assert the SQL query value is not equal to an expected value |
backup-domain-measures |
Backup a list of measures |
clear-rdm-status |
Clears the rdm status code |
copy-domain |
Does a simple copy of a domain to a new location. |
delete-informal-position |
Deletes the DPM data |
dim-registry-version |
Save the current dimension registry version |
dpmposentry |
DPM position Entry |
dpmposinfo |
DPM position info |
dump-domain-measure |
Dump a measure to a text file. |
execute-sql-query |
Execute the SQL query provied as the value of this tag |
get-dimregistry-path |
Get current dimension registry path for give domain. |
load-domain-measure |
Load a measure from a text file. |
process-stop |
Stop RPAC created process |
process-wait |
Wait for RPAC created process to exit |
reset-seq-generator |
Reset a sequence generator to a specific value. |
restore-domain-measures |
Restore a list of measures |
rpasce_run |
Start a rpasce run script with the argsments provided as the value of this tag |
set-fact-value |
Set the value of a fact based on provided attributes |
set-rdm-status |
Sets the rdm status code |
shell |
Start a shell process with the command provided as the value of this tag |
update-dpm |
Updates the DPM data |
update-informal-positions |
Updates the informal positions |
set-database-role |
Sets the role for access to the database |
load-database-tables |
Loads one or more tables from CSV text file, given a list of text files or directories contain these files. Each file must have a .csv extension. The file path is relative to the RPAC data directory. The table will be truncated before the data is loaded from the CSV text file. |
dump-database-tables |
Dumps one or more SQL tables to the CSV text file, given a list of SQL tables. The CSV test files created contain in the RPAC data directory unless the attribute dst-directory is used to specify the directory to contain these files. |
truncate-database-tables |
Truncates the comma-separated list of database tables provided as the value for this tag. |
assert-fact-value-popcount-value-eq |
Asserts that the fact-value measure pop count is equal to an expected value. |
assert-fact-value-popcount-value-le |
Asserts that the fact-value measure pop count is less than or equal to an expected value. |
assert-fact-value-popcount-value-lt |
Asserts that the fact-value measure pop count is less than an expected value. |
assert-fact-value-popcount-value-ge |
Asserts that the fact-value measure pop count is greater than or equal to an expected value. |
assert-fact-value-popcount-value-gt |
Asserts that the fact-value measure pop count is greater than an expected value. |
assert-fact-value-popcount-value-ne |
Asserts that the fact-value measure pop count is not equal to an expected value. |
execute-bdi-importer |
Execute the request from the BDI importer. |
execute-bdi-extractor |
Execute the SQL query provided as the value of this tag. |
clear-fact-value |
Clear the fact measure of all data. |
clear-fact-value-list |
Clear a list of the fact measures for all data. Must provide either the attribute filename, where the list of measures is contain in a file, or the attribute measures, where the value of the attribute is a comma-separated list of measure names. |
set-database-role
Set the role for access to the database.
Attribute | Description | Category |
---|---|---|
role | Required | |
debug | True for waitForDebugger (defaults to false). | Optional |
load-database-tables
Loads one or more tables from the CSV text file, given a list of text files or directories containing these files. Each file must have a .csv extension. The file path is relative to the RPAC data directory. The table will be truncated before the data is loaded from the CSV text file.
Attribute | Description | Category |
---|---|---|
csv-files | List of CSV text files or directories containing these files. Each file must have a .csv extension. The file path is relative to the RPAC data directory. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
dump-database-tables
Dump one or more SQL tables to the CSV text file, given a list of SQL tables. The CSV test files created are contained in the RPAC data directory unless the attribute dst-directory is used to specify the directory to contain these files.
Attribute | Description | Category |
---|---|---|
sql-tables | List of SQL table names to dump to the CSV text files. | Required |
dst-directory | Path of directory that will contain the CSV text files. This path is relative to the RPAC data directory. If this is not provided, the CSV text files will be written into the RPAC data directory. | Optional |
sorted | Use the table keys to sort the rows (defaults to false). | Optional |
debug | True for waitForDebugger (defaults to false). | Optional |
truncate-database-tables
Truncates comma separated list of database tables provided as the value of this tag.
Attribute | Description | Category |
---|---|---|
debug | True for waitForDebugger (defaults to false). | Optional |
execute-bdi-extractor
Executes the request from the BDI extractor. The return control identifier is contained in the variable EXTRACTOR_CONTROL_ID.
Attribute | Description | Category |
---|---|---|
extractor | Extractor name. | Required |
job-context | Job context. | Required |
control-id | Control identifier (defaults to 0). | Optional |
debug | True for waitForDebugger (defaults to false). | Optional |
extractor-bdi-importer
Executes the request BDI importer.
Attribute | Description | Category |
---|---|---|
importer | Importer name. | Required |
appl-name | Application name. | Required |
module | Name of module. | Required |
data-set-type | Data set type. | Required |
job-context | Job context. | Required |
data-set-id | Data set identifier (defaults to 0). | Optional |
debug | True for waitForDebugger (defaults to false). | Optional |
clear-fact-value
Clears the fact measure of all data.
Attribute | Description | Category |
---|---|---|
name | Measure name. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
clear-fact-value-list
Clears a list of fact measures of all data. Must provide either the attribute filename, where the list of measures is contained in a file, or the attribute measures, where the value of the attribute is a comma-separated list measures names.
Attribute | Description | Category |
---|---|---|
filename | Filename of file containing measures names. | Optional |
measures | Comma-separated list of measure names. | Optional |
debug | True for waitForDebugger (defaults to false). | Optional |
assert-fact-value-popcount-value-eq
Asserts that a fact-value measure pop count is equal to an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name. | Required |
pop-count | Expected pop count. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
assert-fact-value-popcount-value-ge
Asserts that a fact-value measure pop count is greater than or equal to an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name. | Required |
pop-count | Expected pop count. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
assert-fact-value-popcount-value-gt
Asserts that a fact-value measure pop count is greater than a an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name. | Required |
pop-count | Expected pop count. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
assert-fact-value-popcount-value-le
Asserts that a fact-value measure pop count is less than or equal to an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name. | Required |
pop-count | Expected pop count. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
assert-fact-value-popcount-value-lt
Asserts that a fact-value measure pop count is less than a an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name. | Required |
pop-count | Expected pop count. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |
assert-fact-value-popcount-value-ne
Asserts that a fact-value measure pop count is not equal to an expected value.
Attribute | Description | Category |
---|---|---|
name | Measure name. | Required |
pop-count | Expected pop count. | Required |
debug | True for waitForDebugger (defaults to false). | Optional |