EmployeeMBFAdditionalData

Employee MBF

Minor Business Rule

Object Name: B0500575

Parent DLL: CHRM

Location: Client/Server

Language: C

Functional Description

The Employee Master MBF allows both internal and external processes to add, update, delete, fetch and 
edit records in the Employee Master (F060116), International Data (F060117), and Additional Data 
(F060120) tables. Records in the Employee Job (F060118) and Employee Job History (F060119) tables are 
maintained by the MBF through calls to the Update Employee Job Server (N0800020) business function.

Because the Employee Master table contains a large number of columns, the MBF organizes it into 
several logical segments. The following functions are used to maintain Employee Master records:

Process Master Data. This function handles all of the core data columns for an employee. The core 
data columns include the employee's personal, organization, and compensation information as well as 
30-35 miscellaneous data elements.

Process User Defined Data. This function handles all of the user defined category code and date 
columns.

Process National Data US. This function handles the national fiscal data that is specific to the 
United States.

Process National Data CA. This function handles the national fiscal data that is specific to 
Canada.

Process Eligibility Data. This function handles the columns in the Employee Eligibility and NDT 
application.

Process Payroll Data. This function handles the columns in the Employee Payroll application.

In addition to the Employee Master table, the MBF provides support for the International Data 
(F060117) and Additional Data (F060120) tables. The following two functions maintain records in these tables:

Process International Data. This function handles all columns in the F060117 table.

Process Additional Data. This function handles all columns in the F060120 table.

Each data structure that the MBF uses contains a block of control parameters followed by a block of 
data parameters. The control block is the same for all data structures. The data block is unique to 
each data structure. It contains data parameters and processing option parameters.

The MBF also provides support for a cache. The cache is used to store data collected during the new 
hire process, to store data for multi-segment operations, and to manage warning messages. The ability 
to update and fetch from the cache is programmed into each function. The following function provides 
support for cache-related operations:

Process Cache. This function is used to initialize and terminate the cache, to clear records from 
the cache, and to commit cache records to the database.

Technical Specification

Processing Modes

The MBF uses the following parameters to control processing. They are included in the control block 
at the top of each data structure.

cActionCode. The action code determines which basic operation to perform. Valid actions codes are:
   I           - Inquiry
   A           - Add new employee record (new hire)
   C           - Change an existing employee record
   D           - Delete (Master segment)

cInquiryMode. The inquiry mode controls how an inquiry is processed. Data can be fetched from the 
table, fetched from the table and saved in cahce, or fetched from cache. Valid inquiry modes are:
   0 or blank  - Fetch from table
   1           - Fetch from table and save in cache
   2           - Fetch from cache

cUpdateMode. The update mode controls what portion of the update to execute. Data can be edited, 
updated, or both. Valid update modes are:
   0 or blank  - Edit and update
   1           - Edit only
   2           - Update only

cUpdateDataSource. The update data source specifices whether the MBF updates the table or the cache. 
Valid update data sources are:
   0 or blank  - Save to table if cActionCode = C
                 Save to cache if cActionCode = A
   1           - Save to cache

cEditMode. The edit mode 
   0 or blank  - Full edit
   1           - Partial edit (no data dictionary edit)

cErrorMode
   0 or blank  - Normal error processing
   1           - Suppress error message display

The Column List Parameter

The column list parameter (szColumnList) is used to process a specific list of columns rather than 
all of the columns for a segment. It is included in the control block at the top of each data structure.

The column list string is composed of the alias for each column, separated by a comma. For example, 
to edit or update an employee's salary and pay frequency, pass SAL,PFRQ in the column list and the new 
values in the salary and pay frequency data parameters.

Error Handling


Using the Cache

The cache stores data records for an employee, warning messages issued by edit operations, and 
parameters that are used across function call boundaries. The cache is required in order to add new employee 
records to the database, to issue warning messages during edit operations, and to share parameters 
across function call boundaries. The cache is not required to perform inquiries and updates to existing 
records, although using the cache for multiple segment inquiries and updates improves performance.

The cache is initialized once at the beginning of a process by calling the Employee MBF Cache Create 
function.  This initialization routine returns the name assigned to the cache for use in subsequent 
cache operations.

The cache must be closed prior to the end of the process that creates it. Failure to close the cache 
will result in a memory leak. To close the cache, call the Employee MBF Cache Destroy.

Cache records are written to the database using one of two action codes when calling the Employee MBF 
Cache Commit function. If an action code of I is passed to the Employee MBF Cache Commit function the 
MBF will insert the cache records in the database. If an action code of U is passed to the Employee 
MBF Cache Commit function the MBF will update the database with the records stored in cache. Attempting 
to insert an existing record or to update a new record will result in an error.

The MBF containts two functions for clearing the cache, Employee MBF Cache Clear and Employee MBF 
Cache Error Clear. Calling the Employee MBF Cache Clear function instructs the MBF to clear all records 
from all caches. Calling the Employee MBF Cache Error Clear function instructs the MBF to clear the 
warning messages cache. These functions are useful when using the MBF to process multiple employee 
records in a loop or across application boundaries.

Adding a New Employee

Perform the following steps to add a new employee to the database:

1. Initialize the cache.

   Employee MBF Cache Create
          szCacheName  -> Cache Variable
     cErrorMode   <- 0 Normal or 1 Suppress
     cErrorStatus -> 1 Failure or Blank Success                    

2. Update the cache with data for the Master Data segment. If you do not want to update all of the 
columns for the segment, use the szColumnList parameter.

   F060116ProcessMasterData
     cActionCode         <- A
     szCacheName         <- Cache Variable
     szCallingProgramId  <- program name
     szCallingVersion    <- version of calling program
     mnAddressNumber     <- employee's address book number
     data columns        <- new data values
     processing options  <- as desired

3. Update the cache with data for other segments. If you do not want to update all of the columns for 
a particular segment, use the szColumnList parameter.

4. Insert the cached records into the database.

   Employee MBF Cache Commit
     cActionCode      <- I
     szCacheName      <- Cache Variable
     cErrorMode   <- 0 Normal or 1 Suppress
     cErrorStatus -> 1 Failure or Blank Success

5. Close the cache.

   Employee MBF Cache Destroy
     szCacheName  <- Cache Variable  //saved cache name
     cErrorMode   <- 0 Normal or 1 Suppress
     cErrorStatus -> 1 Failure or Blank Success


Updating a Single Segment For an Employee

Perform the following steps to update a single data segement for an employee:

1. Initialize the cache.

   F060116ProcessCache
     cActionCode  <- 1  //initialize cache
     szCacheName  -> Cache Variable  //save for subsequent calls

In this example, the cache is used primarily to provide support for warning messages. If you are 
suppressing messages, or if it is acceptable to ignore warning messages, omit the cache function 
calls. The MBF ignores warnings if the cache is not available.

2. Update the database. This example uses the Master Data segment. The control parameter settings 
depicted will work with any other segment. If you do not want to update all of the columns for the 
segment,use the 
szColumnList parameter.

   F060116ProcessMasterData
     cActionCode         <- C
     szCacheName         <- Cache Variable
     szCallingProgramId  <- program name
     szCallingVersion    <- version of calling program
     mnAddressNumber     <- employee's address book number
     szChangeReason      <- change reason code
     jdDateEffective     <- current system date
     data columns        <- new data values
     processing options  <- as desired

3. Close the cache.

   F060116ProcessCache
     cActionCode  <- 2  //close cache
     szCacheName  <- Cache Variable  //saved cache name

Updating Multiple Segments For an Employee

Perform the following steps to update multiple data segment for an employee:

1. Initialize the cache. Save the cache name for use in subsequent calls.

   F060116ProcessCache
     cActionCode  <- 1
     szCacheName  -> Cache Variable

2. Fetch and cache the records for each segment.

   F060116ProcessMasterData
     cActionCode  <- I
     szCacheName  -> Cache Variable
     cInquiryMode -> 1

A second call to other F060116 segments is not necessary. This call to the MBF stores the entire 
F060116 record in cache.

   F060120ProcessAdditionalData
     cActionCode  <- I
     szCacheName  -> Cache Variable
     cInquiryMode -> 1

3. Update the cache. If you do not want to update all of the columns for a paticular segment, use the 
szColumnList parameter.

   F060116ProcessMasterData
     cActionCode         <- C
     szCacheName         <- Cache Variable
     cUpdateDataSource   <- 1
     szCallingProgramId  <- program name
     szCallingVersion    <- version of calling program
     mnAddressNumber     <- employee's address book number
     data columns        <- new data values
     processing options  <- as desired

   F060116ProcessUserDefinedData
     cActionCode         <- C
     szCacheName         <- Cache Variable
     cUpdateDataSource   <- 1
     szCallingProgramId  <- program name
     szCallingVersion    <- version of calling program
     mnAddressNumber     <- employee's address book number
     data fields         <- new values
     processing options  <- as desired

   F060120ProcessAdditionalData
     cActionCode         <- C
     szCacheName         <- Cache Variable
     cUpdateDataSource   <- 1
     szCallingProgramId  <- program name
     szCallingVersion    <- version of calling program
     mnAddressNumber     <- employee's address book number
     data columns        <- new data values
     processing options  <- as desired

4. Update the database with the records that are saved in the cache.

   F060116ProcesCache
     cActionCode      <- 4
     szCacheName      <- Cache Variable

5. Close the cache.

   F060116ProcessCache
     cActionCode  <- 2
     szCacheName  <- Cache Variable

Deleting an Employee

Perform the following step to delete an employee:

F060116ProcessMasterData
  cActionCode         <- D
  mnAddressNumber     <- employee's address book number

The MBF performs a pre-delete edit to verify that the employee record can be deleted. If the MBF 
encounters an error, the delete is not performed and 501G is returned in the szErrorMessageId parameter. 
If the pre-delete edit completes successfully, all records for the employee are deleted from the 
employee tables.


Data Structure

D0500575H - Employee MBF Additional Data

Parameter NameData ItemData TypeReq/OptI/O/Both
cActionCodeACTNcharREQINPUT

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

szColumnListDSScharOPTINPUT

This field will contain a bar delimited string of data item names from the Employee Master (F060116). Each data item in the string 
corresponds with a data item in a UBE data structure. This mapping will allow RI values to be passed to a UBE when run dynamically from a BSFN.

szCacheNameDTAIcharOPTINPUT

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.

cInquiryModeEV01charOPTINPUT

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

cUpdateModeEV01charOPTINPUT

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

cUpdateDataSourceEV01charOPTINPUT

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

cEditModeEV01charOPTINPUT

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

cErrorModeEV01charOPTINPUT

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

szCallingProgramIdPIDcharOPTINPUT

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.

szCallingVersionVERScharOPTINPUT

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.

cErrorStatusEV01charOPTOUTPUT

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

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

cMaritalStatusActualMSAcharOPTNONE

This is the marital status of the employee.

szCountryBirthCTBBcharOPTNONE

A user defined code list (00/CN) that indicates the country in which the employee was born.

szNationality1stCTB1charOPTNONE

A user defined code list (00/CN) that indicates the first country in which the employee has Citizenship.

szDataProtectionCodeDPSCcharOPTNONE

Data protection code - a user defined code indicating the status of the employee's agreement for the transmission of his/her personal data 
outside their work country.

szNationality2ndCTB2charOPTNONE

A user defined code list (00/CN) that indicates the second country, if any, in which the employee has citizenship.

szNationality3rdCTB3charOPTNONE

A user defined code list (00/CN) that indicates the third country, if any, in which the employee has citizenship.

szJobTitleJBCXcharOPTNONE

A title associated with an employee's job.

jdDateinCurrentJobCDIJJDEDATEOPTNONE

The date when an employee started working in this job.

szOrganizationalBusinessUnORMCUcharOPTNONE

A business unit that is included in the organizational structure for job competencies. You use organizational business units to assign job 
competency information to levels within your organizational structure. This business unit is independent of an employee's home business unit 
and security business unit.

jdLastSalaryreviewdateLSRDJDEDATEOPTNONE

The date the last compensation review was given.

jdNextSalaryreviewdateNSRDJDEDATEOPTNONE

The date on which the employee is scheduled for the next compensation review.

mnPerformanceAppraisalLevelPAPLMATH_NUMERICOPTNONE

A code that specifies the level of proficiency at which a supervisor rates a person or asset for a particular competency type and 
competency code.

mnTierRankingTIRNKMATH_NUMERICOPTNONE

A value that allows a supervisor to either rank employees individually or group them into tiers. When employees are ranked, each 
employee is assigned a unique number. When employees are grouped into tiers, several employees can have a common number. For example, a 
supervisor can assign a tier of 1 through 3 to 12 employees. Each employee can be assigned to tier 1, 2, or 3.

jdLastTierRankdateTRNKDJDEDATEOPTNONE

The date the Tier/Rank was last updated.

mnTotalJobCompetencyPercenJBPCTRQDMATH_NUMERICOPTNONE

A number that indicates how an employee is progressing in relation to the required competency level for a particular job.  The system 
calculates this value by first calculating the value for the Employee Competency Percent of Required field (EEPCTRQD) for all employee 
competencies that are related to a job competency for a particular job. The system then multiplies these percentages by their respective weighting 
factor and adds them together to determine the total job competency percent achieved.

jdLastTotalJobCompetencyreLTJCRWJDEDATEOPTNONE

The date on which the last job competency review took place.

jdDateLastReviewedDATRVWJDEDATEOPTNONE

A date that indicates when the process was last reviewed.

cReviewTypeRWTYPcharOPTNONE

A code that indicates the last compensation review type.

mnMentorMNTRMATH_NUMERICOPTNONE

A number that identifies an entry in the Address Book system. Use this number to identify mentors.

szTeamTEAMcharOPTNONE

A code that identifies a team.

mnKeyValueSerialNumberSERKMATH_NUMERICOPTNONE

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.

cTypeIncreaseLastRevwTINCLcharOPTNONE

A code that identifies the type of the last salary or wage review for which the score for the employee performance appraisal was updated. 
This is a user defined code (06/RV).

jdDateDataProtectionDPSDJDEDATEOPTNONE

The date on which the data protection code was last updated.

Related Functions

B0000130 Retrieve Company From Business Unit
B0000564 Get Internal Next Number
B0100066 Recursive Relationship Check
B0500543 Validate Geo Code
B0500895 Is a Real Time Event Enabled
B0800007 Delete Employee Related Tables
B5100003 F0006 Check Business Unit Existence
B9800100 Get Audit Information
B9800420 Get Data Dictionary Definition
B9900410 Get Environment Value
N0500020 Update Payroll Lockout Code
N0500025 Salary Calculations Server
N0500032 Synchronize EE/Supervisor in EE Master &&&& Org Structure
N0500042 F08001 Retrieve Specific Job Information
N0800002 Set Employee Current Status Flag\Employee Id Validation
N0800003 Verify Job/Retrieve Job Default Information
N0800004 Compa-Ratio Server
N0800005 Pay Grade Server
N0800007 Delete Employee Edit
N0800008 Update F06210 to Force Payroll Rerun
N0800020 Update Employee Job (F060118) Server
N0800029 Transfer Supp Data on Hire/Terminate Employee
N0800030 Fiscal Year Begin & End Dates
N0800031 Get UDC Description
N0800050 Position Budget Edit Server
N0800069 F08040 - Get HR Constants Information
N0800146 Get a Specific Employee Self Service Common Setting
N0800204 Track Employee Date in Current Position/Job
XX0901 Validate Account Number

Related Tables

F0006 Business Unit Master
F00091 Supplemental Database Data Types
F00092 Supplemental Data
F00191 Generic Message/Rates
F0101 Address Book Master
F0150 Address Organization Structure Master
F060116 Employee Master Information
F060117 Employee Master - International Data
F060120 Employee Master Additional Information File
F065016 Automatic Bank Deposit Master
F069096 Payroll General Constants
F07300 Employee Lockout Code File
F08005 Business Unit/ Job Id. X-Ref
F08092 Human Resources General Description-User Def Codes
F08101 Position Master
F08102 Requisition Information
F08105 Requisition Activity
F08401 Applicant Master
F9203 Data Item Alpha Descriptions
F9210 Data Field Specifications (OneWorld)
EmployeeMBFCacheClear

EmployeeMBFCacheClear

Employee MBF

Minor Business Rule

Object Name: B0500575

Parent DLL: CHRM

Location: Client/Server

Language: C

Function Name: EmployeeMBFCacheClear

Purpose and Processing (why use it and what the function does)


• 
This function deletes all of the records from all of the MBF caches. 

• 
The jdeCacheClear API is called for each cache. 

• 
The caches are not deleted by this function, only the data in the caches is deleted.

• 
This function is useful if you are processing multiple employees, and need to clear the cache 
between employees.

  Important Notes

• 
This function does not terminate the caches. You must call the Employee MBF Cache Destroy 
function to terminate the caches.
 

Parameters (how to call the function)
    
Parameter       I/ODescription
---------------------- ------------------------------------------
szCacheNameIThe name assigned to the cache by the
Employee MBF Cache Create function.

cErrorMode  I0 or blank  - Normal error processing
   1          - Suppress error message display

cErrorStatusO0 or blank  - Success
1       - Failure


Use (how to use the function and other related functions)

This example demonstrates use of the Employee MBF Cache Clear function when updating multiple 
segments for multiple employees.

1. Initialize the cache.

   Employee MBF Cache Create
Cache Variable <- szCacheName       
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                   

2. Get the next employee address book number to process.

3. Inquire on the table and save the record to cache.

   Employee MBF Master Data
I -> cActionCode              
Cache Variable -> szCacheName 
1 -> cInquireyMode
Error Status Variable<- cErrorStatus                           
employee's address book number-> mnAddressNumber     

4. Update the cache with data for the first segment. Replace the segment shown here with the segment 
that you want to update. Use the szColumnList parameter if you do not want to update all of the 
columns for the segment.

   Employee MBF Master Data
C -> cActionCode 
Columns to update or blank-> szColumnList           
Cache Variable -> szCacheName  
1 -> cUpdateDataSource 
Error Status Variable<- cErrorStatus                                 
employee's address book number-> mnAddressNumber     
new data values -> data columns        
as desired  -> processing options  

5. Update the cache with data for other segments. Replace the segment shown here with the segment 
that you want to update. This example uses the column list to update the TARA and TARR fields.

   Employee MBF National Data US
C -> cActionCode              
TARA,TARR -> szColumnList
Cache Variable -> szCacheName
1 -> cUpdateDataSource
Error Status Variable<- cErrorStatus                                          
employee's address book number-> mnAddressNumber     
new data values -> data columns        

6. Update the database with the records in cache.

   Employee MBF Cache Commit
U   -> cActionCode           
Cache Variable -> szCacheName    
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                                 

7. Delete all records from all of the MBF caches.

   Employee MBF Cache Clear
Cache Variable -> szCacheName       
0 or 1 -> cErrorMode
Error Status Variable<- cErrorStatus

8. Repeat steps 2 through 7 until all employees are processed.

9. Destroy the cache.

   Employee MBF Cache Destroy
Cache Variable  -> szCacheName
0 or 1-> cErrorMode  
Error Status Variable<- cErrorStatus        





Data Structure

D0500575L - Employee MBF Cache Clear

Parameter NameData ItemData TypeReq/OptI/O/Both
szCacheNameDTAIcharREQINPUT

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.

cErrorModeEV01charOPTINPUT

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

cErrorStatusEV01charOPTOUTPUT

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

Related Functions

B0000130 Retrieve Company From Business Unit
B0000564 Get Internal Next Number
B0100066 Recursive Relationship Check
B0500543 Validate Geo Code
B0500895 Is a Real Time Event Enabled
B0800007 Delete Employee Related Tables
B5100003 F0006 Check Business Unit Existence
B9800100 Get Audit Information
B9800420 Get Data Dictionary Definition
B9900410 Get Environment Value
N0500020 Update Payroll Lockout Code
N0500025 Salary Calculations Server
N0500032 Synchronize EE/Supervisor in EE Master &&&& Org Structure
N0500042 F08001 Retrieve Specific Job Information
N0800002 Set Employee Current Status Flag\Employee Id Validation
N0800003 Verify Job/Retrieve Job Default Information
N0800004 Compa-Ratio Server
N0800005 Pay Grade Server
N0800007 Delete Employee Edit
N0800008 Update F06210 to Force Payroll Rerun
N0800020 Update Employee Job (F060118) Server
N0800029 Transfer Supp Data on Hire/Terminate Employee
N0800030 Fiscal Year Begin & End Dates
N0800031 Get UDC Description
N0800050 Position Budget Edit Server
N0800069 F08040 - Get HR Constants Information
N0800146 Get a Specific Employee Self Service Common Setting
N0800204 Track Employee Date in Current Position/Job
XX0901 Validate Account Number

Related Tables

F0006 Business Unit Master
F00091 Supplemental Database Data Types
F00092 Supplemental Data
F00191 Generic Message/Rates
F0101 Address Book Master
F0150 Address Organization Structure Master
F060116 Employee Master Information
F060117 Employee Master - International Data
F060120 Employee Master Additional Information File
F065016 Automatic Bank Deposit Master
F069096 Payroll General Constants
F07300 Employee Lockout Code File
F08005 Business Unit/ Job Id. X-Ref
F08092 Human Resources General Description-User Def Codes
F08101 Position Master
F08102 Requisition Information
F08105 Requisition Activity
F08401 Applicant Master
F9203 Data Item Alpha Descriptions
F9210 Data Field Specifications (OneWorld)
EmployeeMBFCacheClearError

EmployeeMBFCacheClearError

Employee MBF

Minor Business Rule

Object Name: B0500575

Parent DLL: CHRM

Location: Client/Server

Language: C

Function Name: EmployeeMBFCacheClearError

Purpose and Processing (why use it and what the function does)

• 

This function deletes all of records in the MBF errors and warnings caches. 

• 
The jdeCacheClear API is called for each cache. 

• 
The caches are not deleted by this function, only the data in the caches is deleted.

  Important Notes

• 
This function does not terminate the error and warning caches. They are terminated along with the 
other MBF caches by the Employee MBF Cache Destroy function.

• 
This function is useful when editing multiple segments for an employee, or when paging between 
segments in an application. Calling it will delete the current edit errors and warnings in 
preparation for an edit call for a different segment.


Parameters (how to call the function)
    
ParameterI/ODescription
--------------------------------------------------------------------
szCacheNameIThe name assigned to the cache by the
Employee MBF Cache Create function.

cErrorMode  I0 or blank  - Normal error processing
   1           - Suppress error message display

cErrorStatusO0 or blank  - Success
1  - Failure


Use (how to use the function and other related functions)

This example demonstrates use of the Employee MBF Cache Clear Error function when updating multiple 
segments for an existing employee.

1. Initialize the cache.

   Employee MBF Cache Create
Cache Variable <- szCacheName       
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                   

2. Inquire on the table and save the employee record to cache.

   Employee MBF Master Data
I -> cActionCode              
Cache Variable -> szCacheName 
1 -> cInquireyMode
Error Status Variable<- cErrorStatus                           
employee's address book number-> mnAddressNumber     

3. Edit a segment for the employee. Replace the segment shown here with the segment that you want to 
edit. Use the szColumnList parameter if you do not want to edit all of the columns for the segment.

   Employee MBF Master Data
C  -> cActionCode  
Columns to update or blank-> szColumnList            
1 -> cUpdateMode
1 -> cUpdateDataSource
Error Status Variable<- cErrorStatus
employee's address book number-> mnAddressNumber     
new data values -> data columns 
as desired-> processing options

4. Process errors found by the edit. 

5. Clear the errors and warnings found during the edit in preparation for editing the next segment. 
   
   Employee MBF Cache Clear
Cache Variable  -> szCacheName
0 or 1-> cErrorMode  
Error Status Variable<- cErrorStatus        

6. Edit additional segments for the employee. Repeat steps 3 through 5 for any other segments that 
you want to edit.

7. Destroy the cache.

   Employee MBF Cache Destroy
Cache Variable  -> szCacheName
0 or 1-> cErrorMode  
Error Status Variable<- cErrorStatus        




Data Structure

D0500575M - Employee MBF Cache Clear Error

Parameter NameData ItemData TypeReq/OptI/O/Both
szCacheNameDTAIcharREQINPUT

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.

cErrorModeEV01charOPTINPUT

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

cErrorStatusEV01charOPTOUTPUT

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

Related Functions

