UpdateSupplementalData

Supplemental Database API

Major Business Rule

Object Name: N0000158

Parent DLL: COPBASE

Location: Client/Server

Language: NER

Data Structure

D0000158A - Update Supplemental Data

Parameter NameData ItemData TypeReq/OptI/O/Both
szSupplementalDatabaseCodeSDBcharNONENONE

A user defined code (00/SD) that sets up databases for groups of related supplemental data types. This code differentiates the 
supplemental data types for various systems. For example, the Employee (E) supplemental database contains data types that you use to track 
additional employee information, such as education and job skills.

cActionCodeACTNcharNONENONE

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

szBusinessUnitMCUcharNONENONE

An alphanumeric code that identifies a separate entity within a business for which you want to track costs. For example, a business unit 
might be a warehouse location, job, project, work center, branch, or plant. You can assign a business unit to a document, entity, or person for 
purposes of responsibility reporting. For example, the system provides reports of open accounts payable and accounts receivable by 
business unit to track equipment by responsible department. Business unit security might prevent you from viewing information about business units 
for which you have no authority.

szKeyCompanyKCOcharNONENONE

A number that, with the document number, document type and G/L date, uniquely identifies an original document, such as invoice, voucher, 
or journal entry. If you use the Next Numbers by Company/Fiscal Year feature, the Automatic Next Numbers program (X0010) uses the 
document company to retrieve the correct next number for that company. If two or more original documents have the same document number and 
document type, you can use the document company to locate the desired document.

mnNumericKey1SBN1MATH_NUMERICNONENONE

This field specifies one of the numeric keys to the Generic Supplemental Database. You can select the key from a list of supported data 
items, such as Address Number, Account ID, Asset ID, Item Number, and so on.

mnNumericKey2SBN2MATH_NUMERICNONENONE

This field specifies one of the numeric keys to the Generic Supplmental Database.  The key may be selected from a list of supported data 
items such as address book, Account ID, Asset ID, Item Number etc.

szAlphaKey1SBA1charNONENONE

This field specifies one of the alphanumeric keys to the Generic Supplmental Database.  The key may be selected from a list of supported 
data items such as Job Number, Job Type, Document Type etc

szAlphaKey2SBA2charNONENONE

This field specifies one of the alphanumeric keys to the Generic Supplmental Database.  The key may be selected from a list of supported 
data items such as Job Number, Job Type, Document Type etc

szDataTypeTYDTcharNONENONE

A code that you assign to supplemental data so that you can group data by categories. Valid values include: A Approval steps B Requisition 
requirements C Interview process N Requisition notes

szCopyToBusinessUnitMCUcharNONENONE

An alphanumeric code that identifies a separate entity within a business for which you want to track costs. For example, a business unit 
might be a warehouse location, job, project, work center, branch, or plant. You can assign a business unit to a document, entity, or person for 
purposes of responsibility reporting. For example, the system provides reports of open accounts payable and accounts receivable by 
business unit to track equipment by responsible department. Business unit security might prevent you from viewing information about business units 
for which you have no authority.

szCopyToKeyCompanyKCOcharNONENONE

A number that, with the document number, document type and G/L date, uniquely identifies an original document, such as invoice, voucher, 
or journal entry. If you use the Next Numbers by Company/Fiscal Year feature, the Automatic Next Numbers program (X0010) uses the 
document company to retrieve the correct next number for that company. If two or more original documents have the same document number and 
document type, you can use the document company to locate the desired document.

mnCopyToNumericKey1SBN1MATH_NUMERICNONENONE

This field specifies one of the numeric keys to the Generic Supplemental Database. You can select the key from a list of supported data 
items, such as Address Number, Account ID, Asset ID, Item Number, and so on.

mnCopyToNumericKey2SBN2MATH_NUMERICNONENONE

This field specifies one of the numeric keys to the Generic Supplmental Database.  The key may be selected from a list of supported data 
items such as address book, Account ID, Asset ID, Item Number etc.

szCopyToAlphanumericKey1SBA1charNONENONE

