CustomerSiteUpdate

F1731 Equipment Location Update

Minor Business Rule

Object Name: N1700230

Parent DLL: CCRIN

Location: Client/Server

Language: NER

1.1Purpose

To update the customer site or customer number for an equipment record and optionally transfer all children equipment. For each new customer site
or customer number, an Equipment Location Tracking Record (F1731) is created and the customer site (FALANO) or customer number (FAAN8) is
updated in the Equipment Master F1201.

1.2Setup Notes and Prerequisites

Data Item Data Structure DescriptionI/ORequiredNotes
NUMBAssetItemNumberIR
UKIDUniqueKeyIDInternalINIf UKID is passed in, the program will update the remark only of the current record only,
the children will not be updated.

LANOAddressNumberLessorIRIf LANO value is not blank, the Type of Record is assumed to be 2, which will update the
customer site only.

AN8AddressNumberIRIf AN8 value is not blank, the Type of Record is assumed to be 1, which will update the
customer number only.

ALLocationHistOrSchedIN
EFTBDateBeginningEffectiveIR
DDTSTimeStampBeginningIR
PIDPromagramIdIN
RMKNameRemarkIN
UPLOWUpdateChildrenINTo update children pass "1" to program.

DTAIDataItemONContains errorcode, if any or blank otherwise

ERRCErrorCodeON'1' if errors occurred
SUPPSSuppressErrorMessageIN

1.3Special Logic

The program optionally updates the customer site or customer number of all children, grandchildren, great grandchildren of the parent equipment
number.

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnAssetItemNumber	NUMB	MATH_NUMERIC	OPT	INPUT
An 8-digit number that uniquely identifies an asset.
mnUniqueKeyIDInternal	UKID	MATH_NUMERIC	OPT	INPUT
This field is a unique number used to identify a record in a file.
mnAddressNumberLessor	LANO	MATH_NUMERIC	OPT	INPUT
The address book number for the lessor, renter, or lending institution.
cLocationHistOrSched	AL	char	OPT	INPUT
A code that indicates the type of location record. Valid values are: C Current. Displays only the current location for an asset. This is the default. H Historical. Displays all previous locations for an asset. P Planned or scheduled. Displays only the planned location dates for an asset. You enter planned locations for an asset in the Equipment/Plant Management system. * Displays all locations (current, planned, and historical) that meet your search criteria. Note: You cannot change historical (H) location records. The system automatically updates location records to type H when you change the location and start date of an asset.
jdDateBeginningEffective	EFTB	JDEDATE	OPT	INPUT
The date that an address, item, transaction, or table record becomes active. The meaning of this field differs, depending on the program. For example, the effective date could represent the following: o When a change of address becomes effective. o When a lease becomes effective. o When a price becomes effective. o When the currency exchange rate becomes effective. o When a tax rate becomes effective.
mnTimeStampBeginning	DDTS	MATH_NUMERIC	OPT	INPUT
The time that the asset is transferred to a new location.
szProgramId	PID	char	OPT	INPUT
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.
szNameRemark	RMK	char	OPT	INPUT
A generic field that you use for a remark, description, name, or address.
cUpdateChildren	UPLOW	char	OPT	INPUT
When you change the status of a piece of equipment, the system prompts you to update the status of the children of the equipment as well. Valid values are: Y Update the status of the children with the parent item. N Do not update the children. Update only the equipment item being processed. If you leave this field blank, the default value is N.
mnAddressNumber	AN8	MATH_NUMERIC	OPT	INPUT
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or location.
szDataItem	DTAI	char	OPT	OUTPUT
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.
cErrorCode	ERRC	char	OPT	OUTPUT
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).
cSuppressErrorMessage	SUPPS	char	OPT	INPUT
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.
cF1201Update	BCT1	char	OPT	INPUT
An option that specifies whether the system performs Not-To-Exceed (NTE) processing for Contract Billing. Turn on this option to perform NTE processing.
cDateTimeCheckOnly	BCT2	char	OPT	INPUT
A generic control flag reserved for future use within the Service Billing Batch Header File (F48011).

Data Structure

D1700230 - F1731 Equipment Location

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

mnAssetItemNumber NUMB MATH_NUMERIC OPT INPUT

An 8-digit number that uniquely identifies an asset.

mnUniqueKeyIDInternal UKID MATH_NUMERIC OPT INPUT

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

mnAddressNumberLessor LANO MATH_NUMERIC OPT INPUT

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

cLocationHistOrSched AL char OPT INPUT

A code that indicates the type of location record. Valid values are: C Current. Displays only the current location for an asset. This is the
default. H Historical. Displays all previous locations for an asset. P Planned or scheduled. Displays only the planned location dates for an asset.
You enter planned locations for an asset in the Equipment/Plant Management system. *    Displays all locations (current, planned, and
historical) that meet your search criteria. Note:  You cannot change historical (H) location records. The system automatically updates location
records to type H when you change the location and start date of an asset.

