requestDocument Element

Defines a request document for an orchestration to transfer data to the business solution for processing. Mobile applications occasionally send information or requests to the business solution, for example, when creating or editing a new customer. When a user navigates through an orchestration, tasklets can gather data. A request document contains data that is contributed by the individual tasklets of the orchestration.

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

userRole Element

    orchestrations Element

        orchestration Element

            requestDocument Element


<requestDocument context="explain text" inherit="true|false" name="request document type" stamps="number of stamps" text="request document name" />

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 and localization. This attribute has no effect on the application.

inherit

Optional attribute.

true contributes the content of the request document to the request document of the parent orchestration; otherwise, false. Default is true.

An orchestration (parent) can call a separate orchestration (child). Both the parent and child orchestrations can generate their own request documents. This property allows the child orchestration to contribute its content to the request document of its parent, resulting in a single request document.

For more information, see How to: Combine Request Documents in Microsoft Dynamics Mobile Orchestration Guide online.

name

Required attribute.

The name of the request document type used to process the request document in the business solution.

Depending on the business solution, there are different document types for processing the different kinds of request documents that are sent from the mobile application. For example, there might be one type for adding a new customer and another type for editing a customer. Check with the administrator of the business solution for the exact names of the document types.

For more information, see Working with Request Documents in Microsoft Dynamics AX in Microsoft Dynamics Mobile - Server Components Administration online.

stamps

Optional attribute.

A whole number to prioritize sending request documents to the business solution based on the available network connection type. This attribute works together with the price attribute value assigned to network connection types in the app.config file of the mobile application. When the mobile device is connected to a network, a request document is sent only if its stamp value is equal to or greater than the price value assigned to the connected network type.

For more information, see Prioritizing Request Documents over Network Connection Types in Microsoft Dynamics Mobile Orchestration Guide online.

text

Optional attribute.

A descriptive name for the request document. The name appears in the Request Document Status tasklet user interface and log of the RolePad application.

Child Elements

Element Description

requiredRequest Element

Specifies the tasklets that contribute data to the request document.

Parent Elements

Element Description

orchestration Element

Defines the interaction among one or more tasklets.

Sending a request document requires that the orchestration includes an <exitOrchestration> element that has its submitRequestDocument attribute set to true. For more information, see exitOrchestration Element.

This example shows how to configure a request document for a wizard that creates a new customer.

<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>
<!-- Contact Details -->
    <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

No

Community Additions

ADD
Show: