3Implementation Prerequisites

Implementation Prerequisites

Implementation is the installation of Oracle Field Service Cloud system and its further configuration in accordance with a specific client's specifications, business rules, and requirements. Prior to implementation the following prerequisites have to be provided:

Table Prerequisites

Prerequisite

Details

Oracle Field Service Cloud system The system must be configured and run in compliance with the client's specification.
Network environment The environment must be configured in order to get access to Oracle Field Service Cloud system.
Connectivity testing Network connectivity tests must be performed: connection to the right port, request of the wsdl.
URLs, ports, user logins and passwords Can be configured in the user interface.
Permissions and access details Must be defined in the system as described in the section below.

    Authorization

    Access to the APIs is determined by performing the following tasks:

      Register a Client Application

      Register the application that you want to integrate with Oracle Field Service Cloud.

      1. Click Configuration and select Applications from the Field Service Cloud Manage interface.

      2. Click the Plus icon from the left pane.

      3. Enter the Application Name and Application ID of the application that you want to register.

      4. Click Submit.

        The application displays in the left pane.
      5. Select the type of token service for the registered client application from the Token service drop-down list.

        By default, the type of token service is OFSC.
      6. Click Save.

        Authorize Access to APIs

        You must perform the following tasks to access the APIs:
        • Define the APIs that the application can access

        • Define the users that can access the APIs

        1. Define the APIs that the application can access:

          1. Click Configuration and select Applications from the Field Service Cloud Manage interface.

          2. Select the registered application from the left pane.

          3. Click Add New from the API Access section.

          4. Select the required APIs and click Submit.

          5. Click the icon next to the selected API and select the required option.

            For example, for the Capacity API, you can select the required method using the Available Methods option.
          6. Select the required methods and click Submit.

        2. Define the users that can access the APIs:

          1. Select the Allow access only to certain resources check box in the Additional Restrictions section.

          2. Click Add and select the resources.

          3. Select the Allow access only for certain IP-addresses check box and enter the IP addresses in the text box to restrict access by IP addresses.

        3. Click Save.

          Enable Backward Compatibility for API Access

          Starting Oracle Field Service Cloud Service February 2017, defining user’s access through user types is not supported. If you are upgrading to from an older version to Oracle Field Service Cloud Service February 2017, create an application and associate a user type to it.

          After you associate user types to applications, you can continue to access the APIs and no changes are required for your existing implementations.
          1. Click Configuration and select User Types from the Field Service Cloud Manage interface.

          2. Select the user type.

          3. Select the Allow legacy access via API using user login and password check box.

          4. Select the application that you registered from the API access permissions are configured using selected application drop-down list.

            System Requirements

            Oracle Field Service Cloud Interfaces work via HTTPS protocol. As such, they require an environment that supports SOAP 1.1 and HTTPS protocols: (see http://www.w3.org/TR/2000/NOTE-SOAP-20000508/).

            Actual hardware and operating system platforms are usually not a constraining factor. Oracle Field Service Cloud APIs can be used with a variety of technologies, including but not limited to Java, .Net, and C/C++, on both Windows or UNIX platforms.