This field specifies one of the alphanumeric keys to the Generic Supplmental Database.  The key may be selected from a list of supported 
data items such as Job Number, Job Type, Document Type etc

szCopyToAlphanumericKey2SBA2charNONENONE

This field specifies one of the alphanumeric keys to the Generic Supplmental Database.  The key may be selected from a list of supported 
data items such as Job Number, Job Type, Document Type etc

szCopyToDataTypeTYDTcharNONENONE

A code that you assign to supplemental data so that you can group data by categories. Valid values include: A Approval steps B Requisition 
requirements C Interview process N Requisition notes

szUserDefinedCodeValueKYcharNONENONE

A list of valid codes for a specific user defined code list.

szUDCAssociatedDescriptionDL01charNONENONE

A user defined name or remark.

jdEffectiveDateEFTJDEDATENONENONE

The date that identifies when a date is first valid. The effective date is used generically. It can be a lease effective date, a price or cost 
effective date, a currency effective date, a tax rate effective date, or whatever is appropriate.

jdEndingEffectiveDateEFTEJDEDATENONENONE

The date on which the item, transaction, or table becomes inactive, or through which you want transactions to appear. This field is used 
generically throughout the system. It could be a lease effective date, a price or cost effective date, a currency effective date, a tax rate effective 
date, or whatever is appropriate.

jdTickleDateTKDTJDEDATENONENONE

A date that requires some kind of action, such as when an option ends or an inspection is due.

mnUserDefinedAmount1AMTUMATH_NUMERICNONENONE

A quantity that represents the statistical or measurable information related to the code that is defined for the data type. For example, if the 
data type relates to bid submittal codes, this field could be for bid amounts. Or, if the data type relates to Human Resources Benefits 
Administration, this field could be for the cost of election coverage. If the data type relates to bonuses, this could be the bonus amount.

mnUserDefinedAmount2AMTVMATH_NUMERICNONENONE

The second Amount associated with the code defined for this Supplemental Data Type. For example, if you have a stock option plan, you 
could track the number of shares in User Defined Amount and the strike price in User Defined # 2.

szRemark1RMKcharNONENONE

A generic field that you use for a remark, description, name, or address.

szRemark2RMK2charNONENONE

A generic field that you use for a remark, description, name, or address.

mnUserDefinedDaysDYUDMATH_NUMERICNONENONE

The days associated with the code defined for this supplemental data type. For example, engineering change order leadtime days 
represent an association.

mnUserDefinedAddressNumberAN8MATH_NUMERICNONENONE

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

jdUserDefinedDateUPDJJDEDATENONENONE

A date that can be used with supplemental data information. For example, you can enter a verification date in this field to show when 
information was last reviewed and possibly updated.

szUserIDUSERcharNONENONE

The code that identifies a user profile.

szProgramIDPIDcharNONENONE

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.

cSuppressErrorMessageSUPPScharNONENONE

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.

szErrorMessageIDDTAIcharNONENONE

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.

mnUserDefinedQuantityUORGMATH_NUMERICNONENONE

The quantity of units affected by this transaction.

szCopyToSuppDatabaseCodeSDBcharNONENONE

A user defined code (00/SD) that sets up databases for groups of related supplemental data types. This code differentiates the 
supplemental data types for various systems. For example, the Employee (E) supplemental database contains data types that you use to track 
additional employee information, such as education and job skills.

szRelatedPoSoNumberRORNcharNONENONE

A number that identifies a secondary purchase order, sales order, or work order that is associated with the original order. This number is for 
informational purposes only.

szRelatedOrderTypeRCTOcharNONENONE

A user defined code (system 00, type DT) that indicates the document type of the secondary or related order. For example, a purchase 
order might be document type OP and might have been created to fill a related work order with document type WO.

cNoAssignedEndDateEV01charOPTNONE

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

szRemark3RMK3charOPTNONE

A remark that specifies supplemental data for use with reference and text fields.

mnTimeUPTMMATH_NUMERICOPTNONE