B0000130 Retrieve Company From Business Unit
B0000564 Get Internal Next Number
B0100066 Recursive Relationship Check
B0500543 Validate Geo Code
B0500895 Is a Real Time Event Enabled
B0800007 Delete Employee Related Tables
B5100003 F0006 Check Business Unit Existence
B9800100 Get Audit Information
B9800420 Get Data Dictionary Definition
B9900410 Get Environment Value
N0500020 Update Payroll Lockout Code
N0500025 Salary Calculations Server
N0500032 Synchronize EE/Supervisor in EE Master &&&& Org Structure
N0500042 F08001 Retrieve Specific Job Information
N0800002 Set Employee Current Status Flag\Employee Id Validation
N0800003 Verify Job/Retrieve Job Default Information
N0800004 Compa-Ratio Server
N0800005 Pay Grade Server
N0800007 Delete Employee Edit
N0800008 Update F06210 to Force Payroll Rerun
N0800020 Update Employee Job (F060118) Server
N0800029 Transfer Supp Data on Hire/Terminate Employee
N0800030 Fiscal Year Begin & End Dates
N0800031 Get UDC Description
N0800050 Position Budget Edit Server
N0800069 F08040 - Get HR Constants Information
N0800146 Get a Specific Employee Self Service Common Setting
N0800204 Track Employee Date in Current Position/Job
XX0901 Validate Account Number

Related Tables

F0006 Business Unit Master
F00091 Supplemental Database Data Types
F00092 Supplemental Data
F00191 Generic Message/Rates
F0101 Address Book Master
F0150 Address Organization Structure Master
F060116 Employee Master Information
F060117 Employee Master - International Data
F060120 Employee Master Additional Information File
F065016 Automatic Bank Deposit Master
F069096 Payroll General Constants
F07300 Employee Lockout Code File
F08005 Business Unit/ Job Id. X-Ref
F08092 Human Resources General Description-User Def Codes
F08101 Position Master
F08102 Requisition Information
F08105 Requisition Activity
F08401 Applicant Master
F9203 Data Item Alpha Descriptions
F9210 Data Field Specifications (OneWorld)
EmployeeMBFCacheCommit

EmployeeMBFCacheCommit

Employee MBF

Minor Business Rule

Object Name: B0500575

Parent DLL: CHRM

Location: Client/Server

Language: C

Function Name: EmployeeMBFCacheCommit

Purpose and Processing (why use it and what the function does)

• 

This function is used to write the records stored in the MBF cache to the database.

• 
Using the action code, you can either update an exsisting record or insert a new record.

  Processing Modes 

• 
The cActionCode parameter is used to determine the mode of processing. An action code of I 
inserts cached records into the database. An action code of U updates the database with the records in 
the cache.

  Important Notes

• 
The MBF maintains records in the F060116, F060120 and F060117 tables. 

• 
The MBF maintains a corresponding cache for each table.

• 
A record will not be written to the database for an empty table cache.

 

Parameters (how to call the function)
    
ParameterI/ODescription
--------------------------------------------------------------------
cActionCodeIU - Update Cache to Table
I - Insert Cache to Table

szCacheNameIThe name assigned to the cache by the
Employee MBF Cache Create function.

cErrorMode  I0 or blank  - Normal error processing
   1           - Suppress error message display

cErrorStatusO0 or blank  - Success
1- Failure


Use (how to use the function and other related functions)

This example demonstrates use of the Employee MBF Cache Commit function when updating multiple 
segments for an existing employee.

1. Initialize the cache.

   Employee MBF Cache Create
Cache Variable <- szCacheName       
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                   

2. Inquire on the table and save the record to cache.

   Employee MBF Master Data
I -> cActionCode              
Cache Variable -> szCacheName 
1 -> cInquireyMode
Error Status Variable<- cErrorStatus                           
employee's address book number-> mnAddressNumber     

3. Update the cache with data for the first segment. Replace the segment shown here with the segment 
that you want to update. Use the szColumnList parameter if you do not want to update all of the 
columns for the segment.

   Employee MBF Master Data
C -> cActionCode 
Columns to update or blank-> szColumnList           
Cache Variable -> szCacheName  
1 -> cUpdateDataSource 
Error Status Variable<- cErrorStatus                                 
employee's address book number-> mnAddressNumber     
new data values -> data columns        
as desired  -> processing options  

4. Update the cache with data for other segments. Replace the segment shown here with the segment 
that you want to update. This example uses the column list to update the TARA and TARR fields.

   Employee MBF National Data US
C -> cActionCode              
TARA,TARR -> szColumnList
Cache Variable -> szCacheName
1 -> cUpdateDataSource
Error Status Variable<- cErrorStatus                                          
employee's address book number-> mnAddressNumber     
new data values -> data columns        

5. Update the database with the records in cache.

   Employee MBF Cache Commit
U   -> cActionCode           
Cache Variable -> szCacheName    
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                                 

6. Destroy the cache.

   Employee MBF Cache Destroy
Cache Variable  -> szCacheName
0 or 1-> cErrorMode  
Error Status Variable<- cErrorStatus        


Data Structure

D0500575K - Employee MBF Cache Commit

Parameter NameData ItemData TypeReq/OptI/O/Both
cActionCodeACTNcharREQINPUT

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

szCacheNameDTAIcharREQINPUT

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.

cErrorModeEV01charOPTINPUT

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

cErrorStatusEV01charOPTOUTPUT

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

Related Functions

B0000130 Retrieve Company From Business Unit
B0000564 Get Internal Next Number
B0100066 Recursive Relationship Check
B0500543 Validate Geo Code
B0500895 Is a Real Time Event Enabled
B0800007 Delete Employee Related Tables
B5100003 F0006 Check Business Unit Existence
B9800100 Get Audit Information
B9800420 Get Data Dictionary Definition
B9900410 Get Environment Value
N0500020 Update Payroll Lockout Code
N0500025 Salary Calculations Server
N0500032 Synchronize EE/Supervisor in EE Master &&&& Org Structure
N0500042 F08001 Retrieve Specific Job Information
N0800002 Set Employee Current Status Flag\Employee Id Validation
N0800003 Verify Job/Retrieve Job Default Information
N0800004 Compa-Ratio Server
N0800005 Pay Grade Server
N0800007 Delete Employee Edit
N0800008 Update F06210 to Force Payroll Rerun
N0800020 Update Employee Job (F060118) Server
N0800029 Transfer Supp Data on Hire/Terminate Employee
N0800030 Fiscal Year Begin & End Dates
N0800031 Get UDC Description
N0800050 Position Budget Edit Server
N0800069 F08040 - Get HR Constants Information
N0800146 Get a Specific Employee Self Service Common Setting
N0800204 Track Employee Date in Current Position/Job
XX0901 Validate Account Number

Related Tables

F0006 Business Unit Master
F00091 Supplemental Database Data Types
F00092 Supplemental Data
F00191 Generic Message/Rates
F0101 Address Book Master
F0150 Address Organization Structure Master
F060116 Employee Master Information
F060117 Employee Master - International Data
F060120 Employee Master Additional Information File
F065016 Automatic Bank Deposit Master
F069096 Payroll General Constants
F07300 Employee Lockout Code File
F08005 Business Unit/ Job Id. X-Ref
F08092 Human Resources General Description-User Def Codes
F08101 Position Master
F08102 Requisition Information
F08105 Requisition Activity
F08401 Applicant Master
F9203 Data Item Alpha Descriptions
F9210 Data Field Specifications (OneWorld)
EmployeeMBFCacheCreate

EmployeeMBFCacheCreate

Employee MBF

Minor Business Rule

Object Name: B0500575

Parent DLL: CHRM

Location: Client/Server

Language: C

Function Name: EmployeeMBFCacheCreate

Purpose and Processing (why use it and what the function does)

• 

This function is used to create the set of caches that are used by the MBF to store employee data 
records, warning messages issued by edit operations and parameters that are used across function 
call boundaries. 
• 

• 
The cache is required in order to add new employee records to the database and to issue warning 
messages during edit operations. The cache is not required to perform inquiries and updates to 
existing records, although using the cache for multiple segment inquiries and updates improves 
performance.
• 
• 
The cache is initialized once at the beginning of a process by calling this function. It returns 
the name assigned to the cache for use in subsequent cache operations.
• 

• 
This function creates all seven of the caches used by the MBF.
• 
•   Important Notes
• 
• 
To prevent memory leaks, you must call the EmployeeMBFCacheDestroy MBF function prior to closing 
your program, application or UBE.
 

Parameters (how to call the function)
    
ParameterI/ODescription
--------------------------------------------------------------------
szCacheNameOThe name assigned to the cache.

cErrorMode  I0 or blank  - Normal error processing
   1           - Suppress error message display

cErrorStatusO0 or blank  - Success
1    - Failure


Use (how to use the function and other related functions)

This example demonstrates use of the Employee MBF Cache Create function when updating multiple 
segments for an existing employee.

1. Initialize the cache.

   Employee MBF Cache Create
Cache Variable <- szCacheName       
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                   

2. Inquire on the table and save the record to cache.

   Employee MBF Master Data
I -> cActionCode              
Cache Variable -> szCacheName 
1 -> cInquireyMode
Error Status Variable<- cErrorStatus                           
employee's address book number-> mnAddressNumber     

3. Update the cache with data for the first segment. Replace the segment shown here with the segment 
that you want to update. Use the szColumnList parameter if you do not want to update all of the 
columns for the segment.

   Employee MBF Master Data
C -> cActionCode 
Columns to update or blank-> szColumnList           
Cache Variable -> szCacheName  
1 -> cUpdateDataSource 
Error Status Variable<- cErrorStatus                                 
employee's address book number-> mnAddressNumber     
new data values -> data columns        
as desired  -> processing options  

4. Update the cache with data for other segments. Replace the segment shown here with the segment 
that you want to update. This example uses the column list to update the TARA and TARR fields.

   Employee MBF National Data US
C -> cActionCode              
TARA,TARR -> szColumnList
Cache Variable -> szCacheName
1 -> cUpdateDataSource
Error Status Variable<- cErrorStatus                                          
employee's address book number-> mnAddressNumber     
new data values -> data columns        

5. Update the database with the records in cache.

   Employee MBF Cache Commit
U   -> cActionCode           
Cache Variable -> szCacheName    
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                                 

6. Destroy the cache.

   Employee MBF Cache Destroy
Cache Variable  -> szCacheName
0 or 1-> cErrorMode  
Error Status Variable<- cErrorStatus        

 


Data Structure

D0500575I - Employee MBF Cache Create

Parameter NameData ItemData TypeReq/OptI/O/Both
szCacheNameDTAIcharREQOUTPUT

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.

cErrorModeEV01charOPTINPUT

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

cErrorStatusEV01charOPTOUTPUT

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

Related Functions

B0000130 Retrieve Company From Business Unit
B0000564 Get Internal Next Number
B0100066 Recursive Relationship Check
B0500543 Validate Geo Code
B0500895 Is a Real Time Event Enabled
B0800007 Delete Employee Related Tables
B5100003 F0006 Check Business Unit Existence
B9800100 Get Audit Information
B9800420 Get Data Dictionary Definition
B9900410 Get Environment Value
N0500020 Update Payroll Lockout Code
N0500025 Salary Calculations Server
N0500032 Synchronize EE/Supervisor in EE Master &&&& Org Structure
N0500042 F08001 Retrieve Specific Job Information
N0800002 Set Employee Current Status Flag\Employee Id Validation
N0800003 Verify Job/Retrieve Job Default Information
N0800004 Compa-Ratio Server
N0800005 Pay Grade Server
N0800007 Delete Employee Edit
N0800008 Update F06210 to Force Payroll Rerun
N0800020 Update Employee Job (F060118) Server
N0800029 Transfer Supp Data on Hire/Terminate Employee
N0800030 Fiscal Year Begin & End Dates
N0800031 Get UDC Description
N0800050 Position Budget Edit Server
N0800069 F08040 - Get HR Constants Information
N0800146 Get a Specific Employee Self Service Common Setting
N0800204 Track Employee Date in Current Position/Job
XX0901 Validate Account Number

Related Tables

F0006 Business Unit Master
F00091 Supplemental Database Data Types
F00092 Supplemental Data
F00191 Generic Message/Rates
F0101 Address Book Master
F0150 Address Organization Structure Master
F060116 Employee Master Information
F060117 Employee Master - International Data
F060120 Employee Master Additional Information File
F065016 Automatic Bank Deposit Master
F069096 Payroll General Constants
F07300 Employee Lockout Code File
F08005 Business Unit/ Job Id. X-Ref
F08092 Human Resources General Description-User Def Codes
F08101 Position Master
F08102 Requisition Information
F08105 Requisition Activity
F08401 Applicant Master
F9203 Data Item Alpha Descriptions
F9210 Data Field Specifications (OneWorld)
EmployeeMBFCacheDestroy

EmployeeMBFCacheDestroy

Employee MBF

Minor Business Rule

Object Name: B0500575

Parent DLL: CHRM

Location: Client/Server

Language: C

Function Name: EmployeeMBFCacheDestroy

Purpose and Processing (why use it and what the function does)

• 

This function is called to destroy (terminate) the set of caches used by the MBF.

• 
The cache is destroyed once at the end of a process by calling this function. 

• 
This function destorys all seven of the caches used by the MBF.

  Important Notes

• 
Memory leaks will result of the cache is not destroyed. 


Parameters (how to call the function)
    
ParameterI/ODescription
--------------------------------------------------------------------
szCacheNameIThe name assigned to the cache by the
Employee MBF Cache Create function.

cErrorMode  I0 or blank  - Normal error processing
   1           - Suppress error message display

cErrorStatusO0 or blank  - Success
1    - Failure



Use (how to use the function and other related functions)

This example demonstrates use of the Employee MBF Cache destroy function when updating multiple 
segments for an existing employee.

1. Initialize the cache.

   Employee MBF Cache Create
Cache Variable <- szCacheName       
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                   

2. Inquire on the table and save the record to cache.

   Employee MBF Master Data
I -> cActionCode              
Cache Variable -> szCacheName 
1 -> cInquireyMode
Error Status Variable<- cErrorStatus                           
employee's address book number-> mnAddressNumber     

3. Update the cache with data for the first segment. Replace the segment shown here with the segment 
that you want to update. Use the szColumnList parameter if you do not want to update all of the 
columns for the segment.

   Employee MBF Master Data
C -> cActionCode 
Columns to update or blank-> szColumnList           
Cache Variable -> szCacheName  
1 -> cUpdateDataSource 
Error Status Variable<- cErrorStatus                                 
employee's address book number-> mnAddressNumber     
new data values -> data columns        
as desired  -> processing options  

4. Update the cache with data for other segments. Replace the segment shown here with the segment 
that you want to update. This example uses the column list to update the TARA and TARR fields.

   Employee MBF National Data US
C -> cActionCode              
TARA,TARR -> szColumnList
Cache Variable -> szCacheName
1 -> cUpdateDataSource
Error Status Variable<- cErrorStatus                                          
employee's address book number-> mnAddressNumber     
new data values -> data columns        

5. Update the database with the records in cache.

   Employee MBF Cache Commit
U   -> cActionCode           
Cache Variable -> szCacheName    
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                                 

6. Destroy the cache.

   Employee MBF Cache Destroy
Cache Variable  -> szCacheName
0 or 1-> cErrorMode  
Error Status Variable<- cErrorStatus        


Data Structure

D0500575J - Employee MBF Cache Destroy

Parameter NameData ItemData TypeReq/OptI/O/Both
szCacheNameDTAIcharREQBOTH

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.

cErrorModeEV01charOPTINPUT

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

cErrorStatusEV01charOPTOUTPUT

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

Related Functions

B0000130 Retrieve Company From Business Unit
B0000564 Get Internal Next Number
B0100066 Recursive Relationship Check
B0500543 Validate Geo Code
B0500895 Is a Real Time Event Enabled
B0800007 Delete Employee Related Tables
B5100003 F0006 Check Business Unit Existence
B9800100 Get Audit Information
B9800420 Get Data Dictionary Definition
B9900410 Get Environment Value
N0500020 Update Payroll Lockout Code
N0500025 Salary Calculations Server
N0500032 Synchronize EE/Supervisor in EE Master &&&& Org Structure
N0500042 F08001 Retrieve Specific Job Information
N0800002 Set Employee Current Status Flag\Employee Id Validation
N0800003 Verify Job/Retrieve Job Default Information
N0800004 Compa-Ratio Server
N0800005 Pay Grade Server
N0800007 Delete Employee Edit
N0800008 Update F06210 to Force Payroll Rerun
N0800020 Update Employee Job (F060118) Server
N0800029 Transfer Supp Data on Hire/Terminate Employee
N0800030 Fiscal Year Begin & End Dates
N0800031 Get UDC Description
N0800050 Position Budget Edit Server
N0800069 F08040 - Get HR Constants Information
N0800146 Get a Specific Employee Self Service Common Setting
N0800204 Track Employee Date in Current Position/Job
XX0901 Validate Account Number

Related Tables

F0006 Business Unit Master
F00091 Supplemental Database Data Types
F00092 Supplemental Data
F00191 Generic Message/Rates
F0101 Address Book Master
F0150 Address Organization Structure Master
F060116 Employee Master Information
F060117 Employee Master - International Data
F060120 Employee Master Additional Information File
F065016 Automatic Bank Deposit Master
F069096 Payroll General Constants
F07300 Employee Lockout Code File
F08005 Business Unit/ Job Id. X-Ref
F08092 Human Resources General Description-User Def Codes
F08101 Position Master
F08102 Requisition Information
F08105 Requisition Activity
F08401 Applicant Master
F9203 Data Item Alpha Descriptions
F9210 Data Field Specifications (OneWorld)
EmployeeMBFCacheFetchError

EmployeeMBFCacheFetchError

Employee MBF

Minor Business Rule

Object Name: B0500575

Parent DLL: CHRM

Location: Client/Server

Language: C

Function Name: EmployeeMBFCacheFetchError

Purpose and Processing (why use it and what the function does)


• 
The cache stores data records for an employee, warning messages issued by edit operations, and 
parameters that are used across  function call boundaries. The cache is required in order to add new 
employee records to the database, to issue warning messages  during edit operations, and to share 
parameters across function call boundaries. The cache is not required to perform inquiries and 
updates to existing records, although using the cache for multiple segment inquiries and updates 
improves performance.

• 
This function instructs the MBF to return the next error in the error cache.

• 
Cursor management is handled by the MBF. The first error in the cache is returned by the first 
call, the second by the second call, and so on. One (1) is returned in the cErrorStatus parameter 
when the end of the error cache is reached.

  Important Notes

• 
This function formats the text substitution for the error including the correct value for the 
data item.

• 
This cache is cleared separate from the other caches, however, if caches are destroyed, this one 
is destroyed as well.


Parameters (how to call the function)
    
Parameter       I/ODescription
---------------------- ------------------------------------------
szCacheNameIThe name assigned to the cache by the
Employee MBF Cache Create function.

cErrorMode  I0 or blank  - Normal error processing
   1          - Suppress error message display

cErrorStatusO0 or blank  - Success
1       - Failure

szDataItemI/OThe data item alias for the field that has the error.

szDataItemLongOThe data item description from the Data Dictionary record
for the data item.

szErrorMessageIdI/OThe data item name for the error message.

szErrorMessageOThe formatted error message text including text
substitutions.


Use (how to use the function and other related functions)

Perform the following steps to edit a record and retrieve all errors from the errors cache. Replace 
the data segment shown with the segment you want to edit.

1. Initialize the cache.

   Employee MBF Cache Create
Cache Variable <- szCacheName       
0 or 1 -> cErrorMode
Error Status Variable<- cErrorStatus                   

2. Inquire on the table and save the record to cache.

   Employee MBF Master Data
I -> cActionCode              
1  -> cInquiryMode
Cache Variable -> szCacheName         
employee's address book number-> mnAddressNumber     

3. Edit the data in the cache, passing any changes into the call. Use the szColumnList parameter if 
you do not want to update all of the columns for the segment.

   Employee MBF Master Data
C -> cActionCode              
Columns to update or blank-> szColumnList
Cache Variable -> szCacheName 
2 -> cEditMode 
Error Status Variable<- cErrorStatus                   
employee's address book number-> mnAddressNumber     
new data values  -> data columns        
as required-> processing options 
 
4. Retrieve edit errors from cache.

   If Status Variable is equal to 1 (from step 3)

// Get first error
Employee MBF Cache Error Fetch
   Cache Variable-> szCacheName
   1-> cErrorMode
   Error Status Variable-> cErrorStatus
   Data Item Alais<- szDataItem              
   Data Item Description <- szDataItemLong
   Error Alais<- szErrorMessageId
   Error Message Text<- szErrorMessage

While Status Variable is not equal to 1 (fetch error success)

// Perform necessary work with the error message here

// Get the next error 
Employee MBF Cache Error Fetch
   Cache Variable-> szCacheName
   1 -> cErrorMode
   Error Status Variable-> cErrorStatus
   Data Item Alais<- szDataItem              
   Data Iten Description<- szDataItemLong
   Error Alais<- szErrorMessageId
   Error Message Text<- szErrorMessage

End Whle

   End If

5. Destroy the cache.

   Employee MBF Cache Destroy
Cache Variable-> szCacheName
0 or 1  -> cErrorMode  
Error Status Variable<- cErrorStatus


                  

Data Structure

D0500575N - Employee MBF Cache Fetch Error

Parameter NameData ItemData TypeReq/OptI/O/Both
szCacheNameDTAIcharREQBOTH

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.

cErrorModeEV01charOPTINPUT

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

cErrorStatusEV01charOPTOUTPUT

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

szDataItemDTAIcharOPTOUTPUT

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.

szDataItemLongOWDIcharOPTOUTPUT

An identifier that refers to and defines a unit of information. It is a 32-character, alphabetical field that does not allow blanks or special 
characters such as % & , . +. The data item cannot be changed. It forms the C-code data name (for example AddressNumber) that is used in 
business functions, data structures, and event rules. Also identify a data item by the alias or alpha description.

szErrorMessageIdDTAIcharOPTOUTPUT

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.

szErrorMessageDS01charOPTOUTPUT

A free-form, 80-character text field.

Related Functions

B0000130 Retrieve Company From Business Unit
B0000564 Get Internal Next Number
B0100066 Recursive Relationship Check
B0500543 Validate Geo Code
B0500895 Is a Real Time Event Enabled
B0800007 Delete Employee Related Tables
B5100003 F0006 Check Business Unit Existence
B9800100 Get Audit Information
B9800420 Get Data Dictionary Definition
B9900410 Get Environment Value
N0500020 Update Payroll Lockout Code
N0500025 Salary Calculations Server
N0500032 Synchronize EE/Supervisor in EE Master &&&& Org Structure
N0500042 F08001 Retrieve Specific Job Information
N0800002 Set Employee Current Status Flag\Employee Id Validation
N0800003 Verify Job/Retrieve Job Default Information
N0800004 Compa-Ratio Server
N0800005 Pay Grade Server
N0800007 Delete Employee Edit
N0800008 Update F06210 to Force Payroll Rerun
N0800020 Update Employee Job (F060118) Server
N0800029 Transfer Supp Data on Hire/Terminate Employee
N0800030 Fiscal Year Begin & End Dates
N0800031 Get UDC Description
N0800050 Position Budget Edit Server
N0800069 F08040 - Get HR Constants Information
N0800146 Get a Specific Employee Self Service Common Setting
N0800204 Track Employee Date in Current Position/Job
XX0901 Validate Account Number

Related Tables

F0006 Business Unit Master
F00091 Supplemental Database Data Types
F00092 Supplemental Data
F00191 Generic Message/Rates
F0101 Address Book Master
F0150 Address Organization Structure Master
F060116 Employee Master Information
F060117 Employee Master - International Data
F060120 Employee Master Additional Information File
F065016 Automatic Bank Deposit Master
F069096 Payroll General Constants
F07300 Employee Lockout Code File
F08005 Business Unit/ Job Id. X-Ref
F08092 Human Resources General Description-User Def Codes
F08101 Position Master
F08102 Requisition Information
F08105 Requisition Activity
F08401 Applicant Master
F9203 Data Item Alpha Descriptions
F9210 Data Field Specifications (OneWorld)
EmployeeMBFEligibilityData

EmployeeMBFEligibilityData

Employee MBF

Minor Business Rule

Object Name: B0500575

Parent DLL: CHRM

Location: Client/Server

Language: C

Function Name: EmployeeMBFEligibilityData

Purpose and Processing (why use it and what the function does)

• 

This function performs edits and updates for eligibility related fields in the F060116 (Employee 
Master) table.

• 
This function is one of several Employee MBF segments.

   Processing Modes 

The MBF uses the following parameters to control processing. They are included in the control 
block at the top of the data structure. 

cActionCode      - The action code determines which basic operation to perform.

szColumnList    - Used to process a specific list of columns rather than all of 
the columns for a segment. The column list string is composed         
of the alias for each column separated  by a comma. The MBF processes 
all columns when this value is blank or NULL. The alias for each 
data item is listed below in the  parameters section.

