diff --git a/workday/16.6/modules/ROOT/pages/index.adoc b/workday/16.6/modules/ROOT/pages/index.adoc index 120619b9da..127234f4f0 100644 --- a/workday/16.6/modules/ROOT/pages/index.adoc +++ b/workday/16.6/modules/ROOT/pages/index.adoc @@ -1,5 +1,4 @@ = Workday Connector 16.6 -:page-aliases: connectors::workday/workday-about.adoc, connectors::workday/workday-connector.adoc, connectors::workday/workday-connector-design-center.adoc diff --git a/workday/16.6/modules/ROOT/pages/workday-connector-examples.adoc b/workday/16.6/modules/ROOT/pages/workday-connector-examples.adoc index 46074284a3..dd79cfc77f 100644 --- a/workday/16.6/modules/ROOT/pages/workday-connector-examples.adoc +++ b/workday/16.6/modules/ROOT/pages/workday-connector-examples.adoc @@ -1,5 +1,4 @@ = Workday Connector 16.6 Examples -:page-aliases: connectors::workday/workday-to-add-fund-to-service.adoc, connectors::workday/workday-to-create-position.adoc, connectors::workday/workday-connector-examples.adoc The following examples show how to configure Workday Connector using Anypoint Studio: diff --git a/workday/16.6/modules/ROOT/pages/workday-connector-studio.adoc b/workday/16.6/modules/ROOT/pages/workday-connector-studio.adoc index 73b43a1dae..cbb1157e33 100644 --- a/workday/16.6/modules/ROOT/pages/workday-connector-studio.adoc +++ b/workday/16.6/modules/ROOT/pages/workday-connector-studio.adoc @@ -1,5 +1,4 @@ = Using Anypoint Studio to Configure Workday Connector 16.6 -:page-aliases: connectors::workday/workday-studio.adoc, connectors::workday/workday-connector-studio.adoc Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. diff --git a/workday/16.6/modules/ROOT/pages/workday-connector-upgrade-migrate.adoc b/workday/16.6/modules/ROOT/pages/workday-connector-upgrade-migrate.adoc index 44df9232be..da0115ed6f 100644 --- a/workday/16.6/modules/ROOT/pages/workday-connector-upgrade-migrate.adoc +++ b/workday/16.6/modules/ROOT/pages/workday-connector-upgrade-migrate.adoc @@ -1,5 +1,4 @@ = Upgrading and Migrating Workday Connector to 16.x -:page-aliases: connectors::workday/workday-connector-upgrade-migrate.adoc Upgrade Anypoint Connector for Workday (Workday Connector) to version 16.x.x. diff --git a/workday/16.6/modules/ROOT/pages/workday-connector-xml-maven.adoc b/workday/16.6/modules/ROOT/pages/workday-connector-xml-maven.adoc index bbf49fb7a7..5d8227abdb 100644 --- a/workday/16.6/modules/ROOT/pages/workday-connector-xml-maven.adoc +++ b/workday/16.6/modules/ROOT/pages/workday-connector-xml-maven.adoc @@ -1,5 +1,4 @@ = Workday Connector 16.6 XML and Maven Support -:page-aliases: connectors::workday/workday-xml-ref.adoc, connectors::workday/workday-connector-xml-maven.adoc Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio: diff --git a/workday/16.6/modules/ROOT/pages/workday-reference.adoc b/workday/16.6/modules/ROOT/pages/workday-reference.adoc index 007b16ee68..1c7ef76fb5 100644 --- a/workday/16.6/modules/ROOT/pages/workday-reference.adoc +++ b/workday/16.6/modules/ROOT/pages/workday-reference.adoc @@ -1,5 +1,4 @@ = Workday Connector 16.6 Reference -:page-aliases: connectors::workday/workday-reference.adoc Anypoint Connector for Workday (Workday Connector) provides access to standard Workday operations. diff --git a/workday/16.7/antora.yml b/workday/16.7/antora.yml new file mode 100644 index 0000000000..b39035b4d4 --- /dev/null +++ b/workday/16.7/antora.yml @@ -0,0 +1,20 @@ +name: workday-connector +version: '16.7' +display_version: 16.7 (Mule 4) +title: Workday Connector +nav: +- modules/ROOT/nav.adoc +asciidoc: + attributes: + page-component-desc: Provides access to standard Workday operations. + page-connector-type: Connector + page-connector-level: Select + page-exchange-group-id: com.mulesoft.connectors + page-exchange-asset-id: mule-workday-connector + page-runtime-version: 4.3.0 + page-release-notes-page: release-notes::connector/workday-connector-release-notes-mule-4.adoc + page-vendor-name: workday + page-vendor-title: Workday + page-service-name: Workday + page-connector-name: workday + page-notice-banner-message: Standard support for Java 8 and 11 ends in August 2026 for 4.6 LTS. Plan your upgrade path for apps that are running on Java 8 or 11 accordingly. diff --git a/workday/16.7/modules/ROOT/images/workday-http-props.graffle/data.plist b/workday/16.7/modules/ROOT/images/workday-http-props.graffle/data.plist new file mode 100644 index 0000000000..5901571bd0 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-http-props.graffle/data.plist differ diff --git a/workday/16.7/modules/ROOT/images/workday-http-props.graffle/image1.png b/workday/16.7/modules/ROOT/images/workday-http-props.graffle/image1.png new file mode 100644 index 0000000000..70736e58a5 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-http-props.graffle/image1.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-http-props.graffle/image2.png b/workday/16.7/modules/ROOT/images/workday-http-props.graffle/image2.png new file mode 100644 index 0000000000..49a1be8a3b Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-http-props.graffle/image2.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-http-props.graffle/preview.jpeg b/workday/16.7/modules/ROOT/images/workday-http-props.graffle/preview.jpeg new file mode 100644 index 0000000000..53255c7b84 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-http-props.graffle/preview.jpeg differ diff --git a/workday/16.7/modules/ROOT/images/workday-http-props.png b/workday/16.7/modules/ROOT/images/workday-http-props.png new file mode 100644 index 0000000000..6de112fc7d Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-http-props.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-listener.graffle/data.plist b/workday/16.7/modules/ROOT/images/workday-select-listener.graffle/data.plist new file mode 100644 index 0000000000..e575e8daf9 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-listener.graffle/data.plist differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-listener.graffle/image1.png b/workday/16.7/modules/ROOT/images/workday-select-listener.graffle/image1.png new file mode 100644 index 0000000000..70736e58a5 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-listener.graffle/image1.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-listener.graffle/image2.png b/workday/16.7/modules/ROOT/images/workday-select-listener.graffle/image2.png new file mode 100644 index 0000000000..49a1be8a3b Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-listener.graffle/image2.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-listener.graffle/image3.png b/workday/16.7/modules/ROOT/images/workday-select-listener.graffle/image3.png new file mode 100644 index 0000000000..0084075037 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-listener.graffle/image3.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-listener.graffle/preview.jpeg b/workday/16.7/modules/ROOT/images/workday-select-listener.graffle/preview.jpeg new file mode 100644 index 0000000000..53255c7b84 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-listener.graffle/preview.jpeg differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-listener.png b/workday/16.7/modules/ROOT/images/workday-select-listener.png new file mode 100644 index 0000000000..49a1be8a3b Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-listener.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-listener/Canvas 1.png b/workday/16.7/modules/ROOT/images/workday-select-listener/Canvas 1.png new file mode 100644 index 0000000000..6de112fc7d Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-listener/Canvas 1.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-listener/Canvas 2.png b/workday/16.7/modules/ROOT/images/workday-select-listener/Canvas 2.png new file mode 100644 index 0000000000..a6fd3a59a9 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-listener/Canvas 2.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/data.plist b/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/data.plist new file mode 100644 index 0000000000..b15178311a Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/data.plist differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/image1.png b/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/image1.png new file mode 100644 index 0000000000..70736e58a5 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/image1.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/image2.png b/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/image2.png new file mode 100644 index 0000000000..49a1be8a3b Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/image2.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/image3.png b/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/image3.png new file mode 100644 index 0000000000..0084075037 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/image3.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/image4.png b/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/image4.png new file mode 100644 index 0000000000..2c214b2e21 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/image4.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/preview.jpeg b/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/preview.jpeg new file mode 100644 index 0000000000..53255c7b84 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-transform.graffle/preview.jpeg differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-transform.png b/workday/16.7/modules/ROOT/images/workday-select-transform.png new file mode 100644 index 0000000000..0084075037 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-transform.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-transform/Canvas 1.png b/workday/16.7/modules/ROOT/images/workday-select-transform/Canvas 1.png new file mode 100644 index 0000000000..6de112fc7d Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-transform/Canvas 1.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-transform/Canvas 2.png b/workday/16.7/modules/ROOT/images/workday-select-transform/Canvas 2.png new file mode 100644 index 0000000000..a6fd3a59a9 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-transform/Canvas 2.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-transform/Canvas 3.png b/workday/16.7/modules/ROOT/images/workday-select-transform/Canvas 3.png new file mode 100644 index 0000000000..54e926fda2 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-transform/Canvas 3.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-transform/workday-transform-message/Canvas 1.png b/workday/16.7/modules/ROOT/images/workday-select-transform/workday-transform-message/Canvas 1.png new file mode 100644 index 0000000000..6de112fc7d Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-transform/workday-transform-message/Canvas 1.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-transform/workday-transform-message/Canvas 2.png b/workday/16.7/modules/ROOT/images/workday-select-transform/workday-transform-message/Canvas 2.png new file mode 100644 index 0000000000..a6fd3a59a9 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-transform/workday-transform-message/Canvas 2.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-transform/workday-transform-message/Canvas 3.png b/workday/16.7/modules/ROOT/images/workday-select-transform/workday-transform-message/Canvas 3.png new file mode 100644 index 0000000000..54e926fda2 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-transform/workday-transform-message/Canvas 3.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-select-transform/workday-transform-message/Canvas 4.png b/workday/16.7/modules/ROOT/images/workday-select-transform/workday-transform-message/Canvas 4.png new file mode 100644 index 0000000000..9dce77bef2 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-select-transform/workday-transform-message/Canvas 4.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/data.plist b/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/data.plist new file mode 100644 index 0000000000..b15178311a Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/data.plist differ diff --git a/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/image1.png b/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/image1.png new file mode 100644 index 0000000000..70736e58a5 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/image1.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/image2.png b/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/image2.png new file mode 100644 index 0000000000..49a1be8a3b Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/image2.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/image3.png b/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/image3.png new file mode 100644 index 0000000000..0084075037 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/image3.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/image4.png b/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/image4.png new file mode 100644 index 0000000000..2c214b2e21 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/image4.png differ diff --git a/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/preview.jpeg b/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/preview.jpeg new file mode 100644 index 0000000000..53255c7b84 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-transform-message.graffle/preview.jpeg differ diff --git a/workday/16.7/modules/ROOT/images/workday-transform-message.png b/workday/16.7/modules/ROOT/images/workday-transform-message.png new file mode 100644 index 0000000000..2c214b2e21 Binary files /dev/null and b/workday/16.7/modules/ROOT/images/workday-transform-message.png differ diff --git a/workday/16.7/modules/ROOT/nav.adoc b/workday/16.7/modules/ROOT/nav.adoc new file mode 100644 index 0000000000..eaf730baa4 --- /dev/null +++ b/workday/16.7/modules/ROOT/nav.adoc @@ -0,0 +1,8 @@ +.xref:index.adoc[Workday Connector] +* xref:index.adoc[Workday Connector Overview] +* xref:workday-connector-upgrade-migrate.adoc[Upgrading and Migrating Workday Connector] +* xref:workday-connector-studio.adoc[Using Anypoint Studio to Configure Workday Connector] +* xref:workday-connector-xml-maven.adoc[Workday Connector XML and Maven Support] +* xref:workday-connector-examples.adoc[Workday Connector Examples] +* xref:workday-connector-troubleshoot.adoc[Troubleshooting Workday Connector] +* xref:workday-reference.adoc[Workday Connector Reference] diff --git a/workday/16.7/modules/ROOT/pages/index.adoc b/workday/16.7/modules/ROOT/pages/index.adoc new file mode 100644 index 0000000000..9e93ba60f5 --- /dev/null +++ b/workday/16.7/modules/ROOT/pages/index.adoc @@ -0,0 +1,74 @@ += Workday Connector 16.7 +:page-aliases: connectors::workday/workday-about.adoc, connectors::workday/workday-connector.adoc, connectors::workday/workday-connector-design-center.adoc + + + +Anypoint Connector for Workday (Workday Connector) provides access to standard Workday operations. Workday is a Software-as-a-Service (SaaS) solution developed by Workday, Inc. +Workday provides a set of software apps for financial and human capital management, such as human resources, staffing, recruiting, and performance. + +Workday Connector provides operations that you can use to perform tasks for educational organizations, human resources, professional services, payroll, and benefits administration. + +For compatibility information and fixed issues, see the Workday Connector release notes. + +== Before You Begin + +To use this connector, you must be familiar with: + +* The Workday API +* Anypoint Connectors +* Mule runtime engine (Mule) +* Elements and global elements in a Mule flow +* Creating a Mule app using Anypoint Studio or Anypoint Code Builder + +Before creating an app, you must have access to: + +* The Workday target resource +* Anypoint Studio or Anypoint Code Builder + +== Common Use Cases for the Connector + +Common use cases for Workday Connector include: + +* *Accelerated Recruitment* ++ +Integrate data from applications that handle scheduling, applicant screening, candidate debriefing, and so on, to accelerate the recruitment process. + +* *Automated Employee Onboarding and Offboarding* ++ +Provide an efficient and seamless experience for your new employees by simplifying onboarding and offboarding employees, from payroll to benefit enrollment to directory services governing identity and access, by obtaining a real-time view into multiple systems. + +* *People Analytics* ++ +Integrate Workday with several enterprise systems to run analytics and garner insights about employees to drive strategic decision-making around talent acquisition and retention, compensation, learning, workforce planning and development, and so on. + +* *Streamlined Financials* ++ +Use Workday’s financial modules to compensate employees, account for expenses and commissions in real-time, and automate critical sales processes like quote-to-cash by integrating Workday with ERP systems, such as SAP, NetSuite, and so on. + +For examples of these use cases, refer to xref:workday-connector-examples.adoc[Workday Connector Examples]. + +== Exchange Templates and Examples + +https://www.mulesoft.com/exchange/[Anypoint Exchange] provides templates +that you can use as starting points for your apps and examples that illustrate a complete solution. + +* https://anypoint.mulesoft.com/exchange/org.mule.templates/template-wday2snow-worker-bidirectional-sync[Workday and ServiceNow Worker Bidirectional Sync] +* https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2wday-user-bidirectional-sync[Salesforce and Workday Bidirectional Sync] +* https://anypoint.mulesoft.com/exchange/org.mule.templates/template-wday2snow-workerservicerequest-migration[Workday Worker to ServiceNow Service Request Migration] +* https://www.mulesoft.com/exchange/org.mule.templates/template-wday2sfdc-worker-migration[Salesforce to Workday Financials Account - Customer Migration] +* https://anypoint.mulesoft.com/exchange/org.mule.templates/template-wday2snow-employee-aggregation[Workday and ServiceNow Employee Aggregation] +* https://www.mulesoft.com/exchange/org.mule.templates/template-wday2sfdc-worker-aggregation[Workday and Salesforce Worker Aggregation] +* https://anypoint.mulesoft.com/exchange/org.mule.templates/template-wday2snow-worker-migration[Workday to ServiceNow Service Worker Migration] +* https://anypoint.mulesoft.com/exchange/org.mule.templates/template-wday2snow-worker2servicerequest-broadcast[Workday Worker to ServiceNow Service Request Broadcast] +* https://anypoint.mulesoft.com/exchange/org.mule.templates/template-wday2snow-worker2user-broadcast[Workday Worker to ServiceNow User Broadcast] +* https://www.mulesoft.com/exchange/org.mule.templates/template-wday2sfdc-workercase-broadcast[Workday to Salesforce Worker Case Broadcast] + +== Next Step + +After you complete the prerequisites and try the templates and examples, you are ready to create your own app and configure the connector using xref:workday-connector-studio.adoc[Anypoint Studio]. + +== See Also + +* xref:connectors::introduction/introduction-to-anypoint-connectors.adoc[Introduction to Anypoint Connectors] +* xref:connectors::introduction/intro-use-exchange.adoc[Use Exchange to Discover Connectors, Templates, and Examples] +* https://help.salesforce.com[Salesforce Help] diff --git a/workday/16.7/modules/ROOT/pages/workday-connector-examples.adoc b/workday/16.7/modules/ROOT/pages/workday-connector-examples.adoc new file mode 100644 index 0000000000..01c904a3c6 --- /dev/null +++ b/workday/16.7/modules/ROOT/pages/workday-connector-examples.adoc @@ -0,0 +1,352 @@ += Workday Connector 16.7 Examples +:page-aliases: connectors::workday/workday-to-add-fund-to-service.adoc, connectors::workday/workday-to-create-position.adoc, connectors::workday/workday-connector-examples.adoc + +The following examples show how to configure Workday Connector using Anypoint Studio: + +* <> +* <> + +== Before You Begin + +You must have: + +* Access to Workday +* Your Workday username, password, and tenant name + +[[add-fund]] +== Add a Fund to the Workday Financial Management Service + +This example uses the *Invoke* operation to insert a fund in the Workday financial management service. + +=== Configure HTTP Listener + +Configure *HTTP Listener* to initiate a Mule flow when a call is made to the `/` account path on localhost, port 8081. + +This example uses variables for some field values. You can either: + +* Replace the variables with their values in the code. +* Provide the values for each variable in a properties file and then refer to that file from the connector configuration. + +If you don't know how to use a properties file, see xref:mule-runtime::mule-app-properties-to-configure.adoc[Configuring Property Placeholders]. + +To configure *HTTP Listener*: + +. Create a new Mule project in Studio. +. In the *Mule Palette* view, search for `http` and select the *Listener* operation: ++ +.Select the Listener operation in the Mule Palette view. +image:workday-select-listener.png["Listener component selected in Mule palette"] ++ +. Drag the *Listener* operation onto the canvas. +. In the *Listener* configuration, click *+* next to the *Connector configuration* field to add a global element. +. Click *OK* to accept the defaults. +. Set the *Path* field to `/`: ++ +.Set the Path field in the Listener configuration. +image::workday-http-props.png["Listener configuration in properties window"] + +=== Add a Transform Message Component to Attach the Metadata + +To add and configure a *Transform Message* component: + +. In the *Mule Palette* view, search for `transform` and select *Transform Message*: ++ +.Select Transform Message in the Mule Palette view. +image::workday-select-transform.png["Transform Message component selected in Mule palette"] ++ +. Drag the *Transform Message* component onto the canvas, to the right of the *Listener* component. +. In the *Transform Message* configuration, overlay the brackets in the *Output* section with this XML: ++ +[source,dataweave,linenums] +---- +%dw 2.0 +output application/xml +ns ns0 urn:com.workday/bsvc +--- +{ + ns0#Put_Fund_Request @(ns0#Add_Only: true, ns0#version: "v36.0"): { + ns0#Fund_Data: { + ns0#Fund_Name: "I.M.F", + ns0#Fund_Type_Reference: { + ns0#ID @(ns0#'type': 'Fund_Type_ID'): "FUND_TYPE-6-3" + } + } + } +} +---- + +The following XML shows sample input to the *Transform Message* component + +[source,xml,linenums] +---- + + + I.M.F + + FUND_TYPE-6-3 + + + +---- + +The following screenshot shows the corresponding output, as it appears in the *Output* section of the *Transform Message* configuration: + +.Output in the Transform Message configuration +image::workday-transform-message.png["Transform Message output"] + +=== Add and Configure the Financial Management Operation + +. In the *Mule Palette* view, search for `workday` and select the *Financial management* operation. +. Drag the *Financial management* operation onto the canvas, to the right of the *Transform Message* component. +. In the *Financial management* configuration, click *+* next to the *Connector configuration* field to add a global element. +. Configure the global element as follows: ++ +* *Configuration Name*: `My_Workday_Connection` +* *Connection*: `Basic authentication api` +* *Password*: `${workday.password}` +* *Host Name*: Leave the default, `impl-cc.workday.com` +* *Tenant Name*: `${workday.tenantName}` +* *Username*: `${workday.userName}` ++ +. Click *Test Connection* to ensure your username, password, and tenant name are correct. +. Click *OK*. +. In the properties window, select `Put_Fund` in the *Operation* field. + +=== Add a Logger Component to Display the Response in the Mule Console + +. In the *Mule Palette* view, search for `logger` and select *Logger (Core)*. +. Drag the *Logger* component onto the canvas, to the right of the *Financial management* component. +. Configure the following fields: ++ +[%header%autowidth.spread] +|=== +|Field |Value +|*Display Name* |Enter `Log Response`. +|*Message* |Enter `+++`#[payload]`+++`. +|*Level* |Leave the default, `INFO`. +|=== ++ +. Save the project. +. Test the app by sending a request to `/` on port 8081. +. You will receive an XML response similar to this one: + +[source,xml,linenums] +---- + + + THE_WID_ID_NUMBER + FUND-6-399 + + +---- + +=== XML for the Financial Management Example + +Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: + +[source,xml,linenums] +---- + + + + + + + + + + + + + + + + + + + + + +---- + +[[create-position-request]] +== Create a Workday Position Request + +To create a Workday position request: + +. Create a Mule app in Studio. +. Add and configure HTTP Listener as a source for your flow. +. Set the *Path* field to `/create_position` and use the default configuration for the HTTP Listener connection. +. Add the *Transform* component to your flow. +. Provide this transformation script to DataWeave: ++ +[source,dataweave,linenums] +---- +%dw 2.0 + +ns ns0 urn:com.workday/bsvc + + +output application/xml +--- +{ + ns0#Create_Position_Request: { + ns0#Business_Process_Parameters: { + ns0#Auto_Complete: true, + ns0#Run_Now: true + }, + ns0#Create_Position_Data: { + ns0#Supervisory_Organization_Reference: { + ns0#ID @("ns0:type": "Organization_Reference_ID"): "SUPERVISORY_ORGANIZATION-6-226" + }, + ns0#Position_Data: { + ns0#Job_Posting_Title: "General Manager" + }, + ns0#Position_Group_Restrictions_Data: { + ns0#Availability_Date: "2019-07-06", + ns0#Earliest_Hire_Date: "2019-07-08" + }, + ns0#Edit_Assign_Organization_Sub_Process: { + ns0#Business_Sub_Process_Parameters: { + ns0#Skip: true + } + }, + ns0#Request_Default_Compensation_Sub_Process: { + ns0#Business_Sub_Process_Parameters: { + ns0#Skip: true + } + }, + ns0#Assign_Pay_Group_Sub_Process: { + ns0#Business_Sub_Process_Parameters: { + ns0#Skip: true + } + }, + ns0#Assign_Costing_Allocation_Sub_Process: { + ns0#Business_Sub_Process_Parameters: { + ns0#Skip: true + } + } + } + } +} +---- ++ +. From the *Mule palette* view, select the connector and drag the *Recruiting* operation next to *Transform*. +. On the properties window: +* In the *Operation*, field select `Create_Position`. ++ +Ensure that the value for the *Operation* field is available as a menu item. The values become available once the connector loads the metadata. Do not type the value manually. ++ +* In the *Content* field, leave the default, `payload`. +. Set up, test, and save a Workday configuration for the connection to the Workday server, for example: ++ +* *Name*: `My Workday Config` +* *Connection*: `Basic Authentication Api` +* *Username*: `my_user_name` +* *Password*: `my_password` +* *Tenant Name*: `my_tenant_name` +* *Host Name*: `impl-cc.workday.com` + ++ +If the connection test is unsuccessful, correct any invalid connection parameters and retest the connection. ++ +. Add the *Logger* component to your flow and set `payload` as the message. +. Deploy and run the app. +. To test the app, execute a PUT request to `+http://:8081/create_position+` from a browser or an app such as cURL. ++ +Use the following input in the request body: ++ +[source,xml,linenums] +---- + + + + + true + true + + + + SUPERVISORY_ORGANIZATION-6-226 + + + General Manager + + + 2019-07-06 + 2019-07-08 + + + + true + + + + + true + + + + + true + + + + + true + + + + + +---- + +Workday responds as follows: + +[source,xml,linenums] +---- + + + WID_VALUE + + + WID_VALUE + P-11158 + + +---- + +The logger displays this message: + +[source,xml,linenums] +---- +{Create_Position_Response={Event_Reference={ID=WID_VALUE}, Position_Reference={ID=P-11158}}} +---- + +== See Also + +* xref:connectors::introduction/introduction-to-anypoint-connectors.adoc[Introduction to Anypoint Connectors] +* https://help.salesforce.com[Salesforce Help] diff --git a/workday/16.7/modules/ROOT/pages/workday-connector-studio.adoc b/workday/16.7/modules/ROOT/pages/workday-connector-studio.adoc new file mode 100644 index 0000000000..77d042fbbf --- /dev/null +++ b/workday/16.7/modules/ROOT/pages/workday-connector-studio.adoc @@ -0,0 +1,200 @@ += Using Anypoint Studio to Configure Workday Connector 16.7 +:page-aliases: connectors::workday/workday-studio.adoc, connectors::workday/workday-connector-studio.adoc + +Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. + +To add and configure a connector in Studio: + +. Create a Mule project. +. Add the connector to your Mule project. +. Configure a source for the connector's flow. +. Add a connector operation to the flow. +. Configure a global element for the connector. + +When you run the connector, you can view the app log to check for problems, as described in <>. + +If you are new to configuring connectors in Studio, see xref:connectors::introduction/intro-config-use-studio.adoc[Using Anypoint Studio to Configure a Connector]. If, after reading this topic, you need additional information about the connector fields, see the xref:workday-reference.adoc[Workday Connector Reference]. + +[[create-mule-project]] +== Create a Mule Project + +In Studio, create a new Mule project in which to add and configure the connector: + +. In Studio, select *File > New > Mule Project*. +. Enter a name for your Mule project and click *Finish*. + +[[add-connector-to-project]] +== Add the Connector to Your Mule Project + +Add Workday Connector to your Mule project to automatically populate the XML code with the connector's namespace and schema location and to add the required dependencies to the project's `pom.xml` file: + +. In the *Mule Palette* view, click *(X) Search in Exchange*. +. In *Add Dependencies to Project*, type `workday` in the search field. +. Click *Workday Connector* in *Available modules*. +. Click *Add*. +. Click *Finish*. + +Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. + +[[configure-input-source]] +== Configure a Source + +A source (listener) initiates a flow when a specified condition is met. + +You can configure one of these sources to use with Workday Connector: + +* *On Modified Objects* + +Start your app when an object is created in Workday. +* *HTTP Listener* + +Initiates a flow each time it receives a request on the configured host and port +* *Scheduler* + +Initiates a flow when a time-based condition is met + +To configure the *On Modified Objects* source: + +. In the *Mule Palette* view, select *Workday > On Modified Objects*. +. Drag *On Modified Objects* source to the Studio canvas. +. On the *On Modified Objects* configuration screen, optionally change the value of the *Display Name* field. +. Enter the required information for the following fields: ++ +[%header,cols="30s,70a"] +|=== +|Studio Field |Description +|Connector configuration |Global Element Properties configuration name +|Object type |Type of the Workday object +|Scheduling Strategy a|Tells the source how it can poll the data. This field accepts two options: + +* *Fixed Frequency* + +Polls for data at a specified number of milliseconds, seconds, minutes, hours, or days. The default is 1000 milliseconds. +* *Cron* + +Accepts an expression that polls for data based on a filter, such as every Monday in a month at a given time. See xref:mule-runtime::scheduler-concept.adoc#cron-expressions[Cron Expressions] for examples. +|=== ++ +. Click the plus sign (*+*) next to the *Connector configuration* field to <> that can be used by all instances of the *On Modified Objects* operation in the app. + + +[[add-connector-operation]] +== Add a Connector Operation to the Flow + +When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. + +To add an operation for Workday Connector, follow these steps: + +. In the *Mule Palette* view, select *Workday* and then select the desired operation. +. Drag the operation onto the Studio canvas to the right of the source. + +Each Workday operation has its own required fields in Anypoint Studio. For more information, see +the xref:workday-reference.adoc[Workday Reference]. + +[[configure-global-element]] +== Configure a Global Element + +When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Workday system. Workday Connector supports basic authentication and x.509 authentication. + +To configure the global element for Workday Connector, follow these steps: + +. Select the operation in the Studio canvas. +. In the configuration screen for the operation, click the plus sign (*+*) next to the *Connector configuration* field to access the global element configuration fields. +. On the *General* tab, configure the authentication for the connection as described in the <>, <>, or <> section. ++ +You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see xref:connectors::introduction/intro-connector-configuration-overview.adoc[Anypoint Connector Configuration]. ++ +. On the *Advanced* tab, optionally specify reconnection information, including a reconnection strategy. +. Click *Test Connection* to confirm that Mule can connect with the specified server. + +To validate connectivity using the *Test Connection* button, Workday Connector uses a `Performance_Management` service with the `Get_Degrees` operation. You must ensure that your service account has the required permissions to operate on that service. ++ +[%header%autowidth.spread] +|=== +|Security Policy|Domain/Functional Areas|Permitted Security Groups +|Set Up: Skills and Experience |Worker Profile and Skills a| * HR Administrator +* HR System +* Implementers +* Job and Position Administrator +* Learning Management System +| |Implementation| Implementers +|Special OX Web Services|Implementation| +|=== + +. Click *OK*. + +[[basic-authentication]] +=== Basic Authentication + +Enter the following information on the *General* tab of the *Global Element Properties* screen to configure Basic authentication: + +[%header,cols="30s,70a"] +|=== +|Field |Description +|Connection |Select `Basic authentication`. +|Password |Enter the password with which to log in. +|Host Name |Enter the host name of one of Workday’s Cloud Servers. +|Tenant Name |Enter the Workday Tenant ID, which usually has the suffix `pt1` appended to it, such as `acme_pt1`. +This parameter supports expressions, which allow the value of this parameter to change dynamically. For example, you can use an expression to create a multi-tenant connection. +|User Name |Enter the username with which to log in. +|=== + +[[oauth-authentication]] +=== Workday OAuth Code Authentication Connection + +include::connectors::partial$oauth2-description.adoc[] + +Enter the following information on the *General* tab of the *Global Element Properties* screen to configure OAuth2 authentication: + +[%header,cols="30s,70a"] +|=== +|Field |Description +|Connection |Select `Workday OAuth Code Authentication Connection`. +|Tenant Name |Enter the Workday Tenant ID. This parameter supports expressions, which allow the value of this parameter to change dynamically. For example, you can use an expression to create a multi-tenant connection. +| Consumer Key | Enter the OAuth consumer key as registered with the service provider. +| Consumer Secret | Enter the OAuth consumer secret as registered with the service provider. +| Listener Config | Enter a reference to a `` to use to create the listener that will receive the access token callback endpoint. +| Callback Path | Enter a path of the access token callback endpoint. +| Authorize Path | Enter a path of the local HTTP endpoint that triggers the OAuth dance. +|=== + +[[x509-authentication]] +=== x.509 Authentication + +Enter the following information on the *General* tab of the *Global Element Properties* screen to configure X.509 authentication: + +[%header,cols="30s,70a"] +|=== +|Field |Description +|Connection |Select `x.509 Authentication`. +|Host name |Enter the host name of a Workday cloud server. +|Tenant name |Enter the Workday Tenant ID, which usually has the suffix `pt1` appended to it, such as `acme_pt1`. +This parameter supports expressions, which allow the value of this parameter to change dynamically. For example, you can use an expression to create a multi-tenant connection. +|User Name |Enter the username with which to log in. +|Key store path |Enter the location of the keystore file. +|Type |Select the keystore type. +|Password |Enter the password to access the keystore. +|Alias |Enter the alias of the private key. +|Signature Algorithm |Enter the signature algorithm. +|Digest Algorithm |Enter the digest algorithm. +|Canonicalization algorithm |Enter the c14n (canonicalization) algorithm. +|=== + +[[configure-other-fields]] +== Configure Additional Connector Fields + +After you configure a global element for Workday Connector, configure the other required fields for the connector, as described in xref:workday-reference.adoc[Workday Reference]. + +[[view-app-log]] +== View the App Log + +To check for problems, you can view the app log as follows: + +* If you’re running the app from Anypoint Platform, the output is visible in the Anypoint Studio console window. +* If you’re running the app using Mule from the command line, the app log is visible in your OS console. + +Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. + +== Next Step + +After configuring Workday Connector in Studio, see the xref:workday-connector-examples.adoc[Examples] text for financial management use cases that demonstrate how to use this connector. + +== See Also + +* xref:connectors::introduction/introduction-to-anypoint-connectors.adoc[Introduction to Anypoint Connectors] +xref:connectors::introduction/intro-config-use-studio.adoc[Using Anypoint Studio to Configure a Connector] +* https://help.salesforce.com[Salesforce Help] diff --git a/workday/16.7/modules/ROOT/pages/workday-connector-troubleshoot.adoc b/workday/16.7/modules/ROOT/pages/workday-connector-troubleshoot.adoc new file mode 100644 index 0000000000..072153a065 --- /dev/null +++ b/workday/16.7/modules/ROOT/pages/workday-connector-troubleshoot.adoc @@ -0,0 +1,125 @@ += Troubleshooting Workday Connector 16.7 + +To troubleshoot Anypoint Connector for Workday (Workday Connector), become familiar with the information about addressing specific common errors and interpreting commonly thrown exception messages. + +include::connectors::partial$ssl-logs.adoc[] + +include::connectors::partial$verbose-exception-logs.adoc[] + +include::connectors::partial$verbose-logs-com.adoc[] + +== Troubleshoot Common Errors + +Here is a list of the common Workday Connector errors and how to resolve them: + +* <> +* <> +* <> +* <> + +[[connectivity-errors]] +=== Connectivity Errors + +The connector throws `CONNECTIVITY` errors to trigger the reconnection process. If the connector throws a `CONNECTIVITY` error and reconnection is configured for the configuration that throws the error, the connector recreates the session and retries the operation automatically. + +The reconnection process is handled by Mule runtime and comes with some exceptions, for example, if a `CONNECTIVITY` error is thrown during the connection creation process, then the reconnection is not triggered even if reconnection is configured. This is because the `CONNECTIVITY` error occurs while connecting to the third-party system, so the `CONNECTIVITY` error (usually caused by expired credentials or misconfiguration) is likely to occur every time, which retries the reconnection as many times as the reconnection is configured. It is the user's responsibility to handle `CONNECTIVITY` errors if they are thrown during connection creation. + +[[remove-the-warning-on-every-http-call]] +=== Remove the Warning on Every HTTP Call + +Workday Connector logs the following warning message on every HTTP call: + +[source,xml,linenums] +---- +WARN 2020-11-10 10:51:57,494 [[MuleRuntime].uber.12: [workday].workdayFlow.BLOCKING @766054e8] [processor: ; event: 5ec7a670-233a-11eb-a099-f018989d247f] com.ning.http.client.RequestBuilderBase: Value was null, set to "" +---- + +To remove this warning from the Anypoint Studio console, update `src/main/resources/log4j2.xml` with the following line: + +[source,xml,linenums] +---- + +---- + +[[timeout-in-studio]] +=== Timeout in Studio + +Due to connectivity issues, you might experience a timeout while obtaining metadata from Workday Connector and receive one of the following errors: + +* Error While Retrieving SOAP Client ID ++ +[source,text,linenums] +---- +org.mule.runtime.api.exception.MuleRuntimeException: Error while retrieving soap client id [Absence_Management] + org.mule.runtime.api.exception.MuleRuntimeException: Error while retrieving soap client id [Absence_Management] + Caused by: java.util.concurrent.ExecutionException: + org.mule.wsdl.parser.exception.WsdlParsingException: Error processing + WSDL file [https://wd3-impl-services1.workday.com/ccx/service/deakin_amu1/Absence_Management/v29.1?wsdl]: + Unable to locate document at 'https://wd3-impl-services1.workday.com/ccx/service/deakin_amu1/Absence_Management/v29.1?wsdl'. +---- + +* Mule Agent REST Service Timed Out ++ +[source,text,linenums] +---- +org.mule.tooling.client.api.exception.TimeoutException: Mule Agent REST service timed out + org.mule.tooling.client.api.exception.TimeoutException: Mule Agent REST service timed out + javax.ws.rs.ProcessingException: java.net.SocketTimeoutException: Read timed out + at org.glassfish.jersey.client.HttpUrlConnector.apply(HttpUrlConnector.java:244) + at org.glassfish.jersey.client.ClientRuntime.invoke(ClientRuntime.java:245) + at org.glassfish.jersey.client.JerseyInvocation$1.call(JerseyInvocation.java:671) + at org.glassfish.jersey.client.JerseyInvocation$1.call(JerseyInvocation.java:668) + at org.glassfish.jersey.internal.Errors.process(Errors.java:315) + at org.glassfish.jersey.internal.Errors.process(Errors.java:297) + at org.glassfish.jersey.internal.Errors.process(Errors.java:228) + at org.glassfish.jersey.process.internal.RequestScope.runInScope(RequestScope.java:444) + at org.glassfish.jersey.client.JerseyInvocation.invoke(JerseyInvocation.java:668) + at +---- + +To resolve this error: + +Increase the timeout values in Anypoint Studio: + +. In Anypoint Studio, go to *Preferences > Anypoint Studio > Tooling*. +. Increase the values to double the default value for `Default Connection Timeout` and `Default Read Timeout`. +. Click *Apply* and restart Studio. + +[[get-degrees-error]] +=== Get Degrees Error When Testing the Connection + +When validating connectivity using the *Test Connection* button, you might encounter an error regarding the `Get_Degrees` operation: + +[source,text,linenums] +---- +org.mule.runtime.api.exception.MuleRuntimeException: java.lang.RuntimeException: Unexpected error while consuming the web service operation [Get_Degrees] +---- + +To validate connectivity using the *Test Connection* button, Workday Connector uses a `Performance_Management` service with the `Get_Degrees` operation. You must ensure that your service account has the required permissions to operate on that service. To resolve this error, grant permissions for the `Get_Degrees` operation in the `Performance_Management` web service. + +== Understand Commonly Thrown Exceptions + +Here is a list of commonly thrown exception messages and how to interpret them: + +* WORKDAY:CONNECTIVITY + + A connection cannot be established. + +* WORKDAY:PROCESSING_ERROR + + A processing error occurs, for example, the connector cannot read from the inbound message. + +* WORKDAY:RETRY_EXHAUSTED + + The maximum number of retries for the operation is reached. + +* WORKDAY:VALIDATION_ERROR + + A validation error occurs, for example, an inactive organization includes an active organization. + +== See Also + +* xref:connectors::introduction/introduction-to-anypoint-connectors.adoc[Introduction to Anypoint Connectors] +* xref:workday-reference.adoc[Workday Connector Reference] +* https://help.salesforce.com[Salesforce Help] +* https://help.salesforce.com/s/issues?language=en_US[Known Issues] diff --git a/workday/16.7/modules/ROOT/pages/workday-connector-upgrade-migrate.adoc b/workday/16.7/modules/ROOT/pages/workday-connector-upgrade-migrate.adoc new file mode 100644 index 0000000000..44df9232be --- /dev/null +++ b/workday/16.7/modules/ROOT/pages/workday-connector-upgrade-migrate.adoc @@ -0,0 +1,66 @@ += Upgrading and Migrating Workday Connector to 16.x +:page-aliases: connectors::workday/workday-connector-upgrade-migrate.adoc + +Upgrade Anypoint Connector for Workday (Workday Connector) to version 16.x.x. + +== Supported Upgrade Paths + +[%header,cols="50a,50a"] +|=== +|From Version | To Version +|15.x |16.x +|=== + +== What's Changed + +=== 16.x + +* The connector is upgraded to Workday API version 40.0. +* The connector now supports the *ACA Partner Integrations* and *Student Transfer Credit* operations. +* The connector now throws the new `WORKDAY:BAD_REQUEST` error. +* The com.fasterxml.jackson.core library is upgraded to version 2.15.0-rc1 to address reported security vulnerabilities. +* The mule-soap-engine library is upgraded to version 1.7.2 to address reported security vulnerabilities. +* The org-springframework library is upgraded to version 5.3.27 to address reported security vulnerabilities. + +== Upgrade Prerequisites + +Before you upgrade Workday Connector from version 15.x to version 16.x, you must: + +. Create a backup of your files, data, and configuration in case you need to restore the connector to the previous version. +. Install Workday Connector 16.x to replace the Workday operations that were previously included in Workday Connector 15.x. + +== Upgrade Steps + +Follow these steps to perform the upgrade from Workday Connector 15.x to Workday Connector 16.x: + +. In Studio, create a Mule project. +. In the *Mule Palette* view, click *Search in Exchange*. +. In the *Add Dependencies to Project* window, enter `workday` in the search field. +. In the *Available modules* section, select *Workday Connector - Mule 4* and click *Add*. +. Click *Finish*. +. Verify that the `workday-connector` dependency version is `16.0.0` in the `pom.xml` file. + +Studio upgrades the connector automatically. + +== Verify the Upgrade + +After you install the latest version of the connector, follow these steps to verify the upgrade: + +. In Studio, verify that there are no errors in the *Problems* or *Console* views. +. Check the project `pom.xml` file and verify that there are no problems. +. Test the connection and verify that the operations work. + +== Troubleshooting + +If there are problems with caching the parameters and caching the metadata, try restarting Studio. + +== Revert the Upgrade + +If you must revert to the previous version of Workday Connector, change the `workday-connector` dependency version `16.x.x` in the project's `pom.xml` file to the previous version. + +You must update the project's `pom.xml` file in Studio. + +== See Also + +* xref:connectors::introduction/introduction-to-anypoint-connectors.adoc[Introduction to Anypoint Connectors] +* https://help.salesforce.com[Salesforce Help] diff --git a/workday/16.7/modules/ROOT/pages/workday-connector-xml-maven.adoc b/workday/16.7/modules/ROOT/pages/workday-connector-xml-maven.adoc new file mode 100644 index 0000000000..27b5ae615f --- /dev/null +++ b/workday/16.7/modules/ROOT/pages/workday-connector-xml-maven.adoc @@ -0,0 +1,73 @@ += Workday Connector 16.7 XML and Maven Support +:page-aliases: connectors::workday/workday-xml-ref.adoc, connectors::workday/workday-connector-xml-maven.adoc + +Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio: + +* If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. + +* If you add the connector in Studio, Studio automatically populates the XML code with the connector's namespace and schema location and it also adds a dependency to the `pom.xml` file. + +== Add a Namespace for the Connector + +Paste the following code inside the `mule` tag of the header of your configuration XML: + +[source,xml,linenums] +---- +http://www.mulesoft.org/schema/mule/workday +http://www.mulesoft.org/schema/mule/workday/current/mule-workday.xsd +---- + +This example shows how the namespace statements are placed in the XML: + +[source,xml,linenums] +---- + +---- + +== Add a POM File Dependency + +The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app. If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: + +[source,xml,linenums] +---- + + com.mulesoft.connectors + mule-workday-connector + x.x.x + mule-plugin + +---- + +Replace `x.x.x` with the version that corresponds to the connector you are using. + +To obtain the most up-to-date `pom.xml` file information: + +. Go to https://www.mulesoft.com/exchange/[Anypoint Exchange]. +. In Exchange, click *Login* and supply your Anypoint Platform username and password. +. In Exchange, search for `workday`. +. Click *Dependency Snippets* near the upper right of the screen. + +== Next Step + +After completing your namespace and `pom.xml` file, you can try the xref:workday-connector-examples.adoc[Examples]. + +== See Also + +* xref:connectors::introduction/introduction-to-anypoint-connectors.adoc[Introduction to Anypoint Connectors] +* https://help.salesforce.com[Salesforce Help] diff --git a/workday/16.7/modules/ROOT/pages/workday-reference.adoc b/workday/16.7/modules/ROOT/pages/workday-reference.adoc new file mode 100644 index 0000000000..73840fd02e --- /dev/null +++ b/workday/16.7/modules/ROOT/pages/workday-reference.adoc @@ -0,0 +1,3320 @@ += Workday Connector 16.7 Reference +:page-aliases: connectors::workday/workday-reference.adoc + +Anypoint Connector for Workday (Workday Connector) provides access to standard Workday operations. + + +[[config]] +== Configuration + +Default Configuration for Workday Connector. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +|Name | String | Name for this configuration. Connectors reference the configuration with this name. | | x +| Connection a| * <> +* <> +* <> +| Connection types for this configuration. | | x +| Time Zone a| String | Indicates the timezone. Must be in the format `UTC+01:00`. | `UTC` | +| Encoding a| String | Value that overrides the default Mule encoding value. The value must be one of the standard encoding values, for example, `UTF-8`. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | `60` | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | `SECONDS` | +| Name a| String | ID used to reference this configuration. | | x +| Expiration Policy a| <> | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. | | +|=== + + +[[config_basic-authentication-api]] +=== Workday Basic Authentication Connection Type + +Uses your Workday username and password to authenticate the connection. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Proxy Configuration a| One of: + +* <> +* <> | Configures a proxy for outbound connections. | | +| Host name a| String | Hostname of your Workday instance. | `impl-cc.workday.com` | +| Password a| String | Password associated with the user name. | | x +| Tenant name a| String | Workday tenant name or ID. Use expressions in this field to configure a connection for multiple tenants. | | x +| User Name a| String | User name. | | x +| Use Persistent Connections a| Boolean a| Indicates whether to use persistent connections: + +* `true` ++ +Mule uses persistent connections. + +* `false` ++ +Mule closes the connection after the first request completes. | `true` | +| Max Connections a| Number | Maximum number of parallel outbound connections to keep open. The default value of `-1` means unlimited connections for maximum throughput. If resource consumption is too high, lower this value accordingly. | `-1` | +| Connection Idle Timeout a| Number | When persistent connections are enabled, how long a connection can remain idle before Mule closes it. | `30` | +| Connection Idle Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Connection Idle Timeout* field. | `SECONDS` | +| Stream Response a| Boolean | If set to `true`, Mule streams received responses. | `false` | +| Response Buffer Size a| Number | Size of the buffer that stores the HTTP response, in bytes. | `-1` | +| Connection Timeout a| Number | How long a connection can remain idle before it is closed. The value of this attribute is used only when persistent connections are enabled. | `30` | +| Connection Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Connection Timeout* field. | `SECONDS` | +| TLS Configuration a| <> | Configures TLS. If using the HTTPS protocol, you must configure TLS. | | +| Reconnection a| <> | Configures a reconnection strategy to use when a connector operation fails to connect to an external server. | | +|=== + +[[Config_WorkdayOauthAuthentication]] +=== Workday OAuth Code Authentication Connection Type + +include::connectors::partial$oauth2-description.adoc[] + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Proxy Configuration a| One of: + +* <> +* <> | Configures a proxy for outbound connections. | | +| State a| String | A String value that you send when the OAuth dance is initiated and that is returned back by the service provider with the token callback. + +[NOTE] +==== +Although the *State* parameter is optional, Workday requires it. You can pass the *State* parameter either directly to the OAuth dance or pass it through the *Resource Owner Id* (in multi-tenancy environments), for example, `/authorize?state=test_state`. Failing to do so results in a `The state query parameter is missing from the authorization request` error from Workday. + +The *State* parameter will be deprecated in a future release. +==== | | +| Host name a| String | Hostname of your Workday instance. | `impl-cc.workday.com` | +| Tenant name a| String | Workday tenant name or ID. Use expressions in this field to configure a connection for multiple tenants. | | x +| Use Persistent Connections a| Boolean a| Indicates whether to use persistent connections: + +* `true` ++ +Mule uses persistent connections. + +* `false` ++ +Mule closes the connection after the first request completes. | `true` | +| Max Connections a| Number | Maximum number of parallel outbound connections to keep open. The default value of `-1` means unlimited connections for maximum throughput. If resource consumption is too high, lower this value accordingly. | `-1` | +| Connection Idle Timeout a| Number | When persistent connections are enabled, how long a connection can remain idle before Mule closes it. | `30` | +| Connection Idle Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Connection Idle Timeout* field. | `SECONDS` | + +| Stream Response a| Boolean | If set to `true`, Mule streams received responses. | `false` | +| Response Buffer Size a| Number | Size of the buffer that stores the HTTP response, in bytes. | `-1` | +| Connection Timeout a| Number | How long a connection can remain idle before it is closed. The value of this attribute is used only when persistent connections are enabled. | `30` | +| Connection Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Connection Timeout* field. | `SECONDS` | +| TLS Configuration a| <> | Configures TLS. If using the HTTPS protocol, you must configure TLS. | | +| Reconnection a| <> | Configures a reconnection strategy to use when a connector operation fails to connect to an external server. | | +| Consumer Key a| String | OAuth consumer key, as registered with the service provider. | | x +| Consumer Secret a| String | OAuth consumer secret, as registered with the service provider. | | x +| Authorization Url a| String | Service provider's authorization endpoint URL. | `\https://impl.workday.com/wday/authgwy//authorize` | +| Access Token Url a| String | Service provider's access token endpoint URL. | `\https://wd2-impl-services1.workday.com/ccx/oauth2//token` | +| Scopes a| String | OAuth scopes to request during the OAuth dance. If not provided, it defaults to the OAuth scopes in the annotation. | offline_access | +| Resource Owner Id a| String | The resource owner ID that each component should use if the resource owner ID is not otherwise referenced. | | +| Before a| String | Name of a flow to execute immediately before starting the OAuth dance. | | +| After a| String | Name of a flow to execute immediately after an access token is received. | | +| Listener Config a| String | Reference to a `` to use to create the listener that will receive the access token callback endpoint. | | x +| Callback Path a| String | Path of the access token callback endpoint. | | x +| Authorize Path a| String | Path of the local HTTP endpoint that triggers the OAuth dance. | | x +| External Callback Url a| String | If the callback endpoint is behind a proxy or must be accessed through a non-direct URL, use this parameter to tell the OAuth provider the URL to use to access the callback. | | +| Object Store a| String | Reference to the object store to use to store each resource owner ID's data. If not specified, Mule automatically provisions the default object store. | | +|=== + + +[[config_x509-authentication]] +=== x.509 Authentication Connection Type + +Uses an X.509 certificate to authenticate the connection. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Proxy Configuration a| One of: + +* <> +* <> | Configures a proxy for outbound connections. | | +| Host name a| String | Hostname of your Workday instance. | `impl-cc.workday.com` | +| Tenant name a| String | Workday tenant name or ID. Use expressions in this field to configure a connection for multiple tenants. | | x +| User Name a| String | User name. | | x +| Use Persistent Connections a| Boolean a| Indicates whether to use persistent connections: + +* `true` ++ +Mule uses persistent connections. + +* `false` ++ +Mule closes the connection after the first request completes. | `true` | +| Max Connections a| Number | Maximum number of parallel outbound connections to keep open. The default value of `-1` means unlimited connections for maximum throughput. If resource consumption is too high, lower this value accordingly. | `-1` | +| Connection Idle Timeout a| Number | When persistent connections are enabled, how long a connection can remain idle before Mule closes it. | `30` | +| Connection Idle Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Connection Idle Timeout* field. | `SECONDS` | +| Stream Response a| Boolean | If set to `true`, Mule streams received responses. | `false` | +| Response Buffer Size a| Number | Size of the buffer that stores the HTTP response, in bytes. | `-1` | +| Connection Timeout a| Number | How long a connection can remain idle before it is closed. The value of this attribute is used only when persistent connections are enabled. | `30` | +| Connection Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Connection Timeout* field. | `SECONDS` | +| TLS Configuration a| <> | Configures TLS. If using the HTTPS protocol, you must configure TLS. | | +| Reconnection a| <> | Configures a reconnection strategy to use when a connector operation fails to connect to an external server. | | +| Key store path a| String | Location of the keystore file. You can use an absolute path. | | x +| Type a| Enumeration, one of: + +** JKS +** PKCS12 +** JCEKS +** BCFKS | Type of the keystore. | `JKS` | +| Password a| String | Password to access the keystore. | | +| Alias a| String | Alias of the private key to use. | | x +| Signature Algorithm a| Enumeration, one of: + +** RSA_SHA1 +** RSA_SHA256 | Signature algorithm to use. | `RSA_SHA1` | +| Digest Algorithm a| Enumeration, one of: + +** SHA256 +** SHA512 | Digest algorithm to use. | `SHA256` | +| Canonicalization algorithm a| Enumeration, one of: + +** CANONICAL_XML_1_0 +** CANONICAL_XML_1_1 +** EXCLUSIVE_XML_CANONICALIZATION_1_0 | C14N (canonicalization) algorithm to use. | `EXCLUSIVE_XML_CANONICALIZATION_1_0` | +|=== + +== Sources + +* <> + +[[modified-objects-listener]] +=== On Modified Objects +`` + +Initiates a flow when an instance of the specified Workday object type is created, modified, or deleted. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Watermark Enabled a| Boolean | If set to `true`, Mule processes an item just once, even if it receives the item multiple times. | `false` | +| Object Type a| String +a| Workday object type that applies to this source. The following object types are supported: + +** JOB_PROFILES +** WORKERS +** POSITIONS +** EVERGREEN_REQUISITIONS +** JOB_REQUISITIONS | | x +| Updated From a| String | Required date format is `yyyy-MM-dd'T'HH:mm:ss.SSS`. | | +| Encoding a| String | Value that overrides the default Mule encoding value. The value must be one of the standard encoding values, for example, `UTF-8`. Refer to the `java.nio.charset.StandardCharsets` Javadoc for the format and the valid values for this field. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Scheduling Strategy a| + +* Fixed Frequency +* Cron + | Configures the scheduler that triggers the polling. | | x + | Streaming Strategy a| * <> + * <> + * <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Redelivery Policy a| <> | Defines a policy for processing the redelivery of the same message. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Any +| Attributes Type a| <> +|=== + +==== Associated Configurations +* <> + +== Operations + +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> + + +[[absenceManagement]] +=== Absence Management + +`` + +Invokes the Absence Management web service. The Absence Management web service contains operations that expose absence-related data in Workday Human Capital Management business service. This data includes employee time off, absence inputs for time off, accrual adjustments and overrides for time off, and leave requests. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws + +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + +[[AcaPartnerIntegrations]] +=== Aca Partner Integrations +`` + +Invokes the ACA Partner Integrations web service, which supports Federal and State reporting operations for ACA partners and vendor integrations that report customer ACA data. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws + +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[academicAdvising]] +=== Academic Advising +`` + + +Invokes the Academic Advising web service. Retrieves objects related to academic advising, such as student academic requirement assignments. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[academicFoundation]] +=== Academic Foundation +`` + + +Invokes the Academic Foundation web service, which is a public web service for creating, editing, and retrieving the foundational objects for the student system. These objects include programs of study, educational institutions, and other objects with cross-module uses. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[admissions]] +=== Admissions +`` + + +Invokes the Admissions web service, which is a web service for creating, editing, and retrieving objects related to admissions and applicants. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[adoption]] +=== Adoption + +`` + + +Invokes the Adoption web service. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[benefitsAdministration]] +=== Benefits Administration +`` + + +Invokes the Benefits Administration web service. The Benefits Administration web service contains operations that expose Workday Human Capital Management business services benefits-related data. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[campusEngagement]] +=== Campus Engagement +`` + + +Invokes the Campus Engagement web service, which is a public web service for creating, editing, and retrieving objects related to planning and organizing communication between student prospects and recruiters. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[cashManagement]] +=== Cash Management +`` + + +Invokes the Cash Management web service, which contains operations that expose Workday Financials cash management data. The Cash Management web service includes data relative to banking. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[compensation]] +=== Compensation +`` + + +Invokes the Compensation web service, which contains operations that expose compensation data related to Workday Human Capital Management business services. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[compensationReview]] +=== Compensation Review +`` + + +Invokes the Compensation Review web service, which contains operations that expose the Workday Human Capital Management business services compensation data that relates to reviews. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[Drive]] +=== Drive +`` + + +Invokes the Drive web service. + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Any | Payload for the operation. | `#[payload]` | +| Headers a| Any | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy in case of connectivity errors. | | +|=== + +==== Output + +[%autowidth.spread] +|=== +| Type a| Binary +| Attributes Type a| <> +|=== + +==== Associated Configurations + +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTE +* WORKDAY:VALIDATION_ERROR + + +[[dynamicDocumentGeneration]] +=== Dynamic Document Generation +`` + + +Invokes the Dynamic Document Generation web service, which contains operations to create, edit, and retrieve objects related to document templates, such as text blocks and text block categories. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[externalIntegrations]] +=== External Integrations +`` + + +Invokes the External Integrations web service, which provides an operation that informs external systems of integration events triggered from within Workday. The WSDL for this service provides the structure that an external system must implement to receive event launch information. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[financialAid]] +=== Financial Aid +`` + + +Invokes the Financial Aid web service for the Financial Aid module. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[financialManagement]] +=== Financial Management +`` + + +Invokes the Financial Management web service, which contains operations that expose Workday Financials data. This web service includes data relative to accounts, accounting, business plans, financial reporting, tax, financial organizations, basic worktags, related worktags, and more. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[humanResources]] +=== Human Resources +`` + + +Invokes the Human Resources web service, which contains operations that expose Workday Human Capital Management business services data, including employee, contingent worker, and organization information. Use this web service to integrate with enterprise systems, including corporate directories, data analysis tools, email, other provisioning sub-systems, and any other systems needing worker data, organization data, or both. + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[identityManagement]] +=== Identity Management +`` + + +Invokes the Identity Management web service, which contains operations that relate to Workday identity and access management. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[integrations]] +=== Integrations +`` + + +Invokes the Integrations web service, which contains operations related to all integrations within the Workday system. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[inventory]] +=== Inventory +`` + + +Invokes the Inventory web service, which contains operations that expose Workday Financials Inventory data. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[learning]] +=== Learning +`` + + +Invokes the Learning web service, which contains operations for creating, editing, and retrieving Workday Learning-related data such as courses, course offerings, and enrollments. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR + + +[[MetadataTranslations]] +=== Metadata Translations +`` + + +Invokes the Metadata Translations web service. Imports Metadata Translations using Enterprise Interface Builder (EIB). + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Any | Payload for the operation. | `#[payload]` | +| Headers a| Any | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy in case of connectivity errors. | | +|=== + +==== Output + +[%autowidth.spread] +|=== +| Type a| Binary +| Attributes Type a| <> +|=== + +==== Associated Configurations + +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[moments]] +=== Moments +`` + +Invokes the Moments web service for creating, editing, and retrieving objects related to Workday Moments. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +| Type a| Binary +| Attributes Type a| <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[notification]] +=== Notification +`` + + +Invokes the Notification web service, which provides an operation that informs external systems about business events that occur within Workday. The WSDL for this service provides the structure that an external system must implement to receive notifications for their subscribed Workday business events. Subscriptions and notification details, such as endpoint and security information, are defined within the Workday application. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[OrgStudio]] +=== Org Studio +`` + + +Invokes the Org Studio web service, which contains operations designed for interacting with Org Studio setup data. + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Any | Payload for the operation. | `#[payload]` | +| Headers a| Any | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy in case of connectivity errors. | | +|=== + +==== Output + +[%autowidth.spread] +|=== +| Type a| Binary +| Attributes Type a| <> +|=== + +==== Associated Configurations + +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[payroll]] +=== Payroll +`` + + +Invokes the Payroll web service, which contains operations that expose Workday Payroll data for integration with third parties, such as time and attendance systems. + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[payrollCAN]] +=== Payroll CAN +`` + + +Invokes the Payroll CAN web service, which contains operations that expose Workday Payroll Canadian data for integration with third parties, such as time and attendance systems. + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[payrollFRA]] +=== Payroll FRA +`` + + +Invokes the Payroll FRA web service, which contains operations that expose Workday Payroll France data for integration with third parties. + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[payrollGBR]] +=== Payroll GBR +`` + + +Invokes the Payroll GBR web service, which contains operations that expose Workday UK Payroll data for integration with third parties. + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[payrollInterface]] +=== Payroll Interface +`` + + +Invokes the Payroll Interface web service, which contains operations that expose Workday Human Capital Management business services data for integration with external payroll systems. + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[performanceManagement]] +=== Performance Management +`` + + +Invokes the Performance Management web service, which contains operations that expose Workday Employee Performance Management business services data. Use this web service to integrate with other employee performance management systems. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[professionalServicesAutomation]] +=== Professional Services Automation +`` + + +Invokes the Professional Services web service, which contains operations that expose Workday Financials business services data for integration with Professional Services Automation (PSA) systems. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[recruiting]] +=== Recruiting +`` + + +Invokes the Recruiting web service, which contains operations that expose Workday Human Capital Management business services data for integration with talent management and applicant tracking systems. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[resourceManagement]] +=== Resource Management +`` + + +Invokes the Resource Management web service, which contains operations that expose Workday Financials Resource Management data. The Resource Management web service includes data relative to suppliers, supplier accounts, expenses, business assets, and projects. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[revenueManagement]] +=== Revenue Management +`` + + +Invokes the Revenue Management web service, which contains operations that expose Workday Financials Revenue Management data. The Revenue Management web service includes data relative to customers, customer accounts, prospects, and opportunities. + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + +[[scheduling]] +=== Scheduling +`` + + +Invokes the Scheduling web service, which contains operations for importing and exporting scheduling data. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[settlementServices]] +=== Settlement Services +`` + + +Invokes the Settlement Services web service, which is used for settlement management and services. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[staffing]] +=== Staffing +`` + + +Invokes the Staffing web service, which exposes Workday Human Capital Management business services and data. These services pertain to staffing transactions for both employees and contingent workers, such as bringing employees and contingent workers on board. + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[studentCore]] +=== Student Core +`` + +Invokes the Student Core web service, which is used for creating, editing, and retrieving objects related to students' personal information, such as student documents. + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configure to use repeatable streams | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + +[[studentFinance]] +=== Student Finance +`` + + +Invokes the Student Finance web service, which is used for creating, editing, and retrieving objects related to student finance, such as charges and payments. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[studentRecords]] +=== Student Records +`` + + +Invokes the Student Records web service, which is used for creating, editing, and retrieving objects related to student records, such as student courses, sections, and more. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[studentRecruiting]] +=== Student Recruiting +`` + + +Invokes the Student Recruiting web service, which is used for creating, editing, and retrieving objects related to student recruiting, such as student recruiting events, campaigns, cycles, recruiters, and prospects. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + +[[StudentTransferCredit]] +=== Student Transfer Credit +`` + +Invokes the Student Transfer Credit web service used for creating, editing, and retrieving data related to Student Transfer Credit. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[talent]] +=== Talent +`` + + +Invokes the Talent web service, which consists of operations for interfacing with the Workday Talent Management web service operations. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[tenantDataTranslation]] +=== Tenant Data Translation +`` + + +Invokes the Tenant Data Translation web service, which is a public web service for exporting and importing translatable tenant data. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[timeTracking]] +=== Time Tracking +`` + + +Invokes the Time Tracking web service, which contains operations for importing and exporting time and work schedule information. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[Unauthorize]] +=== Unauthorize +`` + +Deletes all the access token information of a given resource owner ID so that it is impossible to execute any operation for that user without doing the authorization dance again. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Resource Owner Id a| String | ID of the resource owner for whom to invalidate access. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +|=== + +==== Associated Configurations + +* <> + + + +[[workdayConnect]] +=== Workday Connect +`` + + +Invokes the Workday Connect web service, which contains Get and Put web services used for communication capabilities across applications. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[workdayExtensibility]] +=== Workday Extensibility +`` + + +Invokes the Workday Extensibility web service, which is a public web service for extensibility features across applications. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + + +[[workforcePlanning]] +=== Workforce Planning +`` + + +Invokes the Workforce Planning web service, which contains operations that expose Workforce Planning business services and data. + + + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Operation a| String | Type of operation to execute. | | x +| Content a| Binary | Payload for the operation. | `#[payload]` | +| Headers a| Binary | Headers included in the request. | | +| Config Ref a| ConfigurationProvider | Name of the configuration used to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* <> | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Response Timeout a| Number | How long Mule waits for a response to complete before the request times out. | | +| Response Timeout Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Response Timeout* field. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | `#[payload]` | +| Reconnection Strategy a| * <> +* <> | Retry strategy for connectivity errors. | | +|=== + +==== Output +[%autowidth.spread] +|=== +|Type |Binary +|Attributes Type | <> +|=== + +==== Associated Configurations +* <> + +==== Throws +* WORKDAY:BAD_REQUEST +* WORKDAY:CONNECTIVITY +* WORKDAY:PROCESSING_ERROR +* WORKDAY:RETRY_EXHAUSTED +* WORKDAY:VALIDATION_ERROR + +== Object Types + +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> + + + +[[crl-file]] +=== CRL File + +Specifies the location of the certification revocation list (CRL) file. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Path a| String | Path to the CRL file. | | +|=== + +[[custom-ocsp-responder]] +=== Custom OCSP Responder + +Configures a custom OCSP responder for certification revocation checks. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Url a| String | URL of the OCSP responder. | | +| Cert Alias a| String | Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore. | | +|=== + +[[Default]] +=== Default + +Configures the default HTTP proxy configuration type. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Host a| String | Hostname or IP address of the proxy server. | | x +| Port a| Number | Port of the proxy server. | | x +| Username a| String | Username to authenticate against the proxy server. | | +| Password a| String | Password to authenticate against the proxy server. | | +| Non Proxy Hosts a| String | Non-proxy hosts. | | +|=== + +[[ExpirationPolicy]] +=== Expiration Policy + +Configures an expiration policy strategy. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Max Idle Time a| Number | Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. | | +| Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Max Idle Time* field. | | +|=== + +[[KeyStore]] +=== Key Store + +Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Path a| String | Path to the keystore. Mule resolves the path relative to the current classpath and file system. | | +| Type a| String | Type of keystore. | | +| Alias a| String | Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file. | | +| Key Password a| String | Password used to protect the private key. | | +| Password a| String | Password used to protect the keystore. | | +| Algorithm a| String | Encryption algorithm that the keystore uses. | | +|=== + +[[non-repeatable-stream]] +=== Non-Repeatable Stream + +Disables the repeatable stream functionality and uses non-repeatable streams to have lower performance overhead, memory use, and cost. + +[[NTLM]] +=== NTLM + +Configures the NTLM type. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Ntlm Domain a| String | NTLM domain. | | x +| Host a| String | Hostname. | | x +| Port a| Number | Port. | | x +| Username a| String | Username. | | +| Password a| String | Password. | | +| Non Proxy Hosts a| String | Non proxy hosts. | | +|=== + +[[reconnect]] +=== Reconnect + +Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Frequency a| Number | How often to attempt to reconnect, in milliseconds. | | +| Blocking a| Boolean | If `false`, the reconnection strategy runs in a separate, non-blocking thread. | | +| Count a| Number | How many reconnection attempts the Mule app can make. | | +|=== + +[[reconnect-forever]] +=== Reconnect Forever + +Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Frequency a| Number | How often to attempt to reconnect, in milliseconds. | | +| Blocking a| Boolean | If `false`, the reconnection strategy runs in a separate, non-blocking thread. | | +|=== + +[[Reconnection]] +=== Reconnection + +Configures a reconnection strategy for an operation. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Fails Deployment a| Boolean a| What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy: + +* `true` ++ +Allow the deployment to fail. + +* `false` ++ +Ignore the results of the connectivity test. | | +| Reconnection Strategy a| * <> +* <> | Reconnection strategy to use. | | +|=== + +[[RedeliveryPolicy]] +=== Redelivery Policy + +Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Max Redelivery Count a| Number | Maximum number of times that a redelivered request can be processed unsuccessfully before returning a `REDELIVERY_EXHAUSTED` error. | | +| Message Digest Algorithm a| String | Secure hashing algorithm to use if the *Use Secure Hash* field is `true`. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload's `hashCode()` returned. | | +| Message Identifier a| <> | One or more expressions that determine if a message was redelivered. This property can be set only if the *Use Secure Hash* field is `false`. | | +| Object Store a| ObjectStore | Configures the object store that stores the redelivery counter for each message. | | +|=== + +[[RedeliveryPolicyMessageIdentifier]] +=== Redelivery Policy Message Identifier + +Configures how to identify a redelivered message and how to find out when the message was redelivered. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Use Secure Hash a| Boolean | If `true`, Mule uses a secure hash algorithm to identify a redelivered message. | | +| Id Expression a| String | One or more expressions that determine when a message was redelivered. You can set this property only if the *Use Secure Hash* field is `false`. | | +|=== + +[[repeatable-file-store-stream]] +=== Repeatable File Store Stream + +Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer's content to disk and then clears the memory. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| In Memory Size a| Number a| Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance: + +* Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory. + +* Configure a smaller buffer size to decrease memory load at the expense of response time. | | +| Buffer Unit a| Enumeration, one of: + +** BYTE +** KB +** MB +** GB | Unit for the *In Memory Size* field. | | +|=== + +[[repeatable-in-memory-stream]] +=== Repeatable In-Memory Stream + +Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Initial Buffer Size a| Number | Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by *Buffer Size Increment*, with an upper limit of *Max In Memory Size* value. | | +| Buffer Size Increment a| Number | Amount by which the buffer size expands if it exceeds its initial size. Setting a value of `0` or lower specifies that the buffer can't expand. | | +| Max Buffer Size a| Number | Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a `STREAM_MAXIMUM_SIZE_EXCEEDED` error. A value of less than or equal to `0` means no limit. | | +| Buffer Unit a| Enumeration, one of: + +** BYTE +** KB +** MB +** GB | Unit for the *Initial Buffer Size*, *Buffer Size Increment*, and *Buffer Unit* fields. | | +|=== + +[[SoapAttributes]] +=== SOAP Attributes + +Configures the SOAP attributes type. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Transport Additional Data a| Object | Transport additional data. | | +| Transport Headers a| Object | Transport headers. | | +|=== + +[[standard-revocation-check]] +=== Standard Revocation Check + +Configures standard revocation checks for TLS certificates. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Only End Entities a| Boolean a| Which elements to verify in the certificate chain: + +* `true` ++ +Verify only the last element in the certificate chain. + +* `false` ++ +Verify all elements in the certificate chain. | | +| Prefer Crls a| Boolean a| How to check certificate validity: + +* `true` ++ +Check the Certification Revocation List (CRL) for certificate validity. + +* `false` ++ +Use the Online Certificate Status Protocol (OCSP) to check certificate validity. | | +| No Fallback a| Boolean a| Whether to use the secondary method to check certificate validity: + +* `true` ++ +Use the method that wasn't specified in the *Prefer Crls* field (the secondary method) to check certificate validity. + +* `false` ++ +Do not use the secondary method to check certificate validity. | | +| Soft Fail a| Boolean a| What to do if the revocation server can't be reached or is busy: + +* `true` ++ +Avoid verification failure. + +* `false` ++ +Allow the verification to fail. | | +|=== + +[[Tls]] +=== TLS + +Configures TLS to provide secure communications for the Mule app. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Enabled Protocols a| String | Comma-separated list of protocols enabled for this context. | | +| Enabled Cipher Suites a| String | Comma-separated list of cipher suites enabled for this context. | | +| Trust Store a| <> | Configures the TLS truststore. | | +| Key Store a| <> | Configures the TLS keystore. | | +| Revocation Check a| * <> +* <> +* <> | Configures a revocation checking mechanism. | | +|=== + +[[TrustStore]] +=== Trust Store + +Configures the truststore for TLS. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Path a| String | Path to the truststore. Mule resolves the path relative to the current classpath and file system. | | +| Password a| String | Password used to protect the truststore. | | +| Type a| String | Type of truststore. | | +| Algorithm a| String | Encryption algorithm that the truststore uses. | | +| Insecure a| Boolean | If `true`, Mule stops performing certificate validations. Setting this to `true` can make connections vulnerable to attacks. | | +|=== + +== See Also + +* xref:connectors::introduction/introduction-to-anypoint-connectors.adoc[Introduction to Anypoint Connectors] +* https://help.salesforce.com[Salesforce Help]