F1310BeginDoc

F1310 Condition-Based Alerts Master Business Function

Master Business Function

Object Name: B1300950

Parent DLL: CMFG

Location: Client/Server

Language: C

Data Structure

D1300950A - F1310 Begin Document Data Structure

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.

szP1311Version_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.

cPOEquipmentNumberFormat_EV01EV01charOPTINPUT

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

Related Functions

None

Related Tables

None
F1310ClearWorkFile

F1310ClearWorkFile

F1310 Condition-Based Alerts Master Business Function

Master Business Function

Object Name: B1300950

Parent DLL: CMFG

Location: Client/Server

Language: C

Data Structure

D1300950D - F1310 Clear Work File

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
F1310EditLine

F1310EditLine

F1310 Condition-Based Alerts Master Business Function

Master Business Function

Object Name: B1300950

Parent DLL: CMFG

Location: Client/Server

Language: C

Data Structure

D1300950B - F1310 Edit Line Data Structure

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_NUMERICOPTNONE

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

szAssetNumberInput_ASIIASIIcharOPTNONE

An identification code that represents an asset. You enter the identification code in one of the following formats: 1 Asset number (a 
computer-assigned, 8-digit, numeric control number)   2 Unit number (a 12-character alphanumeric field)   3 Serial number (a 25-character alphanumeric 
field) Every asset has an asset number. You can use unit number and serial number to further identify assets. If this is a data entry field, the first 
character you enter indicates whether you are entering the primary (default) format that is defined for your system, or one of the other two 
formats. A special character (such as / or *) in the first position of this field indicates which asset number format you are using. You assign special 
characters to asset number formats on the fixed assets system constants form.

mnAssetItemNumber_NUMBNUMBMATH_NUMERICOPTNONE

An 8-digit number that uniquely identifies an asset.

szUnitNumber_APIDAPIDcharOPTNONE

A 12-character alphanumeric code used as an alternate identification number for an asset. This number is not required, nor does the 
system assign a number if you leave the field blank when you add an asset. If you use this number, it must be unique. For equipment, this is 
typically the serial number.

szSerialTagNumber_ASIDASIDcharOPTNONE

A 25-character alphanumeric number that you can use as an alternate asset identification number. You might use this number to track 
assets by the manufacturer's serial number. You are not required to use a serial number to identify an asset. Every serial number that you enter 
must be unique.

szProductModel_PRODMPRODMcharOPTNONE

A code that classifies an inventory item into a model for customer service. Some examples include: Laser Printer, Inkjet or Fax.

szMeasurementLocation_MELCMELCcharOPTNONE

A code that indicates a measurement location on a piece of equipment. You can use this code to indicate where a measurement is taken 
or where an alert originates on a piece of equipment. Enter a value from UDC table 13/LC (Measurement Location).

mnCustomerNumber_AN8AN8MATH_NUMERICOPTNONE

A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or 
location.

mnSiteNumber_LANOLANOMATH_NUMERICOPTNONE

The address book number for the lessor, renter, or lending institution.

szLocation_LOCLOCcharOPTNONE

The current physical location of an asset. The location must have a valid business unit or job number in the Business Unit Master table 
(F0006).

szEquipmentStatus_EQSTEQSTcharOPTNONE

A user defined code (12/ES) that identifies the equipment or disposal status of an asset, such as available, down, or disposed.

cTypeOfResponse_TYRPTYRPcharOPTNONE

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).

szServiceType_SRVTSRVTcharOPTNONE

A user defined code (12/ST) that describes the preventive maintenance service to be performed. Examples of codes include CLUTCH for 
adjust clutch, OIL for change oil, and 10H for 10 hour service.

mnModelWorkOrder_DOCODOCOMATH_NUMERICOPTNONE

A number that identifies an original document. This document can be a voucher, a sales order, an invoice, unapplied cash, a journal entry, 
and so on.

szAlertDescription_DL01DL01charOPTNONE

A user defined name or remark.

jdEventDate_EVTDTEVTDTJDEDATEOPTNONE

The date on which an event occurred, such as the date of a test reading or the date of a condition-based alarm.

mnEventTime_EVTTMEVTTMMATH_NUMERICOPTNONE

