F1310ProcessorBeginDoc

Condition-Based Alerts Processor Master Business Function

Master Business Function

Object Name: B1301090

Parent DLL: CMFG

Location: Client/Server

Language: C

Data Structure

D1301090A - Condition-Based Alerts Processor - Begin Document DS

Parameter NameData ItemData TypeReq/OptI/O/Both
mnJobNumber_JOBSJOBSMATH_NUMERICOPTOUTPUT

The job number (work station ID) which executed the particular job.

cActionCode_ACTNACTNcharOPTINPUT

A code that specifies the action that is performed. Valid values are: A Add C Change

cProcessEdits_EV01EV01charOPTINPUT

An option that specifies the type of processing for an event.

cInteractiveBatchFlag_EV01EV01charOPTINPUT

An option that specifies the type of processing for an event.

cErrorCode_ERRCERRCcharOPTOUTPUT

This error code indicates if any errors occurred during the creation of the Trip Document Detail (F4914) records by the Delivery Document 
Set Server program (XT4914).

cSuppressErrorMessages_SUPPSSUPPScharOPTINPUT

A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.        0 = allow 
runtime error message handling.        1 = suppress runtime error message handling.

szErrorMessageID_DTAIDTAIcharOPTOUTPUT

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

szProgramId_PIDPIDcharOPTINPUT

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry 
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. 
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the 
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a 
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are 
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry 
program.

szR1312Version_VERSVERScharOPTINPUT

A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined 
processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a 
menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.

Related Functions

None

Related Tables

None
F1310ProcessorClearWorkFile

F1310ProcessorClearWorkFile

Condition-Based Alerts Processor Master Business Function

Master Business Function

Object Name: B1301090

Parent DLL: CMFG

Location: Client/Server

Language: C

Data Structure

D1301090D - Condition-Based Alerts Processor - Clear Work File DS

Parameter NameData ItemData TypeReq/OptI/O/Both
mnJobNumber_JOBSJOBSMATH_NUMERICREQINPUT

The job number (work station ID) which executed the particular job.

cProcessEdits_EV01EV01charOPTINPUT

An option that specifies the type of processing for an event.

cErrorCode_ERRCERRCcharOPTOUTPUT

This error code indicates if any errors occurred during the creation of the Trip Document Detail (F4914) records by the Delivery Document 
Set Server program (XT4914).

cSuppressErrorMessages_SUPPSSUPPScharOPTINPUT

A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.        0 = allow 
runtime error message handling.        1 = suppress runtime error message handling.

szErrorMessageID_DTAIDTAIcharOPTOUTPUT

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

Related Functions

None

Related Tables

None
F1310ProcessorEditLine

F1310ProcessorEditLine

Condition-Based Alerts Processor Master Business Function

Master Business Function

Object Name: B1301090

Parent DLL: CMFG

Location: Client/Server

Language: C

Data Structure

D1301090B - Condition-Based Alerts Processor - Edit Line DS

Parameter NameData ItemData TypeReq/OptI/O/Both
mnJobNumber_JOBSJOBSMATH_NUMERICREQINPUT

The job number (work station ID) which executed the particular job.

cActionCode_ACTNACTNcharOPTINPUT

A code that specifies the action that is performed. Valid values are: A Add C Change

cProcessEdits_EV01EV01charOPTINPUT

An option that specifies the type of processing for an event.

cErrorCode_ERRCERRCcharOPTOUTPUT

This error code indicates if any errors occurred during the creation of the Trip Document Detail (F4914) records by the Delivery Document 
Set Server program (XT4914).

cSuppressErrorMessages_SUPPSSUPPScharOPTINPUT

A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.        0 = allow 
runtime error message handling.        1 = suppress runtime error message handling.

szErrorMessageID_DTAIDTAIcharOPTOUTPUT

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

mnWorkFileLineNumber_XLINXLINMATH_NUMERICOPTBOTH

Line number.

cRecordWrittenToWorkFile_EV01EV01charOPTBOTH

An option that specifies the type of processing for an event.

mnUniqueKeyIDInternal_UKIDUKIDMATH_NUMERICOPTINPUT

This field is a unique number used to identify a record in a file.

cAutoResponseTypeOverride_TYRPTYRPcharOPTINPUT

A code that indicates the type of automatic response required when a condition-based alert is entered in the Condition-Based Alerts table 
(F1310). Valid values are listed in UDC table 13/AR (Automatic Response Type). Valid values include: 1 No Automatic Response. This option 
allows the user to review the alert and manually trigger a response from the Condition-Based Alerts Workbench program (P1310). 2 Create 
Investigation Message. This option automatically creates an investigation message using information from the condition-based alert 
record. 3 Create WO from Model. This option automatically creates a work order using the model work order information from the condition-based 
alert record. 4 Update PM Schedule. This option automatically updates the Maintenance Schedule File table (F1207) using the asset number 
and service type information from the condition-based alert record. Note: To perform the automated response-type processing, you must run 
the Condition-Based Alerts Processor program (R1312).

cRecordBypassed_EV01EV01charOPTOUTPUT

An option that specifies the type of processing for an event.

Related Functions

None

Related Tables

None
F1310ProcessorEndDoc

F1310ProcessorEndDoc

Condition-Based Alerts Processor Master Business Function

Master Business Function

Object Name: B1301090

Parent DLL: CMFG

Location: Client/Server

Language: C

Data Structure

D1301090C - Condition-Based Alerts Processor - End Document DS

Parameter NameData ItemData TypeReq/OptI/O/Both
mnJobNumber_JOBSJOBSMATH_NUMERICREQINPUT

The job number (work station ID) which executed the particular job.

cActionCode_ACTNACTNcharOPTINPUT

A code that specifies the action that is performed. Valid values are: A Add C Change

cProcessEdits_EV01EV01charOPTINPUT

An option that specifies the type of processing for an event.

cInteractiveBatchFlag_EV01EV01charOPTINPUT

An option that specifies the type of processing for an event.

cErrorCode_ERRCERRCcharOPTOUTPUT

This error code indicates if any errors occurred during the creation of the Trip Document Detail (F4914) records by the Delivery Document 
Set Server program (XT4914).

cSuppressErrorMessages_SUPPSSUPPScharOPTINPUT

A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.        0 = allow 
runtime error message handling.        1 = suppress runtime error message handling.

szErrorMessageID_DTAIDTAIcharOPTOUTPUT

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

mnWorkFileLineNumber_XLINXLINMATH_NUMERICOPTINPUT

Line number.

mnPMUniqueID_PMUKIDPMUKIDMATH_NUMERICOPTOUTPUT

The unique ID from the Maintenance Schedule File table (F1207) that indicates the preventive maintenance schedule that was updated as 
a result of the alert.

mnAssignedWorkOrder_WONAWONAMATH_NUMERICOPTOUTPUT

The Work Order Number related to a particular Equipment Maintenance line item. The system assigns this number from next numbers.

cInvestigationMessageSent_SNDVSNDVcharOPTOUTPUT

A code that indicates whether an investigation message has been sent for a condition-based alert. Valid values are: 1 or Y The 
investigation message has been sent. 0 or N The investigation message has not been sent.

mnInvestigationRecipient_INVRINVRMATH_NUMERICOPTOUTPUT

An address book number that identifies the recipient of an alert investigation request. This number can be a single person or a distribution 
list. The system verifies this number against the Address Book.

szInvestigationStructType_ISTTISTTcharOPTOUTPUT

A code that identifies a type of organizational structure that has its own hierarchy in the Address Book system (for example, e-mail). Valid 
values are defined in user defined code table 01/TS.

Related Functions

None

Related Tables

None