cInquiryMode     - The inquiry mode controls how an inquiry is processed. Data 
can be fetched from the table, fetched from the table and saved 
in cache, or fetched from cache. 

cUpdateMode      - The update mode controls what portion of the update to 
execute. Data can be edited, updated, or both. 
 
cUpdateDataSource     - The update data source specifies whether the MBF updates the 
table or the cache. 

cEditMode     - The edit mode specifies whether to perform a full edit or
a partial edit. A partial edit omits data dictionary edits
for the fields.  

cErrorMode     - The error mode controls error message processing. Error
messages can be displayed, suppressed or saved in a cache.

cErrorStatus    - The error status indicates whether or not the MBF encountered
errors.

   Important Notes

• 
You must use the MBF Cache to process any Warnings (type 2 or 3 errors).
• You must use the MBF Cache to Log errors (cErrorMode 2).
• If you are using more that one MBF Segment it is advisable to use the cache.
• There is only one cache for the entire F060116 file so all F060116 segments inquire and update 
the same cache

 
Parameters (how to call the function)
    
ParameterColumn List I/ODescription
---------------------------------------------------------------------------------------
cActionCodeII  - Inquiry
 A  - Add new employee record (new hire)   
     C  - Change an existing employee record        
D  - Delete (Master segment)

szColumnListIList of data items to process or blank
to process all data items.

szCacheNameIThe name assigned to the cache by the
Employee MBF Cache Create function, or
blank if not using the cache.

cInquiryModeI0 or blank  - Fetch from table
1 - Fetch from table and save in cache
2 - Fetch from cache

cUpdateMode I0 or blank  - Edit and update
   1    - Edit only
   2    - Update only

cUpdateDataSource I0 or blank
  - Save to table if cActionCode = C
                           Save to cache if cActionCode = A
   1 - Save to cache

cEditMode I0 or blank  - Full edit
   1 - Partial edit (no data dict. edit)

cErrorMode  I0 or blank  - Normal error processing
   1  - Suppress error message display
2  - Log errors in the cache

szCallingProgramIdIName (ID) of the calling program.  
Updated to audit field PID.

szCallingVersionIVersion of the calling program. May be 
used in processing.

cErrorStatusO0 or blank  - Success
1        - Failure

mnAddressNumberI/OField in F060116 Table

cUpdateFlagI/OField in F060116 Table
                         
szChangeReasonI/OField in F060116 Table
                   
jdDateEffectiveI/OField in F060116 Table
                    
cEligibilityCode1E001I/OField in F060116 Table
                   
cEligibilityCode2E002I/OField in F060116 Table
                   
cEligibilityCode3E003I/OField in F060116 Table
                   
cEligibilityCode4E004I/OField in F060116 Table
                   
cEligibilityCode5E005I/OField in F060116 Table
                   
cEligibilityCode6E006I/OField in F060116 Table
                   
cEligibilityCode7E007I/OField in F060116 Table
                   
cEligibilityCode8E008I/OField in F060116 Table
                   
cEligibilityCode9E009I/OField in F060116 Table
                   
cEligibilityCode010E010I/OField in F060116 Table
                 
cNDTCodeOwnerOfficerK001I/OField in F060116 Table
                
cNDTCodeLookBackTop20K002I/OField in F060116 Table
               
cNDTCodeLookBackYearHCEK003I/OField in F060116 Table
             
cNDTCodeDeterminationTop20K004I/OField in F060116 Table
          
cNDTCodeDeterminationTop100K005I/OField in F060116 Table
         
cNDTCodeDeterminationTop10K006I/OField in F060116 Table
          
cNDTCodeDeterminationYrHCEK007I/OField in F060116 Table
          
cNDTCodeMinHoursEligibilityK008I/OField in F060116 Table
         
c401kNonDiscriminationTest009K009I/OField in F060116 Table
       
c401kNonDiscriminationTest010K010I/OField in F060116 Table
       
cOregonInsuranceORGI/OField in F060116 Table
                    
cPensionPENSI/OField in F060116 Table


Use (how to use the function and other related functions)

You are referred to the Employee MBF Master Data documentation for details on how to add a new 
employee to the database.

Perform the following step to update an exsisting employee (single segment):

1. Call the function with the parameters listed below. Use the szColumnList parameter if you do not 
want to update all of the columns for the segment.

   Employee MBF Eligibility Data
C -> cActionCode 
Columns to update or blank-> szColumnList
Error Status Variable<- cErrorStatus                   
employee's address book number-> mnAddressNumber     
new data values -> data columns        

Perform the following steps to update an existing employee using cache (multiple segments):

1. Initialize the cache.

   Employee MBF Cache Create
Cache Variable <- szCacheName       
0 or 1 -> cErrorMode   
Error Status Variable<- cErrorStatus                   

2. Inquire on the table and save the record to cache for future use.

   Employee MBF Eligibility Data
I -> cActionCode              
1 -> cInquireyMode
Cache Variable -> szCacheName
Error Status Variable<- cErrorStatus                   
employee's address book number-> mnAddressNumber   

3. Update the cache with data for the segment. Use the szColumnList parameter if you do not want to 
update all of the columns for the segment.

   Employee MBF Eligibility Data
C -> cActionCode  
Columns to update or blank-> szColumnList
Cache Variable -> szCacheName  
1 -> cUpdateDataSource 
Error Status Variable<- cErrorStatus                   
employee's address book number-> mnAddressNumber     
new data values -> data columns        

4. Update the cache with data for other segments. Replace the segment shown here with the segment 
that you want to update. This example uses the column list to update the TARA and TARR fields.

   Employee MBF National Data US
C -> cActionCode              
TARA,TARR -> szColumnList
Cache Variable -> szCacheName         
1 -> cUpdateDataSource       
Error Status Variable<- cErrorStatus                   
employee's address book number-> mnAddressNumber     
new data values -> data columns        

5. Update the database with the records in cache.

   Employee MBF Cache Commit
U   -> cActionCode           
Cache Variable -> szCacheName    
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus 

6. Destroy the cache.

   Employee MBF Cache Destroy
Cache Variable  -> szCacheName
0 or 1  -> cErrorMode  
Error Status Variable<- cErrorStatus

Perform the following step to edit an existing employee without updating the table (edit-only):

1. Use this call to edit proposed changes to fields without actually updating the table. The edits 
are performed for only those columns in the column list. If the list is blank, all columns in the data 
structure are edited. 

   Employee MBF Eligibility Data
C  -> cActionCode  
Columns to update or blank-> szColumnList            
1 -> cUpdateMode
Error Status Variable<- cErrorStatus
employee's address book number-> mnAddressNumber     
new data values -> data columns

Data Structure

D0500575E - Employee MBF Eligibility Data

Parameter NameData ItemData TypeReq/OptI/O/Both
cActionCodeACTNcharREQINPUT

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

szColumnListDSScharOPTINPUT

This field will contain a bar delimited string of data item names from the Employee Master (F060116). Each data item in the string 
corresponds with a data item in a UBE data structure. This mapping will allow RI values to be passed to a UBE when run dynamically from a BSFN.

szCacheNameDTAIcharOPTINPUT

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.

cInquiryModeEV01charOPTINPUT

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

cUpdateModeEV01charOPTINPUT

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

cUpdateDataSourceEV01charOPTINPUT

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

cEditModeEV01charOPTINPUT

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

cErrorModeEV01charOPTINPUT

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

szCallingProgramIdPIDcharOPTINPUT

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.

szCallingVersionVERScharOPTINPUT

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.

cErrorStatusEV01charOPTOUTPUT

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

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

cUpdateFlagUFLGcharOPTNONE

This indicator in the employee master is under program control. It is set to Y when anything is added, changed or deleted related to the 
employee including the master file itself, the employee's pay/deduction/benefit/accrual transaction profile, his current time and pay detail 
transactions or interim check information. The principal use of this indicator is to determine whether the employee needs to be reprocessed during 
a pre-payroll rerun. The pre-payroll process automatically resets this flag to blank.

szChangeReasonTRScharOPTNONE

A code that indicates the reason for one of the following:   o  Changing an active employee's record   o  Terminating an employee   o  
Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The 
code for new hires is the default reason code.

jdDateEffectiveEFTJDEDATEOPTNONE

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.

cEligibilityCode1E001charOPTNONE

A code to specify an employee's eligibility for or participation in various user defined plans or programs. For example, these codes can be 
used to designate the following:    Voluntary Accidental Death/Dismemberment Insurance (Y/N)    Overtime Call Up (Y/N)    Profit Sharing 
(Y/N)    Political Action Committee (Y/N)    Coffee Fund (Y/N)    U.S. Citizen (Y/N)

cEligibilityCode2E002charOPTNONE

A code that specifies employee eligibility for or participation in various user-defined plans or programs. For example, you might use these 
codes to designate the following:   o  Voluntary Accidental Death or Dismemberment Insurance (Y/N)   o  Overtime Call Up (Y/N)   o  Profit 
Sharing (Y/N)   o  Political Action Committee (Y/N)   o  Coffee Fund (Y/N)   o  U.S. Citizen (Y/N)

cEligibilityCode3E003charOPTNONE

A code that specifies employee eligibility for or participation in various user-defined plans or programs. For example, you might use these 
codes to designate the following:   o  Voluntary Accidental Death/Dismemberment Insurance (Y/N)   o  Overtime Call Up (Y/N)   o  Profit 
Sharing (Y/N)   o  Political Action Committee (Y/N)   o  Coffee Fund (Y/N)   o  U.S. Citizen (Y/N)

cEligibilityCode4E004charOPTNONE

A code to specify an employee's eligibility for or participation in various user defined plans or programs. For example, these codes can be 
used to designate the following:    Voluntary Accidental Death/Dismemberment Insurance (Y/N)    Overtime Call Up (Y/N)    Profit Sharing 
(Y/N)    Political Action Committee (Y/N)    Coffee Fund (Y/N)    U.S. Citizen (Y/N)

cEligibilityCode5E005charOPTNONE

A code to specify an employee's eligibility for or participation in various user defined plans or programs. For example, these codes can be 
used to designate the following:    Voluntary Accidental Death/Dismemberment Insurance (Y/N)    Overtime Call Up (Y/N)    Profit Sharing 
(Y/N)    Political Action Committee (Y/N)    Coffee Fund (Y/N)    U.S. Citizen (Y/N)

cEligibilityCode6E006charOPTNONE

A code to specify an employee's eligibility for or participation in various user defined plans or programs. For example, these codes can be 
used to designate the following:    Voluntary Accidental Death/Dismemberment Insurance (Y/N)    Overtime Call Up (Y/N)    Profit Sharing 
(Y/N)    Political Action Committee (Y/N)    Coffee Fund (Y/N)    U.S. Citizen (Y/N)

cEligibilityCode7E007charOPTNONE

A code that specifies employee eligibility for or participation in various user-defined plans or programs. For example, these codes might 
be used to designate the following:   o  Voluntary Accidental Death or Dismemberment Insurance (Y/N)   o  Overtime Call Up (Y/N)   o  Profit 
Sharing (Y/N)   o  Political Action Committee (Y/N)   o  Coffee Fund (Y/N)   o  U.S. Citizen (Y/N)

cEligibilityCode8E008charOPTNONE

A code to specify an employee's eligibility for or participation in various user defined plans or programs. For example, these codes can be 
used to designate the following:    Voluntary Accidental Death/Dismemberment Insurance (Y/N)    Overtime Call Up (Y/N)    Profit Sharing 
(Y/N)    Political Action Committee (Y/N)    Coffee Fund (Y/N)    U.S. Citizen (Y/N)

cEligibilityCode9E009charOPTNONE

A code to specify an employee's eligibility for or participation in various user defined plans or programs. For example, these codes can be 
used to designate the following:    Voluntary Accidental Death/Dismemberment Insurance (Y/N)    Overtime Call Up (Y/N)    Profit Sharing 
(Y/N)    Political Action Committee (Y/N)    Coffee Fund (Y/N)    U.S. Citizen (Y/N)

cEligibilityCode010E010charOPTNONE

A code to specify an employee's eligibility for or participation in various user defined plans or programs. For example, these codes can be 
used to designate the following:    Voluntary Accidental Death/Dismemberment Insurance (Y/N)    Overtime Call Up (Y/N)    Profit Sharing 
(Y/N)    Political Action Committee (Y/N)    Coffee Fund (Y/N)    U.S. Citizen (Y/N)

cNDTCodeOwnerOfficerK001charOPTNONE

The non-discrimination testing code that you use to identify owners and officers of the company.

cNDTCodeLookBackTop20K002charOPTNONE

The non-discrimination testing code that identifies the top 20% most highly compensated employees for the previous year.

cNDTCodeLookBackYearHCEK003charOPTNONE

The non-discrimination testing code that identifies the employees who were highly-compensated in the previous year.

cNDTCodeDeterminationTop20K004charOPTNONE

The non-discrimination testing code that identifies the top 20% most highly compensated employees for the determination year.

cNDTCodeDeterminationTop100K005charOPTNONE

The non-discrimination testing code that identifies the 100 employees who were paid the most during the determination year.

cNDTCodeDeterminationTop10K006charOPTNONE

The non-discrimination testing code that identifies the 10 employees who were paid the most during the determination year.

cNDTCodeDeterminationYrHCEK007charOPTNONE

The non-discrimination testing code that identifies the employees who were highly-compensated in the determination year.

cNDTCodeMinHoursEligibilityK008charOPTNONE

A code that indicates an employee has worked the minimum number of hours required for participating in your organization's 401(k) plan. 
When you run the Determine Eligibility by Hours program (P083675), the system automatically completes this field with "yes" for each 
employee who has worked at least the minimum number of hours.

c401kNonDiscriminationTest009K009charOPTNONE

This non-discrimination test field is currently not being used.

c401kNonDiscriminationTest010K010charOPTNONE

This non-discrimination test field is currently not being used.

cOregonInsuranceORGcharOPTNONE

A code to specify whether an employee is participating in the Oregon Industrial Insurance program. The Oregon SUI continuation report 
reads this field to determine what is to be entered into the appropriate box on the tax return. NOTE:  This data item is no longer required, as of 
January 1, 1996.

cPensionPENScharOPTNONE

A code that specifies whether the employee is eligible to participate in the company's retirement plan. When you process W-2 information 
for employees, the code that you enter in this field determines whether the system places an X, indicating employee eligibility, in the 
Retirement plan box of the employee's W-2 form.

Related Functions

B0000130 Retrieve Company From Business Unit
B0000564 Get Internal Next Number
B0100066 Recursive Relationship Check
B0500543 Validate Geo Code
B0500895 Is a Real Time Event Enabled
B0800007 Delete Employee Related Tables
B5100003 F0006 Check Business Unit Existence
B9800100 Get Audit Information
B9800420 Get Data Dictionary Definition
B9900410 Get Environment Value
N0500020 Update Payroll Lockout Code
N0500025 Salary Calculations Server
N0500032 Synchronize EE/Supervisor in EE Master &&&& Org Structure
N0500042 F08001 Retrieve Specific Job Information
N0800002 Set Employee Current Status Flag\Employee Id Validation
N0800003 Verify Job/Retrieve Job Default Information
N0800004 Compa-Ratio Server
N0800005 Pay Grade Server
N0800007 Delete Employee Edit
N0800008 Update F06210 to Force Payroll Rerun
N0800020 Update Employee Job (F060118) Server
N0800029 Transfer Supp Data on Hire/Terminate Employee
N0800030 Fiscal Year Begin & End Dates
N0800031 Get UDC Description
N0800050 Position Budget Edit Server
N0800069 F08040 - Get HR Constants Information
N0800146 Get a Specific Employee Self Service Common Setting
N0800204 Track Employee Date in Current Position/Job
XX0901 Validate Account Number

Related Tables

F0006 Business Unit Master
F00091 Supplemental Database Data Types
F00092 Supplemental Data
F00191 Generic Message/Rates
F0101 Address Book Master
F0150 Address Organization Structure Master
F060116 Employee Master Information
F060117 Employee Master - International Data
F060120 Employee Master Additional Information File
F065016 Automatic Bank Deposit Master
F069096 Payroll General Constants
F07300 Employee Lockout Code File
F08005 Business Unit/ Job Id. X-Ref
F08092 Human Resources General Description-User Def Codes
F08101 Position Master
F08102 Requisition Information
F08105 Requisition Activity
F08401 Applicant Master
F9203 Data Item Alpha Descriptions
F9210 Data Field Specifications (OneWorld)
EmployeeMBFInternationalData

EmployeeMBFInternationalData

Employee MBF

Minor Business Rule

Object Name: B0500575

Parent DLL: CHRM

Location: Client/Server

Language: C

Function Name: EmployeeMBFInternationalData

Purpose and Processing (why use it and what the function does)

• 

This function performs edits and updates for fields in the F060117 (Employee International Data) 
table.

• 
This function is one of several Employee MBF segments.

   Processing Modes 

The MBF uses the following parameters to control processing. They are included in the control 
block at the top of the data structure. 

cActionCode      - The action code determines which basic operation to perform.

szColumnList    - Used to process a specific list of columns rather than all of 
the columns for a segment. The column list string is composed         
of the alias for each column separated  by a comma. The MBF processes 
all columns when this value is blank or NULL. The alias for each 
data item is listed below in the  parameters section.

cInquiryMode     - The inquiry mode controls how an inquiry is processed. Data 
can be fetched from the table, fetched from the table and saved 
in cache, or fetched from cache. 

cUpdateMode      - The update mode controls what portion of the update to 
execute. Data can be edited, updated, or both. 
 
cUpdateDataSource     - The update data source specifies whether the MBF updates the 
table or the cache. 

cEditMode     - The edit mode specifies whether to perform a full edit or
a partial edit. A partial edit omits data dictionary edits
for the fields.  

cErrorMode     - The error mode controls error message processing. Error
messages can be displayed, suppressed or saved in a cache.

cErrorStatus    - The error status indicates whether or not the MBF encountered
errors.

   Important Notes

• 
You must use the MBF Cache to process any Warnings (type 2 or 3 errors).
• You must use the MBF Cache to Log errors (cErrorMode 2).
• If you are using more that one MBF Segment it is advisable to use the cache.

 
Parameters (how to call the function)
    
ParameterColumn ListI/ODescription
---------------------------------------------------------------------------------------
cActionCodeII  - Inquiry
 A  - Add new employee record (new hire)   
     C  - Change an existing employee record        
D  - Delete (Master segment)

szColumnListIList of data items to process or blank
to process all data items.

szCacheNameIThe name assigned to the cache by the
Employee MBF Cache Create function, or
blank if not using the cache.

cInquiryModeI0 or blank  - Fetch from table
1 - Fetch from table and save in cache
2 - Fetch from cache

cUpdateMode I0 or blank  - Edit and update
   1    - Edit only
   2    - Update only

cUpdateDataSource I0 or blank
  - Save to table if cActionCode = C
                           Save to cache if cActionCode = A
   1 - Save to cache

cEditMode I0 or blank  - Full edit
   1 - Partial edit (no data dict. edit)

cErrorMode  I0 or blank  - Normal error processing
   1  - Suppress error message display
2  - Log errors in the cache

szCallingProgramIdIName (ID) of the calling program.  
Updated to audit field PID.

szCallingVersionIVersion of the calling program. May be 
used in processing.

cErrorStatusO0 or blank  - Success
1        - Failure

mnAddressNumberI/OField in F060117 Table

szEmployeeNameNAMPI/OField in F060117 Table

szMaidenNameAlphaMALPI/OField in F060117 Table

mnEstimatedSalaryESALI/OField in F060117 Table

cSeizureExmptMthdESMDI/OField in F060117 Table

mnSeizureExmptAmtRateEXSZI/OField in F060117 Table

szLanguagePreferenceLNGPI/OField in F060117 Table

szAlienRegistrationNumberALRNI/OField in F060117 Table

szSalutationSALUI/OField in F060117 Table

szSuffixSUFFI/OField in F060117 Table

szPreferredNamePRNMI/OField in F060117 Table

szAdditionalNameADDNI/OField in F060117 Table

szCurrencyCodeFromCRCDI/OField in F060117 Table

szNOCCanEmpEquityCENCI/OField in F060117 Table

szCensusMetropAreaCanEmpEQCECMI/OField in F060117 Table

szSectorIndustCodeCanEmpEQCESII/OField in F060117 Table


Use (how to use the function and other related functions)

You are referred to the Employee MBF Master Data documentation for details on how to add a new 
employee to the database.

Perform the following step to update an exsisting employee (single segment):

1. Call the function with the parameters listed below. Use the szColumnList parameter if you do not 
want to update all of the columns for the segment.

   Employee MBF International Data
C -> cActionCode 
Columns to update or blank-> szColumnList
Error Status Variable<- cErrorStatus                   
employee's address book number-> mnAddressNumber     
new data values -> data columns        

Perform the following steps to update an exsisting employee using cache (multiple segments):

1. Initialize the cache.

   Employee MBF Cache Create
Cache Variable <- szCacheName       
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                   

2. Inquire on the table and save the records to cache. Two calls are required here because the 
International Data and Master Data segments access different tables.

   Employee MBF International Data
I -> cActionCode              
1 -> cInquireyMode
Cache Variable -> szCacheName  
Error Status Variable<- cErrorStatus                          
employee's address book number-> mnAddressNumber     

   Employee MBF Master Data
I -> cActionCode              
1 -> cInquireyMode
Cache Variable -> szCacheName 
Error Status Variable<- cErrorStatus                           
employee's address book number-> mnAddressNumber     

3. Update the cache with data for the segment. Use the szColumnList parameter if you do not want to 
update all of the columns for the segment.

   Employee MBF International Data
C -> cActionCode 
Columns to update or blank-> szColumnList
Cache Variable -> szCacheName  
1 -> cUpdateDataSource 
Error Status Variable<- cErrorStatus                         
employee's address book number-> mnAddressNumber     
new data values -> data columns        

4. Update the cache with data for other segments. Replace the segment shown here with the segment 
that you want to update. This example uses the column list to update the TARA and TARR fields.

   Employee MBF Master Data US
C -> cActionCode              
ALPH,SSN-> szColumnList
1 -> cUpdateDataSource       
Cache Variable -> szCacheName 
Error Status Variable<- cErrorStatus                           
employee's address book number-> mnAddressNumber     
as desired  -> processing options  

5. Update the database with the records in cache.

   Employee MBF Cache Commit
U   -> cActionCode           
Cache Variable -> szCacheName    
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus 

6. Destroy the cache.

   Employee MBF Cache Destroy
Cache Variable  ->  szCacheName  //saved cache name
0 or 1-> cErrorMode  
Error Status Variable<- cErrorStatus                   

Perform the following step to edit an existing employee without updating the table (edit-only):

1. Use this call to edit proposed changes to fields without actually updating the table. The edits 
are performed for only those columns in the column list. If the list is blank, all columns in the data 
structure are edited.

   Employee MBF International Data
C  -> cActionCode  
Columns to update or blank-> szColumnList            
1 -> cUpdateMode
Error Status Variable<- cErrorStatus
employee's address book number-> mnAddressNumber     
new data values -> data columns        

   

Data Structure

D0500575G - Employee MBF International Data

Parameter NameData ItemData TypeReq/OptI/O/Both
cActionCodeACTNcharREQINPUT

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

szColumnListDSScharOPTINPUT

This field will contain a bar delimited string of data item names from the Employee Master (F060116). Each data item in the string 
corresponds with a data item in a UBE data structure. This mapping will allow RI values to be passed to a UBE when run dynamically from a BSFN.

szCacheNameDTAIcharOPTINPUT

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.

cInquiryModeEV01charOPTINPUT

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

cUpdateModeEV01charOPTINPUT

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

cUpdateDataSourceEV01charOPTINPUT

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

cEditModeEV01charOPTINPUT

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

cErrorModeEV01charOPTINPUT

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

szCallingProgramIdPIDcharOPTINPUT

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.

szCallingVersionVERScharOPTINPUT

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.

cErrorStatusEV01charOPTOUTPUT

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

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

szEmployeeNameNAMPcharOPTNONE

A 50-character alphabetical field for the extended name for an employee. You can use this field on certain designated reports in place of 
the normal 40-character name.

szMaidenNameAlphaMALPcharOPTNONE

The surname that a female employee had at birth. This information is used for all government reports.

mnEstimatedSalaryESALMATH_NUMERICOPTNONE

The amount of estimated salary recorded on the employee's TDIX form. The system uses this amount and the estimated expenses, to 
determine the taxable gross income for commission taxation.

cSeizureExmptMthdESMDcharOPTNONE

This code defines whether the wages exempt from seizure are an amount or are a percentage of net pay after taxes.

mnSeizureExmptAmtRateEXSZMATH_NUMERICOPTNONE

