The Variables Page

Use the Variable Document Manager page to create and manage your Variable Documents.

If you haven't already, you will need to define your document types using The Document Types Page.

Each document you create will be applicable at the project, version, or context level.

  1. Select Variable Management from the Navigation Toolbar.
  2. Click on the Variables tab, and then the Variables page.

Create Variables

To create a new Variable, follow these steps:

  1. Click the Create button.
  2. Enter a name for your variable in the Variables field.
  3. Configure your variable's settings:

    4. Click image to expand or minimize.

    1. Variable Type: Use this drop-down menu to select the type of variable you are creating. You will be able to choose between Standard, Document, and Nominal Conversion.
    2. Hidden: Use this option to create hidden variables.
    3. Type: Use this drop-down menu to select the type of data stored using this variable. Choose between Real, Integer, Boolean, and Date.
    4. Scalar/Vector: Toggle Scalar or Vector depending on the type of data you are storing with this variable. Select Vector to create a variable that stores array data. Select Scalar to create a single-value variable.
    5. Classification: Select the classification associated with the variable you are creating using this drop-down menu.
    6. Unit: Specify the units associated with your variable's values.
    7. Year to Month Conversion: Select a conversion method associated with your variable using this drop-down menu.
    8. Rollup Method: Choose a rollup method using this drop-down menu. Options include: None, Average, Calculate, Sum, and Time Average.
    9. Comment: Use this field to enter any comments associated with your variable.
    Continue reading below for a complete descriptions of these options.
  4. Once you have configured your variable's settings, click the Save button.

Delete Variables

You will only be able to delete variables when they are not linked to a definition.

To delete a variable, follow these steps:

  1. If you haven't already, use The Definitions Page to unlink the variable you wish to delete. If, when you select the variable you wish to delete, the Delete button is deactivated, the variable is still linked.
  2. Select the variable you wish to delete from the Variables drop-down menu.
  3. Click the Delete button.
  4. You will be prompted to confirm the deletion. Click OK to delete your variable.

Variable Settings

Variable Types

You can create three different variable types using this page. Each one is described below:

Variable TypeDescription
StandardStandard variables store object-specific variables.
DocumentDocument variables are used to store the same value, in more than one place. When configured properly, document variables will save you time with data entry.
Nominal Conversion

Use nominal conversion variables to store percentages.

Selecting the Nominal Conversion variable type will change the list of options substantially. Nominal conversions variables will always store real, vector percentages.

Hidden

This option will need to be toggled when creating variables that play a role in your calculation model, but are not managed by your users.

Type / Scalar / Vector

TypeDescription
RealUse this option to store real values. These numbers do not have to be whole.
IntegerInteger variables store whole numbers. (E.g. a project might be associated with 17 wells).
BooleanBoolean variables store data with two possible values. Typically, these are used for true or false variables.
Date Select this option to create date variables.

Scalar: Scalar variables store single values.

Vector: Vector variables store array data.

Classification

If you have not done so already, you can create classifications using The Classifications Tab. Remember, each variable you create can only be linked to one classification at a time.

Classifications are used to group like-variables with like-variables, and associate them with a unit system. Link the variables you create to a classification using this option.

Unit

Depending on the classification you have selected, different unit types will be available to you. Choose the appropriate units for the variable you are creating.

Year to Month Conversion

The following year to month conversion methods are available:

Conversion Type
None
Volume (Average)
Volume (Day-Weighted Average)
Rate (Average)
Rate (Day-Weighted Average)
Rate (Average, Exclude Nulls)
Rate (Day-Weighted Average, Exclude Nulls)
Rate (Average, Exclude Zeros)
Rate (Day-Weighted Average, Exclude Zeros)
Calculate
First Value
Last Value

Rollup Method

The rollup method you select controls how total variable values are calculated. The following options are available:

Rollup Method Type
None
Sum
Average
Time Average
Calculate