jdDateBeginningEffective EFTB JDEDATE OPT INPUT

The date that an address, item, transaction, or table record becomes active.  The meaning of this field differs, depending on the program.
For example, the effective date could represent the following:   o When a change of address becomes effective.   o When a lease becomes
effective.   o When a price becomes effective.   o When the currency exchange rate becomes effective.   o When a tax rate becomes effective.

mnTimeStampBeginning DDTS MATH_NUMERIC OPT INPUT

The time that the asset is transferred to a new location.

szProgramId PID char OPT INPUT

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.

szNameRemark RMK char OPT INPUT

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

cUpdateChildren UPLOW char OPT INPUT

When you change the status of a piece of equipment, the system prompts you to update the status of the children of the equipment as well.
Valid values are:    Y   Update the status of the children with the parent item.    N   Do not update the children. Update only the equipment item
being processed. If you leave this field blank, the default value is N.

mnAddressNumber AN8 MATH_NUMERIC OPT INPUT

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

szDataItem DTAI char OPT OUTPUT

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.

cErrorCode ERRC char OPT OUTPUT

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

cSuppressErrorMessage SUPPS char OPT INPUT

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.

cF1201Update BCT1 char OPT INPUT

An option that specifies whether the system performs Not-To-Exceed (NTE) processing for Contract Billing. Turn on this option to perform
NTE processing.

cDateTimeCheckOnly BCT2 char OPT INPUT

A generic control flag reserved for future use within the Service Billing Batch Header File (F48011).

Related Functions

None

Related Tables

None

UncloseLocation
UncloseLocation

F1731 Equipment Location Update

Minor Business Rule

Object Name: N1700230

Parent DLL: CCRIN

Location: Client/Server

Language: NER

1.1Purpose
"Unclosing" an equipment location involves deleting the previous current location and making its previous location current by blanking out the End
date and End time.

1.2Setup Notes and Prerequisites

Data Item Data Structure DescriptionI/ORequiredNotes
UKIDUniqueKeyIDInternalIRThe UKID value passed in is the ID of the new current location.

NUMBAssetItemNumberIR
LANOAddressNumberLessorIR
AN8AddressNumberIR
PIDProgramIDIR

1.3Special Logic

The program also updates the F1201 file, indicating that equipment's current location.

Data Structure

D1700230 - F1731 Equipment Location

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

mnAssetItemNumber NUMB MATH_NUMERIC OPT INPUT

An 8-digit number that uniquely identifies an asset.

mnUniqueKeyIDInternal UKID MATH_NUMERIC OPT INPUT

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

mnAddressNumberLessor LANO MATH_NUMERIC OPT INPUT

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

cLocationHistOrSched AL char OPT INPUT

A code that indicates the type of location record. Valid values are: C Current. Displays only the current location for an asset. This is the
default. H Historical. Displays all previous locations for an asset. P Planned or scheduled. Displays only the planned location dates for an asset.
You enter planned locations for an asset in the Equipment/Plant Management system. *    Displays all locations (current, planned, and
historical) that meet your search criteria. Note:  You cannot change historical (H) location records. The system automatically updates location
records to type H when you change the location and start date of an asset.

jdDateBeginningEffective EFTB JDEDATE OPT INPUT

The date that an address, item, transaction, or table record becomes active.  The meaning of this field differs, depending on the program.
For example, the effective date could represent the following:   o When a change of address becomes effective.   o When a lease becomes
effective.   o When a price becomes effective.   o When the currency exchange rate becomes effective.   o When a tax rate becomes effective.

mnTimeStampBeginning DDTS MATH_NUMERIC OPT INPUT

The time that the asset is transferred to a new location.

szProgramId PID char OPT INPUT

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.

szNameRemark RMK char OPT INPUT

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

cUpdateChildren UPLOW char OPT INPUT

When you change the status of a piece of equipment, the system prompts you to update the status of the children of the equipment as well.
Valid values are:    Y   Update the status of the children with the parent item.    N   Do not update the children. Update only the equipment item
being processed. If you leave this field blank, the default value is N.

mnAddressNumber AN8 MATH_NUMERIC OPT INPUT

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

szDataItem DTAI char OPT OUTPUT

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.

cErrorCode ERRC char OPT OUTPUT

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

cSuppressErrorMessage SUPPS char OPT INPUT

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.

cF1201Update BCT1 char OPT INPUT

An option that specifies whether the system performs Not-To-Exceed (NTE) processing for Contract Billing. Turn on this option to perform
NTE processing.

cDateTimeCheckOnly BCT2 char OPT INPUT

A generic control flag reserved for future use within the Service Billing Batch Header File (F48011).

Related Functions

None

Related Tables

None