An amount or a percentage of net pay after taxes which may not be used to satisfy a garnishment deduction.

szLanguagePreferenceLNGPcharOPTNONE

A user defined code (01/LP) that specifies the language to use on forms and printed reports. Before you specify a language, a code for that 
language must exist at either the system level or in your user preferences.

szAlienRegistrationNumberALRNcharOPTNONE

The alien registration number for employees who have more than one ID. For instance, if you have a foreign employee who is working 
under a green card,you could record that number in this field.

szSalutationSALUcharOPTNONE

The salutation code is used to identify the proper title for a given employee. Some examples are Mr., Ms., Dr., and so on.

szSuffixSUFFcharOPTNONE

The suffix code is used to identify the credentials for a given employee. Some examples are Phd, MD, CPA, and so on.

szPreferredNamePRNMcharOPTNONE

The preferred name of the employee. For instance, an employee might have the legal name of Catherine but might be known as Cathy.

szAdditionalNameADDNcharOPTNONE

The additional name field can be used to store middle name(s), a previous married name, or an alias associated with the employee.

szCurrencyCodeFromCRCDcharOPTNONE

A code that identifies the currency of a transaction. 

szNOCCanEmpEquityCENCcharOPTNONE

A code that identifies the National Occupational Classification (NOC) for a job or employee. The Canadian government defines NOC 
codes. See the Canadian Federal Employment Equity documentation for more information about NOC codes.

szCensusMetropAreaCanEmpEQCECMcharOPTNONE

A code that identifies the Census Metropolitan Area code of work. Valid codes are defined by the Canadian government and can be found 
in the Canadian Federal Employment Equity documentation.

szSectorIndustCodeCanEmpEQCESIcharOPTNONE

A code that identifies the Sector Industrial Code. These codes are defined by the Canadian government and can be found in the Canadian 
Federal Employment Equity documentation.

Related Functions

B0000130 Retrieve Company From Business Unit
B0000564 Get Internal Next Number
B0100066 Recursive Relationship Check
B0500543 Validate Geo Code
B0500895 Is a Real Time Event Enabled
B0800007 Delete Employee Related Tables
B5100003 F0006 Check Business Unit Existence
B9800100 Get Audit Information
B9800420 Get Data Dictionary Definition
B9900410 Get Environment Value
N0500020 Update Payroll Lockout Code
N0500025 Salary Calculations Server
N0500032 Synchronize EE/Supervisor in EE Master &&&& Org Structure
N0500042 F08001 Retrieve Specific Job Information
N0800002 Set Employee Current Status Flag\Employee Id Validation
N0800003 Verify Job/Retrieve Job Default Information
N0800004 Compa-Ratio Server
N0800005 Pay Grade Server
N0800007 Delete Employee Edit
N0800008 Update F06210 to Force Payroll Rerun
N0800020 Update Employee Job (F060118) Server
N0800029 Transfer Supp Data on Hire/Terminate Employee
N0800030 Fiscal Year Begin & End Dates
N0800031 Get UDC Description
N0800050 Position Budget Edit Server
N0800069 F08040 - Get HR Constants Information
N0800146 Get a Specific Employee Self Service Common Setting
N0800204 Track Employee Date in Current Position/Job
XX0901 Validate Account Number

Related Tables

F0006 Business Unit Master
F00091 Supplemental Database Data Types
F00092 Supplemental Data
F00191 Generic Message/Rates
F0101 Address Book Master
F0150 Address Organization Structure Master
F060116 Employee Master Information
F060117 Employee Master - International Data
F060120 Employee Master Additional Information File
F065016 Automatic Bank Deposit Master
F069096 Payroll General Constants
F07300 Employee Lockout Code File
F08005 Business Unit/ Job Id. X-Ref
F08092 Human Resources General Description-User Def Codes
F08101 Position Master
F08102 Requisition Information
F08105 Requisition Activity
F08401 Applicant Master
F9203 Data Item Alpha Descriptions
F9210 Data Field Specifications (OneWorld)
EmployeeMBFMasterData

EmployeeMBFMasterData

Employee MBF

Minor Business Rule

Object Name: B0500575

Parent DLL: CHRM

Location: Client/Server

Language: C

Function Name: EmployeeMBFMasterData

Purpose and Processing (why use it and what the function does)

• 

This function performs edits and updates for the largest set of general employee related fields 
in the F060116 (Employee Master) table.
• 
• 
This function is one of several Employee MBF segments.
• 

• 
Processing options and flags drive some of the edits. They are located at the bottom of the data 
structure.
• 

•    Processing Modes
• 
• 
The MBF uses the following parameters to control processing. They are included in the control 
block at the top of the data structure. 
• 
• cActionCode      - The action code determines which basic operation to perform.
• 
• szColumnList    - Used to process a specific list of columns rather than all of 
the columns for a segment. The column list string is composed         of 
the alias for each column separated  by a comma. The MBF processes all 
columns when this value is blank or NULL. The alias for each data item is 
listed below in the  parameters section.
• 
• cInquiryMode     - The inquiry mode controls how an inquiry is processed. Data 
can be fetched from the table, fetched from the table and saved in 
cache, or fetched from cache. 
• 
• cUpdateMode      - The update mode controls what portion of the update to 
execute. Data can be edited, updated, or both. 
• 
• cUpdateDataSource     - The update data source specifies whether the MBF updates the 
table or the cache. 
• 
• cEditMode     - The edit mode specifies whether to perform a full edit or
• a partial edit. A partial edit omits data dictionary edits
• for the fields.  
• 
• cErrorMode     - The error mode controls error message processing. Error
• messages can be displayed, suppressed or saved in a cache.
• 
• cErrorStatus    - The error status indicates whether or not the MBF encountered
errors.
• 
•    Important Notes
• 
• 
You must use the MBF Cache to process any Warnings (type 2 or 3 errors).
• You must use the MBF Cache to Log errors (cErrorMode 2).
• If you are using more that one MBF Segment it is advisable to use the cache.
• There is only one cache for the entire F060116 file so all F060116 segments inquire and update 
the same cache


Parameters (how to call the function)
    
ParameterColumn List I/ODescription
-------------------------------------------------------------------------------------
cActionCodeII  - Inquiry
 A  - Add new employee record (new hire)   
     C  - Change an existing employee record        D  - 
Delete (Master segment)
szColumnListIList of data items to process or blank
to process all data items.

szCacheNameIThe name assigned to the cache by the
Employee MBF Cache Create function, or
blank if not using the cache.

cInquiryModeI0 or blank  - Fetch from table
1 - Fetch from table and save in cache
2 - Fetch from cache

cUpdateModeI0 or blank  - Edit and update
   1    - Edit only
   2    - Update only

cUpdateDataSource I0 or blank
  - Save to table if cActionCode = C
                           Save to cache if cActionCode = A
   1 - Save to cache

cEditMode I0 or blank  - Full edit
   1 - Partial edit (no data dict. edit)

cErrorMode  I0 or blank  - Normal error processing
   1  - Suppress error message display
2  - Log errors in the cache

szCallingProgramIdIName (ID) of the calling program.  
Updated to audit field PID.

szCallingVersionIVersion of the calling program. May be 
used in processing.

cErrorStatusO0 or blank  - Success
1        - Failure

mnAddressNumberI/OField in F060116 Table

cUpdateFlagI/OField in F060116 Table
                         
szChangeReasonI/OField in F060116 Table
                   
jdDateEffectiveI/OField in F060116 Table

szNameAlphaALPHI/OField in F060116 Table
                     
szEmployeeTaxIdSSNI/OField in F060116 Table
                 
szAdditionalEmployeeNoOEMPI/OField in F060116 Table
           
cGenderSEXI/OField in F060116 Table
                             
mnNumberOfDependentsNDEPI/OField in F060116 Table
                
cEmploymentStatusESTI/OField in F060116 Table
                   
szCompanyHomeHMCOI/OField in F060116 Table
                    
szSecurityBusinessUnitMCUI/OField in F060116 Table
          
szBusinessUnitHomeHMCUI/OField in F060116 Table
              
szCheckRouteCodeMAILI/OField in F060116 Table
                
cEmployeePayStatusPASTI/OField in F060116 Table
                
cPayFrequencyPFRQI/OField in F060116 Table
                     
cPayTypeHSPSALYI/OField in F060116 Table
                       
mnBenefitCycleBypassCtBCBI/OField in F060116 Table
            
szUnionCodeUNI/OField in F060116 Table
                    
szJobCategoryJBCDI/OField in F060116 Table
                  
szJobStepJBSTI/OField in F060116 Table
                      
szJobCategoryEeoEEOJI/OField in F060116 Table
               
szEthnicCodeEEOMI/OField in F060116 Table
                   
cOvertimeExemptFLSAI/OField in F060116 Table
                   
cShiftCodeSHFTI/OField in F060116 Table
                        
mnRtSalarySALI/OField in F060116 Table
                        
mnRtHourlyPHRTI/OField in F060116 Table
                        
mnRtPieceworkPPRTI/OField in F060116 Table
                     
mnRtPiecerateAtNxtRaisPWRNI/OField in F060116 Table
            
mnRtHrAtNextRaiseHRTNI/OField in F060116 Table
                 
mnRtBillAtNextRaiseBRTNI/OField in F060116 Table
               
mnRtSalaryAtNxtRaiseSALNI/OField in F060116 Table
              
mnHrsStandardPerPayperSTDHI/OField in F060116 Table
            
mnHoursStandardPerDaySTDDI/OField in F060116 Table
             
mnDaysStandardperYearSDYYI/OField in F060116 Table
             
mnStdHoursPerYearIHI/OField in F060116 Table
                 
jdDateBirthDOBI/OField in F060116 Table
                       
jdDateOriginalEmploymentDSII/OField in F060116 Table
          
jdDateTerminatedDTI/OField in F060116 Table
                  
jdDateEmploymentStartDSTI/OField in F060116 Table
             
jdDatePayStartsPSDTI/OField in F060116 Table
                   
jdDatePayStopsPTDTI/OField in F060116 Table
                    
jdDteNextRaiseEffectiveNRDTI/OField in F060116 Table
           
jdDteNewBillRateEffectNBDTI/OField in F060116 Table
            
jdDteNewPiecerateEffectNPDTI/OField in F060116 Table
           
jdDateLastRaiseDRI/OField in F060116 Table
                   
jdDateLastContactCTDTI/OField in F060116 Table
                 
jdDateLoaExpirationLADTI/OField in F060116 Table
               
jdDateLoaStartsLSDTI/OField in F060116 Table
                   
jdDateCurrentPositionCPDTI/OField in F060116 Table
             
jdDateParticipationPADTI/OField in F060116 Table
               
jdDateRecallRCDTI/OField in F060116 Table
                     
jdDateBonusBSDTI/OField in F060116 Table
                       
InterimProcessingBatchINBTI/OField in F060116 Table
           
zPayStepPSTPI/OField in F060116 Table
                     
szPayrollLockoutIdentifiUSRI/OField in F060116 Table
      
szCountryForPayrolCCPRI/OField in F060116 Table
            
cThirdCtryNationalFlagTCNFI/OField in F060116 Table
            
cResidentAlienFlagRAFI/OField in F060116 Table
                
mnRateBillingBurdenBDRTI/OField in F060116 Table
               
mnNewRechargeBurdenRateBORNI/OField in F060116 Table
           
jdDteNewBurdRateEffectNBDRI/OField in F060116 Table
            
cAddressFlagAFLGI/OField in F060116 Table
                      
szFlagSmokerSMKRI/OField in F060116 Table
                   
mnCashBasisAccumulatorCBACI/OField in F060116 Table
            
cInterimCheckCodeICCI/OField in F060116 Table
                 
szInterimCheckUserIdIUSRI/OField in F060116 Table
          
szTerminalIdInterimCkITRMI/OField in F060116 Table
         
cCashBasisFlagCBAFI/OField in F060116 Table
                    
cPaymentMethodPYMHI/OField in F060116 Table
                    
cUpdateStatusFlagUYSTI/OField in F060116 Table
                 
mnDateTimeStampDTSPI/OField in F060116 Table
                   
szPayPeriodNumberPPNBI/OField in F060116 Table
              
jdPayCycleProcessDatePYDTI/OField in F060116 Table
             
cCashBenefitCBENI/OField in F060116 Table
                      
mnBirthdateMonthDOBMI/OField in F060116 Table
                  
mnStartdateMonthDSTMI/OField in F060116 Table
                  
mnRatePreviousSalaryPSALI/OField in F060116 Table
              
szCreditMessageCMI/OField in F060116 Table
                
mnAnnualSalaryLifeLSALI/OField in F060116 Table
                
szBenefitGroupCodeDIVCI/OField in F060116 Table
             
cVotingSharesFlagVSHFI/OField in F060116 Table
                 
mnPriorYearsVestingPYRVI/OField in F060116 Table
               
mnSupervisorANPAI/OField in F060116 Table
                      
szPayGradePGRDI/OField in F060116 Table
                     
szPayGradeStepPGRSI/OField in F060116 Table
                 
szLocalitySLOCI/OField in F060116 Table
                     
jdDteNextReviewNRVWI/OField in F060116 Table
                   
cTypeIncreaseNextRevwTINCI/OField in F060116 Table
             
szPositionIDPOSI/OField in F060116 Table
                   
szDepartmentCodeDEPTI/OField in F060116 Table
              
mnAgeFixedFAGEI/OField in F060116 Table
                        
mnSalaryFixedFSALI/OField in F060116 Table
                    
jdDateAdjustedServiceADSDI/OField in F060116 Table
             
mnCompaRatioCMPAI/OField in F060116 Table
                      
mnJobEvaluationPointsEPNTI/OField in F060116 Table
             
mnDefaultAutoPayTypeATPYI/OField in F060116 Table
              
cEmployeeBenefitStatusBENSI/OField in F060116 Table
            
mnFullTimeEquivalentsFTEI/OField in F060116 Table
        
jdSalaryForcastChangeDateDTSFI/OField in F060116 Table
         
mnMonthsStandardPerYearSMOYI/OField in F060116 Table
        
cSalaryFrequencyOCalulated For display on P0801CMP 
                    
mnPayPeriodSalaryOCalulated For display on P0801CMP 
                   
cMovetoApplicantPoolIFlag on P0801EMP
                
cPODfltJobInfoAddIProcessing option on P0801, P060116Q 
and R060116P
                   
cPODfltJobInfoChangeIProcessing option on P0801
                
cPODfltJobCategoryAddIProcessing option on P0801, P060116Q 
and R060116P
               
cPODfltJobCategoryChangeIProcessing option on P0801
            
cPOBUJobIDInfoAddIProcessing option on P0801, P060116Q 
and R060116P
cPOBUJobIDInfoChangeIProcessing option on P0801
                
cPOABSecurityBUDefaultIProcessing option on P0801
              
szPOApplicantStatusIProcessing option on P0801
              
szPOCandidateRequisitionStatIProcessing option on P0801
     
szPOOrganizationTypeStructurIProcessing option on P0801ORG                   
         


Use (how to use the function and other related functions)

Perform the following step to update an exsisting employee (single segment):

If updating several fields that cross multiple MBF sgments see caching example.

1. Call the segment with the fields you want to update and the parameters listed below. Use the 
szColumnList parameter if you do not want to update all of the columns for the segment.

   Employee MBF Master Data
      C -> cActionCode 
Columns to update or blank-> szColumnList
Error Status Variable<- cErrorStatus                   
employee's address book number-> mnAddressNumber     
new data values -> data columns        

Perform the following steps to add a new employee to the database:

1. Initialize the cache.

   Employee MBF Cache Create
Cache Variable <- szCacheName       
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                   

2. Update the cache with data for the segment. If you do not want to update all of the columns for 
the segment, use the szColumnList parameter.

   Employee MBF Master Data
A -> cActionCode   
Columns to update or blank-> szColumnList           
Cache Variable -> szCacheName
Error Status Variable<- cErrorStatus                            
employee's address book number-> mnAddressNumber     
new data values -> data columns        
as desired  -> processing options  

3. Update the cache with data for other segments. Replace the segment shown here with the segment 
that you want to update. Use the szColumnList parameter if you do not want to update all of the columns 
for a particular segment.

4. Insert the cached records into the database.

   Employee MBF Cache Commit
I   -> cActionCode           
Cache Variable -> szCacheName    
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus 

5. Close the cache.

   Employee MBF Cache Destroy
Cache Variable  -> szCacheName
0 or 1-> cErrorMode  
Error Status Variable<- cErrorStatus

Perform the following steps to update an exsisting employee using cache (multiple segments):

1. Initialize the cache.

   Employee MBF Cache Create
Cache Variable <- szCacheName       
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                   

2. Inquire on the table and save the record to cache.

   Employee MBF Master Data
I -> cActionCode              
Cache Variable -> szCacheName 
1 -> cInquireyMode
Error Status Variable<- cErrorStatus                           
employee's address book number-> mnAddressNumber     

3. Update the cache with data for the segment. Use the szColumnList parameter if you do not want to 
update all of the columns for the segment.

   Employee MBF Master Data
C -> cActionCode 
Columns to update or blank-> szColumnList           
Cache Variable -> szCacheName  
1 -> cUpdateDataSource 
Error Status Variable<- cErrorStatus                                 
employee's address book number-> mnAddressNumber     
new data values -> data columns        
as desired  -> processing options  

4. Update the cache with data for other segments. Replace the segment shown here with the segment 
that you want to update. This example uses the column list to update the TARA and TARR fields.

   Employee MBF National Data US
C -> cActionCode              
TARA,TARR -> szColumnList
Cache Variable -> szCacheName
1 -> cUpdateDataSource
Error Status Variable<- cErrorStatus                                          
employee's address book number-> mnAddressNumber     
new data values -> data columns        

5. Update the database with the records in cache.

   Employee MBF Cache Commit
U   -> cActionCode           
Cache Variable -> szCacheName    
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                                 

6. Destroy the cache.

   Employee MBF Cache Destroy
Cache Variable  -> szCacheName
0 or 1-> cErrorMode  
Error Status Variable<- cErrorStatus                                 

Perform the following step to edit an existing employee without updating the table (edit-only):

1. Use this call to edit proposed changes to fields without actually updating the table. The edits 
are performed for only those columns in the column list. If the list is blank, all columns in the data 
structure are edited.

   Employee MBF Master Data
C  -> cActionCode  
Columns to update or blank-> szColumnList            
1 -> cUpdateMode
Error Status Variable<- cErrorStatus
employee's address book number-> mnAddressNumber     
new data values -> data columns        

Perform the following steps to delete an employee master record:

1. Call the Employee MBF Master Data segment. This is the only segment that allows the 'D' action 
code. The MBF performs a pre-delete edit to verify that the employee record can be deleted. If the MBF 
encounters an error, the delete is not performed, and 1 (Failure) is returned in the cErrorStatus 
parameter. If the pre-delete edit completes successfully, all records for the employee are deleted from the 
employee tables.

   Employee MBF Master Data
D -> cActionCode              
Cache Variable-> szCacheName         
      Error Status Variable   <- cErrorStatus
employee's address book number-> mnAddressNumber   




Data Structure

D0500575A - Employee MBF Master Data

Parameter NameData ItemData TypeReq/OptI/O/Both
cActionCodeACTNcharREQINPUT

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

szColumnListDSScharOPTINPUT

This field will contain a bar delimited string of data item names from the Employee Master (F060116). Each data item in the string 
corresponds with a data item in a UBE data structure. This mapping will allow RI values to be passed to a UBE when run dynamically from a BSFN.

szCacheNameDTAIcharOPTINPUT

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.

cInquiryModeEV01charOPTINPUT

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

cUpdateModeEV01charOPTINPUT

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

cUpdateDataSourceEV01charOPTINPUT

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

cEditModeEV01charOPTINPUT

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

cErrorModeEV01charOPTINPUT

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

szCallingProgramIdPIDcharOPTINPUT

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.

szCallingVersionVERScharOPTINPUT

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.

cErrorStatusEV01charOPTOUTPUT

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

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

cUpdateFlagUFLGcharOPTNONE

This indicator in the employee master is under program control. It is set to Y when anything is added, changed or deleted related to the 
employee including the master file itself, the employee's pay/deduction/benefit/accrual transaction profile, his current time and pay detail 
transactions or interim check information. The principal use of this indicator is to determine whether the employee needs to be reprocessed during 
a pre-payroll rerun. The pre-payroll process automatically resets this flag to blank.

szChangeReasonTRScharOPTNONE

A code that indicates the reason for one of the following:   o  Changing an active employee's record   o  Terminating an employee   o  
Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The 
code for new hires is the default reason code.

jdDateEffectiveEFTJDEDATEOPTNONE

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.

szNameAlphaALPHcharOPTNONE

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.

szEmployeeTaxIdSSNcharOPTNONE

A number that indicates the tax ID. In the United States, the tax ID is the social security number. In Canada, it is the social insurance number. 
If you add employee information for a non-US or non-Canadian company, you can leave this field blank. However, if the international code is 
set to Y and the default company is non-Canadian and non-United States, you can enter a 16-character number for the tax ID. The system 
does not permit duplicate tax ID numbers. Also, the number cannot include dashes. For example, if a social security number of nn-nn-nnnn is 
used, the number should be entered as follows: 123456789.

szAdditionalEmployeeNoOEMPcharOPTNONE

An alternate employee number, typically the number from the employee tracking system that your organization used prior to converting to 
the J.D. Edwards system. To search using this number, preface the number with a slash (/).

cGenderSEXcharOPTNONE

Valid codes are: M Male   F Female  

mnNumberOfDependentsNDEPMATH_NUMERICOPTNONE

Number of dependents for insurance purposes. See also the definitions for federal and state tax exemptions.

cEmploymentStatusESTcharOPTNONE

A user defined code (07/ES) that specifies an employee's status within the company. You can change the default codes or set up new 
codes to meet the needs of your company. Sample valid values include the following:    Blank Full-time regular.    1        Full-time temporary    2        
Part-time temporary    3        Part-time regular    4        Seasonal    5        Casual

szCompanyHomeHMCOcharOPTNONE

The company number where the employee records generally reside.

szSecurityBusinessUnitMCUcharOPTNONE

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.

szBusinessUnitHomeHMCUcharOPTNONE

The number of the business unit in which the employee generally resides.

szCheckRouteCodeMAILcharOPTNONE

A user defined code (07/CR) that specifies the check routing or mail-stop code. Use this code to sequence the printing of payroll checks to 
facilitate their handling and delivery.

cEmployeePayStatusPASTcharOPTNONE

The code used to indicate whether an employee's pay status is active or inactive. Codes for active pay status employees are numeric, 
and codes for inactive pay status employees are alphabetic. The system omits all employees with alphabetic pay status codes from the 
payroll run. See also Employment Status (EST) and Change Reason (TRS).

cPayFrequencyPFRQcharOPTNONE

A user defined code (07/PF) that indicates how often an employee is paid. Valid codes are: B Biweekly   W Weekly   S Semimonthly  
M Monthly   A Annually   C European Annualized  The system uses the value in the Description-2 field on user defined codes to calculate the amount per 
pay period for a salaried employee.

cPayTypeHSPSALYcharOPTNONE

A code that specifies how an employee is paid. Valid codes are: H Hourly S Salaried P Piecework

mnBenefitCycleBypassCtBCBMATH_NUMERICOPTNONE

The number of pay cycles (paychecks) that you want the system to bypass the benefit calculations. Typically, you specify this information 
during the interim check process. If you leave this value blank when you enter an interim check, the system bypasses the same number of 
cycles that you enter in the Replace Next N Checks field. This number must be equal to or greater than the number of pay bypasses. If you 
specify less than this number, the system bypasses the same number of pay cycles that you entered in the Replace Next N Checks field. When 
you enter a value in this field, the system updates the employee's master record. If you change or delete the other information on the interim 
check,the system does not remove or adjust the bypass count. You must use the Change action on Additional Parameters to change the value 
in the Employee Master table. However, if you delete the interim check the system also deletes the value from the Employee Master table.

szUnionCodeUNcharOPTNONE

A user defined code (06/UN) that represents the union or plan in which the employee or group of employees work or participate.

szJobCategoryJBCDcharOPTNONE

A user defined code (07/G) that defines the jobs within your organization. You can associate pay and benefit information with a job type and 
apply that information to the employees who are linked to that job type.

szJobStepJBSTcharOPTNONE

A user defined code (07/GS) that designates a specific level within a particular job type. The system uses this code in conjunction with job 
type to determine pay rates by job in the Pay Rates table.

szJobCategoryEeoEEOJcharOPTNONE

A user defined code (07/J) that specifies classifications established by the U.S. Equal Employment Opportunity Commission (EEOC) or the 
Canadian Employment Equity Occupational Group (EEOG) for use in reporting levels of minority employment. Do not change any of the 
codes provided by J.D. Edwards. You can add codes if needed.

