Available Methods

Initiated by Oracle Field Service:
  • init: The plug-in is loaded when Oracle Field Service is initialized, and the initialization data can be stored by the plug-in.

  • open: The plug-in content is to be shown on the page in Oracle Field Service.

  • error: Data submitted by the plug-in is invalid, or some internal errors have occurred.

  • wakeup: Oracle Field Service detected that a connection to a server is available and the plug-in has requested to be activated on this event.

  • callProcedureResult: Oracle Field Service returns the result of running the procedure (RPC).

Initiated by the plug-in:
  • ready: The plug-in is loaded and is ready to receive messages.

  • initEnd: The Plug-in finished processing the initialization data.

  • close: The plug-in submits data and its window will be closed if data is valid.

  • update: The plug-in updates OFS entities data without closing its window.
  • sleep: Lets the plug-in finish the background activity (started by “wakeup” method) when all data is synchronized with the server. If the plug-in is not able to synchronize with its own server because network connectivity is not available, it can notify Oracle Field Service to wake it up in the background when the connectivity is available.

  • callProcedure: The plug-in requests the Oracle Field Service to run the procedure (RPC) without closing the plug-in's window.