Workday¶
Bases: BaseModel
Pydantic model for a Workday location record.
raw_data holds the full SOAP response dict for any extra fields.
Bases: WorkdayTypeBase
Handler for the Workday Get_Locations operation.
async
¶
Execute the Get_Locations operation and return a pandas DataFrame.
Supported parameters: - location_id: Specific location ID to fetch (uses Request_References) - location_name: Filter by location name (uses Request_Criteria) - location_type: Filter by location type - location_usage: Filter by location usage - inactive: Filter by inactive status (True/False)
async
¶
Convenience method to get a specific location by ID.
async
¶
Convenience method to get a specific location by name.
async
¶
Convenience method to get locations by type.
Bases: BaseModel
Complete organization model based on actual Workday payload.
Bases: WorkdayTypeBase
Handler for the Workday Get_Organizations operation.
async
¶
Execute the Get_Organizations operation and return a pandas DataFrame.
Supported parameters: - organization_id: Specific organization ID to fetch (uses Request_References) - organization_id_type: Type of organization ID (WID, Organization_Reference_ID, Cost_Center_Reference_ID, etc.) - organization_type: Filter by organization type (Company, Cost Center, Custom, Matrix, Pay Group, Region, Retiree, Supervisory, etc.) - include_inactive: Include inactive organizations (True/False) - enable_transaction_log_lite: Enable transaction log lite (True/False)
async
¶
Get only active organizations.
:return: DataFrame with active organizations data
async
¶
Get all organizations (active and optionally inactive).
:param include_inactive: Whether to include inactive organizations :return: DataFrame with all organizations data
async
¶
Get only company organizations.
:return: DataFrame with company organizations data
async
¶
Get only cost center organizations.
:return: DataFrame with cost center organizations data
async
¶
Get a specific organization by Cost Center Reference ID.
:param cost_center_id: The organization Cost Center Reference ID to fetch :return: DataFrame with organization data
async
¶
Get a specific organization by ID.
:param organization_id: The organization ID to fetch :param id_type: Type of ID (WID, Organization_Reference_ID, Cost_Center_Reference_ID, etc.) :return: DataFrame with organization data
async
¶
Get a specific organization by WID.
:param wid: The organization WID to fetch :return: DataFrame with organization data
async
¶
Get organizations filtered by type.
:param organization_type: Organization type (Company, Cost Center, Custom, Matrix, Pay Group, Region, Retiree, Supervisory, etc.) :return: DataFrame with organizations data
async
¶
Get only supervisory organizations.
:return: DataFrame with supervisory organizations data
Bases: BaseModel
Pydantic model for a Workday calculated time block record.
raw_data holds the full SOAP response dict for any extra fields.
Bases: WorkdayTypeBase
Handler for the Workday Get_Calculated_Time_Blocks operation.
async
¶
Execute the Get_Calculated_Time_Blocks operation and return a pandas DataFrame.
Supported parameters: - worker_id: Specific worker ID to fetch time blocks for - start_date: Start date for date range filter (YYYY-MM-DD) - end_date: End date for date range filter (YYYY-MM-DD) - time_block_id: Specific time block ID to fetch - status: Filter by status - supervisory_org: Filter by supervisory organization - include_deleted: Whether to include deleted time blocks (default: False)
async
¶
Convenience method to get time blocks for a date range.
async
¶
Convenience method to get time blocks for a specific worker.
Bases: BaseModel
Pydantic model for a Workday time request record.
raw_data holds the full SOAP response dict for any extra fields.
Bases: WorkdayTypeBase
Handles Get_Time_Requests operation for Workday Time Tracking API.
async
¶
Get a specific time request by ID.
async
¶
Get all time requests within a date range.
async
¶
Get time requests for a specific organization within an optional date range.
async
¶
Get time requests for a specific worker within an optional date range.
Bases: SOAPClient, FlowComponent
Workday Component
Overview
The Workday class is a Flowtask component for the Workday SOAP API. It encapsulates all Workday-specific logic, including authentication, request/response handling, and data normalization.
Properties
type (str): Operation type to perform (e.g. 'get_workers', 'get_time_blocks') worker_id (str): Optional worker ID to fetch a specific worker use_storage (bool): Enable data storage functionality storage_path (str): Path where to store the data files
Returns:
| Type | Description |
|---|---|
|
Returns a pandas DataFrame with the requested data. |
Examples:
# Basic usage
Workday:
type: get_workers
worker_id: "72037046323885"
# With storage enabled
Workday:
type: get_workers
use_storage: true
storage_path: "/data/workday"
# Location hierarchy assignments with storage
Workday:
type: get_location_hierarchy_assignments
use_storage: true
storage_path: "/data/workday"
# Organizations with storage
Workday:
type: get_organizations
organization_type: "Cost_Center"
use_storage: true
storage_path: "/data/workday"
Bases: BaseModel
Pydantic model for a Workday worker record.
raw_data holds the full SOAP response dict for any extra fields.
Bases: WorkdayTypeBase
Handler for the Workday Get_Workers operation, batching pages
so that no more than max_parallel requests run concurrently.
:param component: Component instance :param max_retries: Maximum retry attempts (default: 5 for connection resilience) :param retry_delay: Base delay between retries in seconds (default: 0.5 for exponential backoff)
async
¶
Execute the Get_Workers operation and return a pandas DataFrame.
If worker_id is provided, fetches only that one; otherwise
fetches all pages in batches of at most max_parallel concurrent requests.
Bases: BaseModel
Pydantic model for a Workday location record.
raw_data holds the full SOAP response dict for any extra fields.
Bases: BaseModel
Complete organization model based on actual Workday payload.
Bases: BaseModel
Pydantic model for a Workday calculated time block record.
raw_data holds the full SOAP response dict for any extra fields.
Bases: BaseModel
Pydantic model for a Workday time request record.
raw_data holds the full SOAP response dict for any extra fields.
Bases: BaseModel
Pydantic model for a Workday worker record.
raw_data holds the full SOAP response dict for any extra fields.
Bases: BaseModel
Pydantic model for a Workday location record.
raw_data holds the full SOAP response dict for any extra fields.
Pydantic models for Location Hierarchy Organization Assignments.
Bases: BaseModel
Model for location hierarchy organization assignment.
Bases: BaseModel
Model for the complete location hierarchy assignments response.
Bases: BaseModel
Model for location hierarchy reference.
Bases: BaseModel
Model for organization assignment by type.
Bases: BaseModel
Model for organization reference in assignments.
Bases: BaseModel
Model for organization type reference.
Bases: BaseModel
Complete organization model based on actual Workday payload.
Bases: BaseModel
Pydantic model for a Workday calculated time block record.
raw_data holds the full SOAP response dict for any extra fields.
Parse benefit enrollments, roles, and worker documents.
Parse the compensation details of the worker.
Extracts
- wage (float)
- compensation_effective_date (str)
- compensation_guidelines (package / grade / profile IDs)
- salary_and_hourly (list of elements)
- compensation_summary (nested summary)
- reason_references (mapping of reason type → ID)
Parse the contact information (email, address, phone) of the worker.
Parse employment-related details (position, hours, job profile).
Parse identification details (national ID, license, custom IDs).
Parse the main location data from Workday response.
Parse management chain data from Worker_Management_Chain_Data.
Parse organization data from Workday SOAP response.
:param org_data: Raw organization data from Workday :return: Parsed Organization model
Parse payroll and tax related data from Position_Data.
Parse the personal information of the worker.
Parse management chain data from Position_Management_Chains_Data. This is different from Worker_Management_Chain_Data and contains the actual management chain.
Parse the main time block data from Workday response.
Parse time request data from the SOAP response.
Parse worker organization information from worker data
Parse worker status details (active, hire/termination dates, eligibility), asegurando no romper si algún _Reference es None.
Parsers for Location Hierarchy Organization Assignments data.
Parse location hierarchy organization assignment data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
assignment_data
|
Dict[str, Any]
|
Raw assignment data from the API (already Location_Hierarchy_Organization_Assignments_Data) |
required |
Returns:
| Type | Description |
|---|---|
LocationHierarchyAssignment
|
Parsed LocationHierarchyAssignment object |
Main parser function for location hierarchy assignments data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
raw_data
|
Dict[str, Any]
|
Raw data from the API response |
required |
Returns:
| Type | Description |
|---|---|
Dict[str, Any]
|
Dictionary with parsed assignments and metadata |
Parse the complete location hierarchy assignments response.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
response_data
|
Dict[str, Any]
|
Raw response data from the API |
required |
Returns:
| Type | Description |
|---|---|
List[LocationHierarchyAssignment]
|
List of parsed LocationHierarchyAssignment objects |
Parse location hierarchy reference data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
reference_data
|
Dict[str, Any]
|
Raw location hierarchy reference data |
required |
Returns:
| Type | Description |
|---|---|
LocationHierarchyReference
|
Parsed LocationHierarchyReference object |
Parse organization assignment by type data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
assignment_data
|
Dict[str, Any]
|
Raw organization assignment data |
required |
Returns:
| Type | Description |
|---|---|
OrganizationAssignment
|
Parsed OrganizationAssignment object |
Parse organization reference data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
org_data
|
Dict[str, Any]
|
Raw organization reference data |
required |
Returns:
| Type | Description |
|---|---|
OrganizationReference
|
Parsed OrganizationReference object |
Parse organization type reference data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
type_data
|
Dict[str, Any]
|
Raw organization type reference data |
required |
Returns:
| Type | Description |
|---|---|
OrganizationTypeReference
|
Parsed OrganizationTypeReference object |
Parse response results (pagination info).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
response_data
|
Dict[str, Any]
|
Raw response data from the API |
required |
Returns:
| Type | Description |
|---|---|
Dict[str, Any]
|
Dictionary with pagination information |
Parse organization data from Workday SOAP response.
:param org_data: Raw organization data from Workday :return: Parsed Organization model
Parse the complete organizations response from Workday.
:param response_data: Raw response data from Workday :return: List of parsed Organization models
Parse benefit enrollments, roles, and worker documents.
Parse the compensation details of the worker.
Extracts
- wage (float)
- compensation_effective_date (str)
- compensation_guidelines (package / grade / profile IDs)
- salary_and_hourly (list of elements)
- compensation_summary (nested summary)
- reason_references (mapping of reason type → ID)
Parse the contact information (email, address, phone) of the worker.
Parse employment-related details (position, hours, job profile).
Parse identification details (national ID, license, custom IDs).
Parse management chain data from Worker_Management_Chain_Data.
Parse payroll and tax related data from Position_Data.
Parse the personal information of the worker.
Parse management chain data from Position_Management_Chains_Data. This is different from Worker_Management_Chain_Data and contains the actual management chain.
Parse worker organization information from worker data
Parse worker status details (active, hire/termination dates, eligibility), asegurando no romper si algún _Reference es None.
Bases: WorkdayTypeBase
Handler for the Workday Get_Locations operation.
async
¶
Execute the Get_Locations operation and return a pandas DataFrame.
Supported parameters: - location_id: Specific location ID to fetch (uses Request_References) - location_name: Filter by location name (uses Request_Criteria) - location_type: Filter by location type - location_usage: Filter by location usage - inactive: Filter by inactive status (True/False)
async
¶
Convenience method to get a specific location by ID.
async
¶
Convenience method to get a specific location by name.
async
¶
Convenience method to get locations by type.
Bases: WorkdayTypeBase
Handler for the Workday Get_Organizations operation.
async
¶
Execute the Get_Organizations operation and return a pandas DataFrame.
Supported parameters: - organization_id: Specific organization ID to fetch (uses Request_References) - organization_id_type: Type of organization ID (WID, Organization_Reference_ID, Cost_Center_Reference_ID, etc.) - organization_type: Filter by organization type (Company, Cost Center, Custom, Matrix, Pay Group, Region, Retiree, Supervisory, etc.) - include_inactive: Include inactive organizations (True/False) - enable_transaction_log_lite: Enable transaction log lite (True/False)
async
¶
Get only active organizations.
:return: DataFrame with active organizations data
async
¶
Get all organizations (active and optionally inactive).
:param include_inactive: Whether to include inactive organizations :return: DataFrame with all organizations data
async
¶
Get only company organizations.
:return: DataFrame with company organizations data
async
¶
Get only cost center organizations.
:return: DataFrame with cost center organizations data
async
¶
Get a specific organization by Cost Center Reference ID.
:param cost_center_id: The organization Cost Center Reference ID to fetch :return: DataFrame with organization data
async
¶
Get a specific organization by ID.
:param organization_id: The organization ID to fetch :param id_type: Type of ID (WID, Organization_Reference_ID, Cost_Center_Reference_ID, etc.) :return: DataFrame with organization data
async
¶
Get a specific organization by WID.
:param wid: The organization WID to fetch :return: DataFrame with organization data
async
¶
Get organizations filtered by type.
:param organization_type: Organization type (Company, Cost Center, Custom, Matrix, Pay Group, Region, Retiree, Supervisory, etc.) :return: DataFrame with organizations data
async
¶
Get only supervisory organizations.
:return: DataFrame with supervisory organizations data
Bases: WorkdayTypeBase
Handler for the Workday Get_Calculated_Time_Blocks operation.
async
¶
Execute the Get_Calculated_Time_Blocks operation and return a pandas DataFrame.
Supported parameters: - worker_id: Specific worker ID to fetch time blocks for - start_date: Start date for date range filter (YYYY-MM-DD) - end_date: End date for date range filter (YYYY-MM-DD) - time_block_id: Specific time block ID to fetch - status: Filter by status - supervisory_org: Filter by supervisory organization - include_deleted: Whether to include deleted time blocks (default: False)
async
¶
Convenience method to get time blocks for a date range.
async
¶
Convenience method to get time blocks for a specific worker.
Bases: WorkdayTypeBase
Handles Get_Time_Requests operation for Workday Time Tracking API.
async
¶
Get a specific time request by ID.
async
¶
Get all time requests within a date range.
async
¶
Get time requests for a specific organization within an optional date range.
async
¶
Get time requests for a specific worker within an optional date range.
Bases: WorkdayTypeBase
Handler for the Workday Get_Workers operation, batching pages
so that no more than max_parallel requests run concurrently.
:param component: Component instance :param max_retries: Maximum retry attempts (default: 5 for connection resilience) :param retry_delay: Base delay between retries in seconds (default: 0.5 for exponential backoff)
async
¶
Execute the Get_Workers operation and return a pandas DataFrame.
If worker_id is provided, fetches only that one; otherwise
fetches all pages in batches of at most max_parallel concurrent requests.
Bases: ABC
Base class for Workday operation types.
Provides
- Default payload structure for all Workday operations.
- Generic pagination logic with retries and logging.
- Common SOAP response handling utilities.
:param component: Component instance (used for run, logger, metrics). :param max_retries: Maximum number of retry attempts per page on failure. :param retry_delay: Seconds to wait between retry attempts.
abstractmethod
async
¶
Execute the specific operation logic. Must be implemented by subclasses.
Get_Location_Hierarchy_Organization_Assignments operation handler.
This module handles the Get_Location_Hierarchy_Organization_Assignments operation which retrieves organization assignments for location hierarchies.
Bases: WorkdayTypeBase
Handler for Get_Location_Hierarchy_Organization_Assignments operation.
Retrieves organization assignments for location hierarchies.
:param component: Component instance :param max_retries: Maximum retry attempts (default: 5 for connection resilience) :param retry_delay: Delay between retries in seconds (default: 2.0 for API rate limiting) :param kwargs: Additional parameters
async
¶
Execute Get_Location_Hierarchy_Organization_Assignments operation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
**kwargs
|
Additional parameters including: - location_hierarchy_ids: List of location hierarchy IDs to fetch - location_hierarchy_id_type: Type of ID (WID, Organization_Reference_ID) - as_of_effective_date: Date for effective data - as_of_entry_datetime: Date/time for entry data - page: Page number for pagination - count: Number of results per page |
{}
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pandas DataFrame containing the location hierarchy organization assignments |
async
¶
Get all location hierarchy organization assignments.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
**kwargs
|
Additional parameters for filtering |
{}
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
DataFrame with all location hierarchy organization assignments |
async
¶
Get organization assignments for a specific location hierarchy.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
location_hierarchy_id
|
str
|
The location hierarchy ID to fetch |
required |
id_type
|
str
|
Type of ID (WID, Organization_Reference_ID) |
'Organization_Reference_ID'
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
DataFrame with organization assignments for the location hierarchy |
Bases: WorkdayTypeBase
Handler for the Workday Get_Locations operation.
async
¶
Execute the Get_Locations operation and return a pandas DataFrame.
Supported parameters: - location_id: Specific location ID to fetch (uses Request_References) - location_name: Filter by location name (uses Request_Criteria) - location_type: Filter by location type - location_usage: Filter by location usage - inactive: Filter by inactive status (True/False)
async
¶
Convenience method to get a specific location by ID.
async
¶
Convenience method to get a specific location by name.
async
¶
Convenience method to get locations by type.
Get_Organization operation handler.
This module handles the Get_Organization operation which retrieves a specific organization by its ID (singular, not plural).
Bases: WorkdayTypeBase
Handler for Get_Organization operation.
Retrieves a specific organization by its ID.
async
¶
Execute Get_Organization operation to retrieve a specific organization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
organization_id
|
str
|
The ID of the organization to retrieve |
required |
organization_id_type
|
str
|
The type of ID (Organization_Reference_ID, WID, etc.) |
'Organization_Reference_ID'
|
**kwargs
|
Additional parameters |
{}
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pandas DataFrame containing the organization data |
async
¶
Get organization by Custom_Organization_Reference_ID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
custom_id
|
str
|
The Custom_Organization_Reference_ID |
required |
**kwargs
|
Additional parameters |
{}
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pandas DataFrame containing the organization data |
async
¶
Get organization by Organization_Reference_ID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
reference_id
|
str
|
The Organization_Reference_ID |
required |
**kwargs
|
Additional parameters |
{}
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pandas DataFrame containing the organization data |
async
¶
Get organization by WID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
wid
|
str
|
The WID of the organization |
required |
**kwargs
|
Additional parameters |
{}
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pandas DataFrame containing the organization data |
Bases: WorkdayTypeBase
Handler for the Workday Get_Organizations operation.
async
¶
Execute the Get_Organizations operation and return a pandas DataFrame.
Supported parameters: - organization_id: Specific organization ID to fetch (uses Request_References) - organization_id_type: Type of organization ID (WID, Organization_Reference_ID, Cost_Center_Reference_ID, etc.) - organization_type: Filter by organization type (Company, Cost Center, Custom, Matrix, Pay Group, Region, Retiree, Supervisory, etc.) - include_inactive: Include inactive organizations (True/False) - enable_transaction_log_lite: Enable transaction log lite (True/False)
async
¶
Get only active organizations.
:return: DataFrame with active organizations data
async
¶
Get all organizations (active and optionally inactive).
:param include_inactive: Whether to include inactive organizations :return: DataFrame with all organizations data
async
¶
Get only company organizations.
:return: DataFrame with company organizations data
async
¶
Get only cost center organizations.
:return: DataFrame with cost center organizations data
async
¶
Get a specific organization by Cost Center Reference ID.
:param cost_center_id: The organization Cost Center Reference ID to fetch :return: DataFrame with organization data
async
¶
Get a specific organization by ID.
:param organization_id: The organization ID to fetch :param id_type: Type of ID (WID, Organization_Reference_ID, Cost_Center_Reference_ID, etc.) :return: DataFrame with organization data
async
¶
Get a specific organization by WID.
:param wid: The organization WID to fetch :return: DataFrame with organization data
async
¶
Get organizations filtered by type.
:param organization_type: Organization type (Company, Cost Center, Custom, Matrix, Pay Group, Region, Retiree, Supervisory, etc.) :return: DataFrame with organizations data
async
¶
Get only supervisory organizations.
:return: DataFrame with supervisory organizations data
Bases: WorkdayTypeBase
Handler for the Workday Get_Calculated_Time_Blocks operation.
async
¶
Execute the Get_Calculated_Time_Blocks operation and return a pandas DataFrame.
Supported parameters: - worker_id: Specific worker ID to fetch time blocks for - start_date: Start date for date range filter (YYYY-MM-DD) - end_date: End date for date range filter (YYYY-MM-DD) - time_block_id: Specific time block ID to fetch - status: Filter by status - supervisory_org: Filter by supervisory organization - include_deleted: Whether to include deleted time blocks (default: False)
async
¶
Convenience method to get time blocks for a date range.
async
¶
Convenience method to get time blocks for a specific worker.
Bases: WorkdayTypeBase
Handles Get_Time_Requests operation for Workday Time Tracking API.
async
¶
Get a specific time request by ID.
async
¶
Get all time requests within a date range.
async
¶
Get time requests for a specific organization within an optional date range.
async
¶
Get time requests for a specific worker within an optional date range.
Bases: WorkdayTypeBase
Handler for the Workday Get_Workers operation, batching pages
so that no more than max_parallel requests run concurrently.
:param component: Component instance :param max_retries: Maximum retry attempts (default: 5 for connection resilience) :param retry_delay: Base delay between retries in seconds (default: 0.5 for exponential backoff)
async
¶
Execute the Get_Workers operation and return a pandas DataFrame.
If worker_id is provided, fetches only that one; otherwise
fetches all pages in batches of at most max_parallel concurrent requests.
Given a list of {'_value_1':…, 'type':…} dicts (or a single dict),
return the _value_1 whose type matches desired_type, or None.
Serialize Decimal, list or dict into JSON-friendly string, or return empty string if None.
Given a list of {'_value_1':…, 'type':…} dicts (or a single dict),
return the _value_1 whose type matches desired_type, or None.
Helper to extract nested data from a dict given a list of keys.
Serialize Decimal, list or dict into JSON-friendly string, or return empty string if None.
Bases: SOAPClient, FlowComponent
Workday Component
Overview
The Workday class is a Flowtask component for the Workday SOAP API. It encapsulates all Workday-specific logic, including authentication, request/response handling, and data normalization.
Properties
type (str): Operation type to perform (e.g. 'get_workers', 'get_time_blocks') worker_id (str): Optional worker ID to fetch a specific worker use_storage (bool): Enable data storage functionality storage_path (str): Path where to store the data files
Returns:
| Type | Description |
|---|---|
|
Returns a pandas DataFrame with the requested data. |
Examples:
# Basic usage
Workday:
type: get_workers
worker_id: "72037046323885"
# With storage enabled
Workday:
type: get_workers
use_storage: true
storage_path: "/data/workday"
# Location hierarchy assignments with storage
Workday:
type: get_location_hierarchy_assignments
use_storage: true
storage_path: "/data/workday"
# Organizations with storage
Workday:
type: get_organizations
organization_type: "Cost_Center"
use_storage: true
storage_path: "/data/workday"