A time that provides supplemental data information. For example, you can enter a verification time in this field to show when information was 
last reviewed and possibly updated.

Related Functions

None

Related Tables

None
VerifySupplementalData

VerifySupplementalData

Supplemental Database API

Minor Business Rule

Object Name: N0000158

Parent DLL: COPBASE

Location: Client/Server

Language: NER

Functional Description

Purpose

This function verifies that Supplemental Data being added to the generic supplemental database passes 
all defined edits.  Information (Dates, Description) that is left blank is defaulted in.  This is 

part of the SDB API to add information.


Setup Notes and Prerequisites

The supplemental database code and key structure need to be known when calling this function.  For a 

copy or move, the existing database information and the new information need to be known.



Technical Specification

Retrieves the editing information from the F00091 table using SupplementalDatabaseCode and DataType 
as the key.


Validates SystemCode and UserDefinedCodes if they are parameters.


Validates SystemCode1 and UserDefinedCodes1 if they are 

parameters.


Validates SystemCode2 and UserDefinedCodes2 if they are parameters.

Verifies Effective Dates.


Verifies Addresss Number if it is a parameter.




^

Data Structure

D0000158C - Verify Supplemental Data

Parameter NameData ItemData TypeReq/OptI/O/Both
szSupplementalDatabaseCodeSDBcharNONENONE

A user defined code (00/SD) that sets up databases for groups of related supplemental data types. This code differentiates the 
supplemental data types for various systems. For example, the Employee (E) supplemental database contains data types that you use to track 
additional employee information, such as education and job skills.

szDataTypeTYDTcharNONENONE

A code that you assign to supplemental data so that you can group data by categories. Valid values include: A Approval steps B Requisition 
requirements C Interview process N Requisition notes

szUserDefinedCodeValueKYcharNONENONE

A list of valid codes for a specific user defined code list.

szUDCAssociatedDescriptionDL01charNONENONE

A user defined name or remark.

jdEffectiveDateEFTJDEDATENONENONE

The date that identifies when a date is first valid. The effective date is used generically. It can be a lease effective date, a price or cost 
effective date, a currency effective date, a tax rate effective date, or whatever is appropriate.

jdEndingEffectiveDateEFTEJDEDATENONENONE

The date on which the item, transaction, or table becomes inactive, or through which you want transactions to appear. This field is used 
generically throughout the system. It could be a lease effective date, a price or cost effective date, a currency effective date, a tax rate effective 
date, or whatever is appropriate.

jdTickleDateTKDTJDEDATENONENONE

A date that requires some kind of action, such as when an option ends or an inspection is due.

mnUserDefinedAmount1AMTUMATH_NUMERICNONENONE

A quantity that represents the statistical or measurable information related to the code that is defined for the data type. For example, if the 
data type relates to bid submittal codes, this field could be for bid amounts. Or, if the data type relates to Human Resources Benefits 
Administration, this field could be for the cost of election coverage. If the data type relates to bonuses, this could be the bonus amount.

mnUserDefinedAmount2AMTVMATH_NUMERICNONENONE

The second Amount associated with the code defined for this Supplemental Data Type. For example, if you have a stock option plan, you 
could track the number of shares in User Defined Amount and the strike price in User Defined # 2.

szRemark1RMKcharNONENONE

A generic field that you use for a remark, description, name, or address.

szRemark2RMK2charNONENONE

A generic field that you use for a remark, description, name, or address.

mnUserDefinedDaysDYUDMATH_NUMERICNONENONE

The days associated with the code defined for this supplemental data type. For example, engineering change order leadtime days 
represent an association.

mnUserDefinedAddressNumberAN8MATH_NUMERICNONENONE

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

mnUserDefinedQuantityUORGMATH_NUMERICNONENONE

The quantity of units affected by this transaction.

jdUserDefinedDateUPDJJDEDATENONENONE

A date that can be used with supplemental data information. For example, you can enter a verification date in this field to show when 
information was last reviewed and possibly updated.

cSuppressErrorMessageSUPPScharNONENONE

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.

