RA-HELP
1.RA Shop
Remote Analyst offers a central hub for Application developers to define their Applications’ metrics they want to display online (on Web ViewPoint Enterprise) and/or export to Remote Analyst. Sections below describe how you can “Create” an Application, define its Objects & Metrics, and finally Publish it. Note that no application code is stored by Remote Analyst.
1.1.Create
Each Application (App) Profile has 4 layers:
-
Producer – That is the company which developed the Application. It is the name of the Company assigned to you when you were given access to Remote Analyst.
-
Application – This is where you name an Application and set its general configuration.
-
Object – An Object is a collection of metrics. You simply give it a name and decide whether any of its Metrics should be exportable to Remote Analyst.
-
Metric – A Metric is an actual piece of information collected for the Application. It may be a specific statistic (number or percentage) or state.
What follows are the details of each layer.
1.1.1.Apps
An Application is identified by its Producer/Developer (your company name as registered in RA), its name & version number. The latter two are yours to define as you wish. You will also set two other fields:
- Interval in seconds – This sets how often the metrics for this application should be collected on the Host Server.
- Retention in minutes – This sets the period of time the metrics should be kept in Host Collector module’s memory. Note that optionally, you may export all such metrics to RA where they will be kept for years!
These two settings are the initial recommended values for you set for this Application, per Host Server. The user can later change these values on their Host, using Web ViewPoint Enterprise.
Interface
On initial access you can see a list of previously defined Applications and Version. This list can be sorted for any Column.
Click on the Add button on the upper right toolbar to add a new Application.
Note that once an Application is added, it can neither be edited or removed!
1.1.2.Objects
This is the third layer of an Application. Consider it as a grouping of Metrics.
There may be one or more Objects per Application.
Interface
On initial access you can see a list of previously defined Objects. This list can be sorted for any Column.
Click on the Add button on the upper right toolbar to add a new Object.
Select a previously defined Application and Version, and simply choose a name for the new Object. Also choose whether Metrics of this Objects should be exportable to Remote Analyst.
Click on the Copy button on the upper right toolbar to copy Objects (and associated metrics settings) from one Application & version to another.
1.1.3.Metrics
This is the fourth layer of an Application. It is where you define individual Metrics of an Application Object. Each Metric is a piece of information (statistic or state) which a Collector on the Host Server can collect. Here you define its detail settings, which determines how it may be displayed on Web ViewPoint Enterprise.
If the “Exportable” flag is set for the associated Application Object, then you may also choose whether this Metric may be exported to Remote Analyst. Note that off these, the user has the final say whether they want to export to Remote Analyst.
Interface
On initial access you can see a list of previously defined Metrics. This list can be sorted for any Column.
Click on the Add button on the upper right toolbar to add a new Metric.
Metric Definitions
Select a previously defined Application, Version, and Object. Now give this Metric a name, and:
-
Value Size: Number of bytes used to store/report this Metric.
-
Type: Whether it is a Number, Time, a Percentage, or a State
-
Min & Max Values: Applicable only to Number, Time & Percentage type, set the Metric’s range of values.
-
Aggregation Method: Specifies the aggregation method that EXExporter must use when converting the data to export
-
Show in Trend:
-
Alert on: Whether this metric should be available as an option in Alert screen of Web ViewPoint Enterprise. Checking this option displays Metric Alert Definitions tab where you define alert definitions and thresholds which will be reflected in Web ViewPoint Enterprise.
-
Exportable: Sets whether this metric should be available to be exported to Remote Analyst.
Metric Alert Definitions
This tab is displayed after Alert On option is enabled in the Metric Definitions screen.
-
Has Instance – Specifies whether instances of this metric can be selected to be alerted
-
Instance filter – Specifies whether instances of this metric can be alerted upon and the type of instance
-
Monitor Frequency
Min Value – Minimum value that monitor frequency can be set for
Max Value – Maximum value that monitor frequency can be set for
Default Monitor Value – Default value for monitor frequency
-
Thresholds
Has Minor threshold – Does this metric support minor threshold. You can select Yes|No. If Yes is selected, below definitions must be added.
Minor Thresholds Definitions
Min Value – Minimum value that a minor threshold can be set for
Max Value – Maximum value that a minor threshold can be set for
Default Value – Default value for a minor threshold
Threshold Condition – Sets the type of comparison for the minor threshold value
G – Greater than (>)
L – Less than (<)
N – Not equal to
Has Major threshold – Does this metric support major threshold. You can select Yes|No. If Yes is selected, below definitions must be added.
Major Thresholds Definitions
Min Value – Minimum value that major threshold can be set for
Max Value – Maximum value that major threshold can be set for
Default Value – Default value for major threshold
Threshold Condition – Sets the type of comparison for the major threshold value
G – Greater than (>)
L – Less than (<)
N – Not equal to
-
Tolerance
Min Value – Minimum value that tolerance time that can be set
Max Value – Maximum value that tolerance time that can be set
Default Minor Value – Default value for minor tolerance
Default Major Value – Default value for major tolerance
Tolerance unit – Unit of the tolerance time value
S – Seconds
M – Minutes
Click on the Copy button on the upper right toolbar to copy a Metric’s setting from one Object to an Object of another Application.
1.2.Publish
This enables you to select and publish a fully defined (has at least one Object & Metric) Application/Version, which has not yet been published.
Note that:
-
A Web ViewPoint Enterprise user looking for Applications, only sees the ones already published.
-
Once an Application/Version is Published, then all its definitions are locked and cannot be changed.
-
Published Applications cannot be removed.
Interface
On initial access you can see a list of previously defined Applications & Versions. Additional Columns show counts of their Object and Metrics. This list can be sorted for any Column.
Simply click on a previously undefined Application/version to Publish it.
2.Review
Coming soon
2.1.XApps
Coming soon
1.RA Shop
Remote Analyst offers a central hub for Application developers to define their Applications’ metrics they want to display online (on Web ViewPoint Enterprise) and/or export to Remote Analyst. Sections below describe how you can “Create” an Application, define its Objects & Metrics, and finally Publish it. Note that no application code is stored by Remote Analyst.
1.1.Create
Each Application (App) Profile has 4 layers:
-
Producer – That is the company which developed the Application. It is the name of the Company assigned to you when you were given access to Remote Analyst.
-
Application – This is where you name an Application and set its general configuration.
-
Object – An Object is a collection of metrics. You simply give it a name and decide whether any of its Metrics should be exportable to Remote Analyst.
-
Metric – A Metric is an actual piece of information collected for the Application. It may be a specific statistic (number or percentage) or state.
What follows are the details of each layer.
1.1.1.Apps
An Application is identified by its Producer/Developer (your company name as registered in RA), its name & version number. The latter two are yours to define as you wish. You will also set two other fields:
- Interval in seconds – This sets how often the metrics for this application should be collected on the Host Server.
- Retention in minutes – This sets the period of time the metrics should be kept in Host Collector module’s memory. Note that optionally, you may export all such metrics to RA where they will be kept for years!
These two settings are the initial recommended values for you set for this Application, per Host Server. The user can later change these values on their Host, using Web ViewPoint Enterprise.
Interface
On initial access you can see a list of previously defined Applications and Version. This list can be sorted for any Column.
Click on the Add button on the upper right toolbar to add a new Application.
Note that once an Application is added, it can neither be edited or removed!
1.1.2.Objects
This is the third layer of an Application. Consider it as a grouping of Metrics.
There may be one or more Objects per Application.
Interface
On initial access you can see a list of previously defined Objects. This list can be sorted for any Column.
Click on the Add button on the upper right toolbar to add a new Object.
Select a previously defined Application and Version, and simply choose a name for the new Object. Also choose whether Metrics of this Objects should be exportable to Remote Analyst.
Click on the Copy button on the upper right toolbar to copy Objects (and associated metrics settings) from one Application & version to another.
1.1.3.Metrics
This is the fourth layer of an Application. It is where you define individual Metrics of an Application Object. Each Metric is a piece of information (statistic or state) which a Collector on the Host Server can collect. Here you define its detail settings, which determines how it may be displayed on Web ViewPoint Enterprise.
If the “Exportable” flag is set for the associated Application Object, then you may also choose whether this Metric may be exported to Remote Analyst. Note that off these, the user has the final say whether they want to export to Remote Analyst.
Interface
On initial access you can see a list of previously defined Metrics. This list can be sorted for any Column.
Click on the Add button on the upper right toolbar to add a new Metric.
Metric Definitions
Select a previously defined Application, Version, and Object. Now give this Metric a name, and:
-
Value Size: Number of bytes used to store/report this Metric.
-
Type: Whether it is a Number, Time, a Percentage, or a State
-
Min & Max Values: Applicable only to Number, Time & Percentage type, set the Metric’s range of values.
-
Aggregation Method: Specifies the aggregation method that EXExporter must use when converting the data to export
-
Show in Trend:
-
Alert on: Whether this metric should be available as an option in Alert screen of Web ViewPoint Enterprise. Checking this option displays Metric Alert Definitions tab where you define alert definitions and thresholds which will be reflected in Web ViewPoint Enterprise.
-
Exportable: Sets whether this metric should be available to be exported to Remote Analyst.
Metric Alert Definitions
This tab is displayed after Alert On option is enabled in the Metric Definitions screen.
-
Has Instance – Specifies whether instances of this metric can be selected to be alerted
-
Instance filter – Specifies whether instances of this metric can be alerted upon and the type of instance
-
Monitor Frequency
Min Value – Minimum value that monitor frequency can be set for
Max Value – Maximum value that monitor frequency can be set for
Default Monitor Value – Default value for monitor frequency
-
Thresholds
Has Minor threshold – Does this metric support minor threshold. You can select Yes|No. If Yes is selected, below definitions must be added.
Minor Thresholds Definitions
Min Value – Minimum value that a minor threshold can be set for
Max Value – Maximum value that a minor threshold can be set for
Default Value – Default value for a minor threshold
Threshold Condition – Sets the type of comparison for the minor threshold value
G – Greater than (>)
L – Less than (<)
N – Not equal to
Has Major threshold – Does this metric support major threshold. You can select Yes|No. If Yes is selected, below definitions must be added.
Major Thresholds Definitions
Min Value – Minimum value that major threshold can be set for
Max Value – Maximum value that major threshold can be set for
Default Value – Default value for major threshold
Threshold Condition – Sets the type of comparison for the major threshold value
G – Greater than (>)
L – Less than (<)
N – Not equal to
-
Tolerance
Min Value – Minimum value that tolerance time that can be set
Max Value – Maximum value that tolerance time that can be set
Default Minor Value – Default value for minor tolerance
Default Major Value – Default value for major tolerance
Tolerance unit – Unit of the tolerance time value
S – Seconds
M – Minutes
Click on the Copy button on the upper right toolbar to copy a Metric’s setting from one Object to an Object of another Application.
1.2.Publish
This enables you to select and publish a fully defined (has at least one Object & Metric) Application/Version, which has not yet been published.
Note that:
-
A Web ViewPoint Enterprise user looking for Applications, only sees the ones already published.
-
Once an Application/Version is Published, then all its definitions are locked and cannot be changed.
-
Published Applications cannot be removed.
Interface
On initial access you can see a list of previously defined Applications & Versions. Additional Columns show counts of their Object and Metrics. This list can be sorted for any Column.
Simply click on a previously undefined Application/version to Publish it.
2.Review
Coming soon
2.1.XApps
Coming soon