Connector
Connector
Integration Architecture
Overview o Integration
System Tools o
Integration Cloud
Connect
Integration System Building Blocks
Core Connectors
o Overview Core Connectors
o Core Connector: Worker
o Core Connector: Inbound Organization
o Integration System Security
Developers also connect to the OMS via the UI Server to make use of the browser-
based tools, for example, when configuring Integration Systems or building
integrations using the EIB.
There are three ways to access the web services to get and update data via an
integration system to your Workday tenant. You may use the delivered configurable
integrations (Cloud Connect), the integration tools to create integration systems (EIB
and Workday Studio) or your own existing middleware.
COMPONENTS OF AN INTEGRATION
There are four elements to an integration system:
Data Source: This indicates what kind of data Workday will receive from an
external source or will be extracted from Workday and the location of that data.
Transformation: This converts the data into something that Workday or the
receiving external system can understand. Workday provides some transformations,
but the "build your own integration" purpose of the EIB lies partly in the fact that
users can create their own.
Packaged integrations
Connectors
Note: All Integration Cloud Connect packaged integrations and Connectors require some
level of tenant configuration and testing. Each customer may have specific mapping
requirements and different endpoint configurations. These differences in customer
configurations can be accommodated with Workday's integration templates and mapping
capabilities.
Workday integrations are simple enough to set up on your own. You start with an
integration template that provides a framework for Workday to communicate with an
external system. The template establishes the framework for data exchange through a
collection of integration services. Workday provides custom integration templates for
benefit providers, payroll services, recruiting applications, directory services, payment
settlement, suppliers, and more.
INTEGRATION SYSTEM BUILDING BLOCKS
Integration Service
Contains a set of attributes and maps related to a specific integration function. Integration
services use XSLT to convert Workday XML into a format that an external system can read.
Integration services focus on functional areas and integration behavior (such as document
retention, field overrides, and file delivery).
Integration Attribute
Provides one or more tenanted values for a data element in Workday. For example,
attributes define deduction codes, pay rate types, benefit plan names, and citizenship
status.
Integration Map
Defines relationships between Workday values and external system values. Examples
are maps for benefit coverage levels, marital status, gender, job classifications, and
locations.
Transaction Log
Provides a record of business processes and events in Workday. Integrations can subscribe to
specific transaction log events to capture the changes to employee data that are relevant to an
external system.
With Workday Core Connectors, you can extract foundational data such as organization,
location, and job-related definitions, transform the data, and send it to an endpoint of your
choice. Using Workday's business objects and Get_Job_Families, Get_Job_Profiles,
Get_Locations, and Get_Organizations public APIs as its foundation, Workday Core
Connectors for HCM provide a single source-of-truth for core data, and configure integration
output files that you can transform as required to serve the needs of multiple downstream
systems.
Each Core Connector is a packaged integration template with a configurable set of data
across a range of categories. Core Connectors let you specify which data elements to include
in integration output files. When launched, the integration collects a snapshot of all data and
creates an output file in XML format based on your specifications.
All Core Connector integrations create integration output files in a Workday-defined XML
format. This output can be configured for delivery, or further transformation.
The Core Connector: Worker integration system exports worker data changes from Workday
in simple XML format. Workday also supports output in CSV (Comma Separated Value)
format, with certain limitations. As you hire, promote, transfer, terminate, or update worker
data, the integration generates a text file containing the changes.
Using configurable data sections or Workday-delivered report fields and calculated fields
that you create, you can export any worker data, in any combination.
Change Detection
The Core Connector: Worker detects changes to worker data by monitoring a transaction
log. When you set up the integration system, you may select which business processes and
transaction types that the integration system should subscribe to. However, if your
integration system does not subscribe to a transaction type that affects your worker's
profile, Workday will not include changes triggered by that transaction type.
The Core Connector: Worker integration uses a three-step process to detect and report
changes:
1. When the Core Connector: Worker integration checks the transaction log, the
integration determines which workers have had changes which resulted in the
generation of at least one of the configured transaction events.
2. For each worker with a matching transactional change, the integration compares
their report fields for the time at which the integration was run and the time at
which it was last successfully run. It identifies which, if any, of the values of interest
have been modified.
3. If the worker has any changes in field values or eligibility, Workday generates an
appropriate creation, change or deletion message.
Integration services manage each category of employee data that is available for output.
Before you can configure fields, you must enable the integration services that manage those
fields. To modify the settings, select Integration System > Configure Integration Services as
a related action on the integration system.
This connector is being driven by the GetWorkers Web Service Operation. This service
operation can be accessed directly by EIB and Workday Studio. The Core Connector: Worker
abstracts the web service and you configure the integration using the tenant, rather than
writing a custom request. Notice the Worker_Response_Group of the GEt_Workers_Request
match the services selectable in the Integration Services of the Worker Connector.
Many times an external system may need a piece of data that is not available in the
Web Service Operation. You cannot change it but by using the Core Connector, you may
add a Custom Integration Service and add additional fields to the output file. These
fields can be Delivered Report Fields, Calculated Fields and even Custom Fields.
When you are defining which services to include, you can add a custom service. For
example, to add group fields not included in the underlying web service operation, create a
new Integration Field Override Service.
Before you build an integration with the Core Connector: Worker template, familiarize
yourself with each data section to understand which fields are available for output and how
the configuration options affect integration behavior
(https://community.workday.com/doc/int/28533).
During integration setup, you enable integration services for each data section that you
want to include in the output file.
INTEGRATION SYSTEM FIELD OVERRIDES
Field overrides are a flexible tool to customize your integration system. Use field overrides to
map tenanted data to an external system and add custom values to integration output files.
Field overrides use report fields or calculated fields to supply the values that are required by
the external system.
The Core Connector: Worker includes the Define Eligibility/ Eligibility criterion field override.
Designate a report field or calculated field that identifies if a worker is or is not eligible for
the integration. The report field or calculated field must be based on the Worker business
object, and it must return a boolean true or false. A Boolean true includes the worker in the
integration, a Boolean false excludes the worker.
Attributes are values that are required to configure the integration system in Workday.
They are configurable constants that may need to be changed occasionally in Workday.
Attributes are grouped by attribute provider; an attribute provider corresponds to an
Attribute Map service. For example, the Integration Document Retention service enables
the integration to store output files for auditing purposes. The corresponding Integration
Document Retention attribute provider includes an attribute where you specify how long
documents should be retained.
Business Case: You will configure a new integration system based on the Core
Connector: Worker template to extract Worker data including Personal Data, Position
Data and Compensation Data. You will configure the integration services, integration
field attribute values and custom attributes in subsequent activities. We will link it to an
Integration Business Process that is initiated when the integration system is launched.
Business Case:
In this activity, you will select the attributes to include in the output file for Personal
Data, Position Data and Compensation Data. You will also configure the Field Override
service by defining two additional field for username and initials.
Integration sequence generation enables your integration to generate a unique, sequenced file
name each time it runs. To create a sequence generator, as a related action on the integration
system, select
Integration System > Configure Integration Sequence Generators.
For each launch/schedule option, you can enter the following launch parameters:
Workers enables you to restrict the integration to only considering those workers
selected in this list. If no values are configured then the integration will consider all
workers when looking for transactional and/or data changes. Specifying workers in
this list does not force their inclusion in the output file; a worker's information will
only appear in the output file if there are changes in the data fields evaluated by the
integration system.
o You may want to specify workers in this parameter at launch time if there was
an error involving data for one or more workers during a prior integration run.
You would correct the worker(s) data and then re-run the integration system
only for those workers. In this case, you should set the Last Successful
Launch Moment to the date and time used for that parameter on the prior run
which had problems.
Full File extracts all data, regardless of how recently it was changed.
As Of Entry Moment enables you to search for and retrieve future-dated data
changes where the change has been entered in Workday, but the effective date has
not passed yet.
Effective Date defines the end of a date range during which changes became
effective. The integration extracts all changes with effective dates on or before
this date.
Last Successful As of Entry Moment defaults to the last moment (date and time)
at which the integration system was successfully launched. You can override this
date and time in order to force the integration to search for and retrieve data
changes over a wider period.
Last Successful Effective Date defines the beginning of a date range during
which changes became effective. The integration extracts all changes with
effective dates after this date.
ACTIVITY 3– MODIFY THE INTEGRATION
ATTRIBUTE SERVICE AND SEQUENCE GENERATOR
Business Case: In this activity, you will modify your integration system and configure
the required integration attributes and file name sequence generator service.
3. Populate the Version attribute by clicking the + and selecting 19 from the prompt.
Business Case: In this activity, you will run the integration and view the resulting file. You
will modify personal data information for Logan and launch the integration again. The
resulting file will contain only changed worker data.
6. Set the field value for Last Successful As of Entry Moment to 01/01/2011
12:00:00 AM then click OK.
7. View the background process. Click Refresh. It will take a few moments to run.
8. Once Status is completed, you may view the xml file on the Output Files tab.
TRANSACTION LOG
The Transaction Log enables your integration to monitor events in Workday. You configure the
Transaction Log to subscribe to events for particular transaction types or business process types.
You can configure the types that you are interested in within a particular date or time range,
thereby allowing you to find and compare differences that have occurred in your Workday data
within a particular time period.
Option Description
Enables your integration system to subscribe to events that take place in Workday. This enables your
integration to only report changed fields for workers, rather than report all fields.
TRANSACTION If disabled, your integration first extracts all data for eligible records, then evaluates the data for
LOG SERVICE changes. Using this option can adversely affect performance.
INTEGRATION BUSINESS PROCESS
Separate the execution of the integration itself from the act of retrieving or
delivering files. Configuring the retrieval or delivery action separately allows you to
add additional steps between these actions and the integration execution, or add
multiple retrieval or delivery actions before or after the integration execution.
The Integration Process Event default definition is usually delivered with your tenant.
The default Integration Process Event consists of 2 steps, Initiation and Service (Fire
Integration). If this default definition has not been defined in your tenant, you must
create the default definition, including the 2 steps. If this default definition and the
Initiation and Fire Integration steps aren't present, you will be unable to:
Initiation: This step launches the integration system to which the Integration
Process Event is associated.
Approval: This step sends a notification to a designated worker or role
requesting that they approve the event.
To Do: You can add additional non-Workday tasks to the process.
Integration: This step triggers an additional integration process. This process can
be of any type, including an EIB, packaged integration, tailored integration, or a
custom integration built using Workday Studio.
Service: The Integration Process Event supports 3 service types:
o DOCUMENT DELIVERY delivers integration files from outbound integration
systems to external endpoints. You can choose to deliver all integration output
files (referred to as Documents) produced by the current Integration Process
Event, or Documents that are
tagged based on your specification.
o Document Retrieval imports integration files either from an external
endpoint or by routing a request to a Workday user so that the user can
manually upload files for use by the integration.
o FIRE INTEGRATION executes the integration system itself, to either
generate an output file or load data from a file into Workday. This step is
always included by default in any Integration Business Process Event.
MULTIPLE INTEGRATION SUPPORT
You can include additional Integration steps in an Integration Process Event. You can have
2 or more Integration steps share the same order in the Integration Process Event.
Workday then executes the steps in parallel. Workday executes the Integration Process
Event for each additional integration before continuing to the next step in the parent
Integration Process Event.
You can also have more than one Integration step in sequential order. For example, you
could add a second integration system, created in Workday Studio, that accepts the
reference of an output document as a launch parameter. You would then configure the
second integration step's launch parameters to assign the output of the first integration
system to be the input of the second. The second integration system consumes the output
file from the previous integration and produces a new integration output file. This is not
limited to a 1-to-1 relationship. For example, you could create an Integration Process Event
with 1 Initiation step and 2 Integration steps, each of which is Step a, followed by a single
Integration Step b that consumes all 3 files produced by the 3 Step a integrations.
Unlike other business process types, the Integration Process Event is associated with an
integration system and it can also be associated with an organization. A single integration
system may be associated with several business process definitions, 1 per organization.
Other business process types can trigger the Integration Process Event as a sub process.
When this happens, Workday attempts to find an Integration Process Event defined for the
same organization as the parent business process. If you haven't defined an Integration
Process Event specifically for that organization, Workday navigates up the organization
hierarchy until it finds a business process definition for that integration system. If one
doesn't exist, Workday uses the default Integration Process Event. Alternately, an integration
system may be associated with 1 business process, with no associated organization.
The Integration Process Event by design separates the generation of an integration file (or
multiple files) and the delivery of the file(s) to an external system. If the external system
doesn't receive an expected integration file, use the following reports to determine what
did not work as expected:
The Process Monitor lists all integration-related events. Any Integration Process Event
that concludes by sending an integration file outside of Workday will generate at least 2
integration-related events in the Process Monitor, 1 for the Integration step and 1 for the
Deliver Document step. Both events must succeed in order for the external system to
receive an integration file. If the Process Monitor shows the integration as completing
successfully, but the external system didn't receive a file, check for failed Deliver
Document events. When you find a failed Deliver Document event, use its related action
menu to determine which Integration Process Event it belongs to. Then use the Full
Process Record report to determine what happened.
The Full Process Record displays the results of each step in a business process
instance. This allows you to determine if the external system did not receive an
integration file due to the Deliver Document step failing, or due to an Integration
step failing to produce a file for the Deliver Document step.
CONFIGURE THE INTEGRATION PROCESS
EVENT
RETRIEVAL SERVICE
Document Retrieval also enables you to retrieve the output of a custom report. In this
case, Document Retrieval retrieves the data from within Workday and stores the report
output in the W: Drive for use by a subsequent integration step.
ACTIVITY 5 – CREATE AN INTEGRATION
BUSINESS PROCESS
Business Case: In this activity, you will create an integration business process for
WICT_HCM_Worker. You will add a Document Delivery step to deliver the output xml file to an
SFTP server.
3. Verify the Effective Date is today and accept the default values. Click OK.
4. Modify the Business Process by adding a step 'c'. It is type 'Service' and the
Specify as
'Document Delivery'. Click OK.