F4100VerifyAndGetLocationMaster

Get Location Master

Minor Business Rule

Object Name: B4100240

Parent DLL: COPBASE

Location: Client/Server

Language: C

Functional Description
Purpose
Retrieve the Location Master record (F4100) with Branch/Plant and Location passed in.

Setup Notes and Prerequisites:

None

Special Logic:

None


Technical Specifications
Processing 

• Validate F4100RecordPointer is being passed in.  If it is passed in, return the data back to the 
data structures without retrieving any records.


IfF4100RecordPtr is not zero


Return F4100 columns into the parameter list (DATASTRUCTURE) 

Exit the program


End


• Retrieve F4100 record if the F4100RecordPtr is not passed in.

Retrieve Location Master (F4100) with the following:
Case Index = 1

Key= 1:LMMCU
Key= 2:LMMCU, LMLOCN

Case Index = 2
Key= 1:LMMCU
Key= 2:LMMCU, LMWSQP

Key= 3:LMMCU, LMWSQP, LMLOCN

Case Index = 3
Key= 1:LMMCU
Key= 2:LMMCU, LMWSQQ

Key= 3:LMMCU, LMWSQQ, LMLOCN

Case Index = 4
Key= 1:LMMCU
Key= 2:LMMCU, LMWSQR

Key= 3:LMMCU, LMWSQR, LMLOCN

Case Index = 5
Key= 1:LMMCU
Key= 2:LMMCU, LMCGRP

Case Index = 6
Key= 1:LMMCU
Key= 2:LMMCU, LMPZON

Otherwise:
Set an Error "4371"


Ifrecord does not exit  OR LastRecordRead equals '1'


LastRecordRead = '1'

IfMultipleRetrieve equals '1'  AND FirstTime Retrieving record   OR 

MulitpleRetrieve not equals '0'

Set an Error "3231"
ErrorCode = '1'
End


Close Table
Exit Program


End

If  Reocord exist


Return the F4100 Data to Parameter list


If  ReturnRecordPtr is equal to '1'

Create a Pointer and return it to F4100RecordPtr

End

IfMultipleRetrieve equals '1'


Return Hrequest to OpenTableHandle

End


^

Data Structure

D4100240B - F4100 Verify And Get Location Master

Parameters:
Data Item Data Structure DescriptionI/ORequired
SUPPSSuppress ErrorIN

DTAIError Message IDON

ERRCErrorCodeON

CDLIndexIN

CDLKeysIN

EV01Call TypeIN

EV01Multiple RetrieveIN

EV01Last Record ReadI/ON

GENLNGOpenTableHandleI/ON

EV01ReturnRecordPtrIN

GENLNGF4100RecordPtrON

MCUBranch/PlantIY

LOCNLocationI/ON

AISLAisleON

BINBinON

LA03Location Code 3ON

LA04Location Code 4ON

LA05Location Code 5ON

LA06Location Code 6ON

LA07Location Code 7ON

LA08Location Code 8ON

LA09Location Code 9ON

LA10Location Code 10ON

LLDLLevel Of DetailON

STY1Location Dimension GroupON

CGRPLocation Characteristic GroupI/ON

LHLDLocation Hold CodeON

FREZFreeze RuleON

NETANettable Allocatable CodeON

MNUPMinimum Putaway PercentON

MNUKMinimum Pick PercentON

LCODLocation Tax CodeON

MMTHCommitment MethodON

EQTYContainer CodeON

CTNFCartonize FlagON

MCNTAllow Mix Container ON

MLOTAllow Mix LotON

MITMMaximum Number Of Item AllowON

STAGStaging Location FlagON

LVERVerification CodeON

PCNFPutaway Confirmation RequiredON

KCNFPicking Confirmation RequiredON

APUTAllow PutawayON

APIKAllow PickingON

ARPLAllow ReplenishON

PZONPutaway ZoneI/ON

KZONPicking ZoneON

ZONRReplenish ZoneON

STGPPutaway Staging LocationON

STGKPicking Staging Location ON

STGRReplenish Staging LocationON

WSQPPutaway Sequence NumberI/ON

WSQQPicking Sequence NumberI/ON

WSQRReplenish Sequence NumberI/ON

DISXLattitudeON

DISYLongitudeON

DISZHeightON

OT1YPotency ControlON

OT2yGrade ControlON


^

Parameter NameData ItemData TypeReq/OptI/O/Both
cSuppressErrorMessageSUPPScharNONENONE

'1' = Error will not be set on
^

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.

cErrorCodeERRCcharNONENONE

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

cCallTypeEV01charNONENONE

'1' = Set an Error when Record not found.
'2' =Set Error when Record found.

^

mnIndexCDLMATH_NUMERICNONENONE

