---
category: [Administration & Integrations, Platform and Product Extensions, Platform and Product Extensions/Integration, Administration & Integrations/Custom Integrations & Apps, Platform and Product Extensions/Workday Extend]
keyword: [Extend, Orchestration Builder, Orchestrate, Orchestration]
nav: wcp_docs
parent_url: /wcp_docs/
title: >- 
  Reference: Trigger Integration
layout: subsection
---

## <a id="section_1"></a>Purpose

Use this component to configure and execute other integrations in your Workday tenant. An integration that you trigger in this way is said to be a child of the orchestration that calls it. The child integration can be any of these types:

-   Workday-delivered packaged integrations.
-   Custom Studio integrations.
-   Other Workday Integration Systems orchestrations.


You can place the component in the top-level workflow, in error handlers, in branches, in loops, and in suborchestrations.

## <a id="section_2"></a>Template Availability

This component is available in this orchestration template only:

-   Workday Integration System.


<b>Note:</b> You can't use this component in join loops.

## <a id="section_3"></a>Properties

Provide a meaningful <b>Reference Name</b> for the step as it will appear in your orchestration.

<b>The Auth Tab</b>

Use this tab to specify the authentication method for the child integration that the step will trigger. From the <b>Authentication</b> drop-down menu, select either <b>Default Workday API Credential</b> or <b>Access Token from Initiating User</b>.

<b>Note:</b> If the child integration system has an ISU configured as part of its definition, that ISU will be its "run as" user when it's triggered. The user configured in the <b>Trigger Integration</b> step, regardless of authentication type, will be the "initiating" user. This initiating user must have the necessary permissions to be able to launch the integration.

If the child integration system doesn't have an ISU configured, the user specified in the <b>Trigger Integration</b> step will be both the "run as" user and the "initiating" user for the child integration. This user must have the necessary permissions to both run and launch the integration.

<b>The Launch Parameters Tab</b>

Use this tab to link to the child Integration System and import its launch parameter definitions. To do so, you must be connected to the relevant tenant. Click <b>Manage Connections</b> at the top of the <b>Launch Parameters</b> tab. Select the tenant from the drop-down menu and connect to it. When the connection has been established, search for the Integration System by name, and link to it.

Orchestration Builder imports and displays the launch parameter definitions from the linked child integration system, grouping them according to their service Provider type.

<b>Note:</b> Instead of using Orchestrate's automatic grouping, you can optionally create your own groups. Click<b>Create Parameter Group</b>, then specify the service <b>Provider ID</b> and <b>Provider Type</b>.

Use Expression Builder to provide the values that will be passed to the child integration as its launch parameters, incorporating upstream data from your orchestration as required. Use the <b>Send in Launch</b> checkbox beside each parameter to specify whether or not it's included when the child integration is triggered.

Click <b>Refresh Launch Parameters</b> at the top of the <b>Launch Parameters</b> tab to reimport the latest parameter definitions from the child integration system. If parameter definitions have been added to or removed from the child integration, the list updates accordingly. If a parameter that had an expression assigned has been removed, Orchestration Builder prompts you to either exclude the parameter or remove the expression.

<b>The Document Tab</b>

Use this tab to pass a document to the child integration. Complete these Expression Builder fields to tell Orchestration Builder what it needs to know about the document:

<table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><b>Document to Store</b></td><td>An expression that specifies the document to attach.</td></tr><tr><td><b>Document Title</b></td><td>An expression that specifies the name the document under which the document will be stored.</td></tr><tr><td><b>Description</b></td><td>(Optional) An expression that provides a brief description of the document's contents.</td></tr><tr><td><b>Collection to Store Document In</b></td><td>(Optional) An expression that specifies the collection where the document will be stored. If you don't specify a collection, Workday creates a new collection using the child integration system WID as its name.</td></tr><tr><td><b>Storage Expires In</b></td><td>An expression that specifies when document storage expires. The default, if no value is set, is 7 days. The maximum retention period is 1 year. Example: to set expiry for 1 month, use the expression <code>zoneddatetime.now().plusMonths(1)</code>.</td></tr><tr><td><b>Tags</b></td><td>(Optional) An expression that provides descriptive tags to help categorize the document. Tags entered here are only valid if they already exist in the tenant.</td></tr><tr><td><b>Add "Retrieved" Workday Tag</b></td><td>(Optional) A boolean expression that evaluates to true or false. If true, makes the child integration treat the document as if it had been sourced from the Integration System retrieval service. Entering a nonboolean expression will lead to an error.</td></tr></tbody></table><br/>

<b>The Settings Tab</b>

Use this tab to configure these request and response details:

-   <b>Overall Timeout</b>: the total time allowed for the operation.
-   <b>Connect Timeout</b>: the time allowed for a client-server connection to establish.
-   <b>Response Timeout</b>: the time allowed for establishing a connection.
-   <b>Response Type</b>: the type of response requested.
-   <b>Retry Settings</b>: select a predefined retry policy. You can create retry policies on the <b>HTTP Retries</b> tab of your orchestration's <b>Settings</b>. Note that these retry mechanisms support retry on failure to trigger the integration, not on failure of the integration itself.


### Related Information

[Concept: Triggering Integrations](/wcp_docs/GUID-a1697f20-c5b9-4c96-94f6-90868152ea21.html)