The time when an event occurred, such as the time of a test reading or the time of a condition-based alarm.

mnEventTimeUTC_EVTUTCEVTUTCMATH_NUMERICOPTNONE

The time of an event, based on the Universal Time Coordinate (UTC). UTC time refers to the number of seconds that have elapsed since 
midnight on January 1, 1970 in Greenwich, England.  Note: UTC Time was formerly called Greenwich Mean Time (GMT).

szTimeZone_TIMEZONESTIMEZONEScharOPTNONE

Choose the time zone for which you want to view the date and time.

szDaylightSavingsRule_DSAVNAMEDSAVNAMEcharOPTNONE

Unique name identifying a daylight savings rule. Use daylight savings rules to adjust time for a geographic and political locale.

szTestID_QTSTQTSTcharOPTNONE

The unique identification for a test to be performed on an item. For example:    COL Color test    DENS Density Test    CL-2   Clarity Test 

szSpecification_QSPCQSPCcharOPTNONE

The unique identification for a set of tests which need to be performed together. For example:        F-156 - FDA Specification 156        SP34 - 
Specification 34

szTestSpecDescription_DSC1DSC1charOPTNONE

Brief information about an item; a remark or an explanation.

szTestValue_QVALQVALcharOPTNONE

The result of the performed test.

cPassFailFlag_QPFQPFcharOPTNONE

The value which identifies whether the test passed (P) or failed (F).

cTestOverrideFlag_TOVRTOVRcharOPTNONE

The flag which designates whether a test has been overridden. Valid values are:    1   overridden    0   not overridden 

mnTester_ANOANOMATH_NUMERICOPTNONE

The address book number of the person who originated the change request. The system verifies this number against the Address Book.

cAlertLevel_PDFLPDFLcharOPTNONE

A code that indicates the functional status of a piece of equipment, as assessed by a condition-based maintenance system. For 
maintenance schedules that are condition-based, the preventive maintenance system uses this code to determine whether maintenance is due. Enter 
a valid value from UDC table 13/AL (Alert Level).

cDataQuality_DQLTDQLTcharOPTNONE

A code that indicates the expected quality of data. Enter a value from UDC 13/DQ (Data Quality). Valid values include: Blank Data Quality 
Unknown 1 Data Inspected - Good 2 Data Inspected - Under Review 3 Data Inspected - Bad

jdDatePlannedToStart_PNSTPNSTJDEDATEOPTNONE

The date when the item or line of work is to start.

mnPMUniqueID_PMUKIDPMUKIDMATH_NUMERICOPTNONE

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_NUMERICOPTNONE

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

cSendNotificationMessage_SNDNSNDNcharOPTNONE

A code that specifies whether a notification message is sent when a condition-based alert is entered into the system. Valid values are: 1 or 
Y Send a notification message. 0 or N Do not send a notification message.

mnNotificationRecipient_NOTRNOTRMATH_NUMERICOPTNONE

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

szNotificationStructType_NSTTNSTTcharOPTNONE

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. 

cAlertStatus_ASTCASTCcharOPTNONE

A code that indicates the status of a condition-based alert. Valid values are listed in user defined code (UDC) 13/AS (Alert Status).

mnInvestigationRecipient_INVRINVRMATH_NUMERICOPTNONE

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_ISTTISTTcharOPTNONE

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.

cInvestigationMessageSent_SNDVSNDVcharOPTNONE

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.

cInvestigationCompleted_IVCPIVCPcharOPTNONE

A code that indicates whether the investigation process has been completed for the condition-based alert. Valid values are: 1 or 
Y Investigation has been completed. 0 or N Investigation has not been completed.

szProblemDescription_ISSUEISSUEcharOPTNONE

A description of the customer issue.

mnTimeScheduledStart_SESTSESTMATH_NUMERICOPTNONE

The time of day that an activity is scheduled to begin. The start time is calculated by the constraints based planning system.

mnScheduledStartUTC_SCHSTTIMESCHSTTIMEMATH_NUMERICOPTNONE

The start time of the job based on Universal Time Coordinate (UTC) Time. UTC Time is the number of seconds elapsed since Midnight on 
January 1, 1970 in Greenwich, England. UTC Time used to be called Greenwich Mean (GM) Time.