Default will be '1'
^

mnKeysCDLMATH_NUMERICNONENONE

Default will be '2'
^

cMultipleRetrieveEV01charNONENONE

'1' = Multiple records will be return and Open table handle (HREQUEST) is to be returned as        well.
^

cLastRecordReadEV01charNONENONE

1' = Last record has been retrieved from F4100
^

idOpenTableHandleGENLNGIDNONENONE

Required as an Input/Output when Multiple retrieve is set to '1'
^

cReturnRecordPtrEV01charNONENONE

'1' = F4100 Record Pointer is to be returned.
^

idF4100RecordPtrGENLNGIDNONENONE

General purpose ID variable.

szBranchPlantMCUcharNONENONE

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.

szLocationLOCNcharNONENONE

The storage location from which goods will be moved.

szAisleAISLcharNONENONE

A code that identifies a location in a warehouse. This code is used in conjunction with a bin and lot identifier, to indicate a specific, tangible 
storage area within a warehouse or yard.

szBinBINcharNONENONE

A specific storage location within a warehouse or store. The system uses the bin with an aisle location to identify a storage area whose 
width, depth, and height can be readily measured.

szLocationCode03LA03charNONENONE

A code that the system uses for one of two purposes:     o To identify a specific location within a Branch/Plant as part of the location identifier.  
   o To use as a general reporting code for location information.

szLocationCode04LA04charNONENONE

A code that the system uses for one of two purposes:     o To identify a specific location within a Branch/Plant as part of the location identifier.  
   o To use as a general reporting code for location information.

szLocationCode05LA05charNONENONE

A code that the system uses for one of two purposes:     o To identify a specific location within a Branch/Plant as part of the location identifier.  
   o To use as a general reporting code for location information.

szLocationCode06LA06charNONENONE

A code that the system uses for one of two purposes:     o To identify a specific location within a Branch/Plant as part of the location identifier.  
   o To use as a general reporting code for location information.

szLocationCode07LA07charNONENONE

A code that the system uses for one of two purposes:     o To identify a specific location within a Branch/Plant as part of the location identifier.  
   o To use as a general reporting code for location information.

szLocationCode08LA08charNONENONE

A code that the system uses for one of two purposes:     o To identify a specific location within a Branch/Plant as part of the location identifier.  
   o To use as a general reporting code for location information.

szLocationCode09LA09charNONENONE

A code that the system uses for one of two purposes:     o To identify a specific location within a Branch/Plant as part of the location identifier.  
   o To be used as a general reporting code for location information.

szLocationCode10LA10charNONENONE

A code that the system uses for one of two purposes:     o To identify a specific location within a Branch/Plant as part of the location identifier.  
   o To be used as a general reporting code for location information.

cLevelOfDetailLLDLcharNONENONE

A code that summarizes or classifies locations and provides a hierarchy of locations for review purposes. For example, you can assign 
aisles to level 2,and individual bins within the aisle as level 3.

szLocationDimensionGroupSTY1charNONENONE

A code (system 46/type LD) that identifies a group of locations that share the same dimensions. A location dimension group defines the 
dimensions for all locations that belong to the group. After you set up a location dimension group, you can assign locations to the group through 
Location Profile Revisions (P46020). You must define location dimensions if you plan to use volume-based putaway.

szLocationCharacteristicsCGRPcharNONENONE

A code (system 46/type LC) that identifies a group of locations that share the same characteristics. A location characteristics group defines 
the characteristics for all locations that belong to the group. After you set up a location characteristics group, you can assign locations to the 
group through Location Characteristics (P46021).

szLocationHoldCodeLHLDcharNONENONE

Reserved for future use.

cFreezeRuleFREZcharNONENONE

A code that indicates what putaway restrictions you want to place on a location during the pick process. Valid codes are:    Blank No freeze. 
The system does not perform any automatic restrictions.    1       Freeze when empty. Do not put away to this location after you pick the location 
empty.    2       Freeze when picked (auto reset). Do not put away to this location after picking. When you pick the location empty, the sytem 
automatically resets the putaway flag to allow putaway to this location.    3       Freeze when picked (manual reset). Do not put away to this 
location after picking. When you pick the location empty, you must manually reset the putaway flag to allow putaway to this location.

cNettableAllocatableNETAcharNONENONE

This is a code used to inform the MPS/MRP system as to the status of the inventory at this location. Allowable values are:    1 Nettable and 
Allocatable    2 Nettable only    3 Allocatable only An item defined as Nettable will be consumed in the MPS/MRP logic, and treated as on-hand 
inventory. An item defined as Allocatable will be treated as available and will enable the system to commit inventory so defined to sales or 
work orders.

