confirmClose Element

Causes a message to appear when the user tries to exit an orchestration. The message enables the user to confirm or cancel the action. The message occurs under the following conditions:

  • The user taps the "X" button in the upper-right corner of the application to close the orchestration.

  • The user exits the orchestration as defined by the use of an <exitOrchestration> element or an <exitTasklet> element.

You typically define a <confirmClose> element in wizards where the user has the opportunity to exit the wizard without saving changes. For more information, see Defining a Wizard in Microsoft Dynamics Mobile Orchestration Guide online.

userRole Element

    orchestrations Element

        orchestration Element

            confirmClose Element


<confirmClose context="explanation of the text" text="message text" />

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

Attributes

Attribute Description

context

Optional attribute.

Provides information about the value of the text attribute, such as a description, usage, and maximum number of characters. Useful for translation and localization.

text

Required attribute.

Specifies the content of the message that is displayed when the user tries to exit the orchestration.

Child Elements

None.

Parent Elements

Element Description

orchestration Element

Defines the interaction among one or more tasklets. For more information, see Defining Orchestrations in the UserRole in Microsoft Dynamics Mobile Orchestration Guide online.

If you want the confirmation message to work with the <exitOrchestration> element or the <exitTasklet> element, you must set the result attribute of the element to None or Cancel.

NoteNote

If you do not use a <confirmClose> element, then the user will not get any warning when exiting an orchestration.

The following example uses the <confirmClose> to specify a confirmation message for exiting a wizard.

NoteNote

The <exitOrchestration> element defined on the <orchestration> element places an action on each wizard step that allows the user to exit the wizard. To launch the confirmation message, the result attribute of the <exitOrchestration> element is set to Cancel.

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

Namespace

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

Schema Name

UserRole Schema

Validation File

Orchestration.xsd

Can be Empty

Not applicable.

Community Additions

ADD
Show: