PPATRetrieveHeaderAndDetail

PPAT Retrieve Header and Detail

Minor Business Rule

Object Name: B0200022

Parent DLL: CFIN

Location: Client/Server

Language: C

Notes
^

Data Structure

D0200021 - PPAT Retrieve F01131 and F01133

Parameter Name Data Item Data Type Req/Opt I/O/Both

mnKeyvalueserialnumber SERK MATH_NUMERIC NONE NONE

A key identification number used internally to identify a composite key structure.  The actual key items must be stored in another file and
given this serial number.  This is to avoid repeating a very large key structure with repeating data items.

mnAddressnumber AN8 MATH_NUMERIC NONE NONE

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

szNamealpha ALPH char NONE NONE

The text that names or describes an address. This 40-character alphabetic field appears on a number of forms and reports. You can enter
dashes, commas, and other special characters, but the system cannot search on them when you use this field to search for a name.

szCallfrom SFRM char NONE NONE

From whom the E-mail or Internet message was sent.

szCallfromcompany CCO char NONE NONE

The associated company name of the individual who is sending the message.

szAallfromphone CPH char NONE NONE

The phone number of the individual who is sending the message.

szMailboxdesignator MBDS char NONE NONE

A field that determines the mailbox associated with the queue that should be used on delivery of the message.

jdDatetickler DTI JDEDATE NONE NONE

The date an activity was performed or, for promise activities, the reminder date.

jdDateupdated UPMJ JDEDATE NONE NONE

The date that specifies the last update to the file record.

mnTimelastupdated UPMT MATH_NUMERIC NONE NONE

The time that specifies when the program executed the last update to this record.

szWorkstationid JOBN char NONE NONE

The code that identifies the work station ID that executed a particular job.

mnSequencenumber52display DSS5 MATH_NUMERIC NONE NONE

A number that specifies the order of a group of records on the form.

szPpatbriefmassage MSGP char NONE NONE

This is a short description or subject of the message.

mnAddressnumberparent PA8 MATH_NUMERIC NONE NONE

The address book number of the parent company. The system uses this number to associate a particular address with a parent company
or location. Any value that you enter in this field updates the Address Organizational Structure Master table (F0150) for the blank structure
type. This address number must exist in the Address Book Master table (F0101) for validation purposes. Examples of address book records
that would have a parent number include:   o  Subsidiaries with parent companies     o  Branches with a home office     o  Job sites with a general
contractor

szCategorycodeppat01 MB01 char NONE NONE

One of two reporting codes that you can assign to a message in the E-mail system.

szCategorycodeppat02 MB02 char NONE NONE

One of two reporting codes that you can assign to a message in the E-mail system.

cMessagetype1 TCNT char NONE NONE

A code used to classify types of messages. For example:    I    Internal Message - entering message of this type does not remove customer
from credit or collection review.    P   Promises, Promises Message.    F   Other Promises, Promises Message - a secondary classification of
Promises, Promises messages.    1   Call Tracking Message If using Promises, Promises, you might want the default to be P, so that you can
print your reports using this code.

cMessagetype2 CMPR char NONE NONE

A code that classifies the type of messages. For example:    S Direct Sale    D Distributor Sale

cMessagetype3 MSG char NONE NONE

A user defined code (01/MT) that specifies speed messages in the Electronic Mail system. When a Speed Message Type code is
entered on Message View/Entry,the code's description is automatically added as the message text. Examples are, "Please call back" or
"Returned your call".

szUserid USER char NONE NONE

The code that identifies a user profile.

szProgramid PID char NONE NONE

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.

cActionmessagecontrol MSGA char NONE NONE

A code to indicate which messages should be displayed. A Y code will display all messages, including those that have been cleared or
processed, but not those already deleted. Any value other than Y will display current messages only.

mnTimeentered ENTT MATH_NUMERIC NONE NONE

The machine system time a particular Inventory count value was entered into the system.  Captured automatically by the program.   Also
used by the Time Log feature of the Electronic Mail system.

cStatuselectronicmailmess STSM char NONE NONE

Indicates the current status of the mail message.    1   Revised - The message has been edited.    2   Unopened   - The message has not
been viewed.    3   Opened  - The message has been viewed.    4   Archived - The message has been archived.    B  Marked for Deletion - The
message has been moved to the deleted queue and may be purged (R01131P).

szPhoneextension PXT1 char NONE NONE

The phone extension of the person leaving the message.

szBasemembername BASE char NONE NONE

The RPG name associated with the particular object. For data files, enter the based on physical file. For physical and logical files, the
name is the same as the physical file name. For join files, use the name of one of the physical files. For file servers the Base Member is always
X98SRV with an install system code of 98.

szSystemcode SY char NONE NONE

A user defined code (98/SY) that identifies a system. Valid values include: 01 Address Book 03B Accounts Receivable 04 Accounts
Payable 09 General Accounting 11 Multicurrency

mnDocumentorderinvoicee DOCO MATH_NUMERIC NONE NONE

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.

szOrdersuffix SFXO char NONE NONE

In the A/R and A/P systems, a code that corresponds to the pay item. In the Sales Order and Procurement systems, this code identifies
multiple transactions for an original order. For purchase orders, the code is always 000. For sales orders with multiple partial receipts against an
order, the first receiver used to record receipt has a suffix of 000, the next has a suffix of 001, the next 002, and so on.

szOrdertype DCTO char NONE NONE

A user defined code (00/DT) that identifies the type of document. This code also indicates the origin of the transaction. J.D. Edwards has
reserved document type codes for vouchers, invoices, receipts, and time sheets, which create automatic offset entries during the post
program. (These entries are not self-balancing when you originally enter them.) The following document types are defined by J.D. Edwards and
should not be changed: P Accounts Payable documents   R Accounts Receivable documents   T Payroll documents   I Inventory documents
O Purchase Order Processing documents   J General Accounting/Joint Interest Billing documents   S Sales Order Processing documents

mnLinenumber LNID MATH_NUMERIC NONE NONE

A number that identifies multiple occurrences, such as line numbers on a purchase order or other document. Generally, the system assigns
this number,but in some cases you can override it.

szCompanykeyorderno KCOO char NONE NONE

A number that, along with order number and order type, uniquely identifies an order document (such as a purchase order, a contract, a
sales order, and so on). If you use the Next Numbers by Company/Fiscal Year facility, the Automatic Next Numbers program (X0010) uses the
order company to retrieve the correct next number for that company. If two or more order documents have the same order number and order
type, the order company lets you locate the desired document. If you use the regular Next Numbers facility, the order company is not used to
assign a next number. In this case, you probably would not use the order company to locate the document.

szTemplateid TMPI char NONE NONE

Used to indicate which data dictionary item will be used in a variable string substitution.  The values which will be substituted into the
Template ID will be stored in Template Values (TSV).

cMisccode3 AB3 char NONE NONE

Future.

mnLevelindented LV MATH_NUMERIC NONE NONE

A number indicating the level of a child in the relationship to its parent in a hierarchy.

mnKeyvalueserialnumber_A PSRK MATH_NUMERIC NONE NONE

A key identification number used internally to identify a composite key structure.  The actual key items must be stored in another file and
given this serial number.  This is to avoid repeating a very large key structure with repeating data items.

szVersion VERS char NONE NONE

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.

szApplicationid EAP char NONE NONE

The ID that the system uses to call an application.

mnF3Addressnumber_A AN8 MATH_NUMERIC NONE NONE

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

szF3Namealpha_A ALPH char NONE NONE

The text that names or describes an address. This 40-character alphabetic field appears on a number of forms and reports. You can enter
dashes, commas, and other special characters, but the system cannot search on them when you use this field to search for a name.

szF3Mailboxdesignator_A MBDS char NONE NONE

A field that determines the mailbox associated with the queue that should be used on delivery of the message.

jdF3Datetickler_A DTI JDEDATE NONE NONE

The date an activity was performed or, for promise activities, the reminder date.

cF3Commandflagppat CMDF char NONE NONE

This field will indicate whether the text that is found in the PPAT text file (F01132) is message text, or is an executable command string.  If the
text is an executable command string then the text will not display in the PPAT message.

cF3Statuselectronicmailmess_A STSM char NONE NONE

Indicates the current status of the mail message.    1   Revised - The message has been edited.    2   Unopened   - The message has not
been viewed.    3   Opened  - The message has been viewed.    4   Archived - The message has been archived.    B  Marked for Deletion - The
message has been moved to the deleted queue and may be purged (R01131P).

mnF3Sequencenumber52display_A DSS5 MATH_NUMERIC NONE NONE

A number that specifies the order of a group of records on the form.

cF3Actionmessagecontrol_A MSGA char NONE NONE

A code to indicate which messages should be displayed. A Y code will display all messages, including those that have been cleared or
processed, but not those already deleted. Any value other than Y will display current messages only.

cF3Misccode3_A AB3 char NONE NONE

Future.

mnF3Timelastupdated_A UPMT MATH_NUMERIC NONE NONE

The time that specifies when the program executed the last update to this record.

cFileRetrieve EV01 char NONE NONE

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

Related Functions

None

Related Tables

F01131 PPAT Message Control File

