GetPossibleLegalUnits

Execute Format

A

FactoryTalk Batch

Server supports an execute with this format:

[GETPOSSIBLELEGALUNITS(

Item, UserID,CreateID \t UnitProcName

)]

where:

Item

Name of the response item as specified by the client.

UserID

User Identification entered into the event journal associated with this event.

CreateID

Unique ID, as assigned by the system, of the procedure which contains the step which requires binding

UnitProcName

Path to a step representing a Unit Procedure inside of a Batch Procedure.

where:

<Path>

is

where:

Field

Format

Description

<CreateID>

ASCII - Integer

Unique batch ID assigned by the

FactoryTalk Batch

Server.

<StepIdentifier>

ASCII – String

Step identifier (for example, Mix:1)

Action

A successful GETPOSSIBLELEGALUNITS execute returns the alias name along with a list of IDs and names of the possible binding units or binding options for the specified Unit Procedure or Operation.

Return Format

The response item populates with this data:

SUCCESS:[

<Units>

] | FAIL:<message> | FAILED

<Units>

is

<UnitList>

is

<Unit>

is

where:

Field Name

Format

Description

<UnitAlias>

ASCII - String

Alias associated with the specified Unit Procedure.

<UnitName>

ASCII - String

Name of a Unit that can be a legal bind target for the Unit Procedure, or a legal binding option (Prompt or First Available)

<UnitID>

ASCII - String

Unit ID associated with the unit name. The legal binding options have this associated Unit ID:

Example: