Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The metadata loading feature in the OneStream dashboard allows the user to push members from the OneStream System into CXO. This page goes through all the steps to push metadata for a given source.

This page assumes After creating a source has been created in OneStream and the source is opened in open it from the CXO Dashboard, as shown in the image below. :

...

The source details screen shows for each dimension the currently configured dimension, hierarchy and member filter. The letters indicate the customizable dimensions in the system: A = Account, E = Entity, S = Scenario, F = Flow, U1-U8 = User-Defined dimensions.

...

To load new metadata into CXO, press the “Edit Dimensions & Hierarchies” button in the bottom left corner of the screen. A new screen is shown, similar to the one below.:

...

To push new metadata perform the following actions:

  • Select the Cube from which the metadata needs to be taken.

  • Under Dimension Selectors, select for each dimension the specific dimension to be taken. The selector shows the name of the dimension followed by the scenario type this dimension belongs to in parentheses.

  • Press the refresh button next to the Dimension Selectors column to populate the Hierarchy Selectors.

  • Under Hierarchy Selectors select for each dimension either the root member of the hierarchy to be exported or choose to specify a custom expression for member selection.

    • When a root member is selected, the metadata push contains this root member and all of its descendants. Using the member property filter the hierarchy can be filtered further.

    • When the option (Custom Expression…) is selected, the metadata push contains all members that are a result of this filter. These members are organized as a flat list under a single root member.

  • Under Custom Expressions, choose the OneStream custom expression to select the members to export. Only needed when (Custom Expression…) is selected for the hierarchy selector. These expressions should follow the OneStream expression syntax, for which we refer to the OneStream documentation (registration for OneStream documentation is needed for access).
    Note that the custom expression is also applied when extracting data from OneStream into CXO. Only data connected to the resulting expression is included in the data push. When selecting multiple members the ; sign should be used as a seperatorseparator.

  • Under Member Property Filter optionally select the Text property used to filter the dimension. Not applied when (Custom Expression…) is selected for the hierarchy selector.

    • Note: Place into the Dimension into one of the Text filters the flag CXO to identify which elements from the dimension will be loaded.

  • Press the load button on the right of the screen and confirm in the pop-up that appears. Select Full metadata extraction to reload all data into CXO. For changes such as creating new nodes or hierarchy movements a full metadata refresh is recommended.
    Use the Standalone metadata extraction featurewhen only a part of the metadata gets updated and the changes to the existing data needed to be loaded. This makes the metadata refresh process faster. Currently, the following scenarios are supported as part of the Standalone metadata extraction:

    • Adding members as leaf members to hierarchies

    • Adding complete branches

    • Deleting leaf members

    • Deleting complete branches

    • Updating members

Please note that after deleting a member or branch, you can only add it back through a full metadata extract.

  • Image Added
  • When the metadata is pushed, the system shows a pop-up indicating the push was successful.

    Image Added

After the metadata is up to date, you can now load the data into the metadata members.

Scheduled Extraction
OneStream Scheduler enables scheduled metadata extraction and data exports. In addition to the existing Full metadata extraction feature, Standalone metadata extraction option is available for OneStream Adapter v6 onwards. You can schedule an extraction by setting the parameter names and values for:

  • SourceSystem

  • DataSet

  • IncludeMetadata (Yes/No)

  • IncrementalMetadataExtraction (Yes/No)

    Image Added

When the parameter IncrementalMetadataExtraction is set to Yes, this can also be seen set as True in the logs.

...