{"id":23106,"date":"2018-01-02T12:52:26","date_gmt":"2018-01-02T04:52:26","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=23106"},"modified":"2024-07-04T13:36:52","modified_gmt":"2024-07-04T05:36:52","slug":"using-the-calculation-editor","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/configuring-your-system\/creating-a-calculation\/using-the-calculation-editor\/","title":{"rendered":"Using the Calculation Editor"},"content":{"rendered":"\n

Quick Start<\/h2>\n

1. Build your calculation expression by dragging and dropping<\/strong> a function into the edit box. You can also drag entities, templates, tags, and other calculations in - click the relevant tab to see the available items. Note you do not need to drag and drop - you can simply type in the edit box if you wish.<\/p>\n

Related: Features of the Edit Box<\/a><\/p>\n

 <\/p>\n

2. In the edit box<\/strong>, make the changes you need to validate your expression.
\nWhen a function is dragged into the edit box, the parameters inside the brackets are simply placeholders, and you will need to modify them with the correct parameters for the function to work. The square brackets [ ] indicate optional parameters.\u00a0<\/p>\n

Related: Calculation Overview and Syntax<\/a>, Keywords<\/a>, Operators<\/a>\u00a0<\/p>\n

 <\/p>\n

3. Check the provided examples in the Details<\/strong> help tab to make sure you are on the right track.\u00a0<\/p>\n

4. Ensure the Errors<\/strong> tab displays 0 errors - this is how you know your function has the correct syntax.<\/p>\n

5. Click the Test<\/strong> tab to use the Calculation Tester<\/strong>, so you can\u00a0check that your calculation returns the correct data.<\/p>\n

Related: Using the Calculation Tester<\/a><\/p>\n

 <\/p>\n

\"\"<\/a><\/p>\n

Note: The Calculation Editor has been designed to support a minimum width of 1024px.<\/p>\n

 <\/p>\n

Calculation Editor Dialog Box<\/h2>\n

In the example below, the Calculation Editor is opened from an Explorer Trend. When the Calculation Editor is opened from Explorer, it is opened in a dialog box with additional features and options:<\/p>\n

\"\"<\/a><\/p>\n

At the top of the dialog box, the name and description will be shown (if applicable), and at the bottom are the available options for saving. They may be a combination of the following:<\/p>\n

Save<\/strong>: Save changes to the existing calculation. Available only when the calculation is being edited, does not apply to new calculations.\u00a0<\/p>\n

Save As<\/strong>: Save the calculation expression as a new calculation with a Name and Description. The name cannot contain reserved characters<\/a>. The calculation is inserted into the trend, with its name appearing in the trace table, rather than its expression.\u00a0This functionality requires Tag Editor permissions<\/a> in IFS OI Security.\u00a0<\/p>\n

Finish<\/strong>: Close the calculation editor and insert the new calculation into the trend. Only available when creating a new calculation in a trend.<\/p>\n

Cancel<\/strong>: Exit the calculation editor. The calculation is not saved or inserted into the trend.<\/p>\n

Cancelling Unsaved Changes<\/h3>\n

If you cancel the calculation editor, and there are unsaved changes, a confirmation dialog appears.\u00a0<\/p>\n

\"\"<\/a><\/p>\n

Save<\/strong>: Save your changes to the calculation.
\nDiscard<\/strong>: Abandon your changes to the calculation.
\nCancel<\/strong>: Return to the calculation editor, which still has your unsaved changes.<\/p>\n

Example<\/h3>\n

In the following example, we search for an entity from the entity list, then choose an attribute value to add to the expression. We multiply the attribute value by 2.<\/p>\n

\"\"<\/a><\/p>\n

In the Calculation Editor<\/strong>:<\/p>\n

1. <\/strong> Click the Entities<\/em> tab. Available component groups are: \"\"Functions and Keywords, \"\" Entities, \"\" Templates, <\/em> \"\" Tags<\/em> and \"\" Calculations<\/em>.<\/p>\n

2. <\/strong> Type search text (TWell 1<\/em>) in the Search box. (You can use wildcard filtering<\/a> here.)<\/p>\n

3. <\/strong>Click an entity in the filtered list (TWell 1<\/em>). The entity's templates are listed in the Templates<\/strong> column in the Details<\/strong> tab.<\/p>\n

4. <\/strong>Click a template to select it (Oil Producing Well<\/em>). The template's attributes are listed in the Attributes<\/strong> column in the Details<\/strong> tab.<\/p>\n

5. <\/strong>Click an attribute to select it (Alloc Oil<\/em>). The attribute's values are listed in the Values<\/strong> column in the Details<\/strong> tab.<\/p>\n

6. <\/strong>Double-click the attribute value that you want to use (Actual<\/em>). This inserts the fully-qualified attribute value into the expression editor.<\/p>\n

7. <\/strong>Complete the calculation expression: type * 2<\/strong> after the fully-qualified attribute value, to multiply by 2.<\/p>\n

8. <\/strong>Click Save As<\/strong> or\u00a0Finish<\/strong>, as required.<\/p>\n

 <\/p>\n","protected":false},"excerpt":{"rendered":"

Click the markers through this interactive tour to learn about the calculation editor's features, and read the Quick Start to quickly learn how to use it.<\/p>\n

Read more<\/i><\/a><\/p>\n","protected":false},"author":1,"featured_media":23157,"parent":23105,"menu_order":2,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[4],"tags":[100],"class_list":["post-23106","page","type-page","status-publish","has-post-thumbnail","hentry","category-explainer","tag-calculations","Version-4-5-4","Product-srv"],"_links":{"self":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/23106","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/comments?post=23106"}],"version-history":[{"count":4,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/23106\/revisions"}],"predecessor-version":[{"id":67761,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/23106\/revisions\/67761"}],"up":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/23105"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media\/23157"}],"wp:attachment":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media?parent=23106"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/categories?post=23106"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/tags?post=23106"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}