Setting up a Protocol

Creating a Protocol

• In the Navigator, select Calculation.
• The folder will expand. Select New Protocol…

• Provide a name for the new protocol, and optionally a description. Also, select the welltype codes that should be used for the well types Low Control and High Control. Finally, choose a starting version number. Note that version numbers must match the pattern “#.#.#” containing three numbers: MajorVersion.MinorVersion.Revision.

When you select Save, the protocol will be created and you will be taken to the Protocol View.

Creating a Protocol using an exported JSON file

Instead of creating a new protocol from scratch, you can also create one as a copy from another protocol, by exporting an existing protocol using the Export button, and then selecting Import… in the protocol creation screen.

Viewing a Protocol

To view a protocol, select Calculation in the Navigator and then select Browse Protocols. A table will be shown, listing all available protocols. Click on the protocol you want to view.

The top section displays general information about the protocol, such as the name, modification date, version number, as well as tags and properties.

The bottom section shows a list of all the features that have been defined in this protocol. Click on any feature to open a third section containing detailed information about the selected feature.

Editing a Protocol

To start editing a protocol, select the Edit button in the protocol view. This will switch the protocol view into Editing Mode:

You can now modify the name, description, well types, tags and properties. Also, you can now add, remove or modify features.

Important: all of the changes you make now, are considered as draft, and will only be applied once you click the Save button. At that point, the current timestamp will be appended to the protocol’s version number automatically.

Editing Features

• When the protocol is in Editing Mode, you can add a feature by selecting the Add Feature button above the feature list.
• To delete an existing feature, select the Trash Can icon on the right side of the feature.
• To modify a feature, select the Pencil icon on the right side of the feature. When you are ready with the changes to the feature, select Edit Feature to add these changes to the draft, or Cancel to discard the changes to the feature.

Browsing Formulas

To browse the available formulas:

• In the Navigator, select Calculation.
• The folder will expand. Select Browse Formulas

A table will list the available formulas, showing some basic information for each formula, such as the name, author, scope and language.

To see more detailed information, either click on a formula, or click on the “…” icon and select Details.

The top section will display general information about the formula. The bottom section will display the formula script.

Editing a Formula

To edit a formula, open a formula and select the Edit button in the top right corner.

You can then modify the formula name, description, scope as well as the formula script itself. When you are done making changes, select Save Changes to apply the modifications to the formula.

Creating a New Formula

To create a new formula, open the formula browser and select New Formula….

TODO