Action Types

Loads data into a given instance of a business or list object.

<!-- Loads “Visit” business object with all visit details-->
<Action name="LoadVisitBO" actionType="LOAD" type="BoVisit">
    <Parameters>
        <Input name="pKey" value="ProcessContext::VisitPKey" />
    </Parameters>
    <Return name="ProcessContext::VisitBO" />
</Action>

Saves a given instance or list of a declared object within the process.

<!-- Save the BO contact partner -->
<Action name="SaveContactPartner" actionType="SAVE">
    <Parameters>
        <Object value="ProcessContext::ContactPartner" />
    </Parameters>
    <TransitionTo action="ReloadContactPartner" />
</Action>

Creates an instance of a given business object. The Action returns a reference to the created business object instance stored in the Process or Application Context.

<!-- Creates the BO "createImageHelper" -->
<Action name="createImageHelper" actionType="CREATE" type="BoImageHelper">
    <Return name="ProcessContext::imageHelper" />
</Action>

Renders a given UI. The VIEW action also declares event handling for the defined user interface and ExitHandlers used for validations.

<!-- Show Visit Info -->
<Action actionType="View" name="showVisitInfo">
    <UIDescription>Visit::InfoUI</UIDescription>
</Action>

Calls a given business logic function from the API or a method defined within the process.

<!-- Load and show not started tasks for a visit -->
<Action actionType="LOGIC" name="LoadNotStartedTasks" call="ProcessContext::VisitBo.loadTasksBasedOnStatus">
    <Parameters>
        <Input name="Status" type="Literal" value="NotStarted" />
        <Input name="Items" value="ProcessContext::VisitBo.loAssessmentTasks" />
    </Parameters>
    <Return name="ProcessContext::NotStartedTasks" />
</Action>

Starts a new process (subprocess) from the current process. The actionType Process can return one or more values. The name of the return value is a reference to a variable in the process context.

<!-- Capture an image in the KPI -->
<Action name="AddImage" actionType="PROCESS" process="Visit::CapturePictureProcess">
    <Parameters>
        <Input name="parentId" value="Event.pKey" />
    </Parameters>
</Action>

Used for transitions in the execution flow. The attribute “defaultLabel” is required for this action.

<Action actionType="NAVIGATION" name="StartSalesNavigation">
    <Parameters name="ProcessContext::NavigationName">
        <Processes selectedId="Questionnaire">
            <Process id="Questionnaire" image="CheckListGrey24" label="questionnaire"
                defaultLabel="Questionnaire"
                action="StartQuestionProcess" />
            <Process id="Notes" image="NoteGrey24" label="notes" defaultLabel="Notes"
                action="StartNotesProcess" />
        </Processes>
    </Parameters>
    <TransitionTo action="StartQuestionProcess" />
</Action>

Evaluates and takes action based on the input parameter.

<Action name="DataAvailability_Decision" actionType="DECISION"
    parameter="ProcessContext::isOrderDataAvailable">
    <Case value="1" action="StartNavigation" />
    <Case value="2" action="Message_OrderDataNotOnDevice" />
    <CaseElse action="LoadOrderOnDemandData" />
</Action>

Enables the user to decide if the pending changes are kept or discarded.

<!-- Complete Visit? -->
<Action name="ConfirmEndVisit" actionType="CONFIRM" confirmType="YesNo">
    <Message messageId="ConfirmEndVisitMessage" />
    <Cases>
        <Case value="Yes" action="CompleteVisit" />
        <Case value="No" action="endWithoutRefresh" />
    </Cases>
</Action>

Validates a business object by using a validation business logic function.

<!-- Validation Opening Hour after clicking Done Button -->
<Action name="ValidateOpeningHours" actionType="VALIDATION">
    <Validations>
        <Validation name="ProcessContext::CustomerDetail.validateCustomerOpeningTime" />
    </Validations>
</Action>

Manages the correlation between a MasterList (List Object) and a DetailObject (Business Object).

Manages the correlation between a MasterList (List Object) and a DetailObject (Business Object).

<Action name="CustomerListMasterDetail" actionType="MASTER_DETAIL_HANDLER">
<MasterList name="ProcessContext::CustomerList"> <!--RELOAD|UPDATE|NONE-->
<ItemUnselected type="RELOAD" />
</MasterList>
<DetailObject name="ProcessContext::CustomerDetail" objectClass="BoCustomer"> <!--type="DIRTY|ALWAYS|NEVER"
confirmation="TRUE|FALSE" validate="TRUE|FALSE" -->
<Save type="DIRTY" confirmation="FALSE" validate="FALSE" />
<Delete confirmation="true" messageId=".ConfirmDeletionID" nextCurrent="Next" />
<Create autoSave="true">
<WizardProcess name="Customer::CallCustomerReviewProcess" submitParameter="customerPKey">
<Parameters>
<Input name="CustomerPKey" value="ProcessContext::CustomerPKey" />
</Parameters>
<ReturnValues>
<Return name="SaveFlag" value="ProcessContext::saveFlag" />
</ReturnValues>
</WizardProcess>
</Create>
</DetailObject>
<TransitionTo action="TabDecision" />
</Action>

Exits the current process.

<Action name="LeaveCapturePicture" actionType="END">
    <ReturnValues>
        <Return name="success" value="1" type="Literal" />
        <Return name="parentId" value="ProcessContext::parentId" />
    </ReturnValues>
</Action>

Captures a scan event.

<Action name="BarCode" actionType="SCAN">
    <TransitionTo action="FindProduct" />
    <Return name="ProcessContext::EAN" />
</Action>
See Barcode Scanning for more information. 

Captures a print event.

<Action name="PrintPreview_Standard" actionType="PRINTV2" printId="ProcessContext::PrintId"
    locale="ApplicationContext::user.languageSpoken"
    showShareButton="ProcessContext::showShareButton"
    watermark="ProcessContext::watermark">
    <Parameters>
        <Input name="header" value="ProcessContext::PrintPreviewHeader" />
        <Input name="data" value="ProcessContext::PrintPreviewData" />
    </Parameters>
    <TransitionTo action="ShowView" />
</Action>