open Element

Opens a specific tasklet or orchestration from a soft key or menu item on a tasklet. When the action opens an orchestration, it launches an instance of the first tasklet defined in the orchestration.

userRole Element

    orchestrations Element

        orchestration Element

            actions Element

                open Element

                group Element

                    open Element

            tasklets Element

                tasklet Element

                    actions Element

                        open Element

                        group Element

                            open Element

    tasklets Element

        tasklet Element

              actions Element

                  open Element

                  group Element

                      open Element


<open context="text description" icon="image.gif" name="tasklet name" orchestration="target orchestration" priority="number" tasklet="target tasklet" text="" validate="true|false" />

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.

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.

orchestration

Optional attribute (see Remarks section).

Opens an orchestration. The value must match that of the name attribute that is specified in the <orchestration> element of the orchestration that will be opened. For more information, see orchestration Element.

The application opens an instance of the first tasklet defined in the orchestration.
NoteNote

priority

Optional attribute.

A whole number to determine the location of the action on the soft keys or in the right soft key menu by comparing it with the priorities of other actions on the tasklet as follows:

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

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

  • Subsequent actions are located in descending order of priority in the soft key menu on the right.

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

tasklet

Optional attribute (see Remarks section).

Opens a tasklet. The value must match that of the name attribute that is specified in the <tasklet> element of the tasklet that will be opened.

The target tasklet must be either defined in the same orchestration as the action element or globally in a <tasklet> element directly under the <userRole> element.
NoteNote

text

Required attribute.

Specifies the label of the action on the soft key or menu of the tasklet user interface.

validate

Optional attribute.

true calls the tasklet validation method Validate for the open tasklet when the open element action is initiated; otherwise, false.

Default is true.

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

Specifies the state keys that must have correct values set before the action is enabled in the tasklet user interface.

inputMappings Element

Maps output parameter values of tasklets to the input parameters of a tasklet that opens as a result of the action using state keys.

Parent Elements

Element Description

actions Element

Specifies the actions available from the tasklet or orchestration. Actions appear as soft keys or as menu items.

group Element

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

Either the orchestration or tasklet attribute must be set. Set the orchestration attribute to open an orchestration and the tasklet attribute to open a tasklet.

The following example shows how to use the <open> element to open a tasklet and how to open an orchestration from a tasklet. The starting tasklet shows a list of customers. From the customer list tasklet, you can open a tasklet that synchronizes the database and an orchestration that lets you see details of a selected customer.

<orchestrations>
  <orchestration text="RolePad" name="Reference Implementation">
    <tasklets>
      <tasklet name="CustomerListTasklet" text="Customer List"  type="CustomerListTasklet.CustomerListTasklet, CustomerListTasklet">
        <outputMappings>
          <outputMapping propertyName="SelectedCustomer" stateKey="CustomerID"/>
        </outputMappings>
        <actions>
          <open text="Details" orchestration="CustomerDetailReadOnly" priority="40">
            <inputMappings>
              <inputMapping propertyName="CustomerId" required="true" stateKey="CustomerID"/>
            </inputMappings>
          </open>
          <open text="Synchronize" tasklet="Synchronization"/>
        </actions>
      </tasklet>
      <tasklet name="Synchronization" text="Synchronization" type="Microsoft.Dynamics.Mobile.Components.Tasklets.SynchronizationTasklet, Microsoft.Dynamics.Mobile.Framework.Runtime" />
    </tasklets>
  </orchestration>
  <orchestration text="Customer detail" name="CustomerDetailReadOnly">
    <tasklets>
      <tasklet name="CustomerDetailTasklet" text="Customer Details" type="CustomerDetailTasklet.CustomerDetailTasklet, CustomerDetailTasklet">
        <actions>
          <open text="Contact" priority="40" tasklet="CustomerContactDetailTasklet">
            <inputMappings>
              <inputMapping propertyName="CustomerId" stateKey="CustomerID"/>
            </inputMappings>
          </open>
         </actions>
      </tasklet>
      <tasklet name="CustomerContactDetailTasklet" text="Contact Details" type="CustomerContactDetailTasklet.CustomerContactDetailTasklet, CustomerContactDetailTasklet" />
    </tasklets>
  </orchestration>
</orchestrations>

When the CustomerDetailReadOnly orchestration opens, it opens to the tasklet named CustomerDetailTasklet.

Required

No

Max occurrences

Unlimited.

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: