Available items

List of all supported items in the
FactoryTalk Batch
Server API:
Item
Description
Number of tags, phases, and equipment operation sequences on which verification failed.
List of all created batches.
Batch list count.
Returns the number of Parameter Expression Overrides currently in effect for each batch on the batch list.
Identifier for a batch.
Command mask for a batch.
Create identifier for a batch.
Description for a batch.
Highest priority failure message for a batch.
Mode for a batch.
Recipe for a batch.
Start time for a batch.
State for a batch.
Type for a batch.
Number of COM clients connected to the
FactoryTalk Batch
Server.
CPR version of the
FactoryTalk Batch
Server.
List of all steps in a recipe.
List of all steps in a recipe (allows displaying of override status of a parameter).
Most recent data for a batch.
Name of a batch data file.
Scale factor for a batch.
Information about all of the data servers defined for the equipment database.
Detailed description of each configured data server conversation and the status of each conversation.
Number of DDE clients connected to the
FactoryTalk Batch
Server.
Decimal symbol used by the
FactoryTalk Batch
Server.
List of the domain names available for authenticating users attempting signoffs on signature requests.
List of enumerations within a specified enumeration set.
Path and file name of the equipment model in use.
Date of the equipment model in use.
The number of times the equipment model in use has been updated.
Most recent severe message in the server’s log file.
List of event data fields in the system.
Current expression values for each term in the expression.
Current expression values for each term in a report expression.
Current expression value and all of its leaf node values for a given expression or unit association.
Tab-delimited list of hyperlink labels for each equipment type.
Count of all incomplete signature requests, excluding those generated by private interfaces.
Most recent information message in the server’s log file.
Number of items created by the
FactoryTalk Batch
Server that are exposed through DDE and COM.
Path to the journals directory.
List separator used by the
FactoryTalk Batch
Server, as read from
Control Panel
>
Regional Options
.
Locale identifier (language ID and code page) used by the
FactoryTalk Batch
Server, as read from the
Control Panel
.
Returns the path to the error log directory specified in the batchsvr.ini file at the time the
FactoryTalk Batch
Server was started.
List of all phases in the system.
Number of OPC clients connected to the
FactoryTalk Batch
Server.
Information about all of the equipment operation sequences in the system.
List of all the equipment operation sequences that are currently in failure or have an error.
Count of the equipment operation sequences errors or failures.
Information about all of the phases in the system.
List of all phases currently in failure or have an error.
Count of the phase errors or failures.
Information where a batch phase belongs.
Phase failure for the specified phase.
Name of the specified phase.
Last phase message logged into the event journal for the specified phase.
All parameters for the specified phase.
All parameters for the specified phase including parameter limits and report limits.
Pause attribute for the specified phase or equipment operation sequence.
Pausing attribute for the specified phase or equipment operation sequence.
Status information for the specified phase or equipment operation sequence.
Status information for the specified phase or equipment operation sequence including a field for storing automatic pauses at each sequence transition (sequence program) or breakpoint (the PPD Instruction in a phase program).
Request value for the specified phase.
Single-step flag for the specified phase or equipment operation sequence.
State of the specified phase or equipment operation sequence.
Returns the current step index for the specified phase.
Current unit for the specified phase or equipment operation sequence.
List of all phases, corresponding equipment IDs, and valid units.
List of all equipment phases, corresponding equipment IDs, recipe phases, the phase type and valid units.
List of all equipment phases, corresponding equipment IDs, recipe phases, phase types, bitmap files, and valid units.
Graphical data for an SFC.
Graphical data for an SFC, including transition names and comment information.
Graphical data for an SFC, including transition names and comment information. This item supports parameter and report expressions.
Recipe report parameters for a procedure.
Status data for an SFC.
Status data for an SFC to support showing the status of report and parameter expressions.
Set of unit requirements configured within the specified recipe structure.
Bitmap index for all process cells within the system.
Information about all units in a process cell.
List of process cells in the current area.
List of process cells in the current area, including the process cell class name.
Path to the recipe directory.
Recipe information for all recipes released to production.
Tag status information for all tags associated with the phase and state machine information to indicate the current status of the phase.
Tab-delimited list of hyperlinks configured in the area model for the equipment element identified by the resource ID.
Resource name denoted by the resource ID.
List of all resources and corresponding IDs currently owned by the operator.
List of all resource owners and the corresponding owner IDs.
List of all resources requested by the operator.
List of all resource requesters and the corresponding owner IDs.
List of the cross invocation strings associated with the resource specified by the resource ID.
List of all resources and corresponding equipment IDs.
An XML list of all resources and corresponding equipment IDs. Recommended for use with large resource lists.
Indicator of whether the server is running in demo or production mode.
Time stamp when the Material Server started.
Information for individual signature requests, excluding those generated by private interfaces.
List of all outstanding signature requests, excluding those generated by private interfaces.
Time stamp of when the
FactoryTalk Batch
Server started.
List of all dynamic owners (control recipes) and owner IDs.
Labels used for the generic strings.
Internationalized string indicating the current state of the tag verification process.
Returns an integer indicating the current state of the tag verification process.
Thousands separator used by the
FactoryTalk Batch
Server as read from the
Control Panel
.
Current time from the
FactoryTalk Batch
Server and the conversation status of the data servers.
Current time from the
FactoryTalk Batch
Server and the most severe conversation status of all defined data servers.
Retrieves information about the selected static information for a timer step on the batch list.
Retrieves dynamic information about a specific timer step.
Retrieves retrieves selected information about all of the timer steps currently on the batch list.
Total number of tags, phases, and equipment operation sequences configured in the equipment database.
Unacknowledged prompt area.
Unacknowledged prompt batch ID.
Default value for the
x
th unacknowledged event in the unacknowledged event list.
Unacknowledged prompt description.
Unacknowledged prompt engineering units.
Unacknowledged prompt event type.
Unacknowledged prompt event ID.
Unacknowledged prompt high.
Unacknowledged prompt low.
Unacknowledged prompt phase.
Unacknowledged prompt process cell.
Unacknowledged prompt recipe.
Unacknowledged prompt response type.
Unacknowledged prompt time.
Unacknowledged prompt unit.
Unacknowledged prompt value.
List of unacknowledged prompts.
Unacknowledged prompt count.
Bitmap index for all units.
Operator entered batch ID for a batch running in the specified unit.
List of all the equipment operation sequences within the specified unit.
List of filenames for the bitmaps within the unit.
List of all the phases within the specified unit.
List of all the phases within the specified unit, including whether there is an associated control strategy.
Unit name, unit class, and tag status information for the specified unit.
Set of binding preferences configured on the specified unit requirement.
Set of binding requirements configured on the specified unit requirement.
List of all units, corresponding equipment IDs, and unit classes.
Total number of verified tags, phases, and equipment operation sequences. This total includes tags, phases, and equipment operation sequences that were successfully verified and those that failed verification.
Server software version.
Most recent warning message in the
FactoryTalk Batch
Server log file.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal