Skip to main content

Authorization

Follow this guide to create a new Oracle Field Service credential that will allow Nexla to authenticate to and exchange data with your Oracle Field Service account.
oracle_field_service_api_auth.png

Oracle Field Service

Prerequisites​

To connect Nexla to Oracle Field Service, you need an active Oracle Field Service instance and administrator access to register an application and generate API credentials. Oracle Field Service uses HTTP Basic Authentication with a Client ID, instance name, and Client Secret — credentials that are created within the Oracle Field Service Configuration interface.

Oracle Field Service Instance URL​

Your Oracle Field Service instance is accessible at a URL in one of the following formats:

  • https://{'{instance_name}'}.etadirect.com — for older instances
  • https://{'{instance_name}'}.fs.ocs.oraclecloud.com — for newer OCI-based instances

The exact base URL for your instance can be confirmed on the Configuration > About screen within the Oracle Field Service application, or by contacting your Oracle Field Service administrator. You will need this URL when configuring the Nexla credential.

Register an Application and Obtain API Credentials​

Oracle Field Service requires that integrations authenticate using a registered application with a Client ID and Client Secret. To create these credentials, an Oracle Field Service administrator must complete the following steps:

  1. Log in to your Oracle Field Service instance with an administrator account.

  2. Navigate to Configuration in the main menu, and select Applications from the list of configuration options.

  3. In the left panel, click the + (plus) icon to open the New Application window.

  4. Enter a descriptive Application Name (for example, Nexla Integration) and a unique Application ID (for example, nexla_integration) to identify this application.

  5. Click Submit to create the application.

  6. In the application settings, locate the Authentication settings section and select the Authenticate using Client ID/Client Secret checkbox.

  7. The system will generate a Client Secret for the application. Copy and securely store this Client Secret immediately, as it may not be fully visible after you navigate away.

  8. Note the Application ID you specified when creating the application — this serves as the Client ID component of the credential.

The username format used for Oracle Field Service Basic Authentication follows the pattern client_id@instance_name, where client_id is the Application ID you created and instance_name is the name of your Oracle Field Service instance (the subdomain portion of your instance URL). For example, if your Application ID is nexla_integration and your instance URL is https://bestcustomer.etadirect.com, the username would be nexla_integration@bestcustomer.

For additional details about Oracle Field Service authentication, refer to the Oracle Field Service REST API Authentication documentation.

Create an Oracle Field Service Credential​

  • To create a new Oracle Field Service credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Oracle Basic Auth Settings​

Oracle Field Service uses HTTP Basic Authentication. The credential requires three pieces of information: your instance base URL, a username formatted as client_id@instance_name, and the Client Secret associated with your registered application.

  1. Enter the base URL of your Oracle Field Service instance in the Instance Base URL field. This should be the root URL of your instance without any path components — for example, https://yourinstance.etadirect.com or https://yourinstance.fs.ocs.oraclecloud.com.

  2. Enter the username for API authentication in the Username or Client ID field. This must be formatted as client_id@instance_name, where client_id is the Application ID of the registered application and instance_name is the subdomain name of your Oracle Field Service instance. For example: nexla_integration@bestcustomer.

    The instance name is the subdomain of your Oracle Field Service URL. For the URL https://bestcustomer.etadirect.com, the instance name is bestcustomer. Combining with an Application ID of nexla_integration, the full username would be nexla_integration@bestcustomer.

  3. Enter the Client Secret associated with your registered application in the Password or Client Secret field. This is the secret that was generated when you created and configured the application in the Oracle Field Service Configuration > Applications interface.

    Important

    The Client Secret is sensitive and should be treated like a password. Store it securely and do not share it. If the Client Secret is lost or compromised, you will need to regenerate it in the Oracle Field Service Configuration > Applications interface.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.