szErrorMessageIDDTAIcharNONENONE

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.

szRelatedPoSoNumberRORNcharNONENONE

A number that identifies a secondary purchase order, sales order, or work order that is associated with the original order. This number is for 
informational purposes only.

szRelatedOrderTypeRCTOcharNONENONE

A user defined code (system 00, type DT) that indicates the document type of the secondary or related order. For example, a purchase 
order might be document type OP and might have been created to fill a related work order with document type WO.

szRemark3RMK3charOPTNONE

A remark that specifies supplemental data for use with reference and text fields.

mnTimeUPTMMATH_NUMERICOPTNONE

A time that provides supplemental data information. For example, you can enter a verification time in this field to show when information was 
last reviewed and possibly updated.

cNoEndEffDateAssignmentEV01charOPTNONE

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

Related Functions

None

Related Tables

None
VerifySupplementalDBKeys

VerifySupplementalDBKeys

Supplemental Database API

Minor Business Rule

Object Name: N0000158

Parent DLL: COPBASE

Location: Client/Server

Language: NER

Functional Description

Purpose

This function verifies that the keys specified for supplemental data exist in the corresponding 
master tables.  The ALIAS of the key is retrieved from the Supplemental Database code setup and depending 

on the alias the master file is checked (e.g. AN8 - Address Book, ITM - Item Master).



Technical Specification

Pass in the SupplementalDatabaseCode.

The function fetches the key structure from the F00090 file.  An error is set if the parameter keys 

are different from the keys specified in the key structure. 


If Business Unit, Company, Address Number, Item Number, Job Type,  Job Step, HRM Requisition Number, 

Document Number, Work Order, or Asset Number are part of the key they must be valid.


Data Structure

D0000158B - VerifySupplementalDBKeys

Parameter NameData ItemData TypeReq/OptI/O/Both
szSupplementalDatabaseCodeSDBcharNONENONE

A user defined code (00/SD) that sets up databases for groups of related supplemental data types. This code differentiates the 
supplemental data types for various systems. For example, the Employee (E) supplemental database contains data types that you use to track 
additional employee information, such as education and job skills.

szBusinessUnitMCUcharNONENONE

An alphanumeric code that identifies a separate entity within a business for which you want to track costs. For example, a business unit 
might be a warehouse location, job, project, work center, branch, or plant. You can assign a business unit to a document, entity, or person for 
purposes of responsibility reporting. For example, the system provides reports of open accounts payable and accounts receivable by 
business unit to track equipment by responsible department. Business unit security might prevent you from viewing information about business units 
for which you have no authority.

szKeyCompanyKCOcharNONENONE

A number that, with the document number, document type and G/L date, uniquely identifies an original document, such as invoice, voucher, 
or journal entry. If you use the Next Numbers by Company/Fiscal Year feature, the Automatic Next Numbers program (X0010) uses the 
document company to retrieve the correct next number for that company. If two or more original documents have the same document number and 
document type, you can use the document company to locate the desired document.

mnNumericKey1SBN1MATH_NUMERICNONENONE

This field specifies one of the numeric keys to the Generic Supplemental Database. You can select the key from a list of supported data 
items, such as Address Number, Account ID, Asset ID, Item Number, and so on.

mnNumericKey2SBN2MATH_NUMERICNONENONE

This field specifies one of the numeric keys to the Generic Supplmental Database.  The key may be selected from a list of supported data 
items such as address book, Account ID, Asset ID, Item Number etc.

szAlphanumericKey1SBA1charNONENONE

This field specifies one of the alphanumeric keys to the Generic Supplmental Database.  The key may be selected from a list of supported 
data items such as Job Number, Job Type, Document Type etc

szAlphanumericKey2SBA2charNONENONE

This field specifies one of the alphanumeric keys to the Generic Supplmental Database.  The key may be selected from a list of supported 
data items such as Job Number, Job Type, Document Type etc

cSuppressErrorMessageSUPPScharNONENONE

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.

szErrorMessageIDDTAIcharNONENONE

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