Working with Excel Add-In for Operations Hub

Features of Excel Add-In for Operations Hub

Following are the features available in Excel add-in for Operations Hub

FeatureDescription
QueryEnables you to perform the model query and to get the data onto the excel.
ConfigurationEnables you to connect to and save Operations Hub server details
AboutDisplays the version information of Excel Add-in for Operations Hub.
HelpDisplays the Help for Excel Add-in for Operations Hub.
LogsOpens the folder where you can view the logs generated.
Note: The log files are in json format. You can open the files in Notepad to view the details.

Configure Operations Hub Server

About this task

To query a model defined in Operations Hub, you should receive a token from Operations Hub Server.

To enable this you can either explicitly launch Configuration window or launch the Query window.

The Operations Hub Configuration window enables you to configure the Operations Hub Server and save the details of Operations Hub Server.

Procedure

  1. Select Configuration menu in Admin.
    The Operations Hub Configuration window appears.
  2. Provide Operations Hub Server details.
    FieldDetails

    Operations Hub Server

    The Operations Hub server name to which you want to connect and get the data.

    Operations Hub UAA Server (url)

    The URL of the UAA service of Operations Hub.

    Example: https://<ophubservername>/uaa

    Note:

    The Token Status field indicates the status of the connection with Operations Hub server.

  3. Select Connect.
    The login page appears.
  4. Provide the User Identifier and Password to connect to Operations Hub.
  5. Select Open UaaAuthSchemeHandler button.
    Operations Hub Server to which you are connected and the status of the token appears.
  6. Select Save to save the Operations Hub server details. The configuration will be retained and used when you open excel add-in again.

Querying an Operations Hub Model

You can query an Operations Hub Model using the Object Types, Data Variables and Objects:

IconDescription
Represents Object Types. Double-click to view the data variables and contained types (Object type)
Note: Object Types are not selectable.

Represents Data Variables.

Represents Objects.

  • Object Types: Object types define the structure of the equipment within your model.
  • Data Variables (including contained types): Data Variables describe the actual data that is received from a data source. Among other things, it defines how to use a property in the Views feature. For example, you can define a property to appear as a trend line on Trend views. For each object type, such as a Car, you set up all the data variable names, such as Color, Speed that any object associated with this type can reuse in its own definition.
  • Objects: Objects are the instances of object types or equipment pieces. Example: BMW, BENZ

Query Operations Hub Model

Procedure

  1. Select the object type from the Object Type drop-down list box. Example: Car.
    The corresponding data variables and contained types are displayed in the Data Variables list for the selected Object Type.
  2. Optional: Select the Get Full Object Type Hierarchy check box to get the complete object type hierarchy for the selected object type in the data variables
    Note: Selecting this option might impact the performance and you may experience the delay in retrieving and browsing the object type hierarchy.
  3. Select the data variables from the Data Variables list.
    Note: Only one level of the object type hierarchy is displayed. Double-click the object types to browse through the other levels.
    Tip: You can right select in the Data Variables section to perform the following actions:
    • Check All: Selects all the data variables.
    • Collapse All: Collapses the hierarchy.
    • Expand All: Expands the hierarchy displaying all the data variables.
    • Uncheck All: Deselects all the data variables.
  4. Optional: Enter a search criterion in the Search String text box and then, select the Search icon to filter the data variables based on the string entered.
    Note: ???* can be used as wild card character in the search text box.
    The resultant data variables matching the filter string appear in the data variables list.
  5. Optional: Select the Auto Search check box to filter the data variables as you type the string in the Search String text box. Note: Auto search option is recommended only when your model has less number data variables.
  6. Select the objects from the Objects list. You can right-select in the Objects section to perform the following actions:
    • Check All: Selects all the objects.
    • Uncheck All: Deselects all the objects.
  7. Select Apply to apply the selection to query the model.
  8. Select View Selected to view the metadata of selected data variables and objects. The details will appear on Excel.
    Note: You can continue with building the query returning to the Build Query window by selecting the Query button.

  9. Optional: You can select the Clear Selections button to clear all selections.
  10. Select the Data Filter Options to retrieve the data based on the sampling and calculation modes:
    • Start/End Time: The duration for which you want to retrieve the data.
    • Sampling modes: The sampling mode for the data. It specifies the way data will be retrieved from Historian. Example: CurrentValue, Interpolated, Calculated and RawByTime. For more information, refer to Sampling Modes.
    • Calculation modes: Calculation modes are used when the sampling mode is set to Calculated. The data type of all calculated values will be DoubleFloat except for MinimumTime, MaximumTime, FirstRawTime and LastRawTime which will be a Date. The datatype of the values of FirstRawValue and LastRawValue will be the same as that of the selected tag.

      The Calculation Field is active only after you select Calculated Sampling as the Sample Type. You can select a Calculation Algorithm type from the drop-down list.

      The calculation modes supported by Historian are supported by Excel Add-in for Operations Hub except Minimum Time, Maximum Time, First Raw Time, Last Raw Time, Time Good, State Count, State Time.

      Note: Minimum Time, Maximum Time, First Raw Time, Last Raw Time, Time Good calculation modes are listed in the Calculation Modes drop-down but are not supported.

      For more information, refer to Calculation Modes.

    Note:

    Some of the calculation modes such as Minimum Time,Maximum Time, First Raw Time, Last Raw Time, Time Good are returning bad data upon query.

  11. Select the Data Quality based on which you want to export the samples.
  12. Select the Data Display Options
    • Columns: Select the Columns for which you want the values to be displayed. By default, Node, Node Id (Tag Name) will be selected.
    • Data time to display: Choose the timestamp format to be displayed.
      • Default: To display the time format as in Operations Hub.
      • Local: To display the time in local time zone.
      • ISO 8601 Format: To display time in ISO 8601 readable format. (Result will include T for the time designator and Z for the zero UTC offset)
        Note: When you query for a data variable in a duration which has no data, the Default mode selection displays time value as 0 and Local and ISO 8601 format displays time as 1970 year because, the 0 epoch time converted to local time is 1970.
  13. Select Get Data to read and display data for the selected data variables in the excel sheet.