---
title: "Workday collector"
canonical: "https://docs.devo.com/space/latest/365527094/Workday%20collector"
format: markdown
---
> Macro (toc)
## Overview
Workday is a service that automates the sourcing, aggregation, normalization, and data management of security data across your organization into a security data lake stored in your account. A security data lake helps make your organization’s security data broadly accessible to your preferred security analytics solutions to power use cases such as threat detection, investigation, and incident response.
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](https://devodocs.atlassian.net/wiki/spaces/latest/pages/311492786).
## Minimum configuration required for basic pulling
Although this collector supports advanced configuration, the fields required to retrieve data with basic configuration are defined below.
> ℹ️ 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.” |
> ℹ️ 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).
> Macro (rw-ui-tabs-macro)
>
> > Macro (rw-tab)
>
> We use a piece of software called Collector Server to host and manage all our available collectors.
>
> To enable the collector for a customer:
>
> 1. In the **Collector Server** **GUI**, access the **domain** in which you want this instance to be created
> 2. Click **Add Collector** and find the one you wish to add.
> 3. In the **Version** field, select the latest value.
> 4. In the **Collector Name** field, set the value you prefer (this name must be unique inside the same Collector Server domain).
> 5. In the sending method select **Direct Send. Direct Send** configuration is optional for collectors that create `Table` events, but mandatory for those that create `Lookups`.
> 6. In the **Parameters** section, establish the **Collector Parameters** as follows below:
>
> ### Editing the JSON configuration
>
> ```
> {
> "globals": {
> "debug": "",
> "id": "not_used",
> "name": "workday",
> "persistence": {
> "type": "filesystem",
> "config": {
> "directory_name": "state"
> }
> }
> },
> "inputs": {
> "workday": {
> "id": "",
> "enabled": true,
> "base_url": "",
> "override_token_endpoint": "",
> “environment”: “”,
> "credentials": {
> "client_id": "",
> "client_secret": "",
> "refresh_token": "",
> "tenant": ""
> },
> "services": {
> "activity_logging": {
> "override_tag": "",
> "start_time_in_utc": "",
> "obfuscation_data": [""]
> }
> }
> }
> }
> }
>
> ```
>
> > ℹ️ 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.
>
> Please replace the placeholders with real world 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. This parameter is used to build the persistence address. Do not use the same value for multiple collectors. It could cause a collision. |
> | `base_url_value` | `string` | mandatory | minimum length: 1 | For the URL [https://wd5-services1.myworkday.com/ccx/api/v1/acme](https://wd5-services1.myworkday.com/ccx/api/v1/acme), the base URL is [https://wd5-services1.myworkday.com](https://wd5-services1.myworkday.com). |
> | `override_token_endpoint_value` | `string` | optional | minimum length: 1 | An optional token endpoint. The default token endpoint follows the pattern: `{base_url}/ccx/oauth2/{tenant}/token` This parameter should be removed if it is not used. |
> | `environment_value` | `str` | Optional | Minimum length: 1 | This is an optional control parameter that is injected into the events and allows to differentiate the environment. For example: dev and prod. This parameter should be removed if it is not used. |
> | `client_id_value` | `str` | mandatory | minimum length: 1 | The Workday API Client ID |
> | `client_secret_value` | `str` | mandatory | minimum length: 1 | The Workday API Client secret |
> | `refresh_token_value` | `str` | mandatory | minimum length: 1 | The Workday refresh token |
> | `tenant_value` | `str` | mandatory | minimum length: 1 | 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](https://wd5-services1.myworkday.com/ccx/api/v1/acme), the base API URL is [https://wd5-services1.myworkday.com](https://wd5-services1.myworkday.com) and the tenant is “acme.” |
> | `override_tag_value` | `str` | optional | Devo tag-friendly string (no special characters, spaces, etc.) For more information see [Devo Tags](https://docs.devo.com/space/latest/95126204/About%20Devo%20tags). | An optional tag that allows users to override the service default tags. 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. This parameter should be removed if it is not used. |
> | `obfuscation_data_values` | `array