Steps

There are six built in Data Management Step types.

Calculate

A Step can be created to use one of the built-in consolidation/calculation options available.

Name

The name of the Data Management Step.

Description (Optional)

The description of the Data Management Step.

Data Management Group

The Data Management Group to which the Step belongs.

Step Type

The type of Data Management Step chosen.

Calculation Type

Calculate

This executes a calculation when Parameter Components are changed.  It runs calculations at the Entity level within the Local Member of the Consolidation Dimension without translating or consolidating.

Translate

This executes Translate when Parameter Components are changed.  It runs the Calculate step above at the Entity level and then translates data within the Translated Member of the Consolidation Dimension for each applicable relationship.

Consolidate

This executes a Consolidate when Parameter Components are changed. This runs the Calculate and Translate steps and then completes the calculations required all the way up the Consolidation Dimension.

Force Calculate, Translate, or Consolidate

The Force menu (e.g. Force Consolidation) items will run as if every cell included is marked as needing to be calculated, translated or consolidated.

Calculate, Translate, or Consolidate with Logging

The Logging items (e.g. Force Translation with Logging) trigger additional detailed logging which can be viewed in the Task Activity area. Drill into a log to see the length of time and details about every calculation.

Force Calculate, Translate, or Consolidate with Logging

This executes a Force Calculation, Translation, or Consolidation with Logging.

Cube

Specify the Cube where the consolidation/calculation will run.

Entity Filter

Specify the Entity, list of Entities or any combination of Entity hierarchies to be included in the consolidation/calculation.

Parent Filter

If alternate hierarchies are used, a Parent may be specified in order to be included in the consolidation/calculation.

Consolidated Filter

Specify the Consolidation Member or Members to be included in the consolidation/calculation.

Scenario Filter

Specify the Scenario Member or Members to be included in the consolidation/calculation.

Time Filter

Specify the Time Member or Members to be included in the consolidation/calculation.

Execute Scenario Hybrid Source Data Copy

Copies base-level Cube data from a specified source Scenario (using the Hybrid Source Data settings) to a specified target Scenario. Data copy occurs when a standard calculation is run on the target Scenario and, by default, follows the standard OneStream calculation sequence.

Clear Data

Name

The name of the Data Management Step.

Description (Optional)

A description of the Data Management Step.

Data Management Group

The Data Management Group to which the Step belongs.

Step Type

The type of Data Management Step chosen.

Use Detailed Logging

If set to True, a detailed log found in the Task Activity Log will provide additional detail about the process. 

Cube

Select the Cube where the consolidation/calculation will run.

Entity Filter

Select the Entity, list of Entities or any combination of Entity hierarchies to be included in the consolidation/calculation.

Scenario Filter

Select the Scenario Member or Members to be included in the consolidation/calculation.

Time Filter

Select the Time Member or Members to be included in the consolidation/calculation.

Clear Imported Data

This indicates whether the Import Member of the Origin Dimension should be included in the Clear Step.  Settings are True or False.

Clear Forms Data

This indicates whether the Forms Member of the Origin Dimension should be included in the Clear Step.  Settings are True or False.

Clear Adjustment Data and Delete Journals

This indicates whether the Adjustment Members of the Origin Dimension should be included in the Clear Step.  Settings are True or False.

Copy Data

Name

The name of the Data Management Step.

Description (Optional)

A description of the Data Management Step.

Data Management Group

The Data Management Group to which the Step belongs.

Step Type

The type of Data Management Step chosen.

Use Detailed Logging

If set to True, a detailed log found in the Task Activity Log will provide additional detail about the process.

Source Cube

Select the source Cube for the data copy.

Source Entity Filter

Select the source Entity, list of Entities or any combination of Entity hierarchies to be included in the data copy.

Source Scenario

Select the source Scenario Member or Members to be included in the data copy.

Source Time Filter

Select the source Time Member or Members to be included in the data copy.

Source View

