Supercharge your Proficy solution! Download a free trial of Proficy Operations Hub, CSense analytics, and more. Explore our Proficy 2024 releases!

Release Notes
Getting Started with Operations Hub
User Guide
- Overview
- Operations Hub (New Layout)
- Applications
- Entities
- Queries
- Plug-ins
- Events
- Email Templates
- Parameters
- Users
- Roles
- Administration
- Data Sources
- Pages
- Navigation
- Explorer
- Themes
- Settings
- Widgets
- General Reference
- APIs
  - Operations Hub M2M Device RESTful APIs
  - Operations Hub REST APIs for Integration
  - Operations Hub REST APIs for App, Group, and Page Permissions
  - Message Queuing Telemetry Transport (MQTT) APIs
  - Custom Plug-in API
    - EMBED Object Functions
      This topic introduces a set of methods that plug-in developers can use to create their own custom plugins.
    - EMBED.getComponent ()
      This method retrieves a JSON object, which contains information about the current instance of a plug-in.
    - EMBED.getRootElement ()
      This method retrieves a jQuery object, which represents the root HTML element of the current instance of a plug-in.
    - EMBED.getTheme ()
      This method retrieves a JSON object, which contains information about the current theme applied to Operations Hub.
    - EMBED.getStyle ()
      This method retrieves a string, which contains information about the styles that are currently being used by the application.
    - EMBED.executeAction
      This method executes a specific action (as defined by id in the manifest).
    - EMBED.getPageData
      This method retrieves all sources of data available on the page, including information about any inputs, outputs, query names, etc.
    - EMBED.fieldTypeIsQuery
      Passing in a data source field from your component, will return if the data source configured is of type Query.
    - EMBED.fieldTypeIsGlobal
      Passing in a data source field from your component, will return if the data source configured is of type Global.
    - EMBED.fieldTypeIsFormula
      Passing in a data source field from your component, will return if the data source configured is of type Formula.
    - EMBED.getGlobalData
      This method retrieves the current value of an Operations Hub global variable.
    - EMBED.getFormulaData
      This method retrieves the current value of an Operations Hub Formula.
    - EMBED.subscribeFieldToFormulaChange
      This method creates a subscription to a data source of Formula type.
    - EMBED.subscribeFieldToGlobalChange (field, callback)
      This method creates a subscription to a data source of Global type.
    - EMBED.subscribeFieldToQueryChange (field, callback)
      This method creates a subscription to a data source of Query type.
    - EMBED.getQueryOutput (field)
      Provided an input field, will return a list of all the outputs of the query, in an array of JSON objects.
    - EMBED.submitTarget (field, value)
      This method sends data from your plug-in back to an Operations Hub data target.
    - EMBED.registerNavChanged (id, callback)
      This method provides a callback, which informs the plug-in that the page is closing/changing.
    - EMBED.subscribeToScreenSizeChange (id, callback)
      This method creates a subscription, which will trigger a callback whenever the Operations Hub runtime detects a screen size change (such as resizing the browser).
- Troubleshooting

EMBED.getComponent ()

This method retrieves a JSON object, which contains information about the current instance of a plug-in.

The schema.data subset of the JSON object contains all the data items defined for the current instance.

Parameters

None

Return Value

JSON object

Example

let data = EMBED.getComponent().schema.data;
let styling = data.styling;	// retrieve the styling information from the manifest