required Element
Specifies a tasklet output that must be set before an action is enabled in the tasklet user interface. This prevents the user from navigating further in the application without providing the necessary information. A tasklet output is identified by a state key assigned by an <outputMapping> element.
For more information on constraints and requiring user input to a tasklet, see Overview of Requiring User Input to Tasklets in Microsoft Dynamics Mobile Orchestration Guide online.
<constraints> <required stateKey="stateKey name" /> </constraints>
The following sections describe attributes, child elements, and parent elements.
Attributes
| Attribute | Description |
|---|---|
|
|
Required attribute. The |
Child Elements
None.
Parent Elements
| Element | Description |
|---|---|
|
Specifies tasklet output parameter values that must be set before an action is active in the user interface. |
The following example demonstrates a three-step wizard that creates a new customer. The example uses the <required> element to set a credit limit in the second step of the wizard before moving on to the third step for setting up a contact person.
<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>
In the example, the constraint is set on the tasklet output parameter with the stateKey named CreditLimit.
Reference
constraints Elementorchestration Element
tasklets Element
inputMapping Element
outputMappings Element
Concepts
UserRole Schema Hierarchy StructureDefining a Wizard
Defining Orchestrations in the UserRole
Defining Tasklets
Other Resources
Mobile OrchestrationRequire and Validate User Input
Working with Actions for Soft Keys and Menu Items