Select the View Member to be included in the data copy.  This selection allows users to copy YTD data into a Periodic Member and vice versa.

Destination Cube

Select the destination Cube for the data copy.            

Destination Entity Filter

Select the destination Entity, list of Entities or any combination of Entity hierarchies to be included in the data copy.

Destination Scenario

Select the destination Scenario Member or Members to be included in the data copy.

Destination Time Filter

Select the destination Time Member or Members to be included in the data copy.

Destination View

Select the destination View Member to be included in the data copy.

Copy Imported Data

Choose True or False to copy O#Import data

Copy Forms Data

Choose True or False to copy O#Forms data. 

Copy Adjustment Data

Choose True or False to copy O#Adjustments data.

NOTE: If the Source and Destination View fields are left blank, the data will copy to the same View Member.  (e.g., YTD will copy to YTD or Periodic will copy to Periodic)

Custom Calculate

The typical use of the Custom Calculate Step is for speed of calculations during data entry and flexibility. For instance, a user could make on-the-spot changes in a Form, run this Custom Calculate and quickly experience What-if analysis based on the limited amount of data on the Form. Instead of running a full Calculate or Consolidation on a Data Unit, the Custom Calculate Data Management Step can be used to run a calculation on a slice of data within one or many Data Units. The calculation could be executed from within Data Management, by clicking Save on a Form in Workflow (through a Forms Event Handler) or related to a button on a Dashboard being used to enter Budget data, to state a few examples.

This type of calculation does not create audit information for each data cell affected, therefore will run faster than using the Copy Data Data Management Step type.

The user executing must be a member of the Scenario’s Manage Data Group or the Step will fail. This helps prevent unauthorized users from launching Steps like this, which could alter or clear data unintentionally.

Name

The name of the Data Management Step.

Description (Optional)

A description of the Data Management Step.

Data Management Group

The Data Management Group to which the Step belongs.

Use Detailed Logging

If set to True, a detailed log found in the Task Activity Log will provide additional detail about the process. 

Data Units

These are the Data Unit settings for what will be affected by calculation being applied. A single Cube and Scenario can be affected by this Step. A single or multiple Entities, Entity Parents, Consolidation members and Time Periods can be affected through Filter settings for Entity, Parent, Consolidation and Time in this section using the Member Filter Builder dialog. The related Business Rule below will run once for each of the number of Data Units specified here. These Data Unit members (e.g. Entity, Scenario, Time, etc.) can be referenced in the related Business Rule with functions such as API.Pov.Entity.Name or similar, but otherwise will not need to be mentioned within the context of the Business Rule. Upon running, this will reset Calculation Status of the affected Data Units to needing calculation.

Point of View

These are the single member entries of dimensions not in the Data Unit to be affected by the calculation. Settings are for View, Account, Flow, Origin, IC and UD1-UD8. These values are provided in the Step as a convenience and to be referenced from within the Business Rule. For instance, the UD1 member listed here in the POV setting could be referenced from within the Business Rule as api.Pov.UD1.Name. This can make the Business Rule flexible since the same rule could be used against multiple Data Management Custom Calculate Steps, but run differently based on the POV setting.

Business Rule / Function Name 
The name of the Finance-Type Business Rule and contained Function to run when this Step runs. This allows the user to specify settings such as Durable Storage within the rule. A simple example of a Business Rule which calculates data with Durable Storage is displayed below:

Select Case api.FunctionType
Case Is = FinanceFunctionType.CustomCalculate
If args.CustomCalculateArgs.FunctionName.XFEqualsIgnoreCase("myFunctionName") Then
    api.Data.Calculate("A#Profit = A#Sales - A#Costs", True)
End If
End Select