szEthnicCodeEEOMcharOPTNONE

A user defined code (07/M) that designates minority classifications according to U.S. Equal Employment Opportunity Commission (EEOC) 
and Canadian Employment Equity Occupational Group (EEOG) standards. The predefined codes that J.D. Edwards provides are 
hardcoded. The system uses these codes to generate EEO reports and to compile Canadian Employment Equity information. Do not change these 
predefined codes. You can add codes, if necessary.

cOvertimeExemptFLSAcharOPTNONE

A code that indicates whether the employee fits the rules of the Fair Labor Standards Act (FLSA) and thus does not have to be paid for 
working overtime. Valid codes are: Y Yes, the employee fits the rules and does not have to be paid for working overtime. N No, the employee 
does not fit the rules and is to be paid for working overtime.

cShiftCodeSHFTcharOPTNONE

A user defined code (00/SH) that identifies daily work shifts. In payroll systems, you can use a shift code to add a percentage or amount to 
the hourly rate on a timecard. For payroll and time entry: If an employee always works a shift for which a shift rate differential is applicable, 
enter that shift code on the employee's master record. When you enter the shift on the employee's master record, you do not need to enter the 
code on the timecard when you enter time. If an employee occasionally works a different shift, you enter the shift code on each applicable 
timecard to override the default value.

mnRtSalarySALMATH_NUMERICOPTNONE

The amount that an employee is paid in one year, assuming that the employee is paid every pay period of the year. For WorldSoftware: For 
the employee's primary job, the system stores the annual salary in the Employee Master Information table (F060116) and the Employee 
Jobs table (F060118). For secondary jobs, the system stores the annual salary only in the Employee Jobs table (F060118). Depending on how 
the value that is entered in the Display Salary (Annual/Effective) field in the HR History Constants table (F08040), this field displays one of the 
following:   o  Annual salary. For salaried employees who are not linked with a contract calendar, the user enters the amount or the system 
retrieves the amount from the Pay Grade/Salary Range Table (F082001). For employees who are linked with a contract calendar, the system 
calculates this amount using the following formula: (((current salary minus salary paid before change) divided by number of periods to pay) 
multiplied by pay frequency).   o  Effective salary. For employees whose jobs are linked with a contract calendar, the system recalculates the 
effective salary when you enter a mid-calendar salary adjustment. After you enter a mid-calendar adjustment, the effective salary equals the 
salary that is paid to the employee from the time of the adjustment through the end of the contract. The system calculates this amount using 
the following formula: ((annual salary divided by pay frequency) times periods to pay). 

mnRtHourlyPHRTMATH_NUMERICOPTNONE

The employee's hourly rate, which is retrieved during time entry. If you enter a rate in this field on any other form, that rate can override the 
value in the Employee Master table. In the Employee Master table, this number is the employee's base hourly rate. In the Union Rates table, it 
is the straight time rate. NOTE: If you change the number of the data display decimal digits for this field, you must also change fields Rate - 
Base Hourly (BHRT) and Rate - Hourly (SHRT) so that they have exactly the same number of data display decimal digits.

mnRtPieceworkPPRTMATH_NUMERICOPTNONE

The rate paid for the type of component (piece) produced.  If you enter a rate in this field, this rate overrides the rate in the Employee Master 
file.

mnRtPiecerateAtNxtRaisPWRNMATH_NUMERICOPTNONE

This will be the employee's new piecework rate of pay for all payroll entries input or automatically generated FOR THE PAYROLL PERIOD 
AFTER his Date of Next Raise from his employee master record. See definition for "Date - Next Raise" (NRDT)

mnRtHrAtNextRaiseHRTNMATH_NUMERICOPTNONE

The base hourly rate increase for an employee. The following will be added together to determine recommended hourly increase for an 
employee:     o Hourly Rate (see data item, HRTN),     o Cost of Living (see data item, AMT6),     o Local Cost of Living (see data item, AMT7),     o 
Merit Increase (see data item, AMT8), and     o Promotion (see data item, AMT9).

mnRtBillAtNextRaiseBRTNMATH_NUMERICOPTNONE

This will be the employee's new hourly billing rate for all payroll entries input or automatically generated FOR THE PAYROLL PERIOD 
AFTER his Date of Next Raise from his employee master record. See definition of "Date - Next Raise" (NRDT)

mnRtSalaryAtNxtRaiseSALNMATH_NUMERICOPTNONE

The employee's new annual salary for all payroll entries manually entered or automatically generated for the payroll period after the Date 
of Next Raise from the employee's master record. See the definition for data item NRDT (Date - Next Raise).

mnHrsStandardPerPayperSTDHMATH_NUMERICOPTNONE

The standard number of hours that you want to pay an hourly employee for in each payroll, regardless of whether the employee works 
more or less hours. If you leave this field blank, the system bases it on time entry only.

mnHoursStandardPerDaySTDDMATH_NUMERICOPTNONE

The number of hours that the employee normally works in one day. If you leave this field blank, the default is the standard number of hours 
per day that you defined in the payroll company constants (company options, in OneWorld). For example, if, in the payroll company constants 
(company options), you specified 8 as the standard number of hours per day, but a few employees normally work 7 hours per day, enter 7 in 
this field for those employees.

mnDaysStandardperYearSDYYMATH_NUMERICOPTNONE

The number of workdays in a year. The number of standard days per year multiplied by the number of hours per day equals the standard 
hours per year. When you set up the human resources constants (System Options, in OneWorld) and you use the pay grade step table as the 
default source for the pay rate,the system calculates the salary for an employee by multiplying the standard days per year by the 
employee's hourly rate.

mnStdHoursPerYearIHMATH_NUMERICOPTNONE

The number of work hours in the year. When you do not set your payroll company constants to use the Pay Grade Step table as the 
pay-rate source, the system uses this number to compute the hourly rate when you supply the annual salary (or to compute the annual salary when 
you supply the hourly rate). When you set your constants to use the Pay Grade Step table as the pay rate source, the system uses the 
following sequence to search for the standard number of hours that it uses to calculate the salary or hourly rate per pay period:     o Employee entry 
forms (this field)     o Pay Grade Step table (hours per day multiplied by days per year)     o Payroll company constants for the employee's 
company     o Payroll company constants for the default company (company 00000)     o Data dictionary     o System default value of 2080 
standard hours per year

jdDateBirthDOBJDEDATEOPTNONE

The employee's date of birth.

jdDateOriginalEmploymentDSIJDEDATEOPTNONE

The date on which the employee was originally hired by the company. If the employee was terminated and subsequently rehired, the new 
start date will be represented by the data in the Date Started (DST) field.

jdDateTerminatedDTJDEDATEOPTNONE

The date that the employee was terminated, if applicable.

jdDateEmploymentStartDSTJDEDATEOPTNONE

The date on which the employee actually reported to work for the most recent period of hire. When an employee initially begins working, 
the default is the original hire date. If no original hire date exists, the system uses the current date. This field can be updated multiple times if, for 
example, an employee is a seasonal worker. For the calculation tables in the Payroll system and the eligibility tables and date codes in the 
Human Resources system, the system also uses this date as a start date when it calculates deductions, benefits, and accruals.

jdDatePayStartsPSDTJDEDATEOPTNONE

The date that an employee may begin participating in the company's benefit plans or may be included in payroll processing. You can also 
use this field to provide a beginning date for seasonal employees or for employees who work only part of the year (such as a teacher who 
works only nine months of the year).

jdDatePayStopsPTDTJDEDATEOPTNONE

The date when an employee should no longer be included in a payroll cycle or the date when an employee stops participating in the 
company's benefit plans. You can use this date for terminated employees, seasonal employees, or employees who work only part of the year 
(such as a teacher who works only nine months of the year). See also data item PSDT. This date may also be the date that a deduction, benefit, 
or accrual instruction stops.

jdDteNextRaiseEffectiveNRDTJDEDATEOPTNONE

The date that the hourly or annual pay rate for the employee increases. The new rate goes into effect after a payroll cycle completes with a 
pay period end date on or after the date of the next raise.

jdDteNewBillRateEffectNBDTJDEDATEOPTNONE

The date on which the new billing rate for an employee goes into effect. The new rates actually go into effect AFTER THE PAYROLL 
PROCESSING RUN that has a payroll date on or after this date.

jdDteNewPiecerateEffectNPDTJDEDATEOPTNONE

The date on which the new piecework rate for an employee goes into effect. The new rates actually go into effect AFTER THE PAYROLL 
PROCESSING RUN that has a payroll date on or after this date.

jdDateLastRaiseDRJDEDATEOPTNONE

The date of the employee's last raise. For the stand-alone HR system, this is the date when you update salary and wages. If you also have 
the Payroll system, this date is automatically updated when a payroll is run. You define pay effective dates using the Pay Rate Information 
screen.

jdDateLastContactCTDTJDEDATEOPTNONE

The date you last contacted a temporary, seasonal, or laid-off employee, or an employee on furlough or leave of absence.

jdDateLoaExpirationLADTJDEDATEOPTNONE

The date on which an employee's paid or unpaid leave of absence expires.

jdDateLoaStartsLSDTJDEDATEOPTNONE

The date on which an employee's paid or unpaid leave of absence begins. Use this date to indicate the leave for the Family and Medical 
Leave Act.

jdDateCurrentPositionCPDTJDEDATEOPTNONE

The date the employee started the current position.

jdDateParticipationPADTJDEDATEOPTNONE

The date the employee began participating in the company deferred income or stock option plan. This date must be later than the Date 
Started date.

jdDateRecallRCDTJDEDATEOPTNONE

The date on which the employee can be recalled for employment, if known.

jdDateBonusBSDTJDEDATEOPTNONE

The date an employee is to receive a bonus.  This date is also part of the supplemental data for a bonus review.

cInterimProcessingBatchINBTcharOPTNONE

This data item for future use.

szPayStepPSTPcharOPTNONE

A quantity that identifies the number of optional pay increments, if any, available within each pay grade.

szPayrollLockoutIdentifiUSRcharOPTNONE

This code is a combination of the IBM user ID and the batch number assigned to a prepayroll selection. It is used to prohibit one employee 
from being processed in more than one concurrent payroll cycle. It also locks out everyone but the user who is running the payroll (or 
prepayroll) from updating the employee's master file or time records until either the the cycle is complete or a reset of the payroll lockout is 
executed.

szCountryForPayrollCCPRcharOPTNONE

A user defined code list 00/CN that indicates the country in which the employee resides.

cThirdCtryNationalFlagTCNFcharOPTNONE

A code which specifies whether the employee is defined as a Third Country Nationalist.

cResidentAlienFlagRAFcharOPTNONE

A code which specifies whether the employee is designation as a Craft or  Staff employee. This field is reserved for future usage for 
EEO/Certified Payroll reporting.

mnRateBillingBurdenBDRTMATH_NUMERICOPTNONE

An hourly rate to be used when charging 'burden' associated with the actual billing (recharge) amounts.

mnNewRechargeBurdenRateBORNMATH_NUMERICOPTNONE

The employee's new burden billing rate for all payroll entries input or automatically generated FOR THE PAYROLL PERIOD AFTER the 
Date of Next Raise from the employee master record. See the definition for "Date - Next Raise" (NRDT).

jdDteNewBurdRateEffectNBDRJDEDATEOPTNONE

The date on which the new burden billing rate for an employee takes effect. The new rates actually go into effect AFTER THE PAYROLL 
PROCESSING RUN that has a payroll date on or after this date.

cAddressFlagAFLGcharOPTNONE

A flag used to designate whether to print address on the pay check.

szFlagSmokerSMKRcharOPTNONE

A flag to identify the language preference of the employee. Codes are:    E English    F French 

mnCashBasisAccumulatorCBACMATH_NUMERICOPTNONE

The amount of Net Pay which was rounded in or out in order to pay the employee a whole dollar versus dollars and cents. Any amount 
within this field will automatically be applied to any subsequent cash payment in order to reduce the accumulator to zero. Therefore, if an 
employee has a cash accumulator of .87  and a Net Pay amount of 1.14, the accumulator will be reduced to .01 and the employee will receive a 
Payslip in the amount of 2.00.

cInterimCheckCodeICCcharOPTNONE

For OneWorld: A code that indicates one of the following conditions:    Blank The payment was processed in a regular payroll cycle.    I         
The payment was processed as an interim. Interim payments can include replacements for both regular voided payments and manually 
voided payments.    X        The payment is an original payment that has been voided. For World: An internal code that indicates one of the following 
conditions:     o The time and pay record is for an interim payment.     o The record in the Payment table (F07350) is an interim payment.     o An 
employee has an interim payment in the Payment table for the current pay period. Valid codes are:    X The payment has been voided.    V 
The payment is a void of a previously-entered payment.    I  The payment was processed as an interim check.    Blank The payment was 
processed in a regular payroll cycle.

szInterimCheckUserIdIUSRcharOPTNONE

This is the user id by which the interim check was entered. This is needed to control the tax, deduction and benefit calculations for the 
interim check. The code is blanked after the calculations are performed.

szTerminalIdInterimCkITRMcharOPTNONE

This is the terminal from which the interim check was entered. This is needed to control the tax, deduction and benefit calculations for the 
interim check. The code is blanked after the calculations are performed.

cCashBasisFlagCBAFcharOPTNONE

A flag to indicate whether the employee wishes to accumulate cents within the Cash Basis Accumulator field(0) or adjust the Federal Tax up 
or down for the amount of the non whole dollar(1).

cPaymentMethodPYMHcharOPTNONE

A flag used to indicate how the employee is to be paid. This field may be used to override all Net Pay Instructions for the employee or 
simply indicate that the employee wishes to be paid in cash. The valid values include:    C        Override all Net Pay Instructions and generate a 
payslip(CASH).    O        Override all Net Pay Instructions and generate a check.    Blank Standard default logic for Net Pay Instructions. *Special 
Use for Canadian Payrolls on the F06210 file: A flag used to indicate if, for Unemployment Insurance purposes, hours worked in multi-week 
pay cycles are to be evaluated on a weekly basis or on a total pay period basis for Qualify Weeks determination:    O        Override Pay Period 
Basis and use weekly evaluation    Blank Use Total Pay Period for U/I Qualifying Weeks evaluation 

cUpdateStatusFlagUYSTcharOPTNONE

This code is used in the final update process to determine if an employee's records have been upated completely, or if the employee must 
be run through final update again.

mnDateTimeStampDTSPMATH_NUMERICOPTNONE

The date and time which the transaction is being, or was processed, through Final Update.

szPayPeriodNumberPPNBcharOPTNONE

The number of the pay period from the beginning of the year. For instance, a monthly payroll cycle beginning in January has a total of 12 
periods with October being the 10th period. Typical values are:        001-052 (Weekly Payroll Cycle)        001-026 (Biweekly Payroll Cycle)        
001-024 (Semimonthly Payroll Cycle)        001-012 (Monthly Payroll Cycle)        001-004 (Quarterly Payroll Cycle)        001-001 (Annual Payroll Cycle)

jdPayCycleProcessDatePYDTJDEDATEOPTNONE

This data item contains the date the pay cycle was processed.

cCashBenefitCBENcharOPTNONE

A code (flag) specifying whether a BENEFIT will print on a check, auto deposit or payslip. The valid codes are:    Y  Yes, print the benefit on 
a check, auto deposit, or payslip.    N  No, do not print the benefit on a check, auto deposit or payslip.

mnBirthdateMonthDOBMMATH_NUMERICOPTNONE

The month in which the employee was born.

mnStartdateMonthDSTMMATH_NUMERICOPTNONE

The month in which the employee started working.

mnRatePreviousSalaryPSALMATH_NUMERICOPTNONE

The salary that was previously attached to an employee. This field is updated by the HR History Monitor whenever a change is made to 
the Salary field.

szCreditMessageCMcharOPTNONE

A value in the user defined code table 00/CM that indicates the credit status of a customer or supplier. Examples are: 1 Over credit 
limit 2 Requires purchase order 3 Not on contract maintenance agreement The credit message displays on inquiry and transaction entry forms in the 
Accounts Payable, Sales Order Management, and Procurement systems. The system displays the temporary credit message in the Accounts 
Receivable system.

mnAnnualSalaryLifeLSALMATH_NUMERICOPTNONE

You can use this field to calculate deductions, benefits, and accruals (DBAs) for an employee's life insurance premium. Any table method 
that begins with an I (Insurance) uses this field.

szBenefitGroupCodeDIVCcharOPTNONE

The benefit group to which the employee is assigned. Benefit groups facilitate employee enrollment by categorizing benefit plans and 
allowing enrollment rules for those categories. For example, assigning an employee to an executive (EXEC) benefit group automatically links the 
employee to the benefits available to executives in your organization.

cVotingSharesFlagVSHFcharOPTNONE

A flag to identify whether the employee ownes stock in the company and therefore is allowed to vote.

mnPriorYearsVestingPYRVMATH_NUMERICOPTNONE

The number of prior years which have been accumulating from pension vesting purposes.

mnSupervisorANPAMATH_NUMERICOPTNONE

The address book number of the supervisor.

szPayGradePGRDcharOPTNONE

A code that designates a category for grouping employees according to pay ranges. For each pay grade, you enter a pay range that 
includes a minimum, a midpoint, and a maximum pay rate. The system uses these pay ranges to calculate compa-ratios for the employees that 
you assign to pay grades. After you enter a pay grade for an employee, the system displays either an error or a warning message if you enter 
a rate for the employee that is not within the pay range for the employee's pay grade. To set up pay grades, use Pay Grades by Class 
(P082001). If you have set up your system to use rates in the Pay Grade Step table as the default pay rates for employees, changing an 
employee's pay grade step causes the system to automatically update the following fields:   o  Salary   o  Hourly Rate   o  Hours per day   o  Hours per 
year   o  Days per year  

szPayGradeStepPGRScharOPTNONE

A code that identifies a pay grade and pay step. You can use this code to determine an employee's pay rate. If you have set up your 
system to use rates in the Pay Grade Step table as the default pay rates for employees, changing an employee's pay grade step causes the 
system to automatically update the following fields:     o Salary     o Hourly Rate     o Hours per day     o Hours per year     o Days per year 

szLocalitySLOCcharOPTNONE

A user defined code (07/SL) that defines the different salary localities within an organization.  For example, you can compare salaries for 
employees on the East Coast with employees in the Midwest.

jdDteNextReviewNRVWJDEDATEOPTNONE

The date on which the employee is scheduled for the next performance or salary review. This field is for information only. It is not used by 
any programs or processes in the system.

cTypeIncreaseNextRevwTINCcharOPTNONE

A user defined code (06/RV) that specifies the type of performance review to be completed for the next review period.

szPositionIDPOScharOPTNONE

A code that you use for budgetary (position) control purposes. The position ID consists of:   o  Position (position code and its description)     
o  Fiscal year     o  Home business unit  For example, you can identify position A0-1 as Accounting Manager for fiscal year 2005-2006, for 
home business unit 41. You might choose to set up positions so that the position IDs are the same as the corresponding job IDs. Within a home 
business unit, positions appear in the alphanumeric sequence of their position IDs. For example, position A0-1 appears before position A0-2.

szDepartmentCodeDEPTcharOPTNONE

The number of the department in which the employee resides.

mnAgeFixedFAGEMATH_NUMERICOPTNONE

For World: The age of the employee as of a certain date (for example, January 1st) for a given year. You can manually update this field or 
update it each year using the future data facility. For One World: The age of the employee as of a certain date (for example, January 1st) for a 
given year. You can manually update this field or the system can update this field when you run the Update Employee Master Age report 
(R083495).

mnSalaryFixedFSALMATH_NUMERICOPTNONE

You can use this field to calculate deductions, benefits, and accruals (DBAs) for a spouse's life insurance premium. Any table method that 
begins with an F uses this field.

jdDateAdjustedServiceADSDJDEDATEOPTNONE

The date the employee was rehired by the company. If the employee terminated and subsequently returned, this date represents the date 
his/her most recent service began.

mnCompaRatioCMPAMATH_NUMERICOPTNONE

A calculation used to compare an employee's salary/wage against a midpoint amount set up within a pay grade or salary range.

mnJobEvaluationPointsEPNTMATH_NUMERICOPTNONE

The number of points calculated for a specific job using any job evaluation method. A job is defined as the combination of job type and job 
step. You can calculate the points manually and enter them at the Job Master Information level, or you can assign points to each individual 
factor that has been defined within the evaluation method.

mnDefaultAutoPayTypeATPYMATH_NUMERICOPTNONE

This code is used specifically to designate the default pay type to be used in the generation of autopay in those instances where the 
system does not use the employee labor distribution instructions. If nothing is entered in this field, then pay type 001 will be used.

cEmployeeBenefitStatusBENScharOPTNONE

A user defined code (06/EA) that specifies an employee status, such as new hire or rehire. The system uses this value as it searches and 
tests for benefits eligibility. An * indicates that the guidelines refer to all employee statuses that are not otherwise specified. Do not change the 
codes that are hard-coded, such as A (Active) and X (Terminated). These are required codes in the system.

mnFullTimeEquivalentsFTEMATH_NUMERICOPTNONE

The full-time equivalent (FTE) amount. This figure is the portion of a full-time worker that an employee represents within the business unit. 
For example, an employee who works 20 hours per week would represent .50 (1/2 FTE). This number cannot be greater than 1 for any 
employee.

jdSalaryForcastChangeDateDTSFJDEDATEOPTNONE

A date in the future when it is expected the employee will be given a salary change. This date is used by the position budget module to 
determine if employee position assignments will result in effective budgeted salary amounts being exceeded. It is also used to include future 
forecast salary changes in generating position budgets when the Create Next Year's Position Budget program (P081820) is used. In both 
cases, the future rate values are held in either the pay rate table (F06xxx) or the pay grade step table (F081002).

mnMonthsStandardPerYearSMOYMATH_NUMERICOPTNONE

The number of periods in the year during which the employee will be paid the salary amount. The system uses this number to calculate the 
annual salary and pay period gross amount for a job that lasts for only part of a year. For employees with contract calendars attached, 
update this value in the contract calendar window.

cSalaryFrequencySFQOWcharOPTNONE

A code which indicates the period upon which the entered salary is based.

mnPayPeriodSalaryPPSOWMATH_NUMERICOPTOUTPUT

Pay Period Salary is calculated by dividing the annual salary by the number of pay periods.

cMovetoApplicantPoolAPLOWcharOPTINPUT

A code that you use to indicate whether a terminated employee should be moved into the applicant pool. When you move an employee to 
the applicant pool, the system changes the employee search type to applicant (A). If you do not move the employee to the applicant pool, 
the system changes the employee search type to terminated (X). If the applicant table does not exist, the system always changes the 
employee search type to terminated (X).

cPODfltJobInfoAddEV01charOPTINPUT

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

cPODfltJobInfoChangeEV01charOPTINPUT

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

cPODfltJobCategoryAddEV01charOPTINPUT

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

cPODfltJobCategoryChangeEV01charOPTINPUT

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

cPOBUJobIDInfoAddEV01charOPTINPUT

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

cPOBUJobIDInfoChangeEV01charOPTINPUT

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

cPOABSecurityBUDefaultEV01charOPTINPUT

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

szPOApplicantStatusAPScharOPTINPUT

A code that defines a step in the hiring process that the applicant has completed, such as initial contact, first interview, and so on. This is a 
user defined code (08/AS). When you enter or change the status of an applicant with the Applicant Entry program (P08401), the system adds a 
record to the supplemental data type for applicant status. To review the history of an applicant's status, you can view the information that has 
been added to this supplemental data type.

szPOCandidateRequisitionStatCRSTcharOPTINPUT

The current activity level of a candidate record that is attached to a requisition. The system retrieves these codes from user defined code 
table 08/CN. You can group candidate requisition status codes based on the hard-coded special handling code values in the table. These 
hard-coded values are: CAN Any candidate code   DET Any code indicating that the position is detached or no longer filled   FIL Any code 
indicating that the position has been filled   REJ Rejected TMP Temporarily filled  Candidate requisition status codes that have a special handling 
code of either FIL or TMP update the Filled Headcount field. However, only those status codes that have special handling codes of FIL can 
cause the system to change the requisition status to "Filled and Closed."

szPOOrganizationTypeStructurOSTPcharOPTINPUT

A user defined code (01/TS) that identifies a type of organizational structure that has its own hierarchy in the Address Book system (for 
example, e-mail). When you create a parent/child relationship for the Accounts Receivable system, the structure type must be blank.

szBeforePayGradePGRDcharOPTNONE

