Public Requests

Public API Builder tool

A Public Request is a message that can be sent to a Worker from an external source, such as from a Worker's Caller (within a Workers application), from another LabVIEW application or framework, or from TestStand. You can create and edit a Worker's Public Requests in the Requests tab of the Public API Builder tool, as shown in the image below:

Requests tab (Public API Builder tool)

1. Create new Request

See section Creating Public Requests.

2. Create Start Exiting Request

You can create a Public API Request to send a message to the <Start Exiting> MHL case of a Worker. Since this MHL case is a Framework Case, you can't manually create a Public API Request for this case. However you can create a Start Exiting Public Request for a Worker by pressing this button.

3. Right Click Menu

Edit Request

This option allows you to edit a Public Request that already exists. When selected, the following dialog window will appear:

Public API Request Editor

Current Request Name

The current name of the selected Public Request.

New Request Name

The new name of the Public Request. The new name will be updated in the following places:

1. The filenames of the associated Public Request VIs and typedefs.

2. The associated MHL case name that will receive the Public Request message

3. The internal Case Label constant within the Public Request VI.

Icon Text

Text that will be written on the Public Request VI and typedef icons, to help users understand which MHL Case will receive the Public Request message.

MHL Case Description

A new description for the Public Request MHL case. This description will also be written to the Public Request VI description.

Good to know

If this tool is being used to edit a Public Request in a Worker base class, then all Workers that inherit from the Worker base class (within the scope of the open LabVIEW project) that override the Public Request will also have the override MHL case name and description updated.

Show Request VI

This option will open the front panel of the associated Public Request VI.

Show Request Data

This option will open the front panel of the associated message data typedef.

Show MHL Case

This option will open the associated MHL case on the block-diagram of the Worker that owns the Public Request.