NOTE: When a Calculation or Consolidation runs on this same Data Unit after this Data Management Step is run, the data saved as calculated by this Step will be cleared unless it is saved with a Storage Type of Durable. ClearCalculatedData is first step in the standard Calculation Sequence that runs during a Calculation or Consolidation on Cube data. In this case, Durable data will be ignored during a calculate or even a Force Calculate or Consolidate unless a ClearCalculated function is used within the Business Rule or Member Formula to purposely clear the Durable data. However, if a calculation recalculates even data marked as Durable, it will then be replaced by the newly calculated data.

It is suggested that if this calculation within a Custom Calculate Data Management Step is to be replicated within a separate Member Formula or Business Rule, both can refer to the same saved Finance Business Rule function by name. To refer to this logic, see Defining a Reference to a Shared Business Rule in Implementing Security.

See Examples of Key Functions in About the Financial Model for examples of using API.Data.Calculate and API.Data.ClearCalculated to store and clear Durable data as desired.

Parameters

Refer to any parameters inside the Business Rule by listing them here in name-value pairs in this fashion:

Name1=Frankfurt, Name2=[Houston Heights]

Custom Parameters can be used by using the correct syntax. This will result in a prompt to the user at run time.

Name3=|!myParam!|

Execute Business Rule

Name

The name of the Data Management Step.

Description (Optional)

A description of the Data Management Step.

Data Management Group

The Data Management Group to which the Step belongs.

Step Type

The type of Data Management Step chosen.

Use Detailed Logging

If set to True, a detailed log found in the Task Activity Log will provide additional detail about the process.

Business Rule

Select from the available application Business Rules to run custom scripts or procedures.

Parameters (Optional)

This field is provided to pass Parameters or variables into the selected Business Rule.

Export Data

Name

The name of the Data Management Step.

Description (Optional)

A description of the Data Management Step.

Data Management Group

The Data Management Group to which the Step belongs.

Step Type

The type of Data Management Step chosen.

Use Detailed Logging

If set to True, a detailed log found in the Task Activity Log will provide additional detail about the process.

File Share File Name

The name given to the file being exported to the application file share.

Include Cube in File Name

If set to True, the Cube name will be included in the file name when exporting. 

Include Entity in File Name

If set to True, the Entity name will be included in the file name when exporting. 

Include Parent in File Name

If set to True, the Parent name will be included in the file name when exporting. 

Include Cons in File Name

If set to True, the Consolidation Member name will be included in the file name when exporting. 

Include Scenario in File Name

If set to True, the Scenario name will be included in the file name when exporting. 

Include Time in File Name

If set to True, the Time name will be included in the file name when exporting. 

Overwrite Existing Files

Set this to True to overwrite a previously exported file when exporting. 

Include Zeroes

If set to True, zero amount records will be included when exporting. 

Include Member Descriptions

If set to True, Member descriptions will be included when exporting. 

Include Cell Annotations

If set to True, cell annotations will be included when exporting. 

Include Input Data

If set to True, input type data will be included when exporting. 

Include Calculated Data

If set to True, calculated data will be included when exporting. 

Cube

Specify the Cube where consolidation/calculation will run.

Entity Filter

Specify the Entity, list of Entities or any combination of Entity hierarchies to be included in the consolidation/calculation.

Parent Filter

If alternate hierarchies are used, a Parent may be specified in order to be included in the consolidation/calculation.

Consolidated Filter

Specify the Consolidation Member or Members to be included in the consolidation/calculation.

Scenario Filter

Specify the Scenario Member or Members to be included in the consolidation/calculation.

Time Filter

Specify the Time Member or Members to be included in the consolidation/calculation.

