Export Load Rules for Offline Editing

You can export an Essbase dimension build or data load rule to JSON format, to view and edit advanced options offline or using REST API.

The JSON is structured into dimensions and fields, and reveals build methods and all other defined load rule settings. You can edit the JSON and re-import it to the cube directory, to apply your changes to a dimension build or data load.

Learning Task

Export a rule file to JSON to view its format. Prerequisite: First, import the Sample.Basic cube from the gallery of application workbooks.

In this exercise, you’ll view the JSON format of a dimension build rule for the Product dimension of Sample.Basic.

  1. On the Applications page, expand the application (Sample).

  2. From the Actions menu, to the right of the cube name (Basic), launch the inspector.

  3. Select the Scripts tab, and then click Rules.

  4. From the Actions menu, to the right of Dim_Product, select Export, and save Dim_Product.json to a local directory.

  5. Use a text editor to examine the details of the Product dimension rule settings.

    If you have an advanced editor that recognizes JSON, you can collapse the main sections as shown, to observe the high-level structure of this JSON format rule file.

    Collapsed JSON file contents with keys "dimensions", "fields", "dataSource", "editorOptions", and "studio"

    • The dimensions section contains key/value pairs matching dimension settings that are defined in the rule.

      For example, you can find the following general settings for the Product dimension represented in the JSON file.

      General properties of Product dimension shown in the rule interface. Type: Existing, Storage: Existing, Config: Existing, Unique: Existing, Update Option: Merge, Aggregate level usage: 0, Share: true, Build Method: Parent Child, Member Name: none, Solve Order: -1


      "Existing" specified as the value for any given setting indicates that the designer of the rule has designated no change in preference for that setting (the default is retained).
    • The fields section is repeated for each field in the rule, and contains key/value pairs matching the settings defined in the rule for each field.

      For example, you can find the following field properties for Field 1 of the Product dimension represented in the JSON file.

      Dim_Product rule with field properties for Field 1. Name: PARENT, Width: 12, Case: No Operation, Trim: yes

    • The dataSource section contains all the settings you can find in the Source Properties area of the rule definition.

      For example, the JSON file includes the General properties, and either the File or SQL properties, that are defined in the rule.

      General properties, File properties and SQL properties tabs in the rule interface

    • The key/pair "studio" : true indicates that this is an Index-based rule rather than a Regular type. An index-based rule is sometimes called a BPM rule. It has different validation requirements. To learn more about this kind of dimension build rule, see Create New Dimension Build Rule.