Prerequisites for Creating a Connection

These are the prerequisites for creating a connection with the Oracle Field Service Adapter.

Create an Oracle Field Service User Account

  1. Log in to Oracle Field Service.

  2. Click Configuration in the upper right.

  3. Click User Types in the Users and Security area.

  4. Add a new user type or select an existing user type in the left pane.

  5. Enable API access for the user type based on the Oracle Field Service Adapter version you are using:
    1. If using Oracle Field Service Adapter version 17.2.x or later:

      1. Navigate to Configuration > User Types and select the required user type.

      2. Navigate to the Screen configuration tab, and open the Configuration context under Main Menu Items.
        Description of field_service1.png follows
        Description of the illustration field_service1.png

      3. Click the Click to add button at the bottom left.

      4. In the Add Action dialog, search for Applications and add it.

      5. Give Read Write permissions to the Applications action.


        Description of field_service2.png follows
        Description of the illustration field_service2.png
      6. Navigate to the Configuration page and note that the applications are available under the Users, Security, Integrations section.


        Description of field_service3.png follows
        Description of the illustration field_service3.png
      7. Open the Configuration > Applications page.

      8. Click the + button (at the top left) and add a new application.

      9. Select the newly added application.

      10. Select the Active check box under the General info section.


        Description of field_service4.png follows
        Description of the illustration field_service4.png
      11. Click Add New in the API Access section.

      12. Select the required APIs and click Submit. Core API, Capacity API, and Metadata API are needed for using all Oracle Field Service Adapter Oracle Integration features.

      13. In the API access section, click the hamburger menu against each API and select Available entities.


        Description of field_service6.png follows
        Description of the illustration field_service6.png
      14. In the Available entities dialog, select the required permissions for the entities and click Submit.

      15. Click the Save button at the bottom right to save the application.

      16. Navigate to Configuration > User Types.

      17. Select the required user type.

      18. In the General tab, check Allow legacy access via API using user login and password.

      19. Select the required application from the API access permissions are configured using selected application dropdown list.

      20. Click Save.

      21. Use the username/password of a user, with the newly configured user type, to configure the Oracle Field Service Adapter connection in Oracle Integration.

    2. If using Oracle Field Service Adapter versions prior to 17.2.x:

      1. Select Allow access via API in the Access settings area of the General tab.

      2. Click the API access tab.

      3. Select the Core API check box.

      4. Click Core API and select ReadWrite for the objects that the user type can modify.

      5. Select ReadWrite for Business Events and Collaboration Events.

      6. Click Save.

  6. Associate a user with the user type:

    1. Open the Users page.

    2. Select a bucket from the Resource tree.

    3. To associate a new user, click Add new and select the appropriate user type along with the other required details. Click Ok.

    4. To associate an existing user, select the check box next to the user, click Set User type, and select the appropriate user type. Click Ok.

Get the Client ID/Client Secret from the Oracle Field Service Application

To configure the Client Credentials security policy on the Connections page, you must first obtain the client ID and client secret.

  1. Log in to Oracle Field Service.
  2. Select Configuration.
  3. Click Applications in the Users, Security, Integrations area.
  4. Select the application used in User Types for the integrator role.
  5. Check the following option to see the application used for the integration:
    1. Select User Types under Configuration.
    2. Use the application name displayed next to the API access permissions are configured using selected application configuration.
  6. Select the Authenticate using Client ID/Client Secret option under Authentication settings.
  7. Click Show Client ID / Client secret to see the details.

Enable Event Publishing from Oracle Field Service to Oracle Integration

The steps to follow to enable event publishing from Oracle Field Service to Oracle Integration are based on your version of Oracle Field Service. This configuration enables Oracle Field Service to act as a data trigger to Oracle Integration.

For Oracle Field Service Releases Prior to 18c

Follow these steps to enable event publishing to Oracle Integration from releases of Oracle Field Service prior to 18c.

  1. Log in to the Oracle Field Service Manage application.

  2. Click Configuration > Oracle Integration (OI). The Oracle Integration (OI) page is displayed.

  3. Click Add new. The Add Oracle Integration (OI) Access dialog is displayed.

  4. Enter the following details, then click Add.

    Element Description
    End Point Label

    Enter a human-readable name/description for the application for which you are creating the integration. This field is for user information only.

    ICS Domain

    Enter the host name of your Oracle Integration instance.

    For example, assume your integration URL is as follows:
    https://integration-a12345.integration.us7.oraclecloud.com/integration/flowsvc/ofsccloudadapter/NAME/v01/
    For this field, set the Oracle Integration domain to the host name only:
    integration-a12345.integration.us7.oraclecloud.com
    ICS Username

    Enter the username that you use for logging into Oracle Integration.

    This username and its password are used to authenticate with Oracle Integration when Oracle Field Service starts sending events to an Oracle Integration instance.

    ICS Password/Confirm Password

    Enter the Oracle Integration password, then enter it a second time to confirm.

    The integration details are displayed on the Oracle Integration (OI) page. You can modify or delete the configuration from this location.

