exitOrchestration Element

Exits an orchestration and returns to the previously opened orchestration. If the orchestration is the only orchestration open, then the application closes.

userRole Element

    orchestrations Element

        orchestration Element

                actions Element

                    exitOrchestration Element

                        group Element

                            exitOrchestration Element

              tasklets Element

                    tasklet Element

                        actions Element

                            exitOrchestration Element

                            group Element

                                exitOrchestration Element

    tasklets Element

        tasklet Element

                actions Element

                    exitOrchestration Element

                    group Element

                        exitOrchestration Element


<tasklet>
  <action>
    <exitOrchestration context="describe text" icon="image file" name="reference name" priority="priority number" result="OK|Cancel|Abort|None" submitRequestDocument="true|false" text="menu label" validate="true|false" />
  </actions>
</tasklet>

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute Description

context

Optional attribute.

Provides information about the text attribute value, such as a description, usage, or maximum number of characters. Useful for translation. This attribute has no effect on the application.

icon

Optional attribute.

The full path and file name of a bitmap file to associate with the action. You can develop tasklets to use this attribute.

name

Optional attribute.

A unique reference name for the action.

priority

Optional attribute.

A whole number to determine the location of the action in the menu by comparing it with the priorities of other actions on the tasklet:

  • The action with the highest priority number is located on the left soft key.

  • The action with the second highest priority number is located at the top of the right soft key menu.

  • Subsequent actions are located in the right soft key menu in descending order of priority from top to bottom.

  • For more information, see Arranging Actions on Soft Keys and Menu Items in Microsoft Dynamics Mobile Orchestration Guide online..

result

Optional attribute.

Passes the value to the tasklet that is open when the orchestration closes. There are four values: OK, Cancel, Abort, and None. The value returns to the tasklet when the exitOrchestration element action is initiated. You can develop tasklets to act on these values. For example, a tasklet can save data on exit when the result is set to OK.

The result attribute works together with the <confirmClose> element to display a confirmation message to the user when exiting the orchestration. For the confirmation message to work, set the result value to Cancel or None. For more information, see confirmClose Element.
NoteNote

submitRequestDocument

Optional attribute.

true submits a request document for the orchestration; otherwise, false.

false is default.

For more information, see Setting up Request Documents in Microsoft Dynamics Mobile Orchestration Guide online.

text

Required attribute.

Specifies the label of the action on the soft key or menu.

validate

Optional attribute.

true calls the tasklet validation method Validate on closing the orchestration; otherwise, false.

true is default.

For more information, see How to: Validate User Input to a Tasklet in Microsoft Dynamics Mobile Orchestration Guide online.

Child Elements

Element Description

constraints Element

The state keys that must have correct values set before the action is enabled.

inputMappings Element

Maps tasklet output parameters, identified by the state keys, to the input parameters of the tasklet that opens as a result of the action.

Parent Elements

Element Description

actions Element

Defines actions that control the flow between the application's tasklets and orchestrations.

group Element

Groups one or more actions together in the right-side soft key menu using dividing lines, or in a submenu.

The following example demonstrates two uses of the <exitOrchestration> element in a wizard that creates a new customer. The first instance creates an action on each step that lets the user exit the wizard without saving data. The second instance is in the last step of the wizard. This instance saves the input data in a request document and is sent to the document queue for dispatching.

For more information about wizards, see Defining a Wizard in Microsoft Dynamics Mobile Orchestration Guide online.

<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>

Required

No

Max. occurrences

1 within the parent.

Namespace

schemas.microsoft.com/Dynamics/Mobile/2007/04/Flow

Schema Name

UserRole Schema

Validation File

Orchestration.xsd

Can be Empty

Yes

Community Additions

ADD
Show: