Skip to content

Workday

flowtask.components.Workday.workday

Workday

Workday(*, loop=None, job=None, stat=None, **kwargs)

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"

add_metric

add_metric(key, value)

Add a metric to track

close async

close()

Cleanup resources

run async

run(operation=None, **kwargs)

Execute the component's main operation

serialize_object

serialize_object(obj)

Helper to serialize SOAP objects

start async

start(**kwargs)

Initialize the component