mnMinimumPutawayPercentageMNUPMATH_NUMERICNONENONE

The minimum percentage of the total location capacity that you want the system to use during putaway. You specify a minimum putaway 
percentage when you want an item to fill at least this percentage of an empty putaway location.

mnMinimumPickPercentageMNUKMATH_NUMERICNONENONE

The minimum percentage of the total location capacity that you want the system to use during picking. If you use this minimum percentage, 
the system first determines how many of the items fit in the location. It divides the quantity of the item being picked by the maximum quantity 
that will fit in the location and compares the result to the minimum pick percentage. The system performs this check only if you defined the pick 
movement instructions to have the system do so.

szLocationTaxCodeLCODcharNONENONE

A code (system 46/type LT) that indicates whether the location contains tax-paid inventory (in-bond vs. duty paid). If an item has an 
assigned tax code, the system puts the item away only in locations with the same tax code. You assign tax codes to items through Item Profile 
(P46010).

szCommitmentMethodMMTHcharNONENONE

The preferred method used to move goods through a warehouse.

szContainerCodeEQTYcharNONENONE

A code (46/EQ) that identifies a storage container or a shipping carton. A storage container can be an open container where items are 
stored on the container (for example, a pallet), or a closed container where items are stored in the container (for example, a box). You use the 
Container and Carton Codes program (P46091) to define storage containers.

cCartonizeFlagCTNFcharNONENONE

A code that indicates whether the system recommends shipping cartons when it picks from this location. Valid codes are:    Y Yes, 
recommend cartons when picking from this location. The system recommends a carton only if you have set up the Carton Recommendation Method 
for the item.    N No, do not make carton recommendations when picking from this location.

cAllowMixContainersMCNTcharNONENONE

A code that indicates whether you want to allow more than one type of storage container for an item to be stored in the location. Valid codes 
are:    Y Allow more than one type of container in this location    N Do not allow more than one type of container in this location  You use 
Allowed Containers (P46026) to define which containers are allowed in the location. You can also set up the item profile to allow mixing of 
containers.

cAllowMixLotMLOTcharNONENONE

A code that indicates how you want the system to assign items to a location.

mnMaximumNumberOfItemsAllowMITMMATH_NUMERICNONENONE

A number that specifies the maximum number of different items that can be stored in this location at one time. Enter a number from 1 to 99. If 
you leave the field blank (or zero), the system does not limit the number of different items in the location.

cStagingLocationFlagSTAGcharNONENONE

A code that indicates whether the location is a staging location, where you hold items temporarily before moving them somewhere else. 
Staging locations (such as the receiving and shipping docks) do not require a group definition for dimensions, volume, or weight, because they 
have unlimited capacity. Valid codes are:    Y Yes, this location is a staging location    N No, this location is not a staging location 

szVerificationCodeLVERcharNONENONE

A two-character code that uniquely identifies a location. The Movement Confirmations program uses the code that you enter to verify that 
the system used the correct location during putaway or picking.

cPutawayConfirmationRequiredPCNFcharNONENONE

A Y in this field will indicate putaway confirmation must take place when the goods are physically put into the location.

cPickingConfirmationRequiredKCNFcharNONENONE

A Y in this field will indicate retrieval confirmation must take place when the goods are physically removed from the location.

cAllowPutawayAPUTcharNONENONE

A code that indicates whether the location is valid for putaway selection. Valid codes are:    Y Yes, use this location for putaway    N No, do 
not use this location for putaway

cAllowPickingAPIKcharNONENONE

A code that indicates whether this location is valid for picking. Valid codes are:    Y Yes, use this location for picking    N No, do not use this 
location for picking

cAllowReplenishmentARPLcharNONENONE

A code that indicates whether you allow replenishment from a location.

szPutawayZonePZONcharNONENONE

A code (system 46/type ZN) that identifies areas in the warehouse where goods are put away or stored.

szPickingZoneKZONcharNONENONE

A code (system 46/type ZN) that identifies an area from which items are picked for shipment.

szPutawayStagingLocationSTGPcharNONENONE

A code that specifies a warehouse location where you hold items temporarily (either physically or logically) before moving them 
somewhere else. You use the putaway staging location when the system suggests movement from one location to another while using two-phase 
confirmation. In two-phase confirmation, you confirm the movement from the first location to the staging location, and then confirm the movement 
from the staging location to the final location.

szPickingStagingLocationSTGKcharNONENONE

A code that specifies a warehouse location where you hold items temporarily (either physically or logically) before moving them 
somewhere else. You use the picking staging location when the system suggests movement from one location to another while using two-phase 
confirmation. In two-phase confirmation, you confirm the movement from the first location to the staging location, and then confirm the movement 
from the staging location to the final location.

