Skip to content

Commit

Permalink
fix: Vale errors
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrielraeder committed Mar 5, 2024
1 parent 0a61b47 commit 2cfbbc6
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Use the following table to name Object Types and Values:

## Use example

Here you find an example of an AF databse model to exemplify how the data will be automatically imported by the RCS.
Here you find an example of an AF database model to exemplify how the data will be automatically imported by the RCS.

By default, the Remote Context Server will create two Visual KPI groups out of the two AF elements (Plant 1 and Unit 1) found in the image representation below:

Expand All @@ -67,28 +67,28 @@ If you add specific child attributes to these AF attributes, they will then beco
alt=""
/>

Adding attributes to Unit 1 with names that match keywords for group properties will decorate the Visual KPI group with more information. In the following figure, we have added some sparkline duration properties.
Adding attributes to Unit 1 with names that match keywords for group properties will decorate the Visual KPI group with more information. In the following figure, we've added some sparkline duration properties.

### Using Child Elements as AF Attributes

The Visual KPI Remote Context Server can read Child Elements as AF attributes. You can place all of your Visual KPI keywords under Child Elements.

As you build out your AF Model to include Visual KPI keywords you may find that your AF model becomes quite busy, or even cluttered, with attributes that only Visual KPI cares about. For instance, it is unlikely that users viewing your AF model will care about attributes such as "Sparkline Start Time".
As you build out your AF Model to include Visual KPI keywords you may find that your AF model becomes quite busy, or even cluttered, with attributes that only Visual KPI cares about. For instance, it's unlikely that users viewing your AF model will care about attributes such as "Sparkline Start Time".

To keep your model as clean as possible, you can place all of these keyword attributes under the Child Elements attribute using the name "Visual KPI Properties". This can be seen exemplified in the image below:
To keep your model as clean as possible, you can place all of these keyword attributes under the Child Elements attribute using the name "Visual KPI Properties." This can be seen exemplified in the image below:

<StylizedImage
imgURL="img/setup-adm/automation/how-to-use/af_visual_kpi_properties.png"
alt=""
/>

The Child Elements attribute is not required by default. It is simply a way to tidy up your model. You can specify some or all of your attributes as Child Elements of the Visual KPI Properties attribute. The RCS will first check for this Child Elements property and then read the attributes nested below it, then it will check for attributes outside Child Elements.
The Child Elements attribute isn't required by default. It's simply a way to tidy up your model. You can specify some or all of your attributes as Child Elements of the Visual KPI Properties attribute. The RCS will first check for this Child Elements property and then read the attributes nested below it, then it will check for attributes outside Child Elements.

#### Ignoring attributes

The Child Elements attribute can also be used to mark an element or attribute that you want to be ignored by Visual KPI Remote Context Server. To do this, you need to set the Visual KPI Properties Child Element to **False**, **0** or **Omit**.

In the following example image, we have added a Level attribute to Unit 1 and set the Visual KPI Properties attribute to **False**, which indicates RCS should ignore this attribute and not create it as a Visual KPI value.
In the following example image, we've added a Level attribute to Unit 1 and set the Visual KPI Properties attribute to **False**, which indicates RCS should ignore this attribute and not create it as a Visual KPI value.

<StylizedImage
imgURL="img/setup-adm/automation/how-to-use/af_ignore.jpg"
Expand All @@ -103,7 +103,7 @@ If the Visual KPI Properties attribute is set to be ignored on an AF element, th

Visual KPI Remote Context Server has a setting called **Require Visual KPI Properties Attributes**, which is set to False by default. If set to True, this attribute be will be required in order to process the AF elements and attributes.

If this value is set to True and the Visual KPI Properties attribute is not found on either an AF Element or an AF Attribute, then that AF Element or AF Attribute will be ignored. This functionality toggles the logic requiring the Visual KPI Properties attribute to act as an "Opt In" rather than the default "Opt Out".
If this value is set to True and the Visual KPI Properties attribute isn't found on either an AF Element or an AF Attribute, then that AF Element or AF Attribute will be ignored. This functionality toggles the logic requiring the Visual KPI Properties attribute to act as an "Opt In" rather than the default "Opt Out."


<StylizedImage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Here are a few things to know about using the Visual KPI RCS to automate configu
- The RCS is different from an Interface for reading data. A Visual KPI Interface only gives you access to raw or calculated data, but not all of the attributes or configuration information required to create, define/edit or delete objects.
- You still need the Visual KPI Designer for site-wide settings (things that appear under the gear icon in the Visual KPI Designer).
- You can skip the other parts of the Designer completely, or you can have part of your site automated with the RCS and other parts that are manually configured with the Designer.
- The RCS can be configured in opt-in or opt-out mode. This tells the RCS to “read everything it sees, unless it is specifically decorated to be excluded” or read nothing unless it is specifically decorated to be read”.
- The RCS can be configured in opt-in or opt-out mode. This tells the RCS to “read everything it sees, unless it's specifically decorated to be excluded” or "read nothing unless it's specifically decorated to be read."
- Part of the RCS configuration, when reading a hierarchy of groups and objects, is to define an initial node in the hierarchy to start reading. This is great when you only want part of your application’s hierarchy to be included in Visual KPI and to ignore the rest.

:::support
Expand Down

0 comments on commit 2cfbbc6

Please sign in to comment.