A code that designates a category for grouping employees according to pay ranges. For each pay grade, you enter a pay range that 
includes a minimum, a midpoint, and a maximum pay rate. The system uses these pay ranges to calculate compa-ratios for the employees that 
you assign to pay grades. After you enter a pay grade for an employee, the system displays either an error or a warning message if you enter 
a rate for the employee that is not within the pay range for the employee's pay grade. To set up pay grades, use Pay Grades by Class 
(P082001). If you have set up your system to use rates in the Pay Grade Step table as the default pay rates for employees, changing an 
employee's pay grade step causes the system to automatically update the following fields:   o  Salary   o  Hourly Rate   o  Hours per day   o  Hours per 
year   o  Days per year  

szBeforePayGradeStepPGRScharOPTNONE

A code that identifies a pay grade and pay step. You can use this code to determine an employee's pay rate. If you have set up your 
system to use rates in the Pay Grade Step table as the default pay rates for employees, changing an employee's pay grade step causes the 
system to automatically update the following fields:     o Salary     o Hourly Rate     o Hours per day     o Hours per year     o Days per year 

mnBeforeSalarySALMATH_NUMERICOPTNONE

The amount that an employee is paid in one year, assuming that the employee is paid every pay period of the year. For WorldSoftware: For 
the employee's primary job, the system stores the annual salary in the Employee Master Information table (F060116) and the Employee 
Jobs table (F060118). For secondary jobs, the system stores the annual salary only in the Employee Jobs table (F060118). Depending on how 
the value that is entered in the Display Salary (Annual/Effective) field in the HR History Constants table (F08040), this field displays one of the 
following:   o  Annual salary. For salaried employees who are not linked with a contract calendar, the user enters the amount or the system 
retrieves the amount from the Pay Grade/Salary Range Table (F082001). For employees who are linked with a contract calendar, the system 
calculates this amount using the following formula: (((current salary minus salary paid before change) divided by number of periods to pay) 
multiplied by pay frequency).   o  Effective salary. For employees whose jobs are linked with a contract calendar, the system recalculates the 
effective salary when you enter a mid-calendar salary adjustment. After you enter a mid-calendar adjustment, the effective salary equals the 
salary that is paid to the employee from the time of the adjustment through the end of the contract. The system calculates this amount using 
the following formula: ((annual salary divided by pay frequency) times periods to pay). 

mnBeforeHourlyPHRTMATH_NUMERICOPTNONE

The employee's hourly rate, which is retrieved during time entry. If you enter a rate in this field on any other form, that rate can override the 
value in the Employee Master table. In the Employee Master table, this number is the employee's base hourly rate. In the Union Rates table, it 
is the straight time rate. NOTE: If you change the number of the data display decimal digits for this field, you must also change fields Rate - 
Base Hourly (BHRT) and Rate - Hourly (SHRT) so that they have exactly the same number of data display decimal digits.

mnBeforeHoursPerYearIHMATH_NUMERICOPTNONE

The number of work hours in the year. When you do not set your payroll company constants to use the Pay Grade Step table as the 
pay-rate source, the system uses this number to compute the hourly rate when you supply the annual salary (or to compute the annual salary when 
you supply the hourly rate). When you set your constants to use the Pay Grade Step table as the pay rate source, the system uses the 
following sequence to search for the standard number of hours that it uses to calculate the salary or hourly rate per pay period:     o Employee entry 
forms (this field)     o Pay Grade Step table (hours per day multiplied by days per year)     o Payroll company constants for the employee's 
company     o Payroll company constants for the default company (company 00000)     o Data dictionary     o System default value of 2080 
standard hours per year

cBeforePayTypeSALYcharOPTNONE

A code that specifies how an employee is paid. Valid codes are: H Hourly S Salaried P Piecework

szBeforeLocalitySLOCcharOPTNONE

A user defined code (07/SL) that defines the different salary localities within an organization.  For example, you can compare salaries for 
employees on the East Coast with employees in the Midwest.

szBeforeUnionCodeUNcharOPTNONE

A user defined code (06/UN) that represents the union or plan in which the employee or group of employees work or participate.

mnBeforeFullTimeEquivalentsFTEMATH_NUMERICOPTNONE

The full-time equivalent (FTE) amount. This figure is the portion of a full-time worker that an employee represents within the business unit. 
For example, an employee who works 20 hours per week would represent .50 (1/2 FTE). This number cannot be greater than 1 for any 
employee.

Related Functions

B0000130 Retrieve Company From Business Unit
B0000564 Get Internal Next Number
B0100066 Recursive Relationship Check
B0500543 Validate Geo Code
B0500895 Is a Real Time Event Enabled
B0800007 Delete Employee Related Tables
B5100003 F0006 Check Business Unit Existence
B9800100 Get Audit Information
B9800420 Get Data Dictionary Definition
B9900410 Get Environment Value
N0500020 Update Payroll Lockout Code
N0500025 Salary Calculations Server
N0500032 Synchronize EE/Supervisor in EE Master &&&& Org Structure
N0500042 F08001 Retrieve Specific Job Information
N0800002 Set Employee Current Status Flag\Employee Id Validation
N0800003 Verify Job/Retrieve Job Default Information
N0800004 Compa-Ratio Server
N0800005 Pay Grade Server
N0800007 Delete Employee Edit
N0800008 Update F06210 to Force Payroll Rerun
N0800020 Update Employee Job (F060118) Server
N0800029 Transfer Supp Data on Hire/Terminate Employee
N0800030 Fiscal Year Begin & End Dates
N0800031 Get UDC Description
N0800050 Position Budget Edit Server
N0800069 F08040 - Get HR Constants Information
N0800146 Get a Specific Employee Self Service Common Setting
N0800204 Track Employee Date in Current Position/Job
XX0901 Validate Account Number

Related Tables

F0006 Business Unit Master
F00091 Supplemental Database Data Types
F00092 Supplemental Data
F00191 Generic Message/Rates
F0101 Address Book Master
F0150 Address Organization Structure Master
F060116 Employee Master Information
F060117 Employee Master - International Data
F060120 Employee Master Additional Information File
F065016 Automatic Bank Deposit Master
F069096 Payroll General Constants
F07300 Employee Lockout Code File
F08005 Business Unit/ Job Id. X-Ref
F08092 Human Resources General Description-User Def Codes
F08101 Position Master
F08102 Requisition Information
F08105 Requisition Activity
F08401 Applicant Master
F9203 Data Item Alpha Descriptions
F9210 Data Field Specifications (OneWorld)
EmployeeMBFNationalDataCA

EmployeeMBFNationalDataCA

Employee MBF

Minor Business Rule

Object Name: B0500575

Parent DLL: CHRM

Location: Client/Server

Language: C

Function Name: EmployeeMBFNationalDataCA

Purpose and Processing (why use it and what the function does)

• 

This function performs edits and updates for Canadian national and fiscal related fields in the 
F060116 (Employee Master) table.

• 
This function is one of several Employee MBF segments.

• 
Processing options and flags drive some of the edits. They are located at the bottom of the data 
structure.

    Processing Modes

The MBF uses the following parameters to control processing. They are included in the control 
block at the top of the data structure. 

cActionCode      - The action code determines which basic operation to perform.

szColumnList    - Used to process a specific list of columns rather than all of 
the columns for a segment. The column list string is composed         
of the alias for each column separated  by a comma. The MBF processes 
all columns when this value is blank or NULL. The alias for each 
data item is listed below in the  parameters section.

cInquiryMode     - The inquiry mode controls how an inquiry is processed. Data 
can be fetched from the table, fetched from the table and saved 
in cache, or fetched from cache. 

cUpdateMode      - The update mode controls what portion of the update to 
execute. Data can be edited, updated, or both. 
 
cUpdateDataSource     - The update data source specifies whether the MBF updates the 
table or the cache. 

cEditMode     - The edit mode specifies whether to perform a full edit or
a partial edit. A partial edit omits data dictionary edits
for the fields.  

cErrorMode     - The error mode controls error message processing. Error
messages can be displayed, suppressed or saved in a cache.

cErrorStatus    - The error status indicates whether or not the MBF encountered
errors.

  Important Notes

• 
You must use the MBF Cache to process any Warnings (type 2 or 3 errors).
• You must use the MBF Cache to Log errors (cErrorMode 2).
• If you are using more that one MBF Segment it is advisable to use the cache.
• There is only one cache for the entire F060116 file so all F060116 segments inquire and update 
the same cache
 

Parameters (how to call the function)
    
ParameterColumn List I/ODescription
---------------------------------------------------------------------------------------
cActionCodeII  - Inquiry
 A  - Add new employee record (new hire)   
     C  - Change an existing employee record        
D  - Delete (Master segment)

szColumnListIList of data items to process or blank
to process all data items.

szCacheNameIThe name assigned to the cache by the
Employee MBF Cache Create function, or
blank if not using the cache.

cInquiryModeI0 or blank  - Fetch from table
1 - Fetch from table and save in cache
2 - Fetch from cache

cUpdateMode I0 or blank  - Edit and update
   1    - Edit only
   2    - Update only

cUpdateDataSource I0 or blank
  - Save to table if cActionCode = C
                           Save to cache if cActionCode = A
   1 - Save to cache

cEditMode I0 or blank  - Full edit
   1 - Partial edit (no data dict. edit)

cErrorMode  I0 or blank  - Normal error processing
   1  - Suppress error message display
2  - Log errors in the cache

szCallingProgramIdIName (ID) of the calling program.  
Updated to audit field PID.

szCallingVersionIVersion of the calling program. May be 
used in processing.

cErrorStatusO0 or blank  - Success
1        - Failure

mnAddressNumberI/OField in F060116 Table

cUpdateFlagI/OField in F060116 Table
                         
szChangeReasonI/OField in F060116 Table
                   
jdDateEffectiveI/OField in F060116 Table

mnAddressNumberI/OField in F060116 Table

cUpdateFlagI/OField in F060116 Table
                         
szChangeReasonI/OField in F060116 Table
                   
jdDateEffectiveI/OField in F060116 Table

szMedicalPlanIdHIPNI/OField in F060116 Table
                 
cHandicappedHM04I/OField in F060116 Table
                        
szTaxAreaWorkTARAI/OField in F060116 Table
                   
szTaxAreaResidenceTARRI/OField in F060116 Table
              
szWorkersCompInsurCodeWCMPI/OField in F060116 Table
           
cPOTaxAreasRequiredIProcessing Option on P0801
                 
                    
Use (how to use the function and other related functions)

You are referred to the Employee MBF Master Data documentation for details on how to add a new 
employee to the database.

Perform the following step to update an existing employee (single segment):

1. Call the segment with the fields you want to update and the parameters listed below. Use the 
szColumnList parameter if you do not want to update all of the columns for the segment.

   Employee MBF National Data CA
 C -> cActionCode 
Columns to update or blank-> szColumnList
Error Status Variable<- cErrorStatus                   
employee's address book number-> mnAddressNumber     
new data values -> data columns
as desired  -> processing options         

Perform the following steps to update an exsisting employee using cache (multiple segments):

1. Initialize the cache.

   Employee MBF Cache Create
Cache Variable <- szCacheName       
0 or 1 -> cErrorMode   
Error Status Variable<- cErrorStatus                   

2. Inquire on the table and save the record to cache.

   Employee MBF National Data CA
I -> cActionCode 
Cache Variable -> szCacheName             
1 -> cInquireyMode
Error Status Variable<- cErrorStatus                            
employee's address book number-> mnAddressNumber     

3. Update the cache with data for the segment. Use the szColumnList parameter if you do not want to 
update all of the columns for the segment.

   Employee MBF National Data CA
C -> cActionCode 
Columns to update or blank-> szColumnList             
Cache Variable -> szCacheName  
1 -> cUpdateDataSource  
Error Status Variable<- cErrorStatus                        
employee's address book number-> mnAddressNumber     
new data values -> data columns        
as desired  -> processing options  

4. Update the cache with data for other segments. Replace the segment shown here with the segment 
that you want to update. This example uses column list to update the TARA and TARR fields.

   Employee MBF National Data US
C -> cActionCode              
TARA,TARR -> szColumnList
Cache Variable -> szCacheName    
1 -> cUpdateDataSource       
Error Status Variable<- cErrorStatus                        
employee's address book number-> mnAddressNumber     
new data values -> data columns        
as desired  -> processing options 

5. Update the database with the records in cache.

   Employee MBF Cache Commit
U   -> cActionCode           
Cache Variable -> szCacheName    
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                    

6. Destroy the cache.

   Employee MBF Cache Destroy
Cache Variable  -> szCacheName 
0 or 1  -> cErrorMode  
Error Status Variable<- cErrorStatus                   

Perform the following step to edit an existing employee without updating the table (edit-only):

1. Use this call to edit proposed changes to fields without actually updating the table. The edits 
are performed for only those columns in the column list. If the list is blank, all columns in the data 
structure are edited.

   Employee MBF National Data CA
C  -> cActionCode  
Columns to update or blank-> szColumnList            
1 -> cUpdateMode
Error Status Variable<- cErrorStatus
employee's address book number-> mnAddressNumber     
new data values -> data columns
as desired  -> processing options 
                  

Data Structure

D0500575D - Employee MBF National Data CA

Parameter NameData ItemData TypeReq/OptI/O/Both
cActionCodeACTNcharREQINPUT

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

szColumnListDSScharOPTINPUT

This field will contain a bar delimited string of data item names from the Employee Master (F060116). Each data item in the string 
corresponds with a data item in a UBE data structure. This mapping will allow RI values to be passed to a UBE when run dynamically from a BSFN.

szCacheNameDTAIcharOPTINPUT

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.

cInquiryModeEV01charOPTINPUT

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

cUpdateModeEV01charOPTINPUT

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

cUpdateDataSourceEV01charOPTINPUT

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

cEditModeEV01charOPTINPUT

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

cErrorModeEV01charOPTINPUT

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

szCallingProgramIdPIDcharOPTINPUT

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.

szCallingVersionVERScharOPTINPUT

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.

cErrorStatusEV01charOPTOUTPUT

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

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

cUpdateFlagUFLGcharOPTNONE

This indicator in the employee master is under program control. It is set to Y when anything is added, changed or deleted related to the 
employee including the master file itself, the employee's pay/deduction/benefit/accrual transaction profile, his current time and pay detail 
transactions or interim check information. The principal use of this indicator is to determine whether the employee needs to be reprocessed during 
a pre-payroll rerun. The pre-payroll process automatically resets this flag to blank.

szChangeReasonTRScharOPTNONE

A code that indicates the reason for one of the following:   o  Changing an active employee's record   o  Terminating an employee   o  
Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The 
code for new hires is the default reason code.

jdDateEffectiveEFTJDEDATEOPTNONE

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.

szMedicalPlanIdHIPNcharOPTNONE

A unique identifier for secondary employee numbers, such as an employee's health insurance plan ID number.

cHandicappedHM04charOPTNONE

A code indicating whether this employee has a mental or physical disability. Valid codes are: Y Yes, this employee has a mental or 
physical disability. N No, this employee does not have a mental or physical disability. U Unknown

szTaxAreaWorkTARAcharOPTNONE

A code that identifies a geographical location and the tax authorities for an employee work site, including employee and employer statutory 
requirements. In the Vertex payroll tax calculation software, the tax area code is synonymous with GeoCode. To determine the valid codes 
for your location, refer to the documentation for the tax calculation software that you are using.

szTaxAreaResidenceTARRcharOPTNONE

A code that identifies both the geographical location and the tax authorities for the employee's residence. Authorities include employee 
and employer statutory requirements. This code is synonymous with GeoCode. Refer to Vertex System's Master GeoCode File for valid codes 
for your locations.

szWorkersCompInsurCodeWCMPcharOPTNONE

A user defined code (00/W) that represents a workers' compensation insurance (WCI) code. This code should correspond to the 
classifications on your periodic workers' compensation insurance reports.

cPOTaxAreasRequiredEV01charOPTINPUT

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

Related Functions

B0000130 Retrieve Company From Business Unit
B0000564 Get Internal Next Number
B0100066 Recursive Relationship Check
B0500543 Validate Geo Code
B0500895 Is a Real Time Event Enabled
B0800007 Delete Employee Related Tables
B5100003 F0006 Check Business Unit Existence
B9800100 Get Audit Information
B9800420 Get Data Dictionary Definition
B9900410 Get Environment Value
N0500020 Update Payroll Lockout Code
N0500025 Salary Calculations Server
N0500032 Synchronize EE/Supervisor in EE Master &&&& Org Structure
N0500042 F08001 Retrieve Specific Job Information
N0800002 Set Employee Current Status Flag\Employee Id Validation
N0800003 Verify Job/Retrieve Job Default Information
N0800004 Compa-Ratio Server
N0800005 Pay Grade Server
N0800007 Delete Employee Edit
N0800008 Update F06210 to Force Payroll Rerun
N0800020 Update Employee Job (F060118) Server
N0800029 Transfer Supp Data on Hire/Terminate Employee
N0800030 Fiscal Year Begin & End Dates
N0800031 Get UDC Description
N0800050 Position Budget Edit Server
N0800069 F08040 - Get HR Constants Information
N0800146 Get a Specific Employee Self Service Common Setting
N0800204 Track Employee Date in Current Position/Job
XX0901 Validate Account Number

Related Tables

F0006 Business Unit Master
F00091 Supplemental Database Data Types
F00092 Supplemental Data
F00191 Generic Message/Rates
F0101 Address Book Master
F0150 Address Organization Structure Master
F060116 Employee Master Information
F060117 Employee Master - International Data
F060120 Employee Master Additional Information File
F065016 Automatic Bank Deposit Master
F069096 Payroll General Constants
F07300 Employee Lockout Code File
F08005 Business Unit/ Job Id. X-Ref
F08092 Human Resources General Description-User Def Codes
F08101 Position Master
F08102 Requisition Information
F08105 Requisition Activity
F08401 Applicant Master
F9203 Data Item Alpha Descriptions
F9210 Data Field Specifications (OneWorld)
EmployeeMBFNationalDataUS

EmployeeMBFNationalDataUS

Employee MBF

Minor Business Rule

Object Name: B0500575

Parent DLL: CHRM

Location: Client/Server

Language: C

Function Name: EmployeeMBFNationalDataUS

Purpose and Processing (why use it and what the function does)

• 

This function performs edits and updates for US national and fiscal related fields in the 
F060116(Employee Master) table.

• 
This function is one of several Employee MBF segments.

• 
Processing options and flags drive some of the edits. They are located at the bottom of the data 
structure

   Processing Modes

The MBF uses the following parameters to control processing. They are included in the control 
block at the top of the data structure. 

cActionCode      - The action code determines which basic operation to perform.

szColumnList    - Used to process a specific list of columns rather than all of 
the columns for a segment. The column list string is composed         
of the alias for each column separated  by a comma. The MBF processes 
all columns when this value is blank or NULL. The alias for each 
data item is listed below in the  parameters section.

cInquiryMode     - The inquiry mode controls how an inquiry is processed. Data 
can be fetched from the table, fetched from the table and saved 
in cache, or fetched from cache. 

cUpdateMode      - The update mode controls what portion of the update to 
execute. Data can be edited, updated, or both. 
 
cUpdateDataSource     - The update data source specifies whether the MBF updates the 
table or the cache. 

cEditMode     - The edit mode specifies whether to perform a full edit or
a partial edit. A partial edit omits data dictionary edits
for the fields.  

cErrorMode     - The error mode controls error message processing. Error
messages can be displayed, suppressed or saved in a cache.

cErrorStatus    - The error status indicates whether or not the MBF encountered
errors.

  Important Notes

• 
You must use the MBF Cache to process any Warnings (type 2 or 3 errors).
• You must use the MBF Cache to Log errors (cErrorMode 2).
• If you are using more that one MBF Segment it is advisable to use the cache.
• There is only one cache for the entire F060116 file so all F060116 segments inquire and update 
the same cache
 

Parameters (how to call the function)
    
ParameterColumn List I/ODescription
---------------------------------------------------------------------------------------
cActionCodeII  - Inquiry
 A  - Add new employee record (new hire)   
     C  - Change an existing employee record        
D  - Delete (Master segment)

szColumnListIList of data items to process or blank
to process all data items.

szCacheNameIThe name assigned to the cache by the
Employee MBF Cache Create function, or
blank if not using the cache.

cInquiryModeI0 or blank  - Fetch from table
1 - Fetch from table and save in cache
2 - Fetch from cache

cUpdateMode I0 or blank  - Edit and update
   1    - Edit only
   2    - Update only

cUpdateDataSource I0 or blank
  - Save to table if cActionCode = C
                           Save to cache if cActionCode = A
   1 - Save to cache

cEditMode I0 or blank  - Full edit
   1 - Partial edit (no data dict. edit)

cErrorMode  I0 or blank  - Normal error processing
   1  - Suppress error message display
2  - Log errors in the cache

szCallingProgramIdIName (ID) of the calling program.  
Updated to audit field PID.

szCallingVersionIVersion of the calling program. May be 
used in processing.

cErrorStatusO0 or blank  - Success
1        - Failure

mnAddressNumberI/OField in F060116 Table

cUpdateFlagI/OField in F060116 Table
                         
szChangeReasonI/OField in F060116 Table
                   
jdDateEffectiveI/OField in F060116 Table

mnAddressNumberI/OField in F060116 Table

cUpdateFlagI/OField in F060116 Table
                         
szChangeReasonI/OField in F060116 Table
                   
jdDateEffectiveI/OField in F060116 Table

cEarnIncomeCredStatusEICI/OField in F060116 Table
               
cTaxCalcMethodFICMI/OField in F060116 Table
                      
cI9StatusHM01I/OField in F060116 Table
                           
cVeteranHM02I/OField in F060116 Table
                            
cDisabledVeteranHM03I/OField in F060116 Table
                    
cHandicappedHM04I/OField in F060116 Table
                        
cInitialFrstNmeGovtRpIFNI/OField in F060116 Table
               
cMiddleInitialIMNI/OField in F060116 Table
                      
cMaritalStatusTaxStateMSTII/OField in F060116 Table
              
cMaritalStatusTaxFederalMSTXI/OField in F060116 Table
            
cWorkTaxAreaSourceNSI/OField in F060116 Table
                  
szRegionREGNI/OField in F060116 Table
                         
cMaritalStatusResStateRMSTI/OField in F060116 Table
              
mnSchoolDistrictCodeSCDCI/OField in F060116 Table
                
szStOccupClassCodeSOCCI/OField in F060116 Table
               
cResidencyStatus12WSPSI/OField in F060116 Table
                  
szTaxAreaWorkTARAI/OField in F060116 Table
                   
szTaxAreaResidenceTARRI/OField in F060116 Table
              
szWorkersCompInsurCodeWCMPI/OField in F060116 Table
           
cWorkersCompSubClassWETI/OField in F060116 Table
                
cLocalAreaMaritalLMSTI/OField in F060116 Table
                   
cSourceofSUIReportingSUII/OField in F060116 Table
               
cPOTaxAreasRequiredIProcessing Option on P0801


Use (how to use the function and other related functions)

You are referred to the Employee MBF Master Data documentation for details on how to add a new 
employee to the database.

Perform the following step to update an exsisting employee (single segment):

1. Call the segment with the fields you want to update and the parameters listed below. Use the 
szColumnList parameter if you do not want to update all of the columns for the segment.

   EmployeeMBFNationalDataUS
C -> cActionCode 
Columns to update or blank-> szColumnList
Error Status Variable<- cErrorStatus                   
employee's address book number-> mnAddressNumber     
new data values -> data columns        

Perform the following steps to update an exsisting employee using cache (multiple segments):

1. Initialize the cache.

   Employee MBF Cache Create
Cache Variable <- szCacheName       
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                   

2. Inquire on the table and save the record to cache.

   Employee MBF National Data US
I -> cActionCode              
1 -> cInquireyMode
Cache Variable -> szCacheName  
Error Status Variable<- cErrorStatus                          
employee's address book number-> mnAddressNumber   

 3. Update the cache with data for the segment. Use the szColumnList parameter if you do not want to 
update all of the columns for the segment.

   Employee MBF National Data US
C -> cActionCode 
Columns to update or blank-> szColumnList
Cache Variable -> szCacheName  
1 -> cUpdateDataSource
Error Status Variable<- cErrorStatus                          
employee's address book number-> mnAddressNumber     
new data values -> data columns        
as desired  -> processing options  

4. Update the cache with data for other segments. Replace the segment shown here with the segment 
that you want to update. This example uses the column list to update the TARA and TARR fields.

   Employee MBF National Data CA
C ->  cActionCode              
TARA,TARR -> szColumnList
Cache Variable -> szCacheName         
1 -> cUpdateDataSource
Error Status Variable<- cErrorStatus                          
employee's address book number-> mnAddressNumber     
new data values -> data columns        
as desired  -> processing options

5. Update the database with the records in cache.

   Employee MBF Cache Commit
