Workday has adopted the Open Cybersecurity Schema Framework (OCSF), an open standard. With OCSF support, the service can normalize and combine security data from AWS and a broad range of enterprise security data sources.
Devo collector features
Feature
Details
Allow parallel downloading (multipod)
not allowed
Running environments
collector server
on-premise
Populated Devo events
table
Flattening preprocessing
no
Allowed source events obfuscation
yes
Data sources
Data source
Description
API endpoint
Collector service name
Devo table
Available from release
Workday
Provides the ability to view log entries in the User Activity report data source
/activityLogging
activity_logging
app.workday.user_activity.activity
v1.0.0
For more information on how the events are parsed, visit our page.
...
Info
This minimum configuration refers exclusively to those specific parameters of this integration. There are more required parameters related to the generic behavior of the collector. Check setting sections for details.
Setting
Details
client_id
Client ID
client_secret
Client Secret
refresh_token
The refresh token
base_url
The base URL
Please note that the tenant is used as part of the API URL. For instance, in the URL https://wd5-services1.myworkday.com/ccx/api/v1/acme, the base API URL is https://wd5-services1.myworkday.com and the tenant is “acme.”
tenant
The Workday tenant
Please note that the tenant is used as part of the API URL. For instance, in the URL https://wd5-services1.myworkday.com/ccx/api/v1/acme, the base API URL is https://wd5-services1.myworkday.com and the tenant is “acme.”
Info
See the Accepted authentication methods section to verify what settings are required based on the desired authentication method.
Accepted authentication methods
Authentication method
Client ID
Client Secret
client_id / client_secret
Required
Required
Run the collector
Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).
Rw ui tabs macro
Rw tab
title
On-premise collector
This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running.
Structure
The following directory structure should be created for being used when running the collector:
In Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in <product_name>/certs/. Learn more about security credentials in Devo here.
All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the services object.
Replace the placeholders with your required values following the description table below:
Parameter
Data type
Type
Value Range / Format
Details
debug_status
bool
mandatory
true / false
If the value is true, the debug logging traces will be enabled when running the collector. If the value is false, only the info, warning, and error logging levels will be printed.
devo_address
str
mandatory
collector-us.devo.io
collector-eu.devo.io
Use this parameter to identify the Devo Cloud where the events will be sent.
chain_filename
str
mandatory
minimum length: 4
maximum length: 20
Use this parameter to identify the chain.cert file downloaded from your Devo domain. Usually this file's name is: chain.crt.
cert_filename
str
mandatory
minimum length: 4
maximum length: 20
Use this parameter to identify the file.cert downloaded from your Devo domain.
key_filename
str
mandatory
minimum length: 4
maximum length: 20
Use this parameter to identify the file.key downloaded from your Devo domain.
input_id_value
int
mandatory
minimum length: 5
maximum length: 15
Use this parameter to give a unique ID to this input service.
Note
This parameter is used to build the persistence address. Do not use the same value for multiple collectors. It could cause a collision.
Devo tag-friendly string (no special characters, spaces, etc.) For more information see Devo Tags.
An optional tag that allows users to override the service default tags.
Info
This parameter can be removed or commented.
start_time_in_utc_value
str
optional
UTC datetime string having datetime string format %-Y-%m-%d %H-%M-%S (e.g., “2000-01-01 00:00:01”)
This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (one month back for example) before downloading new events.
Info
This parameter should be removed if it is not used.
Each object represents the necessary configuration to obfuscate messages before these are sent to Devo.
Info
This parameter can be removed or commented.
Download the Docker image
The collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table:
Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace <image_file> and <version> with a proper value.
The Docker image can be deployed on the following services:
Docker
Execute the following command on the root directory <any_directory>/devo-collectors/<product_name>/
Replace <product_name>, <image_name> and <version> with the proper values.
Docker Compose
The following Docker Compose file can be used to execute the Docker container. It must be created in the <any_directory>/devo-collectors/<product_name>/ directory.
To run the container using docker-compose, execute the following command from the <any_directory>/devo-collectors/<product_name>/ directory:
Code Block
IMAGE_VERSION=<version> docker-compose up -d
Note
Replace <product_name>, <image_name> and <version> with the proper values.
Rw tab
title
Cloud collector
We use a piece of software called Collector Server to host and manage all our available collectors. If you want us to host this collector for you, get in touch with us and we will guide you through the configuration.
...
Expand
title
Troubleshooting
This collector has different security layers that detect both an invalid configuration and abnormal operation. This table will help you detect and resolve the most common errors.
Error Type
Error Id
Error Message
Cause
Solution
InitVariablesError
1
Invalid start_time_in_utc: {ini_start_str}. Must be in parseable datetime format.
The configured start_time_in_utcparameter is a non-parseable format.
Update the start_time_in_utcvalue to have the recommended format as indicated in the guide.
InitVariablesError
2
Invalid start_time_in_utc: {ini_start_str}. Must be in the past..
The configured start_time_in_utcparameter is a future date.
Update the start_time_in_utcvalue to a past datetime.
SetupError
101
Failed to fetch OAuth token from {token_endpoint}. Exception: {e}.
The provided credentials, base URL, and/or token endpoint is incorrect.
Revisit the configuration steps and ensure that the correct values were specified in the config file.
SetupError
102
Failed to fetch data from {endpoint}. Source is not pullable.
The provided credentials, base URL, and/or token endpoint is incorrect.
Revisit the configuration steps and ensure that the correct values were specified in the config file.
ApiError
401
Error during API call to.. (API provider HTML error response here)
The server returned an HTTP 401 response.
Ensure that the provided credentials are correct and provide read access to the targeted data.
ApiError
429
Error during API call to .. (API provider HTML error response here)
The server returned an HTTP 429 response.
The collector will attempt to retry requests (default up to 3 times) and respect back-off headers if they exist. If the collector repeatedly encounters this error, adjust the rate limit and/or contact the API provider to ensure that you have enough quota to complete the data pull.
ApiError
500
Error during API call to… to (API provider HTML error response here)
The server returned an HTTP 500 response.
If the API returns a 500 but successfully completes subsequent runs then you may ignore this error. If the API repeatedly returns a 500 error, ensure the server is reachable and operational.
...
Expand
title
Check memory usage
To check the memory usage of this collector, look for the following log records in the collector which are displayed every 5 minutes by default, always after running the memory-free process.
The used memory is displayed by running processes and the sum of both values will give the total used memory for the collector.
The global pressure of the available memory is displayed in the global value.
All metrics (Global, RSS, VMS) include the value before freeing and after previous -> after freeing memory