szReference1_VR01VR01charOPTNONE

An alphanumeric value used as a cross-reference or secondary reference number. Typically, this is the customer number, supplier 
number, or job number.

szReference2Vendor_VR02VR02charOPTNONE

A field available to record reference numbers, such as the supplier's bid document number, quote document, sales order, work order, or 
job number.

szContactName_WHO2WHO2charOPTNONE

The name of the caller, customer, or other contact.

szPhoneAreaCode_AR1AR1charOPTNONE

The first segment of a telephone number. In the United States, the prefix is the three-digit area code.

szPhoneNumber_PHN1PHN1charOPTNONE

szAddressLine1_ADD1ADD1charOPTNONE

The first line of a mailing address for an employee, customer, or supplier in the Address Book system. The U.S. Internal Revenue Service 
(IRS) restricts the size of the address that prints on an employee's year-end tax return. To comply with IRS regulations, the system has the 
following restrictions:   o  On W-2 returns, the system prints only the last three nonblank address lines plus the city, state, and postal code.   o  On 
1099 returns, the system prints only the last nonblank address line plus the city, state, and postal code.   o  On other U.S. federal magnetic 
media, the system prints only the last nonblank address line plus the city, state, and postal code.

szAddressLine2_ADD2ADD2charOPTNONE

The second line of the mailing address for an employee, customer, or supplier in the Address Book system. Attention Payroll users: The 
Internal Revenue Service (IRS) restricts the size of the address that prints on employee's year-end forms. To comply with IRS regulations, the 
address that prints on W-2 forms includes only the last three nonblank address lines plus the city, state, and postal code. The address that 
prints on 1099 forms includes only the last nonblank address line plus the city, state, and postal code. If you process year-end information using 
the federal magnetic media format, the address that prints on those forms contains only the last nonblank address line plus the city, state, 
and postal code.

szAddressLine3_ADD3ADD3charOPTNONE

The third line of the mailing address for an employee, customer, or supplier in the Address Book system. Attention Payroll users: The 
Internal Revenue Service (IRS) restricts the size of the address that prints on employee's year-end forms. To comply with IRS regulations, the 
address that prints on W-2 forms includes only the last three nonblank address lines plus the city, state, and postal code. The address that prints 
on 1099 forms includes only the last nonblank address line plus the city, state, and postal code. If you process year-end information using 
the federal magnetic media format, the address that prints on those forms contains only the last nonblank address line plus the city, state, and 
postal code.

szAddressLine4_ADD4ADD4charOPTNONE

The fourth line of the mailing address for an employee, customer, or supplier in the Address Book system. Attention Payroll users: The 
Internal Revenue Service (IRS) restricts the size of the address that prints on employee's year-end forms. To comply with IRS regulations, the 
address that prints on W-2 forms includes only the last three nonblank address lines plus the city, state, and postal code. The address that 
prints on 1099 forms includes only the last nonblank address line plus the city, state, and postal code. If you process year-end information using 
the federal magnetic media format, the address that prints on those forms contains only the last nonblank address line plus the city, state, and 
postal code.

szCity_CTY1CTY1charOPTNONE

A name that indicates the city associated with the address.

szState_ADDSADDScharOPTNONE

A user defined code (00/S) that specifies the state or province. This code is usually a postal service abbreviation.

szZipCodePostal_ADDZADDZcharOPTNONE

The United States ZIP code or the postal code that specifies where a letter is to be routed.  Attach this code to the address for delivery in 
other countries. This code is used as the low end value when doing Postal Code Transaction range processing.

szCountyAddress_COUNCOUNcharOPTNONE

The name of a county, parish, or other political district that is necessary for the address or for tax purposes.

szCountry_CTRCTRcharOPTNONE

A user defined code (00/CN) that identifies a country. The country code has no effect on currency conversion. The Address Book system 
uses the country code for data selection and address formatting.

mnUserReservedNumber_URABURABMATH_NUMERICOPTNONE

This is a 8 position code that is reserved for the user.  JDE does not currently use this field and will not utilize this field in the future.

mnUserReservedAmount_URATURATMATH_NUMERICOPTNONE

