1. Mobile Plug-in Framework
  2. Configure a Plug-In to Add to the Main Menu

Configure a Plug-In to Add to the Main Menu

You can add plug-ins that are created as HTML5 applications to the Main menu. You cannot add native application plug-ins.

  1. Click Configuration > Forms & Plugins.
  2. Click Add Plugin.
  3. Complete these fields on the Add Plugin page:
    Field Name Description
    General Information section
    Name (English) A mandatory field defining the plug-in name in the English language. The action or plug-in appears under this name in the actual context.
    Name (other languages) Plug-in name translations to other languages, if used.
    Label A mandatory field defining a unique action or plug-in label.
    Entity Entity (activity, inventory, required inventory, resource, service request, user) to which the action or plug-in is to be related. For example, if you select Inventory, the action will appear only in the contexts related to inventory. Leave the field blank for the action to be available in all contexts of all the entities.
    Visibility rules similar to The base action from which the plug-in is to be derived, if needed. When a base action is selected, the resulting plug-in functions per the same rules as the base action. The base action affects only the visibility of buttons and not the functioning of the plug-in. It appears only in the contexts in which the base action appears and is shown or hidden according to the same visibility conditions. For example, if start_activity is selected as the base action for a plug-in, the plug-in is only be shown in the context of a pending activity when there is no started activity in the same route, similar to the Start action. The list of available base actions is filtered according to the Entity that is selected.
    Type

    The type of plug-in you want to use. Select HTML5 application.

    This means, the plug-in uses an external application to extend the functionality. The HTML5 plugin is a URL of an external resource that is opened in a new window or in an iframe.
    Fields for the HTML 5 Application Option
    Use Plug-in API

    Determines whether you want the plug-in to communicate with Oracle Field Service using the Plug-in API. Clear this check box.

    When you do not use the Plug-In API, the URL is opened in a new tab, window, or iframe. To interact with Oracle Field Service you must pass some data (such as activity id, resource name) to the plug-in using the placeholders in the "POST Data" and "URL" fields.
    URL The path to a URL (for external plug-ins). This URL processes the HTML5 application and it runs the plug-in in the entire browser window. The URL must start with the protocol (https). The URL must point to an external resource, which is opened either in a new window or inside Oracle Field Service in an iframe (if the “Tab or iframe layout” option is selected).
    POST Data The data that you want to be sent to the external plug-in. You can use only User entity fields as placeholders.
    Disable plug-in in offline Determines whether you want to disable the plug-in when Oracle Field Service is offline. Clear this check box for the plug-in to work in offline mode.
    Open in iframe Determines whether the plug-in uses the iframe layout. If you clear the field, the plug-in’s URL is opened in a new browser tab or window.
  4. Click Save.
    If you set the external plug-in as the first item on the Main menu context layout, the menu item is displayed in the correct order. However, the plug-in does not open when a user logs in to the application. Instead, a standard page or a plug-in that you have created using the Plugin API Framework that is next in the order is opened.