CreateGapSnapshot

Create Gap Snapshot

Minor Business Rule

Object Name: N0800156

Parent DLL: CHRM

Location: Client/Server

Language: NER

Functional Description

Purpose
The purpose of this business function is to create a snapshot of a gap analysis. This gap analysis
shows the difference, as of a point in time, between the competency levels required for a job and an
employee's competency levels.

Setup Notes and Prerequisites

Special Logic

Technical Specification

If the Gap Reason is passed in use the effective date. If this is blank, use the current date.

If the Performance Appraisal Reason is passed in and EFT (effective date)
passed in is blank, use the Next Review Date (NRVW) from the Employee Master
(F060116).

Check the handle passed in (JOBS).
If it is null or blank, then the cache
has not been created and it needs to be created.

If OTPS is blank, get the default OTPS from F08043 using N0800193.

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szCacheHandle	JOBN	char	OPT	NONE
The code that identifies the work station ID that executed a particular job.
szGapReason	GAPR	char	OPT	NONE
A user defined code (08/GN) indicating the reason that a Gap Snapshot is done. For example, a Gap Snapshot may be done at the end of every fiscal year (Gap Reason = "Fiscal Year End"). A Gap Snapshot may also be used when there is a major organizational change and management wants to make a snapshot (Gap Reason = "1999 Organizational Changes").
szPerformanceAppraisalReas	PAPR	char	OPT	NONE
Obsolete data item. Do not use.
jdDateEffectiveRates	EFT	JDEDATE	OPT	NONE
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.
mnAddressNumber	AN8	MATH_NUMERIC	REQ	INPUT
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or location.
szOrganizationType	OTPS	char	REQ	INPUT
A user-defined code (00/TS) that identifies the type of organization structure, such as financial or responsibility. Each type of organization structure can have a separate hierarchy.
szJobCategory	JBCD	char	REQ	INPUT
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.
szJobStep	JBST	char	REQ	INPUT
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.
szOrganizationalBusinessUn	ORMCU	char	OPT	NONE
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.
cClearRecordsOutOfCache	OWYSNO	char	REQ	INPUT
Specifies an indicator setting. Valid values are: 0 No 1 Yes
cErrorCode	ERRC	char	OPT	NONE
This error code indicates if any errors occurred during the creation of the Trip Document Detail (F4914) records by the Delivery Document Set Server program (XT4914).
cSuppressErrorMessage	SUPPS	char	OPT	NONE
A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function. 0 = allow runtime error message handling. 1 = suppress runtime error message handling.
mnCacheJobnumberA	JOBS	MATH_NUMERIC	OPT	NONE
The job number (work station ID) which executed the particular job.
idGenericLong	GENLNG	ID	OPT	NONE
General purpose ID variable.
szUserId	USER	char	OPT	NONE
The code that identifies a user profile.
szProgramId	PID	char	OPT	NONE
The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry program.
szWorkStationId	JOBN	char	OPT	NONE
The code that identifies the work station ID that executed a particular job.
jdDateUpdated	UPMJ	JDEDATE	OPT	NONE
The date that specifies the last update to the file record.
mnTimeLastUpdated	UPMT	MATH_NUMERIC	OPT	NONE
The time that specifies when the program executed the last update to this record.
szMessageID	DTAI	char	OPT	OUTPUT
A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.
cTypeIncreaseNextRevw	TINC	char	OPT	NONE
A user defined code (06/RV) that specifies the type of performance review to be completed for the next review period.
mnTotalJobCompetencyPercAch	BFAC	MATH_NUMERIC	OPT	OUTPUT
This is a factor computed for every time record entered (or created) for an employee. It is used to prorate the actual company payroll burden and charge each job (business unit) for its share of these expenses. The total of the factors for all time records for an employee for a pay period is 1.000000.

In this situation, it is assumed that everything is defaulted (JBCD, JBST, and ORMCU).
These will be retrieved from the F060116 and the F060120.

If OTPS is not blank:

F0004 Validate UDC Value

Verify that JBCD, JBST, and ORMCU are not blank,  if they are, get the defaults.

If the organizational business unit is blank, get it from the Additional Employee information
file F060120.

Validate the Structure Type entered along with the effective date



Build the JCC Cache for the selected level in the organization

Build the Gap Snapshot based on data found in the cache

Data Item Data Structure DescriptionI/ORequiredNotes
GENLNGCache CursorIN
JOBSJob Number (Key_1) INThe cache key that identifies this cache from
other B0800154 caches that may be out on the same server.
GAPRGap ReasonIN
PAPRPerformance Appraisal ReasonIN
EFTEffective DateINIt only pertains to a performance appraisal.
AN8Address Book NumberIN
OTPSStructure TypeIN
JBCDJob TypeIN
JBSTJob StepIN
ORMCUOrganizational Business UnitIN
OWYSNOClear Records out of the cacheIY
ERRCError Message IdON
SUPPSSuppress Error MessageON

Data Structure

D0800156 - Create Gap Snapshot

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

szCacheHandle JOBN char OPT NONE

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

szGapReason GAPR char OPT NONE

A user defined code (08/GN) indicating the reason that a Gap Snapshot is done. For example, a Gap Snapshot may be done at the end of
every fiscal year (Gap Reason = "Fiscal Year End"). A Gap Snapshot may also be used when there is a major organizational change and
management wants to make a snapshot (Gap Reason = "1999 Organizational Changes").

szPerformanceAppraisalReas PAPR char OPT NONE