szReplenishStagingLocationSTGRcharNONENONE

A code that specifies a warehouse location where you hold items temporarily (either physically or logically) before moving them 
somewhere else. You use the replenishment staging location when the system suggests movement from one location to another while using two-phase 
confirmation. In two-phase confirmation, you confirm the movement from the first location to the staging location, and then confirm the 
movement from the staging location to the final location.

mnPutawaySequenceWSQPMATH_NUMERICNONENONE

A number that you assign to a location to determine its place in the putaway sequence. Putaway is the movement of inventory to storage 
after receipt. A sequence of locations describes the path that warehouse employees follow through the warehouse during movement tasks. 
You can specify in the Movement Instructions (P46095) whether the system uses the putaway sequence as a tiebreaker when there is more than 
one location selected for putaway. For example, you can establish sequencing for the most efficient putaway routing.

mnPickingSequenceWSQQMATH_NUMERICNONENONE

A number that you assign to a location to determine its place in the picking sequence. Picking is the movement of inventory from storage to 
satisfy an order. A sequence of locations describes the path that warehouse employees follow through the warehouse during movement 
tasks. You can specify in the Movement Instructions (P46095) whether the system uses the picking sequence as a tiebreaker when there is 
more than one location selected to pick from. For example, you can establish sequencing for the most efficient pick routing.

mnReplenishSequenceWSQRMATH_NUMERICNONENONE

A number that you assign to a location to determine its place in the replenishment sequence. Replenishment is the movement of inventory 
from storage locations to picking locations. A sequence of locations describes the path that warehouse employees follow through the 
warehouse during movement tasks. You can specify in the Movement Instructions (P46095) whether the system uses the replenishment sequence 
as a tiebreaker when there is more than one location selected to replenish from. For example, you can establish sequencing for the most 
efficient replenishment routing.

mnLattitudeCoordinateDISXMATH_NUMERICNONENONE

The X or latitude coordinate of a location in the warehouse. The system can use latitude, longitude, and height as a tiebreaker when 
suggesting locations for putaway and picking.

mnLongitudeCoordinateDISYMATH_NUMERICNONENONE

The Y or longitude coordinate of a location in the warehouse. The system can use latitude, longitude, and height as a tiebreaker when 
suggesting locations for putaway and picking.

mnHeightCoordinateDISZMATH_NUMERICNONENONE

The Z or height coordinate of a location in the warehouse. The system can use latitude, longitude, and height as a tiebreaker when 
suggesting locations for putaway and picking.

cPotencyControlOT1YcharNONENONE

A code that indicates whether you control the item by potency.

cGradeControlOT2YcharNONENONE

A code that indicates whether you control the item by grade.

szReplenishmentZoneZONRcharNONENONE

A code (system 46/type ZN) that identifies replenishment zones, which are areas in the warehouse from which items are retrieved to 
replenish or refill picking locations. You assign zones to locations using Location Master (P4100).

Related Functions

None

Related Tables

F4100 Location Master
GetLocationMaster

GetLocationMaster

Get Location Master

Minor Business Rule

Object Name: B4100240

Parent DLL: COPBASE

Location: Client/Server

Language: C

Functional Description
Purpose
Retrieve Location Master (F4100) table with Branch/Plant and Location as the key.  It will return Put 
Away Zone, Picking Zone, and Replenishment Zone.  If Suppress Error Message is set to (1),  the error 

message will not be turned on; but it will return an value in Error Message ID


Setup Notes and Prerequisites

None

Special Logic:

None


Technical Specifications

^

Data Structure

D4100240 - Get Location Master

Parameters:
Data Item Data Structure DescriptionI/ORequired
MCUBranch/PlantIY

LOCNLocationIY

PZONPutaway ZoneON

KZONPicking ZoneON

ZONRReplenishment ZoneON

EV01Suppress ErrorIN

DTAIError Message IDON


^

Parameter NameData ItemData TypeReq/OptI/O/Both
szBranchPlantMCUcharNONENONE

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.

szLocationLOCNcharNONENONE

The storage location from which goods will be moved.

szPutAwayZonePZONcharNONENONE

A code (system 46/type ZN) that identifies areas in the warehouse where goods are put away or stored.

szPickingZoneKZONcharNONENONE

A code (system 46/type ZN) that identifies an area from which items are picked for shipment.

szReplenishmentZoneZONRcharNONENONE

A code (system 46/type ZN) that identifies replenishment zones, which are areas in the warehouse from which items are retrieved to 
replenish or refill picking locations. You assign zones to locations using Location Master (P4100).

cSuppressErrorMessageEV01charNONENONE

'1' = Error will not be set on
^

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

F4100 Location Master