This is a 15 position code that is reserved for the user.  JDE does not currently use this field and will not utilize this field in the future.

szUserReservedCode_URCDURCDcharOPTNONE

This is a 2 position code that is reserved for the user.  JDE does not currently use this field and will not utilize this field in the future.

jdUserReservedDate_URDTURDTJDEDATEOPTNONE

This is a 6 position code that is reserved for the user.  JDE does not currently use this field and will not utilize this field in the future.

szUserReservedReference_URRFURRFcharOPTNONE

A 15-position reference that is reserved for the user.  J.D. Edwards does not currently use this field and does not plan to use it in the future.

cCBUserReservedChar01_CBURCH1CBURCH1charOPTNONE

A code that indicates a user defined value. You can define the use and description of this field to fit the needs of your organization.

cCBUserReservedChar02_CBURCH2CBURCH2charOPTNONE

 A code that indicates a user defined value. You can define the use and description of this field to fit the needs of your organization.

jdCBUserReservedDate01_CBURDT1CBURDT1JDEDATEOPTNONE

A code that indicates a user defined value. You can define the use and description of this field to fit the needs of your organization.

jdCBUserReservedDate02_CBURDT2CBURDT2JDEDATEOPTNONE

A code that indicates a user defined date. You can define the use and description of this field to fit the needs of your organization.

mnCBUserResNumeric01_CBURMN1CBURMN1MATH_NUMERICOPTNONE

A number that indicates a user defined value. You can define the use and description of this field to fit the needs of your organization.

mnCBUserResNumeric02_CBURMN2CBURMN2MATH_NUMERICOPTNONE

A number that indicates a user defined value. You can define the use and description of this field to fit the needs of your organization.

mnCBUserResNumber01_CBURAB1CBURAB1MATH_NUMERICOPTNONE

A number that indicates a specific use and description for the organization, based on user defined information.

mnCBUserResNumber02_CBURAB2CBURAB2MATH_NUMERICOPTNONE

A number that indicates a specific use and description for the organization based on user defined information.

szCBUserResString01_CBURST1CBURST1charOPTNONE

A code that indicates a user defined alphanumeric value. You can define the use and description of this field to fit the needs of your 
organization.

szCBUserResString02_CBURST2CBURST2charOPTNONE

A code that indicates a user defined alphanumeric value. You can define the use and description of this field to fit the needs of your 
organization.

szCBUserResString03_CBURST3CBURST3charOPTNONE

A code that indicates a user defined alphanumeric value. You can define the use and description of this field to fit the needs of your 
organization.

szCBUserResString04_CBURST4CBURST4charOPTNONE

A code that indicates a user defined alphanumeric value. You can define the use and description of this field to fit the needs of your 
organization.

szCBUserResString05_CBURST5CBURST5charOPTNONE

A code that indicates a user defined alphanumeric value. You can define the use and description of this field to fit the needs of your 
organization.

szCBUserResString06_CBURST6CBURST6charOPTNONE

A code that indicates a user defined alphanumeric value. You can define the use and description of this field to fit the needs of your 
organization.

szCBUserResString07_CBURST7CBURST7charOPTNONE

A code that indicates a user defined alphanumeric value. You can define the use and description of this field to fit the needs of your 
organization.

szCBUserResString08_CBURST8CBURST8charOPTNONE

A code that indicates a user defined alphanumeric value. You can define the use and description of this field to fit the needs of your 
organization.

szCBUserResString09_CBURST9CBURST9charOPTNONE

A code that indicates a user defined alphanumeric value. You can define the use and description of this field to fit the needs of your 
organization.

szCBUserResString10_CBURST0CBURST0charOPTNONE

A code that indicates a user defined alphanumeric value. You can define the use and description of this field to fit the needs of your 
organization.

Related Functions

None

Related Tables

None
F1310EndDoc

F1310EndDoc

F1310 Condition-Based Alerts Master Business Function

Master Business Function

Object Name: B1300950

Parent DLL: CMFG

Location: Client/Server

Language: C

Data Structure

D1300950C - F1310 End Document Data Structure

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.

mnF1310UniqueID_UKIDUKIDMATH_NUMERICOPTOUTPUT

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

Related Functions

None

Related Tables

None