Skip to main content
Administrator Guide
Last Updated: 2024-07-26
Concept: Common Components

Concept: Common Components

Workday Studio provides a range of prepackaged subassemblies that you can use to build your integrations. These subassemblies are available from the
Common Components
tab of the
Palette
. When you add one to your assembly diagram, Studio inserts a
local-out
element in the XML source with the appropriate endpoint in Workday.
It also displays the parameters you can use with that subassembly, with required parameters already selected. You can adjust parameters at any time in the subassembly's
Properties
view.
Studio includes these
Common Components
on the
Palette
:
Name
Function
Notes
Ftp
Routes to an
ftp-out
transport.
  • Provides a single entry point for all FTP transports.
  • Uses the
    wd.ftp.endpoint
    parameter value to determine the type of FTP transport implemented. Examples:
    ftp://
    ,
    sftp://
    , or
    ftps://
    .
  • Exposes the transport settings that are commonly used in Workday, such as username and password authentication. Hides more advanced public key authentication.
The FTP Subassembly is no longer available from the Studio Palette. In new integrations, you should use the
ftp-out
or
sftp-out
components to send documents to an FTP server. These components offer improved security, better performance, and enhanced reliability. They’re also compatible with later versions of JSCAPE. The FTP Subassembly remains functional in existing integrations, but Workday recommends that, where practical, you replace it.
GetEventConfigurations
Retrieves the service configurations attached to a particular integration event.
GetEventDocuments
Retrieves the documents attached to a particular integration event.
GetIntegrationEvent
Retrieves an integration event based on a Workday reference ID.
GetIntegrationSystems
Retrieves the integration system's configuration from Workday and parses it.
PagedGet
Implements the paging logic required by any
paged-get
Web service operation, enabling page-by-page data retrieval.
  • Use the
    is.paged.get.process.endpoint
    parameter to send each page of response data to another subassembly for processing.
  • Use the
    is.paged.get.aggregate.header
    ,
    is.paged.get.aggregate.footer
    , and
    is.paged.get.aggregate.xpath
    parameters to aggregate all pages of response data.
  • Aggregated XML data is available as the message in the
    MediationContext
    when the subassembly returns.
  • If a web service is expected to return a large number of pages, use the per-page processing approach.
PagedGetLocalPaging
Implements the paging logic required by any
paged-get
local Web service operation, enabling page-by-page data retrieval.
  • Enables the paging process to be performed locally at the ESB server, rather than remotely by Workday.
  • Uses a single query to return all Workday IDs. Subsequent calls retrieve the data for each Workday ID.
PdfPrintStep
Converts custom report data from a
workday-out-rest
request to PDF format using a BIRT report design.
  • Specify a literal string value for each of the MVEL-capable parameters by enclosing it in single quotes.
PutIntegrationEvent
Updates an integration system's integration event status in Workday.
  • Uses the
    Put_Integration_Event
    web service operation.
  • Puts the event response Workday ID returned from the Web service operation in the
    MediationContext
    property
    integrations.event.response.wid
    .
PutIntegrationMessage
Sends update integration messages to Workday.
  • Can also add documents in the form of references to Workday document storage.
  • Uses the
    Put_Integration_Message
    web service operation.
  • Workday limits the number of calls a
    PutIntegrationMessage
    subassembly can make in a single integration to 500. Subsequent integration messages are logged to a log file and can't be viewed in the integration event. (Redirect doesn't apply to messages that have attachments or change the integration event status.)
SalesforceConnector
Sends authenticated messages to salesforce.com.
PrismConnector
Sends CSV data to Prism Analytics.