Skedulo Data Source
Skedulo
Create a New Data Flow
-
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.
-
Select the Skedulo connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Skedulo instance, and click Next; or, create a new Skedulo credential for use in this flow.
-
In Nexla, Skedulo data sources can be created using pre-built endpoint templates, which expedite source setup for common Skedulo data objects. Each template is designed specifically for the corresponding Skedulo API endpoint, making source configuration easy and efficient.
• To configure this source using a template, follow the instructions in Configure Using a Template.Skedulo sources can also be configured manually, allowing you to ingest data from Skedulo endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
• To configure this source manually, follow the instructions in Configure Manually.
Configure Using a Template
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Skedulo data objects. Each template is designed specifically for the corresponding Skedulo API endpoint, making data source setup easy and efficient.
Endpoint Settings
- Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.
Endpoint Testing
Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.
-
To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.
-
If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.
Configure Manually
Skedulo data sources can be manually configured to ingest data from any valid Skedulo API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates, executing custom GraphQL queries, or applying custom authentication headers and request parameters.
The Skedulo API accepts both GET requests (for REST-style endpoints) and POST requests with JSON bodies (for GraphQL endpoints). GraphQL queries are sent to the /graphql/graphql path on your regional base URL.
API Method
-
To manually configure this source, select the Advanced tab at the top of the configuration screen.
-
Select the API method that will be used for calls to the Skedulo API from the Method pulldown menu. The most common methods for Skedulo are:
- GET: For REST-style endpoints such as resource tracking, availability summary, rule violations, and the WhoAmI endpoint
- POST: For GraphQL queries — all GraphQL requests to
/graphql/graphqluse POST with a JSON body containing thequeryfield
API Endpoint URL
- Enter the URL of the Skedulo API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the regional base URL and any required path parameters. For example:
- GraphQL:
https://api.skedulo.com/graphql/graphql - Resource tracking:
https://api.skedulo.com/resources/tracking - Availability:
https://api.skedulo.com/availability
- GraphQL:
Replace https://api.skedulo.com with the regional base URL appropriate for your tenant (UK: https://api.uk.skedulo.com, CA: https://api.ca.skedulo.com, AU: https://api.au.skedulo.com). Ensure the API endpoint URL is accessible with your current credentials by using the Test button after configuring the URL.
Date/Time Macros (API URL)
Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. This is particularly useful for Skedulo endpoints that accept date range parameters such as from, to, start, and end.
Macros are particularly useful for Skedulo endpoints that require date ranges, such as resource tracking, availability summary, and rule violations endpoints.
-
To add a macro, type
{at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.{now}– The current datetime{now-1}– The datetime one time unit before the current datetime{now+1}– The datetime one time unit after the current datetimecustom– Datetime macros can reference any number of time units before or after the current datetime—for example, enter(now-4)to indicate the datetime four time units before the current datetime
-
Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of
{now}in{now-1}. -
Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro
{now-1}, whenDayis selected,{now-1}will be converted to the datetime one day before the current datetime.
Lookup-Based Macros (API URL)
Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that adapt based on existing data. For Skedulo, this is useful when you need to construct endpoints that reference specific resource UIDs, job IDs, or other identifiers retrieved from another Nexla source.
Lookup-based macros are useful when you need to create Skedulo API endpoints that reference specific UIDs or parameters obtained from other Nexla data sources in your environment.
-
To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.
-
Type
{at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.
Path to Data
If only a subset of the data returned by the API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. Skedulo API responses commonly nest the relevant data within a structured envelope.
For example, most Skedulo GraphQL responses return data under $.data.[objectName].edges[*].node, and REST endpoint responses typically use $.result[*].
Specifying the correct path to data is essential for Skedulo responses, as both GraphQL and REST responses wrap the relevant records within nested structures.
-
To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.
- For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (for example,
$.data.jobs.edges[*].nodeto access job nodes from a GraphQL response, or$.result[*]to access records from a REST endpoint response).
Path to Data Example:For a Skedulo GraphQL query that returns job records, the response is structured as
data.jobs.edges[].node. The correct path to enter would be$.data.jobs.edges[*].node. - For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (for example,
Autogenerate Path Suggestions
Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.
-
To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.
-
Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.
Metadata
If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve contextual information such as Skedulo's pageInfo pagination metadata (which contains hasNextPage and endCursor fields) alongside each record.
Metadata paths are particularly useful for preserving Skedulo GraphQL response context like pagination information that applies to all records in the response.
-
To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.
- For responses in JSON format, enter the JSON path to the object or array that contains the metadata.
Request Headers
-
If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (for example,
header1:value1,header2:value2). This is useful for specifying theContent-Typeheader when using GraphQL POST requests (Content-Type:application/json), or for any custom Skedulo API versioning headers.You do not need to include the
Authorizationheader — this is handled automatically by Nexla based on your Skedulo credential configuration.
Endpoint Testing
After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.
-
To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.
-
If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.
Save & Activate the Source
- Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Skedulo data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.