orchestration Element
Defines an orchestration of the application. The orchestration element controls the flow and data transfer between groups of one or more tasklets in a Microsoft Dynamics Mobile application. Typically, a mobile application consists of multiple orchestration elements, with each orchestration representing a business activity or transaction, such as viewing customer details or sending a sales order. The orchestrations are pieced together to form the complete application by using actions. All orchestrations are contained in the orchestrations element.
<orchestration context="title text description" text="title text" />
The following sections describe attributes, child elements, and parent elements.
Attributes
| Attribute | Description |
|---|---|
|
|
Optional attribute. Provides information about the |
|
|
Required attribute. Specifies a unique name for this orchestration. By referring to the name, the orchestration can be opened from other parts of the UserRole.xml file, including orchestrations and tasklet actions. |
|
|
Optional attribute. Specifies a text string that is displayed in the title bar of the user interface on the mobile device. By default, this is only used in wizard orchestrations. For more information, see wizardSteps Element. |
Child Elements
| Element | Description |
|---|---|
|
Specifies actions that can be initiated in the orchestration. | |
|
Contains | |
|
Defines a confirmation message that appears when the user tries to exit the orchestration prompting the user to continue or cancel. | |
|
Specifies a request document for the orchestration to send data to the business solution for processing. | |
|
Declares the tasklets used in the orchestration. | |
|
Contains the step definitions of a wizard. |
Parent Elements
| Element | Description |
|---|---|
|
Contains all the orchestration definitions for the application. |
The following example consists of an orchestration that defines a wizard for creating a new customer. The orchestration consists of three tasklets that make up the steps of the wizard. For more information, see Defining a Wizard in Microsoft Dynamics Mobile Orchestration Guide online.
<orchestrations>
<orchestration name="NewCustomerWizard" text="New Customer">
<confirmClose text="The customer data will be lost. Are you sure you want to close?" />
<requestDocument name="CreateCustomer" stamps="1" text="Create a customer">
<requiredRequests>
<request name="CustomerDetails"/>
<request name="CreditLimit"/>
<request name="ContactDetails"/>
</requiredRequests>
</requestDocument>
<wizardSteps>
<wizardStep tasklet="CustomerDetails" />
<wizardStep tasklet="CreditLimit" />
<wizardStep tasklet="ContactDetails" />
</wizardSteps>
<actions>
<exitOrchestration priority="-1" text="Cancel" submitRequestDocument="false" result="Cancel"/>
</actions>
<tasklets>
<tasklet name="CustomerDetails" text="Customer Details" type="CustomerDetailTasklet.CustomerDetailTasklet, CustomerDetailTasklet ">
<outputMappings>
<outputMapping propertyName="CustomerType" stateKey="CustomerType"/>
<outputMapping propertyName="CustomerName" stateKey="CustomerName"/>
</outputMappings>
<actions>
<next priority="2" text="Next" validate="true"/>
</actions>
</tasklet>
<tasklet name="CreditLimit" text="Credit Limit" type="CustomerCreditLimitDetailTasklet.CustomerCreditLimitDetailTasklet, CustomerCreditLimitDetailTasklet ">
<outputMappings>
<outputMapping propertyName="CreditLimit" stateKey="CreditLimit"/>
</outputMappings>
<inputMappings>
<inputMapping propertyName="CustomerType" stateKey="CustomerType"/>
<inputMapping propertyName="CustomerName" stateKey="CustomerName"/>
</inputMappings>
<actions>
<previous priority="1" text="Previous" />
<next priority="2" text="Next">
<constraints>
<required stateKey="CreditLimit"/>
</constraints>
</next>
</actions>
</tasklet>
<tasklet name="ContactDetails" text="Contact Details" type="CustomerContactDetailTasklet.CustomerContactDetailTasklet, CustomerContactDetailTasklet">
<inputMappings>
<inputMapping propertyName="CustomerName" stateKey="CustomerName"/>
</inputMappings>
<actions>
<previous priority="1" text="Previous" />
<exitOrchestration priority="2" text="Finish" submitRequestDocument="true" result="OK"/>
</actions>
</tasklet>
</tasklets>
</orchestration>
</orchestrations>
This example shows a single orchestration. To define additional orchestrations, add an <orchestration> element for each orchestration.
Reference
orchestrations Elementtasklet Element
actions Element
appSettings Element
confirmClose Element
requestDocument Element
Concepts
UserRole Schema Hierarchy StructureDefining Orchestrations in the UserRole
Defining Tasklets
Other Resources
Mobile UserRole Schema ReferenceMobile Orchestration
How to: Build a Mobile Application Using Orchestration
Working with Actions for Soft Keys and Menu Items