U   -> cActionCode           
Cache Variable -> szCacheName    
0 or 1 -> cErrorMode   
Error Status Variable<- cErrorStatus                   

6. Destroy the cache.

   Employee MBF Cache Destroy
Cache Variable  -> szCacheName 
0 or 1 -> cErrorMode  
Error Status Variable<- cErrorStatus                   

Perform the following step to edit an existing employee without updating the table (edit-only):

1. Use this call to edit proposed changes to fields without actually updating the table. The edits 
are performed for only those columns in the column list. If the list is blank, all columns in the data 
structure are edited.

   Employee MBF National Data US
C  -> cActionCode  
Columns to update or blank-> szColumnList            
1 -> cUpdateMode
Error Status Variable<- cErrorStatus
employee's address book number-> mnAddressNumber     
new data values -> data columns
as desired  -> processing options


Data Structure

D0500575C - Employee MBF National Data US

Parameter NameData ItemData TypeReq/OptI/O/Both
cActionCodeACTNcharREQINPUT

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

szColumnListDSScharOPTINPUT

This field will contain a bar delimited string of data item names from the Employee Master (F060116). Each data item in the string 
corresponds with a data item in a UBE data structure. This mapping will allow RI values to be passed to a UBE when run dynamically from a BSFN.

szCacheNameDTAIcharOPTINPUT

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.

cInquiryModeEV01charOPTINPUT

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

cUpdateModeEV01charOPTINPUT

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

cUpdateDataSourceEV01charOPTINPUT

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

cEditModeEV01charOPTINPUT

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

cErrorModeEV01charOPTINPUT

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

szCallingProgramIdPIDcharOPTINPUT

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.

szCallingVersionVERScharOPTINPUT

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.

cErrorStatusEV01charOPTOUTPUT

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

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

cUpdateFlagUFLGcharOPTNONE

This indicator in the employee master is under program control. It is set to Y when anything is added, changed or deleted related to the 
employee including the master file itself, the employee's pay/deduction/benefit/accrual transaction profile, his current time and pay detail 
transactions or interim check information. The principal use of this indicator is to determine whether the employee needs to be reprocessed during 
a pre-payroll rerun. The pre-payroll process automatically resets this flag to blank.

szChangeReasonTRScharOPTNONE

A code that indicates the reason for one of the following:   o  Changing an active employee's record   o  Terminating an employee   o  
Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The 
code for new hires is the default reason code.

jdDateEffectiveEFTJDEDATEOPTNONE

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.

cEarnIncomeCredStatusEICcharOPTNONE

A code that specifies whether the employee qualifies for the earned income credit and elects for the employer to give him or her the 
advance. Valid values are:    N The employee does not qualify (default).    Y The employee qualifies and the employee is single/head of 
household.    M The employee qualifies and is married without spouse filing certificate.     B The employee qualifies and his or her spouse also 
qualifies.

cTaxCalcMethodFICMcharOPTNONE

A code that specifies the tax method that the Vertex payroll-tax calculation system uses to calculate certain taxes. The codes are defined in 
UDC 07/TM. This code can also determine the form that the employee receives for year-end tax reporting. For example, when you enter C, 
a contract employee receives IRS Form 1099-M rather than IRS Form W-2. If a form is not specified in Description 2, the system generates 
IRS Form W-2. For employees who are paid multiple times within one pay period, the system should review previous payments within the same 
pay period and then adjust tax amounts. To specify this function, enter S. If a tax method exists for an employee in addition to the normal tax 
method that is set up in the Employee Master Information table (F060116), the system can use the alternative tax method to interactively 
process interim payments. To specify this function, enter Z. Some values, such as S and Z, might require additional setup in the UDC table.

cI9StatusHM01charOPTNONE

A code indicating the method used to verify that this employee is eligible to work in the United States. Valid codes are:    Y I9 form on file    P 
Passport used for verification    L Driver's license and Social Security card    V Visa (worker's permit)    B Birth certificate    N Waiting for 
verification

cVeteranHM02charOPTNONE

A code that indicates the veteran status of the employee for EEO reporting purposes.  Valid values are: N This employee is not a 
veteran. Y This employee is a veteran. V This employee is a Vietnam veteran. O This employee is a veteran, classified as Other as defined by the U.S. 
Department of Labor.  

cDisabledVeteranHM03charOPTNONE

A code indicating whether this employee is a disabled veteran.  Valid codes are: Y Yes, this employee is a disabled veteran. N No, this 
employee is not a disabled veteran. This field is used to generate the Veterans Employee (VETS-100) report.

cHandicappedHM04charOPTNONE

A code indicating whether this employee has a mental or physical disability. Valid codes are: Y Yes, this employee has a mental or 
physical disability. N No, this employee does not have a mental or physical disability. U Unknown

cInitialFrstNmeGovtRpIFNcharOPTNONE

The first letter of the employee's first (given) name. This is primarily used to facilitate certain statutory reporting requirements.

cMiddleInitialIMNcharOPTNONE

The first letter of the individual's middle name. This is primarily used to facilitate certain statutory reporting requirements.

cMaritalStatusTaxStateMSTIcharOPTNONE

The employee's "Work" state marital status code as retrieved from the state W-4. This code is used in the computation of all state payroll 
taxes associated with the state in which the employee performed work. If you leave this field blank, the Federal status is used.

cMaritalStatusTaxFederalMSTXcharOPTNONE

A user defined code (system 06, type MS) that specifies the employees' federal marital status code as retrieved from the W-4 form. This 
code is used in the computation of all federal income tax.  You can add codes if needed.

cWorkTaxAreaSourceNScharOPTNONE

This code is used to determine the source for obtaining the tax area code for the employee's work location.    N Use time entry, job master, 
employee labor rules or employee master to determine Tax Area.    E Always use the Work Tax Area from the employee master on time 
record. When blank the system assumes N.

szRegionREGNcharOPTNONE

A region within a state.  This field is intended for use in preparation of unemployment reports for some states.

cMaritalStatusResStateRMSTcharOPTNONE

A user defined code (system 06, type MS) that specifies the marital status code for the state of residence. It is used for tax computations. 
This code is related to specific VERTEX system codes (see the VERTEX Tax Manual for their explanation). Also, two special codes have 
been provided: one designates single for Federal and married for State, and the other designates married for Federal and single for State.

mnSchoolDistrictCodeSCDCMATH_NUMERICOPTNONE

A user-defined code in UDC 06/SD that determines the school district tax for taxation purposes. Vertex automatically calculates the school 
district tax. This feature is primarily used by the public sector.

szStOccupClassCodeSOCCcharOPTNONE

A series of codes that identify occupational titles and their definitions. These codes are used in one or more states in the preparation of 
unemployment reports.

cResidencyStatus12WSPScharOPTNONE

A value that identifies out-of-state employees for whom an employer must withhold tax for the state of residence. Valid values are: N 
(Default) The system uses the employee residence state to calculate taxes. Because the work state has a reciprocal agreement with the employee 
state of residence, the system uses the employee residence state from the Employee Master Information table (F060116).  W The system 
uses only the work state to calculate taxes.

szTaxAreaWorkTARAcharOPTNONE

A code that identifies a geographical location and the tax authorities for an employee work site, including employee and employer statutory 
requirements. In the Vertex payroll tax calculation software, the tax area code is synonymous with GeoCode. To determine the valid codes 
for your location, refer to the documentation for the tax calculation software that you are using.

szTaxAreaResidenceTARRcharOPTNONE

A code that identifies both the geographical location and the tax authorities for the employee's residence. Authorities include employee 
and employer statutory requirements. This code is synonymous with GeoCode. Refer to Vertex System's Master GeoCode File for valid codes 
for your locations.

szWorkersCompInsurCodeWCMPcharOPTNONE

A user defined code (00/W) that represents a workers' compensation insurance (WCI) code. This code should correspond to the 
classifications on your periodic workers' compensation insurance reports.

cWorkersCompSubClassWETcharOPTNONE

A code that specifies any special circumstances associated with the workers compensation insurance (WCI) code, resulting in multiple 
rates for the same WCI code due to location or risk, for example. The subclass should remain blank if multiple rates do not exist. Default codes 
are: Blank There are no special circumstances associated with this code. F There are special circumstances associated with this code.

cLocalAreaMaritalLMSTcharOPTNONE

The employee's Local marital status code as retrieved from the locality's W-4. This code is used in the computation of all local (city, county) 
payroll taxes associated with the state in which the employee performed work. If you leave this field blank, the Federal status is used.

cSourceofSUIReportingSUIcharOPTNONE

Use this field to specify the work tax area that is used for SUI reporting. You can specify that the system use either the resident state or the 
work state, regardless of where the employee worked. FUI is calculated in the same state where SUI is calculated. Weeks Worked are the 
number of weeks the employee worked in the taxed state.  Valid values are:    N   Use the work tax area in the time entry record to determine 
SUI. This is the default value.    R   Always use residence tax area from Employee Master table even if the time entry record is different.    W  
Always use work tax area from Employee Master table even if the time entry record is different.

cPOTaxAreasRequiredEV01charOPTINPUT

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

Related Functions

B0000130 Retrieve Company From Business Unit
B0000564 Get Internal Next Number
B0100066 Recursive Relationship Check
B0500543 Validate Geo Code
B0500895 Is a Real Time Event Enabled
B0800007 Delete Employee Related Tables
B5100003 F0006 Check Business Unit Existence
B9800100 Get Audit Information
B9800420 Get Data Dictionary Definition
B9900410 Get Environment Value
N0500020 Update Payroll Lockout Code
N0500025 Salary Calculations Server
N0500032 Synchronize EE/Supervisor in EE Master &&&& Org Structure
N0500042 F08001 Retrieve Specific Job Information
N0800002 Set Employee Current Status Flag\Employee Id Validation
N0800003 Verify Job/Retrieve Job Default Information
N0800004 Compa-Ratio Server
N0800005 Pay Grade Server
N0800007 Delete Employee Edit
N0800008 Update F06210 to Force Payroll Rerun
N0800020 Update Employee Job (F060118) Server
N0800029 Transfer Supp Data on Hire/Terminate Employee
N0800030 Fiscal Year Begin & End Dates
N0800031 Get UDC Description
N0800050 Position Budget Edit Server
N0800069 F08040 - Get HR Constants Information
N0800146 Get a Specific Employee Self Service Common Setting
N0800204 Track Employee Date in Current Position/Job
XX0901 Validate Account Number

Related Tables

F0006 Business Unit Master
F00091 Supplemental Database Data Types
F00092 Supplemental Data
F00191 Generic Message/Rates
F0101 Address Book Master
F0150 Address Organization Structure Master
F060116 Employee Master Information
F060117 Employee Master - International Data
F060120 Employee Master Additional Information File
F065016 Automatic Bank Deposit Master
F069096 Payroll General Constants
F07300 Employee Lockout Code File
F08005 Business Unit/ Job Id. X-Ref
F08092 Human Resources General Description-User Def Codes
F08101 Position Master
F08102 Requisition Information
F08105 Requisition Activity
F08401 Applicant Master
F9203 Data Item Alpha Descriptions
F9210 Data Field Specifications (OneWorld)
EmployeeMBFPayrollData

EmployeeMBFPayrollData

Employee MBF

Minor Business Rule

Object Name: B0500575

Parent DLL: CHRM

Location: Client/Server

Language: C

Function Name: EmployeeMBFPayrollData


Purpose and Processing (why use it and what the function does)

• 

This function performs edits and updates for payroll related fields in the F060116 (Employee 
Master) table.

• 
This function is one of several Employee MBF segments.

   Processing Modes

The MBF uses the following parameters to control processing. They are included in the control 
block at the top of the data structure. 

cActionCode      - The action code determines which basic operation to perform.

szColumnList    - Used to process a specific list of columns rather than all of 
the columns for a segment. The column list string is composed         
of the alias for each column separated  by a comma. The MBF processes 
all columns when this value is blank or NULL. The alias for each 
data item is listed below in the  parameters section.

cInquiryMode     - The inquiry mode controls how an inquiry is processed. Data 
can be fetched from the table, fetched from the table and saved 
in cache, or fetched from cache. 

cUpdateMode      - The update mode controls what portion of the update to 
execute. Data can be edited, updated, or both. 
 
cUpdateDataSource     - The update data source specifies whether the MBF updates the 
table or the cache. 

cEditMode     - The edit mode specifies whether to perform a full edit or
a partial edit. A partial edit omits data dictionary edits
for the fields.  

cErrorMode     - The error mode controls error message processing. Error
messages can be displayed, suppressed or saved in a cache.

cErrorStatus    - The error status indicates whether or not the MBF encountered
errors.

  Important Notes

• 
You must use the MBF Cache to process any Warnings (type 2 or 3 errors).
• You must use the MBF Cache to Log errors (cErrorMode 2).
• If you are using more that one MBF Segment it is advisable to use the cache.
• There is only one cache for the entire F060116 file so all F060116 segments inquire and update 
the same cache
 

Parameters (how to call the function)
    
ParameterColumn List I/ODescription
---------------------------------------------------------------------------------------
cActionCodeII  - Inquiry
 A  - Add new employee record (new hire)   
     C  - Change an existing employee record        
D  - Delete (Master segment)

szColumnListIList of data items to process or blank
to process all data items.

szCacheNameIThe name assigned to the cache by the
Employee MBF Cache Create function, or
blank if not using the cache.

cInquiryModeI0 or blank  - Fetch from table
1 - Fetch from table and save in cache
2 - Fetch from cache

cUpdateMode I0 or blank  - Edit and update
   1    - Edit only
   2    - Update only

cUpdateDataSource I0 or blank
  - Save to table if cActionCode = C
                           Save to cache if cActionCode = A
   1 - Save to cache

cEditMode I0 or blank  - Full edit
   1 - Partial edit (no data dict. edit)

cErrorMode  I0 or blank  - Normal error processing
   1  - Suppress error message display
2  - Log errors in the cache

szCallingProgramIdIName (ID) of the calling program.  
Updated to audit field PID.

szCallingVersionIVersion of the calling program. May be 
used in processing.

cErrorStatusO0 or blank  - Success
1        - Failure

mnAddressNumberI/OField in F060116 Table

cUpdateFlagI/OField in F060116 Table
                         
szChangeReasonI/OField in F060116 Table
                   
jdDateEffectiveI/OField in F060116 Table

mnAddressNumberI/OField in F060116 Table

cUpdateFlagI/OField in F060116 Table

cVacationFactorsAAFI/OField in F060116 Table
                    
cAutoDepositPreNoteADPNI/OField in F060116 Table
                 
mnAddressNumberPayeeANN8I/OField in F060116 Table
                
cEmployeeClassificationECNTI/OField in F060116 Table
             
szLocationHomeHMLCI/OField in F060116 Table
                   
szStateHomeHMSTI/OField in F060116 Table
                      
jdDateLastCheckLCDTI/OField in F060116 Table
                     
mnLaborLoadingFactorLFI/OField in F060116 Table
                
cLaborLoadingMethodLMTHI/OField in F060116 Table
                 
szLocationWorkCityLWK1I/OField in F060116 Table
               
szLocationWorkCountyLWK2I/OField in F060116 Table
             
mnAmountMaximumNetPayNMAXI/OField in F060116 Table
               
mnRtDistributionOrBillPBRTI/OField in F060116 Table
              
szPayCycleCodePCCDI/OField in F060116 Table
                   
mnPayCycleBypassCountPYCBI/OField in F060116 Table
               
szBusinessUnitLastWorkedSGI/OField in F060116 Table
        
cTippedEmployeeTIPEI/OField in F060116 Table
                     
szStateWorkingWKSEI/OField in F060116 Table
                   
cWorkScheduleCodeWSI/OField in F060116 Table
                   
cRecordTypeRCCDI/OField in F060116 Table
                      

Use (how to use the function and other related functions)

You are referred to the Employee MBF Master Data documentation for details on how to add a new 
employee to the database.

Perform the following step to update an exsisting employee (single segment):

1. Call the segment with the fields you want to update and the parameters listed below. Use the 
szColumnList parameter if you do not want to update all of the columns for the segment.

   Employee MBF Payroll Data
C -> cActionCode 
Columns to update or blank-> szColumnList
Error Status Variable<- cErrorStatus                   
employee's address book number-> mnAddressNumber     
new data values -> data columns        

Perform the following steps to update an exsisting employee using cache (multiple segments):

1. Initialize the cache.

   Employee MBF Cache Create
Cache Variable <- szCacheName       
0 or 1 -> cErrorMode   
Error Status Variable<- cErrorStatus                   

2. Inquire on the table and save the record to cache.

   Employee MBF Payroll Data
I -> cActionCode              
1 -> cInquireyMode
Cache Variable -> szCacheName 
Error Status Variable<- cErrorStatus                           
employee's address book number-> mnAddressNumber     

3. Update the cache with data for the segment. Use the szColumnList parameter if you do not want to 
update all of the columns for the segment.

   Employee MBF Payroll Data
C -> cActionCode              
Cache Variable -> szCacheName  
1 -> cUpdateDataSource 
Error Status Variable<- cErrorStatus                         
employee's address book number-> mnAddressNumber     
new data values -> data columns        

4. Update the cache with data for other segments. Replace the segment shown here with the segment 
that you want to update. This example uses the column list to update the TARA and TARR fields.

   Employee MBF National Data US
C -> cActionCode              
TARA,TARR -> szColumnList
Cache Variable -> szCacheName 
1 -> cUpdateDataSource       
Error Status Variable<- cErrorStatus                         
employee's address book number-> mnAddressNumber     
new data values-> data columns  
as desired  -> processing options        

5. Update the database with the records in cache.

   Employee MBF Cache Commit
U   -> cActionCode           
Cache Variable -> szCacheName    
0 or 1  -> cErrorMode   
Error Status Variable<- cErrorStatus                    

6. Destroy the cache.

   Employee MBF Cache Destroy
Cache Variable  -> szCacheName
0 or 1-> cErrorMode  
Error Status Variable<- cErrorStatus                   

Perform the following step to edit an existing employee without updating the table (edit-only):

1. Use this call to edit proposed changes to fields without actually updating the table. The edits 
are performed for only those columns in the column list. If the list is blank, all columns in the data 
structure are edited.

   Employee MBF Payroll Data
C  -> cActionCode  
Columns to update or blank-> szColumnList            
1 -> cUpdateMode
Error Status Variable<- cErrorStatus
employee's address book number-> mnAddressNumber     
new data values -> data columns     


Data Structure

D0500575F - Employee MBF Payroll Data

Parameter NameData ItemData TypeReq/OptI/O/Both
cActionCodeACTNcharREQINPUT

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

szColumnListDSScharOPTINPUT

This field will contain a bar delimited string of data item names from the Employee Master (F060116). Each data item in the string 
corresponds with a data item in a UBE data structure. This mapping will allow RI values to be passed to a UBE when run dynamically from a BSFN.

szCacheNameDTAIcharOPTINPUT

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.

cInquiryModeEV01charOPTINPUT

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

cUpdateModeEV01charOPTINPUT

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

cUpdateDataSourceEV01charOPTINPUT

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

cEditModeEV01charOPTINPUT

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

cErrorModeEV01charOPTINPUT

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

szCallingProgramIdPIDcharOPTINPUT

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.

szCallingVersionVERScharOPTINPUT

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.

cErrorStatusEV01charOPTOUTPUT

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

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

cUpdateFlagUFLGcharOPTNONE

This indicator in the employee master is under program control. It is set to Y when anything is added, changed or deleted related to the 
employee including the master file itself, the employee's pay/deduction/benefit/accrual transaction profile, his current time and pay detail 
transactions or interim check information. The principal use of this indicator is to determine whether the employee needs to be reprocessed during 
a pre-payroll rerun. The pre-payroll process automatically resets this flag to blank.

szChangeReasonTRScharOPTNONE

A code that indicates the reason for one of the following:   o  Changing an active employee's record   o  Terminating an employee   o  
Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The 
code for new hires is the default reason code.

jdDateEffectiveEFTJDEDATEOPTNONE

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.

cVacationFactorsAAFcharOPTNONE

A value in this field represents the number of pay periods that this check is to cover. This is used by the Payroll system to direct the Vertex 
payroll tax program to treat the pay as a vacation advance. The computed taxes are automatically averaged over the number of pay periods. 
See the Vertex system manual for an explanation of the method of calculating tax on vacation advances.

cAutoDepositPreNoteADPNcharOPTNONE

A code that lets you test the deposit instructions for one pay period before actually processing a deposit. Adding an employee to this form 
automatically activates this person in the automated deposit system. The system prenotes this employee in the next applicable payroll run 
to test the auto deposit instructions you have set up before actually depositing a check. In the prenote test, the system creates a no-dollar 
entry for this employee and sends it to the employee's bank account. In addition, the employee receives a check for this amount. After the test, 
the system changes this field to N. To repeat this test, enter P in this field. If you leave this field blank, the system uses the default value of P. If 
you change an employee's automatic deposit instructions, the system creates a prenote. If you do not want a prenote, you must change the 
value in the Prenote Flag field to N. You cannot use this field for Canadian employees.

mnAddressNumberPayeeANN8MATH_NUMERICOPTNONE

The address book number for the supplier who receives the final payment. In Benefits administration, this is the address book number of the 
company that issues the plan and receives premium payments for it. For wage attachments, payee is the address book number of the 
agency, company, individual, or court that is to receive the payment of the check.

cEmployeeClassificationECNTcharOPTNONE

Employee classification determines the type of employee to the system.  It identifies them as an independent contractor, a regular 
employee, or a Step Progression employee.  Values are:  Y Independent Contractor  N Regular Employee  S  Employee using Step Progression 

szLocationHomeHMLCcharOPTNONE

The location or city where the employee resides.

szStateHomeHMSTcharOPTNONE

The employee's home state for tax reporting purposes. This code designates the state in which the employee resides. Note: For W-2 
reporting, use the numeric value equivalent of the designated state. For example: 06 - Colorado, 05 - California. Otherwise, the system produces 
undesirable report results. If you leave this field blank, the system uses the value in the Tax Area (Resident) field on Pay and Tax Information 
as the employee's resident (base) state.

jdDateLastCheckLCDTJDEDATEOPTNONE

The date of the last payroll check issued to the employee. The system automatically updates this field when you run a payroll.  If you leave 
this field blank, the system uses the check date as the default.

mnLaborLoadingFactorLFMATH_NUMERICOPTNONE

A multiplier to load direct labor costs with burden.  For example, a factor of 1.32 would load every dollar of labor cost with 32 cents worth of 
burden.

cLaborLoadingMethodLMTHcharOPTNONE

Controls whether the labor costs include a flat burden for payroll taxes and benefits. Valid values are:    0   The flat burden factor is always 
1.0000, so the resulting amount for the flat burden is zero.    1   The flat burden factor is always greater than 1.0000, so the labor costs include a 
flat burden.

szLocationWorkCityLWK1charOPTNONE

A code identifying the city in which the employee works.

szLocationWorkCountyLWK2charOPTNONE

A code identifiying the county in which the employee works.

mnAmountMaximumNetPayNMAXMATH_NUMERICOPTNONE

The lowest amount to be generated as a check, bank advice, or payslip. The system does not allow zero amount checks if you have 
specified a minimum check amount. You can leave this field blank. Generally, this field's value will specify the minimum amount that must be paid 
to the employee.

mnRtDistributionOrBillPBRTMATH_NUMERICOPTNONE

A number that specifies the rate that the system uses to bill for labor services. This rate is often referred to as the billing or recharge rate. 
The system charges the resulting amount, based on this rate, to the primary distribution account for the timecard. The system also enters an 
offset to an account that is derived from automatic accounting instructions. This rate does not affect employee payroll. To allow billing rates in 
time entry, the employee record type must be set to 2 (payroll and recharge processing) or 3 (recharge processing only) with the Employee 
Payroll program (P0801PRL).

szPayCycleCodePCCDcharOPTNONE

A code that identifies the values for a master payroll cycle.

mnPayCycleBypassCountPYCBMATH_NUMERICOPTNONE

The number of pay cycles (that is, paychecks) bypassed. This is normally specified during the interim check process and would be used 
for short-term absences such as vacations and jury duty.  A normal paycheck will only be printed for an employee if this number is zero.  For 
Flexible Spending Accounts Auto Deposit Instructions Only: This field is used to provide a count for the number of Pay cycles you want to 
bypass the auto deposit feature so that you can write a manual check. Reasons for bypassing pay periods might be the employee's involvement 
in jury duty, vacation, or leave of absence. 

szBusinessUnitLastWorkedSGcharOPTNONE

The last business unit (job) number associated with this employee. This field is used for distribution of paychecks and in the generation of 
journal entries. When you process a payroll cycle that includes the employee, the system automatically updates this field.