Obsolete data item.  Do not use.

jdDateEffectiveRates EFT JDEDATE OPT NONE

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.

mnAddressNumber AN8 MATH_NUMERIC REQ INPUT

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

szOrganizationType OTPS char REQ INPUT

A user-defined code (00/TS) that identifies the type of organization structure, such as financial or responsibility. Each type of organization
structure can have a separate hierarchy.

szJobCategory JBCD char REQ INPUT

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.

szJobStep JBST char REQ INPUT

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.

szOrganizationalBusinessUn ORMCU char OPT NONE

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.

cClearRecordsOutOfCache OWYSNO char REQ INPUT

Specifies an indicator setting. Valid values are:    0   No    1   Yes

cErrorCode ERRC char OPT NONE

This error code indicates if any errors occurred during the creation of the Trip Document Detail (F4914) records by the Delivery Document
Set Server program (XT4914).

cSuppressErrorMessage SUPPS char OPT NONE

A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.        0 = allow
runtime error message handling.        1 = suppress runtime error message handling.

mnCacheJobnumberA JOBS MATH_NUMERIC OPT NONE

The job number (work station ID) which executed the particular job.

idGenericLong GENLNG ID OPT NONE

General purpose ID variable.

szUserId USER char OPT NONE

The code that identifies a user profile.

szProgramId PID char OPT NONE

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value.
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry
program.

szWorkStationId JOBN char OPT NONE

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

jdDateUpdated UPMJ JDEDATE OPT NONE

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

mnTimeLastUpdated UPMT MATH_NUMERIC OPT NONE

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

szMessageID DTAI char OPT OUTPUT

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

cTypeIncreaseNextRevw TINC char OPT NONE

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

mnTotalJobCompetencyPercAch BFAC MATH_NUMERIC OPT OUTPUT

This is a factor computed for every time record entered (or created) for an employee. It is used to prorate the actual company payroll
burden and charge each job (business unit) for its share of these expenses. The total of the factors for all time records for an employee for a pay
period is 1.000000.

Related Functions

None

Related Tables

None

GetEmployeeCompLevels
GetEmployeeCompLevels

Create Gap Snapshot

Minor Business Rule

Object Name: N0800156

Parent DLL: CHRM

Location: Client/Server

Language: NER

Functional Description

Purpose
The purpose of this function is to read through the cache (which contains records relating to the job
competencies for a job) and find the employee competency level for each job competency option found.
The cache will be updated with the employee competency level for each job competency option.

Setup Notes and Prerequisites

Special Logic

Technical Specification

Go through the cache and update it with the employee competencies that match the job competencies.
For each record found in the cache, read the F05100 to get the employee competency level and update the cache.

Data Item Data Structure DescriptionI/ORequiredNotes
JOBSJob Number (Key_1) INThe cache key that identifies this cache from
other B0800154 caches that may be out on the same server.
AN8Address Book NumberIN
ERRCError Message IdON

Data Structure

D0800156B - Get Employee Competency Levels

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

mnJobnumberA JOBS MATH_NUMERIC REQ INPUT

The job number (work station ID) which executed the particular job.

mnAddressNumber AN8 MATH_NUMERIC REQ INPUT

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

cErrorCode ERRC char OPT NONE

This error code indicates if any errors occurred during the creation of the Trip Document Detail (F4914) records by the Delivery Document
Set Server program (XT4914).

Related Functions

None

Related Tables

None

ValidateOrgStructAndDates
ValidateOrgStructAndDates

Create Gap Snapshot

Minor Business Rule

Object Name: N0800156

Parent DLL: CHRM

Location: Client/Server

Language: NER

Functional Description

Purpose
The purpose of this function is to validate the data coming into the business function.
Specifically, this function validates the data to make sure that the information requested is valid in the given
point in time.

Setup Notes and Prerequisites

Special Logic

Verify that the Organizational Structure is in effect as of the date.  If not,
or if the Organizational Structure is blank, set an error.

Check to see if this is a draft.  (Drafts do not have any effective dates)

Error Message Id is returns a 1 if successful, 0 if unsuccessful.

Technical Specification

Data Item Data Structure DescriptionI/ORequiredNotes
OTPSStructure TypeIN
EFTEffective DateIN
SUPPSSupress Error MessageIN
ERRCError Message IdON
DTAIData ItemON

Data Structure

D0800156A - Validate Organizational Structure and Dates

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

szOrganizationType OTPS char OPT NONE

A user-defined code (00/TS) that identifies the type of organization structure, such as financial or responsibility. Each type of organization
structure can have a separate hierarchy.

jdDateEffectiveRates EFT JDEDATE OPT NONE

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.

cErrorCode ERRC char OPT NONE

This error code indicates if any errors occurred during the creation of the Trip Document Detail (F4914) records by the Delivery Document
Set Server program (XT4914).

szMessageID DTAI char OPT NONE

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.

cSuppressErrorMessage SUPPS char OPT NONE

A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.        0 = allow
runtime error message handling.        1 = suppress runtime error message handling.

Related Functions

None

Related Tables

None

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnJobnumberA	JOBS	MATH_NUMERIC	REQ	INPUT
The job number (work station ID) which executed the particular job.
mnAddressNumber	AN8	MATH_NUMERIC	REQ	INPUT
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or location.
cErrorCode	ERRC	char	OPT	NONE
This error code indicates if any errors occurred during the creation of the Trip Document Detail (F4914) records by the Delivery Document Set Server program (XT4914).