Combinations of Data Filters (use #All for all stored base-level data)

Use standard Member Filter functionality to select specific data required for all Dimensions listed below:

Account Filter (e.g., “A#IS.Descendants, A#All”)
Flow Filter
Origin Filter
IC Filter
UD1-8 Filter

Specific Data Filters

Use standard Member Filter functionality in order to have fine grain control over the data exported.  Use this filter to choose more specific intersections of data.

Export File

Use the Export File Data Management Step to export an Extensible Document or Report Book to OneStream’s File Share.

Name

The name of the Data Management Step.

Description (Optional)

A description of the Data Management Step.

Data Management Group

The Data Management Group to which the Step belongs.

Step Type

The type of Data Management Step chosen.

Use Detailed Logging

If set to True, a detailed log found in the Task Activity Log will provide additional detail about the process.

File Share Folder

Enter the name of the File Share Folder where the desired file is saved.

File Name Suffix

Enter a suffix to include in the name of the file.

Overwrite Existing Files

Set to True to overwrite a previously exported file when exporting.

File Source Type

URL

Display a file from an internal or external web page. 

Application/System Dashboard File

Display a file stored in a Dashboard Maintenance Unit File section. 

Application/System Database File

Display a file stored in the Application or System Database Share. 

File Share File

Display a file from the File Share. 

URL or Full File Name

The URL or name of the file being used.  Enter the full URL name, or click the ellipsis and browse to the desired file.

Process Extensible Document

If set to True, the Data Management Step will run and process the attached Extensible Document file, if set to False the unprocessed file will display which is mainly used for testing purposes.

NOTE: An Extensible Document is a Text, Word, PowerPoint, or Excel file that uses Parameters in its content.  The file name must contain .xfDoc before the extension.

Example: StatusReport.xfDoc.docx

See Extensible Document Framework in Presenting Data With Extensible Documents for more details on this feature.

Read Parameter Names from Extensible Doc

If set to True, the Parameters used in the Extensible Document will prompt the user when the Data Management Sequence is run, if this is set to False, the Parameters can be specified ahead of time in the Parameters property below.

Parameters

Enter a comma separated list of name value pairs.

Example: ParameterName1=ValueName1, ParameterName2=[Value Name2]    

Export Report

Name

The name of the Data Management Step.

Description (Optional)

A description of the Data Management Step.

Data Management Group

The Data Management Group to which the Step belongs.

Step Type

The type of Data Management Step chosen.

Use Detailed Logging

If set to True, a detailed log found in the Task Activity Log will provide additional detail about the process.

File Share File Name

The name given to file being exported to the application file share.

Include Object Name in File

If set to True, the Dashboard Object will be included in the file name when exporting. 

Overwrite Existing Files

Set to True to overwrite a previously exported file when exporting. 

Report File Type

PDFs in Zip File

This will export all contained PDF’s individually in a ZIP file.

Combined PDF File

This will combine and then export all report PDF’s into one PDF file.

Object Type

Indicate whether a Dashboard or Dashboard Profile object is to be exported.

Object Name

The name of the Dashboard or Dashboard Profile being used.

Object Parameters (Optional)

This field is provided to pass Parameters or variables used when running the report normally.

Reset Scenario

Similar to Clear Data Step, except it clears additional related application data, yet does not create audit information for each data cell affected, therefore will run faster. It clears data within a range (including parent Entity data), audit information, Workflow Status and Calculation Status as if it never existed. This is intended for Administrator use. User executing must be a member of the Scenario’s Manage Data Group or the Step will fail. This helps prevent unauthorized users from launching Steps like this, which could alter or clear data unintentionally. It is recommended to only changes Manage Data Group from Nobody to a select exclusive User Group before running and then change back to Nobody afterwards. Also, ensure that your application database is backed up before performing a Reset Scenario.  Note that Reset Data will clear even data marked as Durable.

Name

The name of the Data Management Step.

Description (Optional)

A description of the Data Management Step.

Data Management Group

The Data Management Group to which the Step belongs.

Use Detailed Logging

If set to True, a detailed log found in the Task Activity Log will provide additional detail about the process. 

Scenario

Choose one Scenario to be reset.

Reset All Time Periods

Default is True, which will remove data and reset Workflow Status for all time periods. If False, the next three properties will be enabled. 

Start Year / End Year

The first and last years’ worth of time to clear from the Application and Workflow Status.

Start Time Period in First Year 

Optional. Time Period referenced in First Year to begin clearing data.