CubeRuleGet

CubeRuleGet retrieves a specified cube rule as a single string. This function is valid only in Planning Analytics processes.

Syntax

CubeRuleGet(RuleName);

Argument

Description

RuleName

The name of the rule that you want to retrieve. You do not need to specify the .rux file extension.

The rule must exist on the database where the process is executed.

Example

CubeRuleGet('RevenueRule');

The RevenueRule contains these three lines:

['Gross Margin %']=c: (['Gross Margin']\['Gross Revenue'])*100;
['Unit Price'] = c: ['Gross Revenue']\['Units Sold'];
['Unit Cost'] = c: ['Cost of Sales']\['Units Sold'];

The example returns this single string:

'['Gross Margin %']=c: (['Gross Margin']\['Gross Revenue'])*100; ['Unit Price'] = c: ['Gross Revenue']\['Units Sold']; ['Unit Cost'] = c: ['Cost of Sales']\['Units Sold'];'