×

Supercharge your Proficy solution! Download a free trial of Proficy Operations Hub, CSense analytics, and more. Explore our Proficy 2024 releases!

Home
Building and Configuring Workflows
Basic Activities
Message Queue Activities
These activities are used for working with a messaging queue in order to co-ordinate work between workflows and activities.
Receive Message from Queue
This activity allows an author to configure a message to be received from a queue, which was sent via the Send Message to Queue activity, in order to coordinate work between workflows and activities.

Workflow IPI
Get Started
Tutorials
Orientation
Configure Your Environment
Security
Resource Information and Configuration
Data Administration
Forms and User Displays
Building and Configuring Workflows
- Workflow Design Basics
- Workflow Foundations
- Task Management for Administrators
- Task Configuration
- Task Step Configuration
- Global Subprocesses
- Basic Activities
  - Activities Used to Create Workflows
    Activities comprise the main building blocks or steps that perform the actions in a subprocess or workflow.
  - Third-party Activities
    Workflow can utilize third-party activities that are compatible with Microsoft Windows Workflow Foundation.
  - Predefined User Activities
    A user activity defines part of a user-defined process in a workflow process step. For a workflow to run, all user activities must be valid (contain no errors) and enabled (active).
  - Data Access Activities
    These activities are used for passing information and data between workflows and activities.
  - Workflow Control Activities
    These activities are used for creating changes in a workflow, such as starting or stopping activities, during run time.
  - Message Queue Activities
    These activities are used for working with a messaging queue in order to co-ordinate work between workflows and activities.
    - Create Message Queue Activity
      This activity creates a message queue for sending or receiving messages between workflows or activities in order to coordinate work.
    - Send Message to Queue
      This activity allows an author to configure a workflow to send a message to a queue by specifying the workflow instance ID, queue name, message type, and message in order to coordinate work between workflows and activities.
    - Receive Message from Queue
      This activity allows an author to configure a message to be received from a queue, which was sent via the Send Message to Queue activity, in order to coordinate work between workflows and activities.
      - Configure a workflow to receive a message from a queue during run time
        This activity allows an author to configure a message to be received from a queue, which was sent via the Send Message to Queue activity, in order to coordinate work between workflows and activities.
    - Delete Message Queue Activity
      This activity deletes a message queue when it is no longer required.
  - Flow Control Activities
    These activities are used to create multiple execution layers within workflow logic.
  - Event-based Activities
    These activities are used when you require workflow logic to start an event during run time.
  - Keyword Activities
    You can use keywords to replace text in work instructions and email subjects and bodies. This text is replaced with keyword values in a workflow at run time.
  - Operator Activities
    These activities are used by operators when a workflow is running the Task List.
  - eSOP Activities
    These activities are used when working with the eSOP Editor.
- Schedules
- Faults
- Test Workflows
- Debug Workflows
- Track Data
- Web Services Service Provider
- Legacy Workflow Web Service
- Categories
- Completion Codes
- Actuals
- REST APIs
eSOP
ActiveX Task Controls
Service Interfaces
Operator Task List in the Workflow Client
Best Practices

Receive Message from Queue

This activity allows an author to configure a message to be received from a queue, which was sent via the Send Message to Queue activity, in order to coordinate work between workflows and activities.

This activity interacts with a WorkflowQueue using the WorkflowQueuingService.

Note: The following restrictions apply:

The message queue name cannot be null or empty, and you cannot use workflow instance ID, task instance ID, or task step instance ID as a queue name, because doing so causes the activities to fault at run time.
Empty GUIDs are not allowed.
Leading and trailing spaces are trimmed in the queue name; otherwise, the queue name is invalid.
A queue must be created before sending a message.
The workflow instance should be running before sending a message. If it is not running, the instance is not loaded/restarted.

Queue Configuration Properties

Property	Value	Description
Queue Name	User-defined; GUID; String	Specifies the name of the message queue, which is scoped to this workflow instance. This value can be configured using a literal value, expression, or bind.
Time Out	User-defined	Specifies the duration that the message is in the queue before it is no longer valid. If this activity times out, it will be cancelled. As the default value is zero, if this property is not configured, this activity does not end; it will wait forever.

Message Input Properties

Property	Value	Description
Message Type	User-defined	Specifies the data type of the message received, which is scoped to the Send Message to Queue activity.

Message Output Properties

Property	Value	Description
Message	Read Only; Object	Specifies the message being received from another queue, which is bound to the Send Message from Queue activity. This value can be configured using a literal value, expression, or bind.
Message Received	Read Only; Boolean	Specifies whether the sent message has been received.
Timed Out	Boolean	Specifies whether the received message is no longer valid because the allotted pre-set time to view the message has expired.