F01133 PPAT Message Detail File

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnKeyvalueserialnumber	SERK	MATH_NUMERIC	NONE	NONE
A key identification number used internally to identify a composite key structure. The actual key items must be stored in another file and given this serial number. This is to avoid repeating a very large key structure with repeating data items.
mnAddressnumber	AN8	MATH_NUMERIC	NONE	NONE
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or location.
szNamealpha	ALPH	char	NONE	NONE
The text that names or describes an address. This 40-character alphabetic field appears on a number of forms and reports. You can enter dashes, commas, and other special characters, but the system cannot search on them when you use this field to search for a name.
szCallfrom	SFRM	char	NONE	NONE
From whom the E-mail or Internet message was sent.
szCallfromcompany	CCO	char	NONE	NONE
The associated company name of the individual who is sending the message.
szAallfromphone	CPH	char	NONE	NONE
The phone number of the individual who is sending the message.
szMailboxdesignator	MBDS	char	NONE	NONE
A field that determines the mailbox associated with the queue that should be used on delivery of the message.
jdDatetickler	DTI	JDEDATE	NONE	NONE
The date an activity was performed or, for promise activities, the reminder date.
jdDateupdated	UPMJ	JDEDATE	NONE	NONE
The date that specifies the last update to the file record.
mnTimelastupdated	UPMT	MATH_NUMERIC	NONE	NONE
The time that specifies when the program executed the last update to this record.
szWorkstationid	JOBN	char	NONE	NONE
The code that identifies the work station ID that executed a particular job.
mnSequencenumber52display	DSS5	MATH_NUMERIC	NONE	NONE
A number that specifies the order of a group of records on the form.
szPpatbriefmassage	MSGP	char	NONE	NONE
This is a short description or subject of the message.
mnAddressnumberparent	PA8	MATH_NUMERIC	NONE	NONE
The address book number of the parent company. The system uses this number to associate a particular address with a parent company or location. Any value that you enter in this field updates the Address Organizational Structure Master table (F0150) for the blank structure type. This address number must exist in the Address Book Master table (F0101) for validation purposes. Examples of address book records that would have a parent number include: o Subsidiaries with parent companies o Branches with a home office o Job sites with a general contractor
szCategorycodeppat01	MB01	char	NONE	NONE
One of two reporting codes that you can assign to a message in the E-mail system.
szCategorycodeppat02	MB02	char	NONE	NONE
One of two reporting codes that you can assign to a message in the E-mail system.
cMessagetype1	TCNT	char	NONE	NONE
A code used to classify types of messages. For example: I Internal Message - entering message of this type does not remove customer from credit or collection review. P Promises, Promises Message. F Other Promises, Promises Message - a secondary classification of Promises, Promises messages. 1 Call Tracking Message If using Promises, Promises, you might want the default to be P, so that you can print your reports using this code.
cMessagetype2	CMPR	char	NONE	NONE
A code that classifies the type of messages. For example: S Direct Sale D Distributor Sale
cMessagetype3	MSG	char	NONE	NONE
A user defined code (01/MT) that specifies speed messages in the Electronic Mail system. When a Speed Message Type code is entered on Message View/Entry,the code's description is automatically added as the message text. Examples are, "Please call back" or "Returned your call".
szUserid	USER	char	NONE	NONE
The code that identifies a user profile.
szProgramid	PID	char	NONE	NONE
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.
cActionmessagecontrol	MSGA	char	NONE	NONE
A code to indicate which messages should be displayed. A Y code will display all messages, including those that have been cleared or processed, but not those already deleted. Any value other than Y will display current messages only.
mnTimeentered	ENTT	MATH_NUMERIC	NONE	NONE
The machine system time a particular Inventory count value was entered into the system. Captured automatically by the program. Also used by the Time Log feature of the Electronic Mail system.
cStatuselectronicmailmess	STSM	char	NONE	NONE
Indicates the current status of the mail message. 1 Revised - The message has been edited. 2 Unopened - The message has not been viewed. 3 Opened - The message has been viewed. 4 Archived - The message has been archived. B Marked for Deletion - The message has been moved to the deleted queue and may be purged (R01131P).
szPhoneextension	PXT1	char	NONE	NONE
The phone extension of the person leaving the message.
szBasemembername	BASE	char	NONE	NONE
The RPG name associated with the particular object. For data files, enter the based on physical file. For physical and logical files, the name is the same as the physical file name. For join files, use the name of one of the physical files. For file servers the Base Member is always X98SRV with an install system code of 98.
szSystemcode	SY	char	NONE	NONE
A user defined code (98/SY) that identifies a system. Valid values include: 01 Address Book 03B Accounts Receivable 04 Accounts Payable 09 General Accounting 11 Multicurrency
mnDocumentorderinvoicee	DOCO	MATH_NUMERIC	NONE	NONE
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.
szOrdersuffix	SFXO	char	NONE	NONE
In the A/R and A/P systems, a code that corresponds to the pay item. In the Sales Order and Procurement systems, this code identifies multiple transactions for an original order. For purchase orders, the code is always 000. For sales orders with multiple partial receipts against an order, the first receiver used to record receipt has a suffix of 000, the next has a suffix of 001, the next 002, and so on.
szOrdertype	DCTO	char	NONE	NONE
A user defined code (00/DT) that identifies the type of document. This code also indicates the origin of the transaction. J.D. Edwards has reserved document type codes for vouchers, invoices, receipts, and time sheets, which create automatic offset entries during the post program. (These entries are not self-balancing when you originally enter them.) The following document types are defined by J.D. Edwards and should not be changed: P Accounts Payable documents R Accounts Receivable documents T Payroll documents I Inventory documents O Purchase Order Processing documents J General Accounting/Joint Interest Billing documents S Sales Order Processing documents
mnLinenumber	LNID	MATH_NUMERIC	NONE	NONE
A number that identifies multiple occurrences, such as line numbers on a purchase order or other document. Generally, the system assigns this number,but in some cases you can override it.
szCompanykeyorderno	KCOO	char	NONE	NONE
A number that, along with order number and order type, uniquely identifies an order document (such as a purchase order, a contract, a sales order, and so on). If you use the Next Numbers by Company/Fiscal Year facility, the Automatic Next Numbers program (X0010) uses the order company to retrieve the correct next number for that company. If two or more order documents have the same order number and order type, the order company lets you locate the desired document. If you use the regular Next Numbers facility, the order company is not used to assign a next number. In this case, you probably would not use the order company to locate the document.
szTemplateid	TMPI	char	NONE	NONE
Used to indicate which data dictionary item will be used in a variable string substitution. The values which will be substituted into the Template ID will be stored in Template Values (TSV).
cMisccode3	AB3	char	NONE	NONE
Future.
mnLevelindented	LV	MATH_NUMERIC	NONE	NONE
A number indicating the level of a child in the relationship to its parent in a hierarchy.
mnKeyvalueserialnumber_A	PSRK	MATH_NUMERIC	NONE	NONE
A key identification number used internally to identify a composite key structure. The actual key items must be stored in another file and given this serial number. This is to avoid repeating a very large key structure with repeating data items.
szVersion	VERS	char	NONE	NONE
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.
szApplicationid	EAP	char	NONE	NONE
The ID that the system uses to call an application.
mnF3Addressnumber_A	AN8	MATH_NUMERIC	NONE	NONE
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or location.
szF3Namealpha_A	ALPH	char	NONE	NONE
The text that names or describes an address. This 40-character alphabetic field appears on a number of forms and reports. You can enter dashes, commas, and other special characters, but the system cannot search on them when you use this field to search for a name.
szF3Mailboxdesignator_A	MBDS	char	NONE	NONE
A field that determines the mailbox associated with the queue that should be used on delivery of the message.
jdF3Datetickler_A	DTI	JDEDATE	NONE	NONE
The date an activity was performed or, for promise activities, the reminder date.
cF3Commandflagppat	CMDF	char	NONE	NONE
This field will indicate whether the text that is found in the PPAT text file (F01132) is message text, or is an executable command string. If the text is an executable command string then the text will not display in the PPAT message.
cF3Statuselectronicmailmess_A	STSM	char	NONE	NONE
Indicates the current status of the mail message. 1 Revised - The message has been edited. 2 Unopened - The message has not been viewed. 3 Opened - The message has been viewed. 4 Archived - The message has been archived. B Marked for Deletion - The message has been moved to the deleted queue and may be purged (R01131P).
mnF3Sequencenumber52display_A	DSS5	MATH_NUMERIC	NONE	NONE
A number that specifies the order of a group of records on the form.
cF3Actionmessagecontrol_A	MSGA	char	NONE	NONE
A code to indicate which messages should be displayed. A Y code will display all messages, including those that have been cleared or processed, but not those already deleted. Any value other than Y will display current messages only.
cF3Misccode3_A	AB3	char	NONE	NONE
Future.
mnF3Timelastupdated_A	UPMT	MATH_NUMERIC	NONE	NONE
The time that specifies when the program executed the last update to this record.
cFileRetrieve	EV01	char	NONE	NONE
An option that specifies the type of processing for an event.

F01131 PPAT Message Control File
F01133 PPAT Message Detail File