Workday Source
When you create a Workday collector Source, you add it to an existing Sumo Logic hosted collector. Before creating the Source, identify the hosted collector you want to use or simply create a new hosted collector. For further instructions, see Configure a Hosted Collector.
Note - The steps below assume that you have already configured Step 1 of this page.
To configure a Workday Source:
-
On the Manage Data > Collection > Collection page, click Add Source next to a Hosted Collector.
-
Select Workday.
-
Enter a Name for the Source in the Sumo Logic console. The description is optional.
-
For Source Category (Optional), enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
-
Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM Enterprise. When configured with the Forward to SIEM option the following metadata fields are set automatically by the integration (Do not include below fields as custom log metadata Fields):
|
Field Name |
Value |
|
_siemVendor |
Workday |
|
_siemProduct |
Workday |
|
_siemFormat |
JSON |
|
_siemEventID |
SigonLogs Or AuditLogs |
-
Fields. Click the +Add link to add custom log metadata Fields.
-
Define the fields you want to associate, each field needs a name (key) and value.
-
A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
-
An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema or is disabled it is ignored, known as dropped.
-
-
-
SignOn Report URL: Paste the signon report url from Step 1.5.
-
Integration System User Name: Name of the account created in Step 1.1.
-
Integration System User Password: Paste the SumoLogic_ISU account password copied from Step 1.1.
-
Workday Rest API Endpoint: Paste the Workday Rest API endpoint copied from Step 1.3.
-
Workday Refresh Token Endpoint: Paste the Workday Rest API endpoint copied from Step 1.3.
-
Client ID: Paste the API Client ID copied from Step 1.3.
-
Client Secret: Paste the API Client SECRET copied from Step 1.3.
- Refresh Token: Paste the Refresh token generated from Step 1.3.
-
Collection Should begin - Select the time range for how far back you want this source to start collecting data from Workday. Options available are: Now, 24 hours ago
-
Polling Interval (Optional) : Enter how often you want the Source to collect data from Workday. This is set to 10 minutes by default.
-
When you are finished configuring the source click Submit.
Polling Interval and Workday API rate limits
During each polling interval, the Workday Source will make a REST API request to fetch audit activity logs and another request to the RAAS API to fetch the Signon logs. The REST API can fetch a maximum of 100 records at a time and the RAAS API has a limit of 2GB. We recommend you do not set the polling interval below 10 min.
States
The Workday Source reports errors, its health, and initialization status. Other than indicating that the source is healthy, you are also informed, in real-time, if the source is running into trouble communicating with Workday REST API, or if there's an error that requires user action indicated by Sumo Logic Health Events.
A Workday Source goes through the following states when created:
-
Pending: Once the Source is submitted, details are stored and and the source is placed in a Pending state.
-
Started: A collection task is created on the hosted collector.
-
Initialized: Task configuration is complete in Sumo Logic.
-
Authenticated: The Source has successfully authenticated with Workday
-
Collecting: The Source is actively collecting data from Workday.
If the Source has any issues during any one of these states it is placed in an Error state.
Hover your mouse over the status icon to view a tooltip with details on the detected issue.
When you delete the source it is placed in a Stopping state and when it has successfully stopped it is deleted from your Hosted Collector.
On the Collection page, the Health and Status for Sources is displayed. Use Health Events to investigate issues with collection.
Error types
When Sumo Logic detects an issue it is tracked by Health Events. The following table shows the three possible error types, the reason the error would occur, if the Source attempts to retry, and the name of the event log in the Health Event Index.
|
Type |
Reason |
Retries |
Retry Behavior |
Health Event Name |
|---|---|---|---|---|
|
ThirdPartyConfig |
Normally on account of invalid configuration. You will need to review your Source configuration and make an update. |
No retries are attempted until the Source is updated. |
Not applicable |
ThirdPartyConfigError |
|
ThirdPartyGeneric |
Normally due to an error communicating with the third party service APIs. |
Yes |
The Source will retry for up to 90 minutes, after which retries will be attempted every 60 minutes. |
ThirdPartyGenericError |
|
FirstPartyGeneric |
Normally due to an error communicating with the internal Sumo Logic APIs. |
Yes |
The Source will retry for up to 90 minutes, after which retries will be attempted every 60 minutes. |
FirstPartyGenericError |
JSON configuration
Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details.
|
Parameter |
Type |
Required |
Description |
Access |
|---|---|---|---|---|
|
config |
JSON Object |
Yes |
Contains the configuration parameters for the Source. |
|
|
schemaRef |
JSON Object |
Yes |
Use {"type":"Salesforce"} for Workday Source. |
not modifiable |
|
sourceType |
String |
Yes |
Use Universal for Workday Source. |
not modifiable |
The following table shows the config parameters for Workday Source.
|
Parameter |
Type |
Required |
Default |
Description |
Access |
|---|---|---|---|---|---|
|
name |
String |
Yes |
|
Type a desired name of the Source. The name must be unique per Collector. This value is assigned to the metadata field _source. |
modifiable |
|
description |
String |
No |
null |
Type a description of the Source. |
modifiable |
|
category |
String |
No |
null |
Type a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details. |
modifiable |
|
fields |
JSON Object |
No |
|
JSON map of key-value fields (metadata) to apply to the Collector or Source.
Use the boolean field _siemForward to enable forwarding to SIEM. |
modifiable |
|
isu_password |
String |
Yes |
|
Type the workday ISU account password for the username created in Step 1.1 |
modifiable |
|
isu_username |
String |
Yes |
|
Type integration system user account name created in Step 1.1 |
modifiable |
|
backfill_days |
String |
No |
Now |
Type the collection start time. Available options are 0, 1, |
modifiable |
|
polling_interval_minutes |
Integer |
No |
10 |
This sets how often the Source checks for new data The unit is in minutes. |
modifiable
|
|
client_id |
String |
Yes |
|
Type in the API Client ID copied from Step 1.3. |
modifiable |
|
client_secret |
String |
Yes |
|
Type in the API Client Secret copied from Step 1.3. |
modifiable |
|
refresh_token |
String |
Yes |
|
Type in the token endpoint generated from Step 1.3. |
modifiable |
|
signon_report_url |
String |
Yes |
|
Type in the signon report url from Step 1.5. |
modifiable |
|
Workday_rest_api_endpoint |
String |
Yes |
|
Type in the Workday Rest API endpoint copied from Step 1.3. |
modifiable |
|
Refresh_token_endpoint |
String |
Yes |
|
Type in the Workday Rest API Token endpoint copied from Step 1.3. |
modifiable |
Workday Source JSON example:
|
{ |