Formula Linked Definitions using UI

1. Creation

1.1 Existing formulas

The list shows existing formulas and their status

1.2 New formulas

New formula can be created by clicking on the ‘Create New’ button in the corresponding UI form.

1.3 Configuration

After a formula is created it needs to be configured.

1.3.1 Basic configuration

Basic configuration of Formulas include name and description. It is advisable to use meaningful texts for these configuration options to enable viewers to easily understand the meaning and the purpose of the formula.

1.3.2 Math configuration

Formulas can be composed from the unlimited number of items of the 4 types (as shown in the screenshot below):

  • Constants

  • Variables

  • Formulas

  • Text

1.3.2.1 Constants

Constants are variables with fixed values. Definition of constants contain Name, Description and Value.

1.3.2.2 Variables

Variables in Formulas represent data from documents. Variables can be linked with specific fields in schemas (using “Link” field). Similarly to ‘Constant’, ‘Variable’ definitions also contain Name and Description fields.

Link – special field which links variables to a schema field, or a component of another formula.

1.3.2.3 Formulas

Formula definitions can be re-used in other formulas. Formulas are defined using LaTex notation.

Link – a special field which indicates the field in the document schema where the result of the calculation is located.

Relationships – to enable navigation in a Formula using its variables, the list of these variables must be defined in the corresponding field.

1.3.2.4 Text

Text - a component which allows the description of the calculation algorithm without using mathematical notation. This component does not require any specific syntax.

2. Publishing

Formulas are linked to Policies and are only meaningful in the context of a Policy. Formulas can be published at the same time as the corresponding Policies, or separately after the Policy has been published. In the later case the Policy archive file will not include Formula definitions but otherwise will also be fully functional.

3. Viewing

Formulas are accessible via the corresponding button for all document which have linked formulas.

The Formula display dialogue shows all linked formulas and provides facilities to navigate through the components of these formulas.

4. Access

Policy Author users can create and edit formulas. Formulas are visible to all uses which access to the documents to which formulas are linked.

5. Import\Export

Formula definitions can be exported into a file.

Corresponding, Formula definition can be imported from a file.

Last updated