Back Forward Obj-Set-Tickets method

Methods and instructions by function

Use this method in an activity to set (turn on) one or more tickets, or reset (turn off) one or more tickets.

TipAs a best practice to simplify your application, call the standard activity Work-.SetTicket from your activity rather than reference this method. That activity sets and later resets a single ticket, identified in an activity parameter.

CautionYour application must reset the tickets that it sets to prevent possibly indefinite looping behavior when work items are later resolved. Design your activity or processing sequence to call the Obj-Set-Tickets twice; once to set the ticket and later to reset the same ticket.

For a flow rule edited in Process Modeler, tickets may be referenced in the Properties panel, Ticket tab. For a flow rule edited in Visio, tickets in a flow rule are identified by the Ticket shape.

Each ticket can identify a ticket rule. Tickets act as a type of event or condition. Setting a ticket is similar to "raising" an event or performing a GOTO statement in some programming environments.

When a ticket is set, processing of any currently executing flows that reference that ticket (subject to rule resolution) is paused. Flows not started, and flows started in the future, are not affected. Flow processing resumes at the ticket location.

A shape in a flow can require that two (or more) tickets to be set before control resumes at that shape.

Parameters

This method has two parameters:

Parameter

Description

SetTicketNames

Optional. Identify one or more ticket names, typically the second key part of an instance of the Rule-Obj-Ticket rule type.

This ticket becomes "raised" or activated when this method executes, immediately affecting the processing of any flow (of appropriate Work- class) that contains a ticket of that name.

RemoveTicketNames

Optional. Identify the name of one or more tickets to be removed (disabled, inactivated). Removing a ticket (or resetting it) has no effect on executing flows that have resumed processing at that ticket.

Resetting a ticket can affect other flows that require two or more tickets to be set before processing resumes.

Debugging aid

As a debugging aid, the standard HTML rule @baseclass.DeferredOps interrogates system internals and presents an ordered list of deferred (uncommitted) database operations for the current Thread. Your activity can display this HTML rule using the Show-Page method.

Results

When a ticket is raised (set) through this method, the system searches through all flows on the step page (not only through the flow that contains the activity that contains the method.)

This interrupts processing in every flow execution that references that ticket by name. Flow execution resumes under certain conditions at the shape on the diagram that references the ticket.

Checking the method status

This method updates the pxMethodStatus property. See How to test method results using a transition.

Definitions ticket
Related topics About Tickets
Flow form — Editing in Process Modeler — Tickets
Flow form — Editing in Visio — Ticket shapes

UpMethods and instructions by function