cTippedEmployeeTIPEcharOPTNONE

A code that specifies whether this employee receives or claims tips and should be included in any necessary Tip Processing programs. 
This field applies to U.S. Payroll Only. This field must contain Y for tip processing.

szStateWorkingWKSEcharOPTNONE

The employee's work state for tax reporting purposes. This code indicates the state in which the employee normally works. The system 
uses this code to compute state income tax withholding. You can override this code during time entry, if necessary.

cWorkScheduleCodeWScharOPTNONE

A user defined code to designate intra-pay period work schedules. This code can be used for reporting and to select employees to be 
included in a payroll run. For example:    A Monday through Friday    B Saturday through Wednesday    C Monday through Thursday (4 x 10 hrs)

cRecordTypeRCCDcharOPTNONE

A code that identifies whether the employee is to be handled through the Recharge processing option for the Payroll Journal Entry 
program. Valid codes are:    1   Payroll Processing Only    2   Payroll and Recharge Processing    3   Recharge Processing Only  After a timecard has 
been added, you cannot change its record type.

Related Functions

B0000130 Retrieve Company From Business Unit
B0000564 Get Internal Next Number
B0100066 Recursive Relationship Check
B0500543 Validate Geo Code
B0500895 Is a Real Time Event Enabled
B0800007 Delete Employee Related Tables
B5100003 F0006 Check Business Unit Existence
B9800100 Get Audit Information
B9800420 Get Data Dictionary Definition
B9900410 Get Environment Value
N0500020 Update Payroll Lockout Code
N0500025 Salary Calculations Server
N0500032 Synchronize EE/Supervisor in EE Master &&&& Org Structure
N0500042 F08001 Retrieve Specific Job Information
N0800002 Set Employee Current Status Flag\Employee Id Validation
N0800003 Verify Job/Retrieve Job Default Information
N0800004 Compa-Ratio Server
N0800005 Pay Grade Server
N0800007 Delete Employee Edit
N0800008 Update F06210 to Force Payroll Rerun
N0800020 Update Employee Job (F060118) Server
N0800029 Transfer Supp Data on Hire/Terminate Employee
N0800030 Fiscal Year Begin & End Dates
N0800031 Get UDC Description
N0800050 Position Budget Edit Server
N0800069 F08040 - Get HR Constants Information
N0800146 Get a Specific Employee Self Service Common Setting
N0800204 Track Employee Date in Current Position/Job
XX0901 Validate Account Number

Related Tables

F0006 Business Unit Master
F00091 Supplemental Database Data Types
F00092 Supplemental Data
F00191 Generic Message/Rates
F0101 Address Book Master
F0150 Address Organization Structure Master
F060116 Employee Master Information
F060117 Employee Master - International Data
F060120 Employee Master Additional Information File
F065016 Automatic Bank Deposit Master
F069096 Payroll General Constants
F07300 Employee Lockout Code File
F08005 Business Unit/ Job Id. X-Ref
F08092 Human Resources General Description-User Def Codes
F08101 Position Master
F08102 Requisition Information
F08105 Requisition Activity
F08401 Applicant Master
F9203 Data Item Alpha Descriptions
F9210 Data Field Specifications (OneWorld)
EmployeeMBFUserDefinedData

EmployeeMBFUserDefinedData

Employee MBF

Minor Business Rule

Object Name: B0500575

Parent DLL: CHRM

Location: Client/Server

Language: C

Function Name: EmployeeMBFUserDefinedData

Purpose and Processing (why use it and what the function does)

• 

This function performs edits and updates for user defined code and user defined date fields in 
the F060116 (Employee Master) table.

• 
This function is one of several Employee MBF segments.

   Processing Modes

The MBF uses the following parameters to control processing. They are included in the control 
block at the top of the data structure. 

cActionCode      - The action code determines which basic operation to perform.

szColumnList    - Used to process a specific list of columns rather than all of 
the columns for a segment. The column list string is composed         
of the alias for each column separated  by a comma. The MBF processes 
all columns when this value is blank or NULL. The alias for each 
data item is listed below in the  parameters section.

cInquiryMode     - The inquiry mode controls how an inquiry is processed. Data 
can be fetched from the table, fetched from the table and saved 
in cache, or fetched from cache. 

cUpdateMode      - The update mode controls what portion of the update to 
execute. Data can be edited, updated, or both. 
 
cUpdateDataSource     - The update data source specifies whether the MBF updates the 
table or the cache. 

cEditMode     - The edit mode specifies whether to perform a full edit or
a partial edit. A partial edit omits data dictionary edits
for the fields.  

cErrorMode     - The error mode controls error message processing. Error
messages can be displayed, suppressed or saved in a cache.

cErrorStatus    - The error status indicates whether or not the MBF encountered
errors.

  Important Notes

• 
You must use the MBF Cache to process any Warnings (type 2 or 3 errors).
• You must use the MBF Cache to Log errors (cErrorMode 2).
• If you are using more that one MBF Segment it is advisable to use the cache.
• There is only one cache for the entire F060116 file so all F060116 segments inquire and update 
the same cache
 

Parameters (how to call the function)
    
ParameterColumn List I/ODescription
---------------------------------------------------------------------------------------
cActionCodeII  - Inquiry
 A  - Add new employee record (new hire)   
     C  - Change an existing employee record        
D  - Delete (Master segment)

szColumnListIList of data items to process or blank
to process all data items.

szCacheNameIThe name assigned to the cache by the
Employee MBF Cache Create function, or
blank if not using the cache.

cInquiryModeI0 or blank  - Fetch from table
1 - Fetch from table and save in cache
2 - Fetch from cache

cUpdateMode I0 or blank  - Edit and update
   1    - Edit only
   2    - Update only

cUpdateDataSource I0 or blank
  - Save to table if cActionCode = C
                           Save to cache if cActionCode = A
   1 - Save to cache

cEditMode I0 or blank  - Full edit
   1 - Partial edit (no data dict. edit)

cErrorMode  I0 or blank  - Normal error processing
   1  - Suppress error message display
2  - Log errors in the cache

szCallingProgramIdIName (ID) of the calling program.  
Updated to audit field PID.

szCallingVersionIVersion of the calling program. May be 
used in processing.

cErrorStatusO0 or blank  - Success
1        - Failure

mnAddressNumberI/OField in F060116 Table

cUpdateFlagI/OField in F060116 Table

szChangeReasonI/OField in F060116 Table

jdDateEffectiveI/OField in F060116 Table
  
jdUserDefinedDate001ED01I/OField in F060116 Table

jdUserDefinedDate002ED02I/OField in F060116 Table

jdUserDefinedDate003ED03I/OField in F060116 Table

jdUserDefinedDate004ED04I/OField in F060116 Table

jdUserDefinedDate005ED05I/OField in F060116 Table

jdUserDefinedDate006ED06I/OField in F060116 Table

jdUserDefinedDate007ED07I/OField in F060116 Table

jdUserDefinedDate008ED08I/OField in F060116 Table

jdUserDefinedDate009ED09I/OField in F060116 Table

jdUserDefinedDate010ED10I/OField in F060116 Table

jdUserDefinedDate011ED11I/OField in F060116 Table

jdUserDefinedDate012ED12I/OField in F060116 Table

jdUserDefinedDate013ED13I/OField in F060116 Table

jdUserDefinedDate014ED14I/OField in F060116 Table

jdUserDefinedDate015ED15I/OField in F060116 Table

jdUserDefinedDate016ED16I/OField in F060116 Table

jdUserDefinedDate017ED17I/OField in F060116 Table

jdUserDefinedDate018ED18I/OField in F060116 Table

jdUserDefinedDate019ED19I/OField in F060116 Table

jdUserDefinedDate020ED20I/OField in F060116 Table

szReportingCodesPayro001P001I/OField in F060116 Table

szReportingCodesPayro002P002I/OField in F060116 Table

szReportingCodesPayro003P003I/OField in F060116 Table

szReportingCodesPayro004P004I/OField in F060116 Table

szReportingCodesPayro005P005I/OField in F060116 Table

szReportingCodesPayro006P006I/OField in F060116 Table

szReportingCodesPayro007P007I/OField in F060116 Table

szReportingCodesPayro008P008I/OField in F060116 Table

szReportingCodesPayro009P009I/OField in F060116 Table

szReportingCodesPayro010P010I/OField in F060116 Table

szReportingCodesPayro011P011I/OField in F060116 Table

szReportingCodesPayro012P012I/OField in F060116 Table

szReportingCodesPayro013P013I/OField in F060116 Table

szReportingCodesPayro014P014I/OField in F060116 Table

szReportingCodesPayro015P015I/OField in F060116 Table

szReportingCodesPayro016P016I/OField in F060116 Table

szReportingCodesPayro017P017I/OField in F060116 Table

szReportingCodesPayro018P018I/OField in F060116 Table

szReportingCodesPayro019P019I/OField in F060116 Table

szReportingCodesPayro020P020I/OField in F060116 Table


Use (how to use the function and other related functions)

You are referred to the Employee MBF Master Data documentation for details on how to add a new 
employee to the database.

Perform the following step to update an exsisting employee (single segment):

1. Call the segment with the fields you want to update and the parameters listed below. Use the 
szColumnList parameter if you do not want to update all of the columns for the segment.

   EmployeeMBFUserDefinedData
C -> cActionCode 
Columns to update or blank-> szColumnList
Error Status Variable<- cErrorStatus                   
employee's address book number-> mnAddressNumber     
new data values -> data columns        

Perform the following steps to update an exsisting employee using cache (multiple segments):

1. Initialize the cache.

   Employee MBF Cache Create
Cache Variable<- szCacheName       
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus                   

2. Inquire on the table and save the record to cache.

   Employee MBF User Defined Data
I ->  cActionCode              
Cache Variable-> szCacheName 
1 -> cInquireyMode
Error Status Variable<- cErrorStatus        
employee's address book number-> mnAddressNumber     

3. Update the cache with data for the segment. Use the szColumnList parameter if you do not want to 
update all of the columns for the segment.

   Employee MBF User Defined Data
C-> cActionCode              
Cache Variable-> szCacheName  
1-> cUpdateDataSource
Error Status Variable<- cErrorStatus       
employee's address book number-> mnAddressNumber     
new data values-> data columns        

4. Update the cache with data for other segments. Replace the segment shown here with the segment 
that you want to update. This example uses column list to update the TARA and TARR fields.

   Employee MBF National Data US
C -> cActionCode              
TARA,TARR -> szColumnList
Cache Variable-> szCacheName  
1 -> cUpdateDataSource       
Error Status Variable<- cErrorStatus       
employee's address book number-> mnAddressNumber     
new data values-> data columns  
as desired-> processing options        

5. Update the database with the records in cache.

   Employee MBF Cache Commit
U-> cActionCode           
Cache Variable -> szCacheName    
0 or 1-> cErrorMode   
Error Status Variable<- cErrorStatus

6. Destroy the cache.

   Employee MBF Cache Destroy
Cache Variable-> szCacheName
0 or 1-> cErrorMode  
Error Status Variable<- cErrorStatus

Perform the following step to edit an existing employee without updating the table (edit-only):

1. Use this call to edit proposed changes to fields without actually updating the table. The edits 
are performed for only those columns in the column list. If the list is blank, all columns in the data 
structure are edited.

   Employee MBF User Defined Data
C  -> cActionCode  
Columns to update or blank-> szColumnList            
1 -> cUpdateMode
Error Status Variable<- cErrorStatus
employee's address book number-> mnAddressNumber     
new data values -> data columns


Data Structure

D0500575B - Employee MBF User Defined Data

Parameter NameData ItemData TypeReq/OptI/O/Both
cActionCodeACTNcharREQINPUT

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

szColumnListDSScharOPTINPUT

This field will contain a bar delimited string of data item names from the Employee Master (F060116). Each data item in the string 
corresponds with a data item in a UBE data structure. This mapping will allow RI values to be passed to a UBE when run dynamically from a BSFN.

szCacheNameDTAIcharOPTINPUT

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.

cInquiryModeEV01charOPTINPUT

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

cUpdateModeEV01charOPTINPUT

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

cUpdateDataSourceEV01charOPTINPUT

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

cEditModeEV01charOPTINPUT

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

cErrorModeEV01charOPTINPUT

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

szCallingProgramIdPIDcharOPTINPUT

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.

szCallingVersionVERScharOPTINPUT

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.

cErrorStatusEV01charOPTOUTPUT

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

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

cUpdateFlagUFLGcharOPTNONE

This indicator in the employee master is under program control. It is set to Y when anything is added, changed or deleted related to the 
employee including the master file itself, the employee's pay/deduction/benefit/accrual transaction profile, his current time and pay detail 
transactions or interim check information. The principal use of this indicator is to determine whether the employee needs to be reprocessed during 
a pre-payroll rerun. The pre-payroll process automatically resets this flag to blank.

szChangeReasonTRScharOPTNONE

A code that indicates the reason for one of the following:   o  Changing an active employee's record   o  Terminating an employee   o  
Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The 
code for new hires is the default reason code.

jdDateEffectiveEFTJDEDATEOPTNONE

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.

jdUserDefinedDate001ED01JDEDATEOPTNONE

A user defined date. Because this field is not linked to any specific function or application within the system, you can use this date for any 
purpose needed by your company. For example, you can use this date field to track the expiration of a license or certification.

jdUserDefinedDate002ED02JDEDATEOPTNONE

A user defined date. Because this field is not linked to any specific function or application within the system, you can use this date for any 
purpose needed by your company. For example, you can use this date field to track the expiration of a visa or green card.

jdUserDefinedDate003ED03JDEDATEOPTNONE

A user defined date. Because this field is not linked to any specific function or application within the system, you can use this date for any 
purpose needed by your company. For example, you can use this date field to track the expiration of a license or certification.

jdUserDefinedDate004ED04JDEDATEOPTNONE

A user defined date. Because this field is not linked to any specific function or application within the system, you can use this date for any 
purpose needed by your company. For example, you can use this date field to track the expiration of a license or certification.

jdUserDefinedDate005ED05JDEDATEOPTNONE

A user defined date. Because this field is not linked to any specific function or application within the system, you can use this date for any 
purpose needed by your company. For example, you can use this date field to track the expiration of a license or certification.

jdUserDefinedDate006ED06JDEDATEOPTNONE

A user defined date. Because this field is not linked to any specific function or application within the system, you can use this date for any 
purpose needed by your company. For example, you can use this date field to track the expiration of a license or certification.

jdUserDefinedDate007ED07JDEDATEOPTNONE

A user defined date. Because this field is not linked to any specific function or application within the system, you can use this date for any 
purpose needed by your company. For example, you can use this date field to track the expiration of a license or certification.

jdUserDefinedDate008ED08JDEDATEOPTNONE

A user defined date. Because this field is not linked to any specific function or application within the system, you can use this date for any 
purpose needed by your company. For example, you can use this date field to track the expiration of a license or certification.

jdUserDefinedDate009ED09JDEDATEOPTNONE

A user defined date. Because this field is not linked to any specific function or application within the system, you can use this date for any 
purpose needed by your company. For example, you can use this date field to track the expiration of a license or certification.

jdUserDefinedDate010ED10JDEDATEOPTNONE

A user defined date. Because this field is not linked to any specific function or application within the system, you can use this date for any 
purpose needed by your company. For example, you can use this date field to track the expiration of a license or certification.

jdUserDefinedDate011ED11JDEDATEOPTNONE

A user-defined date in a field that can hold a date which is not already defined in the Payroll system. For example, if your organization 
needs to track the date when an employee received a particular certification or license, you can set up this user-defined date field to track that 
date information. If you use this field, you can change the appropriate screen text as needed.

jdUserDefinedDate012ED12JDEDATEOPTNONE

A user-defined date in a field that can hold a date that is not already defined in the Payroll system. For example, if your organization needs 
to track the date when an employee received a particular certification or license, you can set up this user-defined date field to track that date 
information. If you use this field, you can change the appropriate screen text as needed.

jdUserDefinedDate013ED13JDEDATEOPTNONE

A user-defined date in a field that can hold a date which is not already defined in the Payroll system. For example, if your organization 
needs to track the date when an employee received a particular certification or license, you can set up this user-defined date field to track that 
date information. If you use this field, you can change the appropriate screen text as needed.

jdUserDefinedDate014ED14JDEDATEOPTNONE

A user-defined date in a field that can hold a date which is not already defined in the Payroll system. For example, if your organization 
needs to track the date when an employee received a particular certification or license, you can set up this user-defined date field to track that 
date information. If you use this field, you can change the appropriate screen text as needed.

jdUserDefinedDate015ED15JDEDATEOPTNONE

A user-defined date in a field that can hold a date which is not already defined in the Payroll system. For example, if your organization 
needs to track the date when an employee received a particular certification or license, you can set up this user-defined date field to track that 
date information. If you use this field, you can change the appropriate screen text as needed.

jdUserDefinedDate016ED16JDEDATEOPTNONE

A user-defined date in a field that can hold a date that is not already defined in the Payroll system. For example, if your organization needs 
to track the date when an employee received a particular certification or license, you can set up this user-defined date field to track that date 
information. If you use this field, you can change the appropriate screen text as needed.

jdUserDefinedDate017ED17JDEDATEOPTNONE

A user-defined date in a field that can hold a date that is not already defined in the Payroll system. For example, if your organization needs 
to track the date when an employee received a particular certification or license, you can set up this user-defined date field to track that date 
information. If you use this field, you can change the appropriate screen text as needed.

jdUserDefinedDate018ED18JDEDATEOPTNONE

A user-defined date in a field that can hold a date that is not already defined in the Payroll system. For example, if your organization needs 
to track the date when an employee received a particular certification or license, you can set up this user-defined date field to track that date 
information. If you use this field, you can change the appropriate screen text as needed.

jdUserDefinedDate019ED19JDEDATEOPTNONE

A user-defined date in a field that can hold a date that is not already defined in the Payroll system. For example, if your organization needs 
to track the date when an employee received a particular certification or license, you can set up this user-defined date field to track that date 
information. If you use this field, you can change the appropriate screen text as needed.

jdUserDefinedDate020ED20JDEDATEOPTNONE

A user-defined date in a field that can hold a date that is not already defined in the Payroll system. For example, if your organization needs 
to track the date when an employee received a particular certification or license, you can set up this user-defined date field to track that date 
information. If you use this field, you can change the appropriate screen text as needed.

szReportingCodesPayro001P001charOPTNONE

A category code that defines payroll system needs. You can define the use and description of this code to fit your organization. For 
example, you can set up a category code for information such as Division, Supervisor, Branch office, Health insurance plan, Stock plan, and so on. 
Note: When setting up category codes in the Workforce Management system, you should coordinate information with the payroll department 
to insure that information is not duplicated or overwritten.

szReportingCodesPayro002P002charOPTNONE

A category code which specifies payroll system needs. You may define the use and description of this code to fit your organization.  For 
example, you can set up a category code for any of the following categories:   o Division     o Supervisor     o Branch Office     o Health Insurance 
Plan     o Stock Plan  Work Force Management: Coordinate the use of this category code with the payroll department.

szReportingCodesPayro003P003charOPTNONE

A category code which specifies payroll system needs. You can define the use and description of this code to fit your organization. For 
example, you can set up a category code for any of the following categories:   o Division     o Supervisor     o Branch Office     o Health Insurance 
Plan     o Stock Plan   Work Force Management: Coordinate the use of this category code with your payroll department.

szReportingCodesPayro004P004charOPTNONE

A category code which specifies payroll system needs. You can define the use and description of this code to fit your organization. For 
example, you can set up a category code for any of the following categories:   o Division     o Supervisor     o Branch Office     o Health Insurance 
Plan     o Stock Plan   Work Force Management: Coordinate the use of this category code with your payroll department.

szReportingCodesPayro005P005charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan     o Stock Plan  This category code is 
shared by HR and Payroll.  You should not change the definition of this category code  unless both HR and Payroll are aware of the change.

szReportingCodesPayro006P006charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan     o Stock Plan  This category code is 
shared by HR and Payroll.  You should not change the definition of this category code unless both HR and Payroll are aware of the change.

szReportingCodesPayro007P007charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan     o Stock Plan  This category code is 
shared by HR and Payroll.  You should not change the definition of this category code unless both HR and Payroll are aware of the change.

szReportingCodesPayro008P008charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan     o Stock Plan  This category code is 
shared by HR and Payroll.  You should not change the definition of this category code unless both HR and Payroll are aware of the change.

szReportingCodesPayro009P009charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan     o Stock Plan  This category code is 
shared by HR and Payroll.  You should not change the definition of this category code unless both HR and Payroll are aware of the change.

szReportingCodesPayro010P010charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan     o Stock Plan  This category code is 
shared by HR and Payroll.  You should not change the definition of this category code unless both HR and Payroll are aware of the change.

szReportingCodesPayro011P011charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan     o Stock Plan  This category code is 
shared by HR and Payroll.  You should not change the definition of this category code unless both HR and Payroll are aware of the change.

szReportingCodesPayro012P012charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan     o Stock Plan  This category code is 
shared by HR and Payroll.  You should not change the definition of this category code unless both HR and Payroll are aware of the change.

szReportingCodesPayro013P013charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan     o Stock Plan  This category code is 
shared by HR and Payroll.  You should not change the definition of this category code unless both HR and Payroll are aware of the change.

szReportingCodesPayro014P014charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan     o Stock Plan  This category code is 
shared by HR and Payroll.  You should not change the definition of this category code unless both HR and Payroll are aware of the change.

szReportingCodesPayro015P015charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan     o Stock Plan  This category code is 
shared by HR and Payroll.  You should not change the definition of this category code unless both HR and Payroll are aware of the change.

szReportingCodesPayro016P016charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan  This category code is shared by HR 
and Payroll.  You should not change the definition of this category code unless both HR and Payroll are aware of the change.

szReportingCodesPayro017P017charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan     o Stock Plan  This category code is 
shared by HR and Payroll.  You should not change the definition of this category code unless both HR and Payroll are aware of the change.

szReportingCodesPayro018P018charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan     o Stock Plan  This category code is 
shared by HR and Payroll.  You should not change the definition of this category code unless both HR and Payroll are aware of the change.

szReportingCodesPayro019P019charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan     o Stock Plan  This category code is 
shared by HR and Payroll.  You should not change the definition of this category code unless both HR and Payroll are aware of the change.

szReportingCodesPayro020P020charOPTNONE

Your may define the use and description of this code to fit the needs of your organization.  You can, for example, set up a category code for 
any of the following categories:     o Division     o Supervisor     o Branch Office     o Health Insurance Plan     o Stock Plan  This category code is 
shared by HR and Payroll.  You should not change the definition of this category code unless both HR and Payroll are aware of the change.

Related Functions

B0000130 Retrieve Company From Business Unit
B0000564 Get Internal Next Number
B0100066 Recursive Relationship Check
B0500543 Validate Geo Code
B0500895 Is a Real Time Event Enabled
B0800007 Delete Employee Related Tables
B5100003 F0006 Check Business Unit Existence
B9800100 Get Audit Information
B9800420 Get Data Dictionary Definition
B9900410 Get Environment Value
N0500020 Update Payroll Lockout Code
N0500025 Salary Calculations Server
N0500032 Synchronize EE/Supervisor in EE Master &&&& Org Structure
N0500042 F08001 Retrieve Specific Job Information
N0800002 Set Employee Current Status Flag\Employee Id Validation
N0800003 Verify Job/Retrieve Job Default Information
N0800004 Compa-Ratio Server
N0800005 Pay Grade Server
N0800007 Delete Employee Edit
N0800008 Update F06210 to Force Payroll Rerun
N0800020 Update Employee Job (F060118) Server
N0800029 Transfer Supp Data on Hire/Terminate Employee
N0800030 Fiscal Year Begin & End Dates
N0800031 Get UDC Description
N0800050 Position Budget Edit Server
N0800069 F08040 - Get HR Constants Information
N0800146 Get a Specific Employee Self Service Common Setting
N0800204 Track Employee Date in Current Position/Job
XX0901 Validate Account Number

Related Tables

F0006 Business Unit Master
F00091 Supplemental Database Data Types
F00092 Supplemental Data
F00191 Generic Message/Rates
F0101 Address Book Master
F0150 Address Organization Structure Master
F060116 Employee Master Information
F060117 Employee Master - International Data
F060120 Employee Master Additional Information File
F065016 Automatic Bank Deposit Master
F069096 Payroll General Constants
F07300 Employee Lockout Code File
F08005 Business Unit/ Job Id. X-Ref
F08092 Human Resources General Description-User Def Codes
F08101 Position Master
F08102 Requisition Information
F08105 Requisition Activity
F08401 Applicant Master
F9203 Data Item Alpha Descriptions
F9210 Data Field Specifications (OneWorld)