Oracle Field Service Destination

Oracle Field Service
Create an Oracle Field Service Destination
-
Click the + icon on the Nexset that will be sent to the Oracle Field Service destination, and select the Send to Destination option from the menu.
-
Select the Oracle Field Service connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Oracle Field Service organization, and click Next; or, create a new Oracle Field Service credential for use in this flow.
-
In Nexla, Oracle Field Service destinations can be created using pre-built endpoint templates, which expedite destination setup for common Oracle Field Service endpoints. Each template is designed specifically for the corresponding Oracle Field Service endpoint, making destination configuration easy and efficient.
• To configure this destination using a template, follow the instructions in Configure Using a Template.Oracle Field Service destinations can also be configured manually, allowing you to send data to Oracle Field Service endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
• To configure this destination manually, follow the instructions in Configure Manually.
Configure Using a Template
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Oracle Field Service endpoints. Each template is designed specifically for the corresponding Oracle Field Service endpoint, making destination setup easy and efficient.
-
To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.
Configure Manually
Oracle Field Service destinations can be manually configured to send data to any valid Oracle Field Service API endpoint.
Using manual configuration, you can also configure Nexla to automatically send the response received from the Oracle Field Service API after each call to a new Nexla webhook data source.
API Method
-
To manually configure this destination, select the Advanced tab at the top of the configuration screen.
-
Select the API method that will be used for calls to the Oracle Field Service API from the Method pulldown menu. Oracle Field Service uses the following HTTP methods:
- POST: For creating new records (activities, service requests)
- PUT: For creating or fully replacing records (resources, users, inventory types)
- PATCH: For partially updating existing records (activities, resources)
Data Format
- Select the format in which the Nexset data will be sent to the Oracle Field Service API from the Content Format pulldown menu. Oracle Field Service REST APIs accept JSON format for all write operations — select
JSONto ensure proper data formatting.
API Endpoint URL
-
Enter the URL of the Oracle Field Service API endpoint to which you want to send the Nexset data in the URL field. For update operations (PATCH) or resource creation/replacement by ID (PUT), include the resource identifier at the end of the URL path.
Oracle Field Service REST API write endpoints follow the base path pattern:
- Core operations:
https://{'{your_instance}'}.etadirect.com/rest/ofscCore/v1/ - Metadata operations:
https://{'{your_instance}'}.etadirect.com/rest/ofscMetadata/v1/
For example, to create an activity, the endpoint URL would be
https://yourinstance.etadirect.com/rest/ofscCore/v1/activities. To update a specific resource, the URL would include the resource ID:https://yourinstance.etadirect.com/rest/ofscCore/v1/resources/{resourceId}.Refer to the Oracle Field Service REST API reference for a full list of available write endpoints.
- Core operations:
Request Headers
-
If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g.,
header1:value1,header2:value2).You do not need to include the
AuthorizationorContent-Typeheaders — these are automatically handled by Nexla based on your Oracle Field Service credential configuration and the selected content format.
Exclude Attributes from the Call
-
If any record attributes in the Nexset should be omitted when sending data to this Oracle Field Service destination, select the attributes from the Exclude Attributes pulldown menu.
-
Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.
Record Batching
-
If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.
-
Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to
100. -
Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.
Response Webhook
Nexla can automatically send the response received from the Oracle Field Service API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call — such as the newly created activity ID or any validation errors returned by Oracle Field Service.
- To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.
Sample Request Payload
Sample request payloads containing a portion of the Nexset data that will be sent to the Oracle Field Service API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.
- Click on a sample request payload to expand it and view the complete payload content.
- Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.
Endpoint Testing (Manual Configuration)
After all endpoint settings have been configured, Nexla can send a test payload to the Oracle Field Service API to ensure that the destination is configured correctly.
-
To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.
-
If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.
-
Click the Send Test Data button at the top of a sample payload to send the test payload to the Oracle Field Service API using the current settings.
Save & Activate the Destination
-
Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to Oracle Field Service, open the destination resource menu, and select Activate.
The Nexset data will not be sent to Oracle Field Service until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.