For Oracle Field Service Releases 18c and Later

Follow these steps to enable event publishing to Oracle Integration from Oracle Field Service Release 18c and later.

Add an Oracle Integration Channel

You can add an Oracle Integration channel using the Outbound Integration Channels configuration page.

  1. Navigate to the Configuration page.
  2. Click Outbound Integration.
  3. On the Outbound Integration Channels page, click Add Channel.

    The Add Channels dialog shows the options to add a new channel.

  4. On the Add Channels dialog, provide the following details to create an Oracle Integration channel:

    Note:

    To update the values in this dialog, contact the Oracle Integration administrator.
    Element Description
    Channel Type Select Integration Cloud Service from the drop down list.

    Note that selecting Integration Cloud Service is applicable for configuring Oracle Integration.

    Name Enter the channel name to be displayed.
    Host Enter the host name or the address of the Oracle Integration database server. For example, assume your integration URL is as follows:
    https://integration-a12345.integration.us7.oraclecloud.com/integration/
    flowsvc/ofsccloudadapter/NAME/v01/
    For this field, set the Oracle Integration domain to the host name only:
    integration-a12345.integration.us7.oraclecloud.com

    Note: This URL is case sensitive on the Oracle Field Service side. The correct case must be given for the hostname, otherwise the event flow does not occur. See Configuration Issue Between Oracle Field Service (Source) and Oracle Integration.

    User Name Enter the user name to access the Oracle Integration database. The user must have permissions such as CREATE TABLE, ALTER TABLE , DROP TABLE , and INSERT records.
    Password and Confirm Password Provide the password to access the Oracle Integration database, then enter it a second time.
  5. Click OK. The new channel is updated to the Outbound Integration Channels page.

    The Oracle Integration channel is updated (which is displayed as ICS) on the Outbound Integration Channels page.

Modify Oracle Integration Channel Details

You can modify the existing endpoint configurations for the Oracle Integration channel.

  1. Navigate to the Configuration page.
  2. Click Outbound Integration.
  3. On the Outbound Integration Channels page, select the Oracle Integration channel (which is displayed as ICS) to edit.
  4. Click the Properties icon and select Modify.

    The Edit Channel dialog shows the options to edit the selected channel.

  5. Edit the following details as necessary:
    Element Description
    Name Edit the channel name to be displayed.
    Host Edit the host name or the address of the Oracle Integration database server. For example, assume your integration URL is as follows:
    https://integration-a12345.integration.us7.oraclecloud.com/integration/
    flowsvc/ofsccloudadapter/NAME/v01/
    For this field, edit the Oracle Integration domain to the host name only:
    integration-a12345.integration.us7.oraclecloud.com

    Note: This URL is case sensitive on the Oracle Field Service side. The correct case must be given for the hostname, otherwise the event flow does not occur. See Configuration Issue Between Oracle Field Service (Source) and Oracle Integration.

    User Edit the user name to access the Oracle Integration database. The user must have permissions such as CREATE TABLE, ALTER TABLE , DROP TABLE , and INSERT records.
    Password and Confirm Password Edit the password to access Oracle Integration database, then enter it a second time.
  6. Click OK.

Delete an Existing Oracle Integration Channel

You can delete Oracle Integration (ICS) channels from the Outbound Integration Channels page.

  1. On the Outbound Integration Channels page, select the Oracle Integration (ICS) channel to delete.
  2. Click the properties icon and then click Delete.

    Note:

    Deleting an Oracle Integration channel (which is displayed as ICS) deletes the channel configurations from Oracle Field Service.
  3. In the Delete Confirmation dialog, click OK.

View Oracle Integration Channel Details

You can view the Oracle Integration channels using the Outbound Integration Channels page.

  1. On the Outbound Integration Channels page, a newly created Oracle Integration (ICS) channel appears as follows:

    The channel status indicates that the data transfer has not yet started. After the data transfer starts for the selected channel, the status show the time at which the last update occurred.
    Description of view_channel.png follows
    Description of the illustration view_channel.png

    The data transmission success rate is the percentage of successfully transferred data (data transmission success rate = (total number of events successfully transferred / total events selected).

Migrate to Oracle Field Service Version 19c

When migrating to Oracle Field Service version 19c, the following changes to the authentication method are recommended:

  • Users of Oracle Integration versions prior to 19.3.1 that use Basic Authentication should change the username and password to the client ID and client secret combination. Do this because username and password-based authentication has been deprecated in Oracle Field Service and integrations authenticated using the username and password do not work.
  • It is recommended that users of Oracle Integration version 19.3.1 and above change their security policy to OAuth. Use the client ID and client secret and re-activate their integration for the migration. OAuth functionality is available with the Client Credentials selection on the Connections page. See Configure Connection Security.