This appendix provides an overview of the Time Collection Device (TCD) reporting feature in Time and Labor and discusses:
Input data sent to TCD systems.
Output data produced by TCD systems.
Objects received by the TCD.
Objects sent from the TCD.
Configuration of the Integration Broker and the TCD server.
Error handling and resolution.
Frequently asked questions
This section discusses the interface process between Time and Labor and third-party data collection systems. The term TCD refers to the badge-based terminal that can range from a very simple TCD to a very sophisticated data collection system.
The TCD Interface uses the PeopleSoft Integration Broker to send and receive data from the TCD system. Data in Time and Labor and the TCD system are synchronized by either a full data replication or an incremental approach (changes only).
The TCD Vendor Interface process is part of the Time Reporting feature of Time and Labor. The TCD Vendor Interface process:
Identifies a generic set of input data to be sent to the various TCD systems. Each TCD vendor determines which data elements are needed based on the customer’s business requirements and the capabilities of the devices it markets and supports.
Identifies a generic set of output data to be produced by the various TCD systems. The TCD vendor populates all required fields and optional fields when applicable.
Provides TCD vendors with the following detailed information to implement the interface process:
Instructions to implement the PeopleSoft Integration Broker service operation.
Information to interpret the input data elements and data structures and their relationships.
Instructions to populate the output data structures.
The frequency for passing data between the TCD system and Time and Labor is determined by your business requirements. PeopleSoft and your TCD vendor collectively determine the frequency of communications on an implementation to implementation basis.
Note. To research the technical details of any integration point (EIP) used by PeopleSoft applications, refer to the Interactive Services Repository in the Implementation Guide section of My Oracle Support.
Time and Labor interfaces with many data collection systems. Input data to be sent to the TCD system varies by vendor. To accommodate as many vendors as possible, PeopleSoft allows you to define a generic set of input data to pass to your TCD. The TCD vendor uses only the data it must send to TCDs to meet the customer’s time reporting needs.
Time and Labor uses the definitions of TCD type to control the data going to your TCD. It does not send data that your TCD cannot process. This reduces the traffic on the network and the amount of data the TCD has to ignore.
Time Reporter
The Time Reporter data structure contains general information about the time reporter and foreign keys to related data on other data structures that follow.
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
Empl ID |
Char |
11 |
TL_EMPL_DATA |
Identifier. |
2 |
Empl RCD# |
Num |
3 |
TL_EMPL_DATA |
Identifier used in PS applications to accommodate multiple concurrent jobs (positions). |
3 |
Badge ID |
Char |
20 |
BADGE_TABLE |
Identifier. |
4 |
Time Reporting Status |
Char |
1 |
TL_EMPL_DATA |
Active or Inactive. |
5 |
Last Name |
Char |
30 |
PERSONAL_DATA |
Last name. |
6 |
First Name |
Char |
30 |
PERSONAL_DATA |
First name. |
7 |
Hire Date |
Date |
10 |
EMPLOYMENT |
Needed for calculating anniversary date. |
8 |
Service Date |
Date |
10 |
EMPLOYMENT |
Needed for determining seniority. |
9 |
Birth Date |
Date |
10 |
PERSONAL_DATA |
Needed for displaying a ‘Happy Birthday’ message. |
10 |
Restriction Profile ID |
Char |
10 |
TL_TCDGRP_TBL or TL_EMPL_DATA |
Identifies the employee’s restriction profile. Blank means there are no restrictions for the time reporter. |
11 |
Task Template ID |
Char |
10 |
TL_TASKGRP_TBL |
Identifies the employee’s task template ID. |
12 |
Task Profile ID |
Char |
10 |
TL_EMPL_DATA |
Identifies the employee’s task profile. |
With a few exceptions, Time and Labor obtains this information from the Employee Profile process and direct selects from tables. The Restriction Profile ID is from the TCD Group unless there is an override Restriction Profile on the Time and Labor Employee Data (TL_EMPL_DATA) record. The TASK_PRFL_TMPLT_ID is from the Taskgroup Table based on the employee’s assigned Taskgroup in TL_EMPL_DATA.
Time and Labor sends both Badge ID and Empl ID/Empl Rcd#. The TCD can use either in collecting data.
This record is sent as a full table and as incremental changes are made in PeopleSoft. For example, for setup of the TCD, a TCD would receive all the reporters for that TCD. If a reporter was just activated in Time and Labor Employee Data, an incremental message is sent to all TCD’s in the reporters TCD group.
The Task Template ID specified on this message is in the TCD Task Template message only if the template is valid for the TCDs to which this reporter can report time.
Schedule
The Schedule data structure contains time reporters’ daily schedules.
Time reporters’ daily schedules are provided to your TCD. The TCD uses this to determine when the time reporter is scheduled to punch in/out for work, meals, and breaks. Based on user-defined criteria (in restriction profiles), the TCD issues warning/error messages or prevents the user from using it.
The TCD definition defines whether this type of TCD can accept schedules. Time and Labor does not send schedules or restriction profiles if the TCD cannot accommodate them.
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
Badge ID |
Char |
20 |
TL_SCHEDULE |
Identifier. |
2 |
Emplid |
Char |
11 |
TL_EMPL_DATA |
Identifier. |
3 |
Empl Rcd# |
Num |
3 |
TL_EMPL_DATA |
Identifier. |
4 |
Punch Date Time |
DateTime |
See Interface Specifications (Appendix F) |
TL_SCHEDULE |
Identifier. |
5 |
Sequence Number |
Num |
3 |
TL_SCHEDULE |
Identifier − needed when schedule spans multiple days. |
6 |
Punch Type |
Char |
1 |
TL_SCHEDULE |
(1 = In, 2 = Out, 3 = Meal, 4 = Break, 5 = Transfer). |
Note. This data structure contains multiple instances of schedules per day. If the vendor requires that there is only one schedule record per day, the vendor must reformat the input data before sending to TCDs.
Restriction Profile
The Restriction Profile data structure contains customer defined restriction information. The vendor determines which restriction profiles to send to which TCDs based on the assignments of time reporters to restriction profile on the Time Reporter data structure. The vendor should be able to send all restriction profiles received from Time and Labor to all TCDs.
The TCD requires restriction profiles to determine when to allow or disallow punches to occur.
The TCD definition defines whether this type of TCD can accept schedules. Time and Labor does not send schedules or restriction profiles if the TCD cannot process them.
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
Restriction Profile ID |
Char |
10 |
TL_RESTRCTN_TBL |
Identifier. |
2 |
Early In Restriction Ind |
Char |
1 |
TL_RESTRCTN_TBL |
Y/N. |
3 |
Early In Margin |
Num |
4 |
TL_RESTRCTN_TBL |
Minutes. |
4 |
Late In Restriction Ind |
Char |
1 |
TL_RESTRCTN_TBL |
Y/N. |
5 |
Late In Margin |
Num |
4 |
TL_RESTRCTN_TBL |
Minutes. |
6 |
Early Out Restriction Ind |
Char |
1 |
TL_RESTRCTN_TBL |
Y/N. |
7 |
Early Out Margin |
Num |
4 |
TL_RESTRCTN_TBL |
Minutes. |
8 |
Late Out Restriction Ind |
Char |
1 |
TL_RESTRCTN_TBL |
Y/N. |
9 |
Late Out Margin |
Num |
4 |
TL_RESTRCTN_TBL |
Minutes. |
10 |
Early Meal Restriction Ind |
Char |
1 |
TL_RESTRCTN_TBL |
Y/N. |
11 |
Early Meal Margin |
Num |
4 |
TL_RESTRCTN_TBL |
Minutes. |
12 |
Late Meal Restriction Ind |
Char |
1 |
TL_RESTRCTN_TBL |
Y/N. |
13 |
Late Meal Margin |
Num |
4 |
TL_RESTRCTN_TBL |
Minutes. |
14 |
Early Break Restriction Ind |
Char |
1 |
TL_RESTRCTN_TBL |
Y/N. |
15 |
Early Break Margin |
Num |
4 |
TL_RESTRCTN_TBL |
Minutes. |
16 |
Late Break Restriction Ind |
Char |
1 |
TL_RESTRCTN_TBL |
Y/N. |
17 |
Late Break Margin |
Num |
4 |
TL_RESTRCTN_TBL |
Minutes. |
Total Hours
The Total Hours data structure contains hours already worked for the week. Total Hours includes any overtime hours earned to date for the period. PeopleSoft provides the total hours by TRC for the current period for the time reporter up to the current date.
The TCD vendor uses this information to send to TCDs to be displayed when inquired by time reporters and supervisors. The TCD definition defines whether this type of TCD can accept hours.
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
Badge ID |
Char |
20 |
BADGE_TABLE |
Identifier. |
2 |
Empl ID |
Char |
11 |
TL_EMPL_DATA |
Identifier. |
3 |
Empl RCD# |
Num |
3 |
TL_EMPL_DATA |
Identifier. |
4 |
Time Reporting Code |
Char |
5 |
TL_PAYABLE_TIME |
Identifier. |
5 |
Total Payable Hours |
Num |
12.6 |
TL_PAYABLE_TIME |
Number. |
Note. Total Hours information comes from the Payable Time Table. To determine total payable hours, Time Administration (Apply Rules) must be executed before such data can be published.
Time Reporting Code
This data structure contains a list of Time Reporting Codes (TRCs) that are allowable at your TCD (such as sick, vacation, holiday, meal allowance, and so on). This is for elapsed time reporting only.
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
TCD ID |
Char |
10 |
TL_TCD_TBL |
Identifies which clock gets this information. |
2 |
Time Reporting Code |
Char |
5 |
TL_TRC_TBL |
Identifier. |
3 |
Description |
Char |
30 |
TL_TRC_TBL |
Description. |
4 |
TRC Type |
Char |
1 |
TL_TRC_TBL |
Amount, Hours, or Units |
5 |
Unit of Measure |
Char |
3 |
TL_TRC_TBL |
Unit of Measure for TRC Type Units |
The interface process only extracts TRCs with the Send To TCD field = Y. The default for this field is N. Ensure that you set this field to Y when the TRC is to be sent to the TCD. This indicator has been added to the TL_TRC_TBL to avoid sending extraneous TRCs to TCDs.
The TCD system may need to convert character codes to numeric codes before using them.
The data in this table is derived from the TRC Program attached to the TCD.
TCD Supervisor
This data structure contains a list of supervisors who are authorized to perform supervisor functions at various TCDs. Each TCD Group can be associated to one or more TCD supervisors. A TCD supervisor may be associated with many TCD Groups.
The TCD Interface process assigns supervisors to TCDs. The vendor does not need to derive this relationship.
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
TCD ID |
Char |
10 |
TL_TCDGPTCD_TBL |
Identifies which clock gets this information. |
2 |
Supervisor ID |
Char |
11 |
TL_TCD_SUPERV |
Identifier. |
3 |
Badge ID |
Char |
20 |
BADGE_TABLE |
Identifier. |
4 |
Supervisor PIN # |
Num |
20 |
TL_TCD_SUPERV |
PIN for supervisor. |
TCD Task Profile
This data structure contains a list of Task Profiles associated with each TCD. Task Profiles contain task and cost allocation data used in the Labor Distribution process in Time and Labor. The system requires Task Profiles for positive task profile reporting. Positive task profile reporting in Time and Labor means the time reporter must indicate the type of task being performed. For example, Time reporter 111111 is assigned to TCD AAAAA. The valid Task Profiles for TCD AAAAA include Packaging, Shipping, Receiving, and Cleaning. Time reporter 11111 selects one of the Task Profiles by pressing a function key at the TCD to indicate the task being performed.
Unlike positive task profile reporting, default task profile reporting refers to time reporters who routinely perform the same tasks and their cost allocation information remains unchanged. A time reporter swipes the badge when starting and stopping work. The TCD system does not need any task information from Time and Labor for these time reporters. Cost allocation data defined on the default Task Profile in Time and Labor is used to allocate costs accordingly.
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
TCD ID |
Char |
10 |
TL_TCD_TASKGRP |
Identifier. |
2 |
Task Profile ID |
Char |
10 |
TL_TASKGRP_TBL |
Identifier. |
3 |
Task Profile Description |
Char |
30 |
TL_TSKPRF_TBL |
Identifier. |
The TCD Task Profile table is derived from the following Time and Labor tables:
TCD Taskgroup − contains a list of Taskgroups associated with each TCD.
Taskgroup Profile − contains a list of task profiles associated with each Taskgroup.
Task Profile − contains task profile definitions. Time and Labor selects only records with SEND_TO_TCD = Y.
TCD Task Template
This data structure contains a list of Task Templates associated with each TCD. Task Templates are required for positive task element reporting. Positive task element reporting requires the time reporter to enter a value for each task element on the Task Template. For example, Time reporter 111111 is assigned to TCD AAAAA. The valid Task Templates for TCD AAAAA include Packaging, Shipping, Receiving, and Cleaning. The Packaging task template includes the following task elements: Customer and Account Code. Time reporter 11111 selects one of the Task Templates by pressing a function key at the TCD to indicate the task being performed. Additionally, the time reporter is required to enter the value for Customer and Account Code when prompted.
This data structure also contains a list of Rule Elements associated with each TCD. Rule Elements are needed in cases where the type of work or the job the time reporter performs influences their pay. Rule Element reporting requires the time reporter to enter a value for each Rule Element. As far as the TCD is concerned, Rule Elements are just another form of Task Elements.
This type of reporting is more complex and requires a few tables to be sent to the TCD system. If data validation is required, PeopleSoft provides all the valid values for certain task elements.
The following tables are sent to the TCDs for positive task element reporting:
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
TCD ID |
Char |
10 |
TL_TCD_TASKGRP _TBL |
Identifier. |
2 |
Task Template ID |
Char |
10 |
TL_TASKGRP_TBL |
Identifier. |
3 |
Task Template Description |
Char |
30 |
TL_TSKPRF_TMPLT |
Identifier. |
The TCD Task Template table is derived from the following Time and Labor tables:
TCD Taskgroup− contains a list of Taskgroups associated with each TCD.
Taskgroup − contains a task template ID associated with each Taskgroup.
Task Template − contains header information for task templates.
If template reporting is used, but the TCD vendor/customer does not present a list of templates to select from, a default template is sent for each time reporter in the Time Reporter message. This default enables automatic prompt for task elements based on the time reporter at the TCD.
Task Template Detail
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
Task Template ID |
Char |
10 |
TL_TSKPRF_TMPLT |
Identifier. |
2 |
Task Element Code |
Char |
3 |
TL_TSKPRF_TMPLT |
Identifier. |
3 |
Task Element Description |
Char |
30 |
TL_TASKELE_TBL |
Description. |
4 |
Required |
Char |
1 |
TL_TSKPRF_TMPLT |
Is this element required or optional. |
The Task Template Detail Table contains all the valid Task Element Codes associated with each Task Template. It is derived from the following Time and Labor tables:
Task Template Element − contains task element codes associated with a Task Template.
Task Element − contains task element codes and associated field names.
PSDBFIELD (PeopleTools table) − contains field names and associated descriptions.
If the time reporter has to report Rule Elements, Time and Labor adds the Rule Element list to the end of each template. The Rule Element codes are RE1, RE2, RE3, RE4, and RE5. The Time and Labor system does not allow Task Element Codes with these values. The Required field is always Y.
Task Element Code Value
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
Task Element Code |
Char |
3 |
TL_TASK_ELE_TBL |
Identifier. |
2 |
Task Element Value |
Char |
25 |
A Prompt Table |
Description. |
3 |
Task Element Value Source |
Char |
2 |
(TL/PC) |
Because PROJECT values and ACTIVITY values can come from two different places, the Source field will be filled in only for those Task Element Codes. |
The Task Element Code Value Table contains all the valid values associated with each Task Element Code. It is derived from the following Time and Labor tables:
Task Template Element − contains task element codes associated with a Task Template.
Task Element − contains task element codes and associated field names.
PSRECFIELD (PeopleTools table) − contains record names, field names, prompt table names and other edit information. Time and Labor uses rows where the record name is TL_TSK_ELMT_WRK (the name of the task derived work record)
This table also contains all the valid values associated with each Rule Element Code.
This table can be quite large. Ensure that the TCD system can process such a large volume of data.
Reporting Element Tables
Sometimes the Time Reporter has to supply information on the location tax purposes. The time reporter or the supervisor may also have to enter override rate information. The following tables contain values for this information.
Country Table
This table is used for positive reporting of a country other than the reporter’s default.
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
Country Code |
Char |
3 |
COUNTRY_TBL |
Identifier. |
2 |
Descr |
Char |
30 |
COUNTRY_TBL |
Description. |
State Table
This table is used for positive reporting of a state other than the reporter’s default.
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
State Code |
Char |
6 |
STATE_NAMES_TBL |
Identifier. |
2 |
Descr |
Char |
30 |
STATE_NAMES_TBL |
Description. |
Locality Table
This table is used for positive reporting of a locality other than the reporter’s default.
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
Locality ID |
Char |
10 |
LOCAL_TAX_TBL |
Identifier. |
2 |
Descr |
Char |
30 |
LOCAL_TAX_TBL |
Description. |
Rate Code Table
This table is used for positive reporting of a comp rate code in conjunction with a Time Reporting Code to specify a different compensation rate. This is used for elapsed time reporting only. Either this or the override rate is entered to adjust a reporter’s compensation.
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
Rate Code |
Char |
6 |
COMP_RT_REG_VW |
Identifier. |
2 |
Descr |
Char |
30 |
COMP_RT_REG_VW |
Description. |
Currency Code Table
This table is used for positive reporting of a conjunction with a Time Reporting Code, Rate Code, or Override Rate to specify a currency different from the default. This is used for elapsed time reporting only.
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
Currency Code |
Char |
3 |
CURRENCY_CD_TBL |
Identifier. |
2 |
Descr |
Char |
30 |
CURRENCY_CD_TBL |
Description. |
Override Reason Code Table
This table is used in conjunction with a supervisor overriding a punch. This is used for punch time reporting only.
# |
Data Element |
Type |
Length |
Source |
Notes |
1 |
Override Reason Code |
Char |
5 |
TL_OVRD_RSN_TBL |
Identifier. |
2 |
Descr |
Char |
30 |
TL_OVRD_RSN_TBL |
Description. |
The TCD system produces the following output data to be passed to Time and Labor:
# |
Table |
Notes |
1. |
Punched Time Interface |
Contains punched time transactions. |
2. |
Punched Task Interface |
Contains punched task transactions related to punched time transactions (child of Punched Time). |
3. |
Elapsed Time Interface |
Contains elapsed time transactions (such as Sick, Vacation, Holiday, and so on). |
4. |
Elapsed Task Interface |
Contains elapsed task transactions related to elapsed time transactions (child of Elapsed Time). |
Time and Labor receives this data through PeopleSoft Integration Broker.
The first step is to validate the information sent by the TCD. This includes standard format edits. This data may also come into Time and Labor through a flat file.
The next step is to translate Badge IDs to EmplIDs and create Reported Time entries.
The last step is to initiate the Validation process, which takes the data to the next step.
Because a time reporter can report time at more than one TCD, Time and Labor must be able to accept data for a time reporter from multiple sources at the same time.
Punched Time Interface
The Punched Time data structure contains punched time transactions. The majority of time transactions are written to this data structure.
# |
Data Element |
Type |
Length |
Required |
Notes |
1 |
Badge ID |
Char |
20 |
N |
The TCD must send either Badge ID or Empl ID/Empl Rcd#. |
2 |
Empl ID |
Char |
11 |
N |
The TCD must send either Badge ID or Empl ID/Empl Rcd#. |
3 |
Empl RCD# |
Num |
3 |
N |
The TCD must send either Badge ID or Empl ID/Empl Rcd#. |
4 |
Punch Date Time |
DateTime |
See Interface Specifications in Using Time Collection Devices |
N |
Identifier. This field is required if the Add/Delete indicator is A. |
5 |
Delete Date |
Date |
10 |
N |
Indicates the Date for an Add/Delete indication of D. This field is required if the Add/Delete indicator is D. |
6 |
Punch Type |
Char |
1 |
N |
1 = In, 2 = Out, 3 = Meal, 4 = Break, 5 = Transfer. This field is required if the Add/Delete indicator is A. |
7 |
TCD ID |
Char |
10 |
Y |
Indicates which TCD time transaction came from. |
8 |
Time Zone |
Char |
9 |
N |
EST, PST, MST, and so on (see end of Appendix E for complete list of valid values) |
9 |
Supervisor ID |
Char |
20 |
N |
Can be blank − Supervisor ID who did the override. |
10 |
User ID |
Char |
8 |
N |
Can be blank − User ID who did the override. |
11 |
Override Reason Code |
Char |
5 |
N |
Can be blank − Reason code for the override. |
12 |
Add/Delete Indicator |
Char |
1 |
N |
Can be blank − A = Add, D = Delete |
13 |
Action Date/Time |
DateTime |
See Interface Specifications in Using Time Collection Devices |
N |
Can be blank − Date and Time when override occurred. |
14 |
Task Profile ID |
Char |
10 |
N |
Can be blank − override or positively reported. |
15 |
Task Template ID |
Char |
10 |
N |
Can be blank − Task Template used when positively reported. |
16 |
Country |
Char |
3 |
N |
Override Country |
17 |
State |
Char |
6 |
N |
Override State |
18 |
Locality |
Char |
10 |
N |
Override Locality |
19 |
Comments |
Char |
254 |
N |
|
The TCD system can send either Badge IDs or Empl ID/Empl Rcd#. Time and Labor translates Badge IDs to EmplIDs.
Note. If the correctEmpl Rcd # is not set up for a clock badge type on the Badge page in Workforce Administration for an employee, the Time and Labor TCD Integration assigns all time to Empl Rcd = 0 when it processes messages converting Badge to Emplid/Empl Rcd.
Time and Labor obtains the time zone from the TCD definition if the time zone does not come in on this record.
Time and Labor compares the Task Template ID on the Punched Time record to the Task Template ID on the Time Reporter’s Taskgroup. If the Task Template IDs do not match, then Time and Labor assumes Taskgroup borrowing has occurred and finds a Taskgroup that contains the Task Template ID.
Time and Labor compares the Task Profile ID on the Punched Time record to the Task Profile IDs attached to the Time Reporter’s Taskgroup. If the Task Profile IDs do not match, then the system assumes Taskgroup borrowing has occurred and finds a Taskgroup that contains the Task Profile ID.
Time and Labor creates an Audit record if the Supervisor ID on the record is not blank. The audit record will have a generic “Override at TCD” reason.
For Country, State and Locality, Time and Labor uses the values on the interface if present. If not present, the system checks the TCD definition to see if these values are specified at the TCD. If they are, Time and Labor uses the TCD definition values. In either case, the system compares these values to the Time Reporter’s values in HR. Time and Labor uses these values as overrides on Reported Time if there is a difference.
In general, PeopleSoft recommends that the deletion and replacement of punches be done online in Time and Labor. However, the Add/Delete Indicator in the Punch Interface provides delete/replace functionality on the day level for an employee. Individual punches cannot be deleted through the interface, and a replacement is a delete of a day and then an add of what the day should be. For this to occur, the TCD must maintain an image of that day, so corrected punches could be sent with the whole day. When a delete is processed in the PeopleSoft system, punch date times are evaluated in the time zone in which they were reported. Here is an example of deleting a punch.
Employee 1 has the following punches on 1/1/99, and these punches have already been sent to Time and Labor:
EMPLID |
PUNCH_DATETIME |
PUNCH_TYPE |
Add/Delete Indicator |
1 |
1/1/99 8AM |
IN |
A |
1 |
1/1/99 12PM |
MEAL |
A |
1 |
1/1/99 1PM |
IN |
A |
1 |
1/1/99 5PM |
OUT |
A |
Someone at the TCD decides that the 12PM MEAL punch and 1PM IN punch need to be deleted because the employee didn’t take lunch.
These are the rows Time and Labor should receive in the interface (the time on a deleted row is irrelevant):
EMPLID |
PUNCH_DATETIME |
DELETE_DATE |
PUNCH_TYPE |
Add/Delete Indicator |
1 |
|
1/1/99 |
|
D |
1 |
1/1/99 8AM |
|
IN |
A |
1 |
1/1/99 5PM |
|
OUT |
A |
Here is an example of replacing a punch.
Employee 2 has the following punches on 1/1/99, and these punches have already been sent to Time and Labor:
EMPLID |
PUNCH_DATETIME |
PUNCH_TYPE |
Add/Delete Indicator |
2 |
1/1/99 8 AM |
IN |
A |
2 |
1/1/99 12 PM |
MEAL |
A |
2 |
1/1/99 1 PM |
IN |
A |
2 |
1/1/99 5 PM |
OUT |
A |
Someone at the TCD decides that the 1PM IN punch should be a 2PM IN punch because Employee 2 really took a two hour lunch.
These are the new rows Time and Labor should receive in the interface:
EMPLID |
PUNCH_DATETIME |
DELETE_DATE |
PUNCH_TYPE |
Add/Delete Indicator |
2 |
|
1/1/99 |
|
D |
2 |
1/1/99 8AM |
|
IN |
A |
2 |
1/1/99 12PM |
|
MEAL |
A |
2 |
1/1/99 2PM |
|
IN |
A |
2 |
1/1/99 5PM |
|
OUT |
A |
Punched Task Interface
The Punched Task data structure contains punched task transactions related to a punched time transaction.
_# |
Data Element |
Type |
Length |
Required |
Notes |
1 |
Badge ID |
Char |
20 |
N |
The TCD must send either Badge ID or Empl ID/Empl Rcd#. |
2 |
Empl ID |
Char |
11 |
N |
The TCD must send either Badge ID or Empl ID/Empl Rcd#. |
3 |
Empl RCD# |
Num |
3 |
N |
The TCD must send either Badge ID or Empl ID/Empl Rcd#. |
4 |
Punch Date Time |
DateTime |
See interface specifications in Using Time Collection Devices |
Y |
Identifier. |
5 |
Delete Date |
Date |
10 |
N |
Always is Null |
6 |
Task Element Code |
Char |
3 |
Y |
Only for positive task element reporters. |
7 |
Task Element Value |
Char |
25 |
Y |
Only for positive task element reporters. |
The TCD system can send either Badge IDs or Empl ID/Empl Rcd#. Time and Labor translates Badge IDs to EmplIDs.
The TCD also passes Rule Elements on this table. Rule Elements look similar to task elements. Time and Labor distinguishes them by the element code and splits out rule elements into specific fields on the reported time record.
Mapping of task element codes may need to occur if the TCD can only process numeric values.
Only punch types of IN and Transfer should produce Punched Task records.
Elapsed Time Interface
The Elapsed Time data structure contains elapsed time transactions reported at the TCDs (such as tip, vacation, sick, holiday, and so on):
# |
Data Element |
Type |
Length |
Required |
Notes |
1 |
Badge ID |
Char |
20 |
N |
The TCD must send either Badge ID or Empl ID/Empl Rcd#. |
2 |
Empl ID |
Char |
11 |
N |
The TCD must send either Badge ID or Empl ID/Empl Rcd#. |
3 |
Empl RCD# |
Num |
3 |
N |
The TCD must send either Badge ID or Empl ID/Empl Rcd#. |
4 |
Date Under Report |
Date |
10 |
N |
Identifier (CCYY-MM-DD). This field is required if the Add/Delete indicator is A. |
5 |
Sequence Number |
Num |
3 |
Y |
Identifier to make each row unique. |
6 |
Delete Date |
Date |
10 |
N |
Indicates the Date for an Add/Delete indication of D. This field is required if the Add/Delete indicator is D. |
7 |
Add/Delete Indicator |
Char |
1 |
Y |
A/D, Default = A. |
8 |
TCD ID |
Char |
10 |
Y |
Indicates which TCD time transaction came from. |
9 |
Time Reporting Code |
Char |
5 |
Y |
TCD vendors may need to convert numeric code to character code. |
10 |
Quantity |
Num |
12.6 |
Y |
This field can represent hours (in hours and tenths), amount, or units. |
11 |
Currency Code |
Char |
3 |
N |
An optional currency code for when the quantity represents money. |
12 |
Pay Rate Override |
Num |
12.6 |
N |
Can be zero. If populated, it will be used to calculate time reporter’s pay. |
13 |
Rate Code Override |
Char |
6 |
N |
Override Rate Code |
14 |
Billable Indicator |
Char |
1 |
Y |
Billable Indicator for use in pay calculations (Y/N) Default=N. |
15 |
Supervisor ID |
Char |
20 |
N |
Can be blank − Supervisor ID who did the override. |
16 |
User ID |
Char |
8 |
N |
Can be blank − User ID who did the override. |
17 |
Override Reason Code |
Char |
5 |
N |
Can be blank − Reason code for the override. |
18 |
Action Date/Time |
Date Time |
See interface specifications in Using Time Collection Devices |
N |
Can be blank − Date and Time when override occurred. |
19 |
Task Profile ID |
Char |
10 |
N |
Can be blank − override or positively reported. |
20 |
Task Template ID |
Char |
10 |
N |
Can be blank − Task Template used when positively reported. |
21 |
Country |
Char |
3 |
N |
Override Country |
22 |
State |
Char |
6 |
N |
Override State |
23 |
Locality |
Char |
10 |
N |
Override Locality |
24 |
Comments |
Char |
254 |
N |
|
The TCD system can send either Badge IDs or Empl ID/Empl Rcd#. Time and Labor translates Badge IDs to EmplIDs.
Time and Labor assumes the currency code attached to the Time Reporting Code definition unless a currency code comes in on this record.
Time and Labor compares the Task Template ID on the Elapsed Time record to the Task Template ID on the time reporter’s Taskgroup. If the Task Template IDs do not match, then the system assumes Taskgroup borrowing has occurred and finds a Taskgroup that contains the Task Template ID.
Time and Labor compares the Task Profile ID on the Elapsed Time record to the Task Profile IDs attached to the time reporters’ Taskgroup. If the Task Profile IDs do not match, then the system assumes Taskgroup borrowing has occurred and finds a Taskgroup that contains the Task Profile ID.
Time and Labor creates an Audit record if the Supervisor ID on the record is not blank. The audit record has a generic “Override at TCD” reason.
For Country, State and Locality, Time and Labor uses the values on the interface if present. If not present, the system checks the TCD definition to see if these values are specified at the TCD. If they are, the system uses the TCD definition values. In either case, Time and Labor compares these values to the time reporter’s values in HR. The system uses these values as overrides on Reported Time if there is a difference.
In general, PeopleSoft recommends that the deletion and replacement of elapsed time records be done online in Time and Labor. However, the Add/Delete Indicator in the Elapsed Time Interface provides delete/replace functionality on the day level for an employee. Individual elapsed time records cannot be deleted through the interface. A replacement is a delete and then an add of what the day should be. For this to occur, the TCD must maintain an image of that day, so corrected elapsed time records could be sent with the whole day.
Here is an example of deleting an elapsed time record.
Employee 1 has reported the following time on 1/1/99, and these records have already been sent to Time and Labor:
EMPLID |
DUR |
SEQNUM |
TRC |
TL Quantity |
Add/Delete Indicator |
1 |
1/1/99 |
1 |
REG |
8 |
A |
1 |
1/1/99 |
2 |
OT |
2 |
A |
Someone at the TCD decides that the OT record was mistakenly reported and should be deleted.
These are the rows Time and Labor should receive in the interface:
EMPLID |
DUR |
SEQNUM |
DELETE_DATE |
TRC |
TL Quantity |
Add/ Delete Indicator |
1 |
|
|
1/1/99 |
|
|
D |
1 |
1/1/99 |
1 |
|
REG |
8 |
A |
Here is an example of replacing an elapsed time record.
Employee 2 has reported the following time on 1/1/99, and these records have already been sent to Time and Labor:
EMPLID |
DUR |
SEQNUM |
TRC |
TL Quantity |
Add/Delete Indicator |
2 |
1/1/99 |
1 |
REG |
8 |
A |
2 |
1/1/99 |
2 |
OT |
2 |
A |
Someone at the TCD decides 3 hours of OT were worked instead of the 2 that were reported.
These are the rows Time and Labor should receive in the interface:
EMPLID |
DUR |
SEQNUM |
DELETE_DATE |
TRC |
TL Quantity |
Add/Delete Indicator |
2 |
|
|
1/1/99 |
|
|
D |
2 |
1/1/99 |
1 |
|
REG |
8 |
A |
2 |
1/1/99 |
2 |
|
OT |
3 |
A |
Elapsed Task Interface
The Elapsed Task data structure contains elapsed task transactions related to each elapsed time transaction.
_# |
Data Element |
Type |
Length |
Required |
Notes |
1 |
Badge ID |
Char |
20 |
N |
The TCD must send either Badge ID or Empl ID/Empl Rcd#. |
2 |
Empl ID |
Char |
11 |
N |
The TCD must send either Badge ID or Empl ID/Empl Rcd#. |
3 |
Empl RCD# |
Num |
3 |
N |
The TCD must send either Badge ID or Empl ID/Empl Rcd#. |
4 |
Date Under Report |
Date |
10 |
Y |
Identifier (CCYY-MM-DD) |
5 |
Sequence Number |
Num |
3 |
Y |
Identifier to make each row unique. |
6 |
Delete Date |
Date |
10 |
N |
Always is Null |
7 |
Task Element Code |
Char |
3 |
Y |
Only for positive task element reporters. |
8 |
Task Element Value |
Char |
25 |
Y |
Only for positive task element reporters. |
The TCD system can send either Badge IDs or Empl ID/Empl Rcd#. Time and Labor translates Badge IDs to EmplIDs.
The TCD also passes Rule Elements on this table. Rule Elements look similar to task elements. Time and Labor distinguishes the difference by the element code and splits out rule elements into specific fields on the Recorded Time record.
Mapping of task element codes may need to occur if the TCD can only use numbers.
Report counts of the various objects attached to the TCD includes counts of Time Reporters, TCD Restriction Profiles, Task Profiles, Task Templates, Task Elements, Task Element Values, Time Reporting Codes, Supervisors, Rule Elements, and Rule Element values. Use this report to monitor memory usage at the TCD.
Time Reporter
Service Operation : TIME_DEVICE_EMPL_ATT_FULLSYNC (initialization/full table)
TIME_DEVICE_EMPL_ATT_SYNC (updates/incremental)
Service Operation Queue: TIME_COLLECTION_DEVICE_SETUP
Record Definition
Record Name: TL_EMPL_DTA_MSG
# |
Data Element |
Description |
Type |
Length |
1 |
MSGNODENAME |
Message Node Name |
Char |
15 |
2 |
TCD_ID |
TCD ID |
Char |
10 |
3 |
TCD_NETWORK_ID |
TCD NetworkID |
Char |
20 |
4 |
TCD_NODE_ID |
TCD Node ID |
Char |
20 |
5 |
EMPLID |
Empl ID |
Char |
11 |
6 |
EMPL_RCD |
Empl RCD# |
Num |
3 |
7 |
BADGE_ID |
Badge ID |
Char |
20 |
8 |
TIME_RPTG_STATUS |
Time Reporting Status |
Char |
1 |
9 |
LAST_NAME |
Last Name |
Char |
30 |
10 |
FIRST_NAME |
First Name |
Char |
30 |
11 |
HIRE_DT |
Hire Date |
Date |
10 |
12 |
SERVICE_DT |
Service Date |
Date |
10 |
13 |
BIRTHDATE |
Birth Date |
Date |
10 |
14 |
RESTRICTION_PRF_ID |
Restriction Profile ID |
Char |
10 |
15 |
TASK_PRFL_TMPLT_ID |
Task Template ID |
Char |
10 |
16 |
TASK_PROFILE_ID |
Task Profile ID |
Char |
10 |
Schedule
Service Operation: TIME_DEVICE_SCHEDULE_FULLSYNC
Service Operation Queue: TIME_COLLECTION_DEVICE_SETUP
Record Definition
Record Name: TL_SCHEDULE_MSG
# |
Data Element |
Description |
Type |
Length |
1 |
MSGNODENAME |
Message Node Name |
Char |
15 |
2 |
TCD_ID |
TCD ID |
Char |
10 |
3 |
TCD_NETWORK_ID |
TCD NetworkID |
Char |
20 |
4 |
TCD_NODE_ID |
TCD Node ID |
Char |
20 |
5 |
BADGE_ID |
Badge ID |
Char |
20 |
6 |
EMPLID |
Employee ID |
Char |
11 |
7 |
EMPL_RCD |
Employee Record Num |
Num |
3 |
8 |
PUNCH_DTTM |
Punch Date Time |
DateTime |
See interface specifications in Using Time Collection Devices |
9 |
SEQNUM |
Sequence Number |
Num |
3 |
10 |
PUNCH_TYPE |
Punch Type |
Char |
2 |
Restriction Profile
Service Operation: TIME_DEVICE_RESTRICT_FULLSYNC
Service Operation Queue: TIME_COLLECTION_DEVICE_SETUP
Record Definition
Record Name: TL_RESTRICT_MSG
# |
Data Element |
Description |
Type |
Length |
1 |
MSGNODENAME |
Message Node Name |
Char |
15 |
2 |
TCD_ID |
TCD ID |
Char |
10 |
3 |
TCD_NETWORK_ID |
TCD NetworkID |
Char |
20 |
4 |
TCD_NODE_ID |
TCD Node ID |
Char |
20 |
5 |
RESTRICTION_PRF_ID |
Restriction Profile ID |
Char |
10 |
6 |
RES_EARLY_IN |
Early In Restriction Ind |
Char |
1 |
7 |
EARLY_IN_PUNCH |
Early In Margin |
Num |
4 |
8 |
RES_LATE_IN |
Late In Restriction Ind |
Char |
1 |
9 |
LATE_IN_PUNCH |
Late In Margin |
Num |
4 |
10 |
RES_EARLY_OUT |
Early Out Restriction Ind |
Char |
1 |
11 |
EARLY_OUT_PUNCH |
Early Out Margin |
Num |
4 |
12 |
RES_LATE_OUT |
Late Out Restriction Ind |
Char |
1 |
13 |
LATE_OUT_PUNCH |
Late Out Margin |
Num |
4 |
14 |
RES_EARLY_MEAL |
Early Meal Restriction Ind |
Char |
1 |
15 |
EARLY_MEAL |
Early Meal Margin |
Num |
4 |
16 |
RES_LATE_MEAL |
Late Meal Restriction Ind |
Char |
1 |
17 |
LATE_MEAL |
Late Meal Margin |
Num |
4 |
18 |
RES_EARLY_BREAK |
Early Break Restriction Ind |
Char |
1 |
19 |
EARLY_BREAK |
Early Break Margin |
Num |
4 |
20 |
RES_LATE_BREAK |
Late Break Restriction Ind |
Char |
1 |
21 |
LATE_BREAK |
Late Break Margin |
Num |
4 |
Total Hours
Service Operation: TIME_DEVICE_PER_HRS_FULLSYNC
Service Operation Queue: TIME_COLLECTION_DEVICE_SETUP
Record Definition
Record Name: TL_TOT_HRS_MSG
# |
Data Element |
Description |
Type |
Length |
1 |
MSGNODENAME |
Message Node Name |
Char |
15 |
2 |
TCD_ID |
TCD ID |
Char |
10 |
3 |
TCD_NETWORK_ID |
TCD NetworkID |
Char |
20 |
4 |
TCD_NODE_ID |
TCD Node ID |
Char |
20 |
5 |
BADGE_ID |
Badge ID |
Char |
20 |
6 |
EMPLID |
Employee ID |
Char |
11 |
7 |
EMPL_RCD |
Employee Record Num |
Num |
3 |
8 |
TRC |
Time Reporting Code |
Char |
5 |
9 |
TL_QUANTITY |
Total Payable Hours |
Num |
12.6 |
Time Reporting Code
Service Operation: TIME_DEVICE_RPTG_CODE_FULLSYNC
Service Operation Queue: TIME_COLLECTION_DEVICE_SETUP
Record Definition
Record Name: TL_TRC_MSG
# |
Data Element |
Description |
Type |
Length |
1 |
MSGNODENAME |
Message Node Name |
Char |
15 |
2 |
TCD_ID |
TCD ID |
Char |
10 |
3 |
TCD_NETWORK_ID |
TCD NetworkID |
Char |
20 |
4 |
TCD_NODE_ID |
TCD Node ID |
Char |
20 |
5 |
TRC |
Time Reporting Code |
Char |
5 |
6 |
DESCR |
Description |
Char |
30 |
TCD Supervisor
Service Operation: TIME_DEVICE_SUPERVSOR_FULLSYNC
Service Operation Queue: TIME_COLLECTION_DEVICE_SETUP
Record Definition
Record Name: TL_TCDSUPRV_MSG
# |
Data Element |
Description |
Type |
Length |
1 |
MSGNODENAME |
Message Node Name |
Char |
15 |
2 |
TCD_ID |
TCD ID |
Char |
10 |
3 |
TCD_NETWORK_ID |
TCD NetworkID |
Char |
20 |
4 |
TCD_NODE_ID |
TCD Node ID |
Char |
20 |
5 |
TCD_SUPERVISR_ID |
Supervisor ID |
Char |
20 |
6 |
BADGE_ID |
Badge ID |
Char |
20 |
7 |
SUPERVISR_PIN_NUM |
Supervisor PIN # |
Num |
20 |
TCD Task Profile
Service Operation: TIME_DEVICE_PROFILES_FULLSYNC
Service Operation Queue: TIME_COLLECTION_DEVICE_SETUP
Record Definition
Record Name: TL_TSK_PROF_MSG
# |
Data Element |
Description |
Type |
Length |
1 |
MSGNODENAME |
Message Node Name |
Char |
15 |
2 |
TCD_ID |
TCD ID |
Char |
10 |
3 |
TCD_NETWORK_ID |
TCD NetworkID |
Char |
20 |
4 |
TCD_NODE_ID |
TCD Node ID |
Char |
20 |
5 |
TASK_PROFILE_ID |
Task Profile ID |
Char |
10 |
6 |
DESCR |
Task Profile Description |
Char |
30 |
TCD Task Template
Service Operation: TIME_DEVICE_TEMPLATES_FULLSYNC
Service Operation Queue: TIME_COLLECTION_DEVICE_SETUP
Record Definition
Record Name: TL_TSK_TEMP_MSG
# |
Data Element |
Description |
Type |
Length |
1 |
MSGNODENAME |
Message Node Name |
Char |
15 |
2 |
TCD_ID |
TCD ID |
Char |
10 |
3 |
TCD_NETWORK_ID |
TCD NetworkID |
Char |
20 |
4 |
TCD_NODE_ID |
TCD Node ID |
Char |
20 |
5 |
TASK_PRFL_TMPLT_ID |
Task Template ID |
Char |
10 |
6 |
DESCR |
Task Template Description |
Char |
30 |
Task Template Detail (sent in TIME_DEVICE_TEMPLATES_FULLSYNC message as a child)
Record Definition
Record Name: TL_TEMP_DTL_MSG
# |
Data Element |
Description |
Type |
Length |
1 |
MSGNODENAME |
Message Node Name |
Char |
15 |
2 |
TCD_ID |
TCD ID |
Char |
10 |
3 |
TCD_NETWORK_ID |
TCD NetworkID |
Char |
20 |
4 |
TCD_NODE_ID |
TCD Node ID |
Char |
20 |
5 |
TASK_PRFL_TMPLT_ID |
Task Template ID |
Char |
10 |
6 |
TASK_ELEMENT_CD |
Task Element Code |
Char |
3 |
7 |
DESCR |
Task Element Description |
Char |
30 |
8 |
CODE_REQUIRED |
Required(Y/N) |
Char |
1 |
Task Element Code Value
Service Operation: TIME_DEVICE_TASK_VALS_FULLSYNC
Service Operation Queue: TIME_COLLECTION_DEVICE_SETUP
Record Definition
Record Name: TL_CD_VALS_MSG
# |
Data Element |
Description |
Type |
Length |
1 |
MSGNODENAME |
Message Node Name |
Char |
15 |
2 |
TCD_ID |
TCD ID |
Char |
10 |
3 |
TCD_NETWORK_ID |
TCD NetworkID |
Char |
20 |
4 |
TCD_NODE_ID |
TCD Node ID |
Char |
20 |
5 |
TASK_ELEMENT_CD |
Task Element Code |
Char |
3 |
6 |
TASK_ELEMENT_VALUE |
Task Element Value |
Char |
25 |
7 |
VALUE_SOURCE |
Value Source(populated only for Codes PRJ and ACT) |
Char |
2 |
Reporting Elements Table
Service Operation: TIME_DEVICE_RPT_ELMNT_FULLSYNC (all reporting element tables are combined into one message definition)
Service Operation Queue: TIME_COLLECTION_DEVICE_SETUP
Record Definition
Record Name: TL_RPTG_ELE_MSG
# |
Data Element |
Description |
Type |
Length |
1 |
MSGNODENAME |
Message Node Name |
Char |
15 |
2 |
TCD_ID |
TCD ID |
Char |
10 |
3 |
TCD_NETWORK_ID |
TCD NetworkID |
Char |
20 |
4 |
TCD_NODE_ID |
TCD Node ID |
Char |
20 |
5 |
RPTG_ELE_IND |
Reporting Element Indicator - See the following possible values |
Char |
2 |
6 |
RPTG_ELE_CODE |
Reporting Element Codes |
Char |
10 |
7 |
DESCR |
Description |
Char |
30 |
Mapping for RPTG_ELE_IND
CO − Country
ST − State
LY − Locality
SH − Shift
RT − Rate Code
CC − Currency Code
OV − Override Reason Code
Punched Time Interface
Service Operation: PUNCHED_TIME_ADD
Service Operation Queue: PUNCHED_TIME
Record Definition
Record Name: TL_PUNCH_INTFC
# |
Data Element |
Description |
Type |
Length |
1 |
BADGE_ID |
Badge ID |
Char |
20 |
2 |
EMPLID |
Empl ID |
Char |
11 |
3 |
EMPL_RCD |
Empl RCD# |
Num |
3 |
4 |
PUNCH_DTTM |
Punch Date Time |
DateTime |
See Interface Specifications in Using Time Collection Devices |
5 |
DELETE_DATE |
Delete Date |
Date |
10 |
6 |
PUNCH_TYPE |
Punch Type |
Char |
1 |
7 |
TCD_ID |
TCD ID |
Char |
10 |
8 |
TIMEZONE |
Time Zone |
Char |
9 |
9 |
TCD_SUPERVISR_ID |
Supervisor ID |
Char |
11 |
10 |
OPRID |
User ID |
Char |
8 |
11 |
OVERRIDE_RSN_CD |
Override Reason Code |
Char |
5 |
12 |
ADD_DELETE_IND |
Add/Delete Indicator |
Char |
1 |
13 |
ACTION_DTTM |
Action Date/Time |
DateTime |
See Interface Specifications in Using Time Collection Devices |
14 |
TASK_PROFILE_ID |
Task Profile ID |
Char |
10 |
15 |
TASK_PRFL_TMPLT_ID |
Task Template ID |
Char |
10 |
16 |
COUNTRY |
Country |
Char |
3 |
17 |
STATE |
State |
Char |
6 |
18 |
LOCALITY |
Locality |
Char |
10 |
19 |
TL_COMMENTS |
Comments |
Char |
254 |
20 |
AUDIT_ACTN |
For PeopleSoft Processing only; always leave field blank |
Char |
1 |
Punched Task Interface (sent in PUNCHED_TIME_ADD message as a child record)
Record Definition
Record Name: TL_PCHTSK_INTFC
# |
Data Element |
Description |
Type |
Length |
1 |
BADGE_ID |
Badge ID |
Char |
20 |
2 |
EMPLID |
Empl ID |
Char |
11 |
3 |
EMPL_RCD |
Empl RCD# |
Num |
3 |
4 |
PUNCH_DTTM |
Punch Date Time |
DateTime |
26 |
5 |
DELETE_DATE |
Delete Date |
Date |
10 |
6 |
TASK_ELEMENT_CD |
Task Element Code |
Char |
3 |
7 |
TASK_ELEMENT_VALUE |
Task Element Value |
Char |
30 |
8 |
AUDIT_ACTN |
For PeopleSoft Processing only; always leave field blank |
Char |
1 |
Elapsed Time Interface
Service Operation: ELAPSED_TIME_ADD
Service Operation Queue: ELAPSED_TIME
Record Definition
Record Name: TL_ELP_INTFC
# |
Data Element |
Description |
Type |
Length |
1 |
BADGE_ID |
Badge ID |
Char |
20 |
2 |
EMPLID |
Empl ID |
Char |
11 |
3 |
EMPL_RCD |
Empl RCD# |
Num |
3 |
4 |
DUR |
Date Under Report |
Date |
10 (CCYY-MM-DD) |
5 |
SEQNUM |
Sequence Number |
Num |
3 |
6 |
DELETE_DATE |
Delete Date |
Date |
10 |
7 |
ADD_DELETE_IND |
Add/Delete Indicator |
Char |
1 |
8 |
TCD_ID |
TCD ID |
Char |
10 |
9 |
TRC |
Time Reporting Code |
Char |
5 |
10 |
TL_QUANTITY |
Quantity |
Num |
12.6 |
11 |
CURRENCY_CD |
Currency Code |
Char |
3 |
12 |
OVERRIDE_RATE |
Pay Rate Override |
Num |
12.6 |
13 |
COMPRATE_CD |
Rate Code Override |
Char |
6 |
14 |
BILLABLE_IND |
Billable Indicator |
Char |
1 |
15 |
TCD_SUPERVISR_ID |
Supervisor ID |
Char |
20 |
16 |
OPRID |
User ID |
Char |
8 |
17 |
OVERRIDE_RSN_CD |
Override Reason Code |
Char |
5 |
18 |
ACTION_DTTM |
Action Date/Time |
Date Time |
26 |
19 |
TASK_PROFILE_ID |
Task Profile ID |
Char |
10 |
20 |
TASK_PRFL_TMPLT_ID |
Task Template ID |
Char |
10 |
21 |
COUNTRY |
Country |
Char |
3 |
22 |
STATE |
State |
Char |
6 |
23 |
LOCALITY |
Locality |
Char |
10 |
24 |
TL_COMMENTS |
Comments |
Char |
254 |
25 |
AUDIT_ACTN |
For PeopleSoft Processing only; always leave field blank |
Char |
1 |
Elapsed Task Interface (sent in ELAPSED_TIME_ADD message as a child record)
Record Definition
Record Name: TL_ELPTSK_INTFC
# |
Data Element |
Description |
Type |
Length |
1 |
BADGE_ID |
Badge ID |
Char |
20 |
2 |
EMPLID |
Empl ID |
Char |
11 |
3 |
EMPL_RCD |
Empl RCD# |
Num |
3 |
4 |
DUR |
Date Under Report |
Date |
10 (CCYY-MM-DD) |
5 |
SEQNUM |
Sequence Number |
Num |
3 |
6 |
DELETE_DATE |
Delete Date |
Date |
10 |
7 |
TASK_ELEMENT_CD |
Task Element Code |
Char |
3 |
8 |
TASK_ELEMENT_VALUE |
Task Element Value |
Char |
30 |
9 |
AUDIT_ACTN |
For PeopleSoft Processing only; always leave field blank |
Char |
1 |
Task Element Code Mapping
Task Element Code |
Description |
ACT |
Activity ID |
ANT |
Account Code |
BUH |
Business Unit HR (Human Resources) |
BUM |
Business Unit PF (Performance Measurement) |
BUP |
PC Business Unit (Project Costing) |
COM |
Company |
CST |
Customer |
DPT |
Department ID |
JOB |
Jobcode |
LOC |
Location |
POS |
Position Number |
PRD |
Product |
PRJ |
Project ID |
RE1 |
Rule Element 1 |
RE2 |
Rule Element 2 |
RE3 |
Rule Element 3 |
RE4 |
Rule Element 4 |
RE5 |
Rule Element 5 |
REC |
Resource Category |
RES |
Resource SubCategory |
RET |
Resource Type |
TSK |
Task |
UF1 |
User Field 1 |
UF2 |
User Field 2 |
UF3 |
User Field 3 |
UF4 |
User Field 4 |
UF5 |
User Field 5 |
List of Valid Time Zones
Value |
Description |
ACST |
AUS Central Time, Darwin |
AFST |
Afghanistan Time, Kabul |
ARST |
Arabian Time, Abu Dhabi, Muscat |
AST |
Atlantic Time (Canada) |
AZST |
Azores Time, Cape Verde Is. |
BST |
Bangkok Time, Hanoi, Jakarta |
CASST |
Central Asia Time, Almaty, Dhaka |
CAUST |
Central Australia, Adelaide |
CHST |
China Time, Beijing, Hong Kong |
CPST |
Central Pacific, Magadan, Solomon Is. |
CST |
Central Time |
CSTST |
Central Time no Daylight Savings |
DST |
Dateline Time, Eniwetok, Kwajalein |
EAUST |
East Australia Time, Brisbane, Guam |
EEST |
East Europe Time, Bucharest |
EGST |
Egypt Time, Cairo |
EKST |
Ekaterinburg Time |
ESAST |
East South America Time |
EST |
Eastern Time |
ESTST |
Eastern Time no Daylight Savings, Indiana |
FLEST |
FLE Time, Helsinki, Riga |
FST |
Fiji Time, Kamchatka, Marshall Is. |
GFTST |
GFT Time, Athens, Istanbul, Minsk |
GMT |
GMT, London, Dublin, Lisbon, Edinburgh |
GMTST |
GMT Standard Time, Casablanca |
HST |
Hawaiian Time |
IRST |
Iran Time, Tehran |
IST |
India Time, Bombay, Calcutta, New Delhi |
KST |
Korea Time, Seoul |
MAST |
Mid-Atlantic Time |
MST |
Mountain Time |
MSTST |
Mountain Time no Daylight Savings, Arizona |
MXST |
Mexico Time, Mexico City, Tegucigalpa |
NST |
Newfoundland Time |
NZST |
New Zealand Time, Auckland, Wellington |
PST |
Pacific Time, Tijuana |
RST |
Russian Time, Moscow, St. Petersburg, Volgograd |
SAEST |
SA Eastern Time, Buenos Aires, Georgetown |
SAFST |
South Africa Time, Israel |
SAPST |
SA Pacific Time, Bogota, Lima, Quito |
SAST |
Saudi Arabia Time, Baghdad, Kuwait, Riyadh |
SAWST |
SA Western Time, Caracas, La Paz |
SGST |
Singapore Time |
SLST |
Sri Lanka Time, Colombo |
SMST |
Samoa Time, Midway Island |
SST |
Sydney Time, Canberra, Melbourne |
TAST |
Tasmania Time, Hobart |
TPST |
Taipei Time |
TST |
Tokyo Time |
VST |
Vladivostok Time |
WASST |
West Asia Time, Islamabad, Karachi, Tashkent |
WAUST |
West Australia Time, Perth |
WEST |
West Europe Time, Berlin, Rome, Paris |
YST |
Yakutsk Time |
This section discusses:
Outgoing service operations from PeopleSoft to the TCD server.
Incoming service operations from TCD server to PeopleSoft .
To view Outbound messages and service operations, use PeopleTools Integration Broker, Integration Setup.
Note. Messages are associated with service operations, which
are delivered Inactive. You must activate the service
operations and the associated handlers, routings, and queues.
Queues are delivered in Pause status. You
must change these to Run on the Queue Definitions
page.
Service Operations
The following table lists the outbound service operations:
Name |
Description |
TIME_DEVICE_EMPL_ATT_FULLSYNC |
Full Set of Employees for TCD |
TIME_DEVICE_EMP_ATT_SYNC |
Incremental update of EE to TCD |
TIME_DEVICE_PERS_HRS_FULLSYNC |
TCD Period TotHrs Full Sync |
TIME_DEVICE_PROFILES_FULLSYNC |
TCD Task Profiles Full Sync |
TIME_DEVICE_RESTRICT_FULLSYNC |
TCD Restriction Prof_Full Sync |
TIME_DEVICE_RPTG_CODE_FULLSYNC |
TCD TRC Full Sync |
TIME_DEVICE_RPT_ELMNT_FULLSYNC |
TCD Reporting Element FullSync |
TIME_DEVICE_SCHEDULE_FULLSYNC |
TCD Schedules Full Sync |
TIME_DEVICE_SUPERVISOR_FULLSYNC |
TCD Supervisor Full Sync |
TIME_DEVICE_TASK_VALS_FULLSYNC |
TCD Task Elemnt Vals Full Sync |
TIME_DEVICE_TEMPLATES_FULLSYNC |
TCD Task Templates Full Sync |
Queue
All the service operations above are associated with the following queue.
Name |
Description |
TIME_COLLECTION_DEVICE_SETUP |
Time Collection Device Setup |
Configuring Outbound Setup Tables
Configure the setup tables for outbound messages and service operations by defining the:
Task Profile
Make sure to check the Send to TCD box on the Task Profile page.
Taskgroup
You will only publish those task profiles with Send to TCD selected.
Time Reporting Code
You will only publish those task profiles with Send to TCD checked.
TRC Program
You will only publish those TRCs with Send to TCD checked on the Time Reporting Code page.
TCD Type Definition
TCD Setup
TCD Group
See Also
Enterprise PeopleTools PeopleBook: Integration Broker
Handler/application class and OnRouteSend codes are in application classes. To see the codes, open the application package with the same name as the message. The OnRouteSend code is located under the RoutingHandler class. The handler/application class is located under the class that has the same name as the message.
Information on the Service Operations Monitor is in the Integration Broker PeopleBook.
See Enterprise PeopleTools PeopleBook: Integration Broker, “Using the Service Operations Monitor”
The following are incoming service operations from the TCD server to the PeopleSoft server, and online pages to check for errors and reported time:
Service Operations and Queue
The two service operations for incoming messages are: ELAPSED_TIME_ADD (Elapsed Time Interface message) and PUNCHED_TIME_ADD (Punched Time Interface message).
The queues for these two messages are: ELAPSED_TIME (Elapsed Time queue) and PUNCHED_TIME (Punched Time queue).
The handler of the service operations triggers the TL_ST_LOADER Application Engine process that inserts rows into the Reported Time Tables. TL_ST_LOADER also initiates the Validation process for the validations defined on the TL Installation page.
TCD Error Queue
This page is located in Set Up HRMS, System Administration, Utilities, Analyze Time and Labor, Review TCD Errors. Using TCD Error Queue, you can check any errors for the Publishing Node you are using. If there are no errors found for the node, you can see the time in the reporting pages.
Report Time
This page is located in Manager Self-Service, Time management, Report Time, Timesheet. This page displays the list of employees using the Find feature on the grid. Select Timesheet and then click on Name which opens with the current date as the start of the week. you can change the Week begin date and click Refresh Date.
See Reporting Time.
Alternate Service Operation Handler and Process for PUNCHED_TIME_ADD Messages
The default service operation handler for PUNCHED_TIME_ADD triggers the TL_ST_LOADER process to insert the content of an incoming message into reported time. Oracle delivers the PUNCH_ADD_DAEMON service operation handler, and the TL_ST_LD_DMN Application Engine process, which provide the following advantages over the default handler and process:
You can configure a limit to the size of each batch of messages the system processes.
The transactions for a given employee are kept within a single job. The system does not allow splitting employee transactions across multiple concurrent processes.
The PUNCH_ADD_DAEMON handler places the contents of incoming message into a staging table (TL_ST_PCHTIME). The handler does not automatically trigger the TL_ST_LD_DMN process. You must specify a repetitive schedule for the STDAEMON job to look for and process new transactions in the staging table. There is no direct tie between incoming message and each recurrence of the STDAEMON job, so the content of each message may be split between multiple jobs. However the process prevents splitting transactions for a given employee across multiple concurrent processes.
The TL_ST_LD_DMN process enables you to configure the maximum size of each batch of messages by setting the Max Punches in a Batch value on the Time and Labor Installation page. The default batch size is 2,000 transactions. The Max Punches in a Batch field is only visible after you activate the PUNCH_ADD_DAEMON handler.
In order to use the PUNCH_ADD_DAEMON handler, and the TL_ST_LD_DMN process, you must perform the following steps:
Activate the PUNCH_ADD_DAEMON handler on the Handlers page (IB_SERVICEHDLR)
Define the batch size for the TL_ST_LD_DMN process on the Time and Labor Installation page.
Define, or modify, a recurrence pattern for the STDAEMON job on the Recurrence Definition page.
Schedule the STDAEMON job on the Schedule JobSet Definition page.
To initiate the first occurrence of the job, set the status to Active. The process has a built-in clean-up of the process monitor queue. This clean-up assumes that the Run Control ID used for the process is “TCD”.
Make sure you configure the system and Integration Broker for this integration.
See Enterprise PeopleTools PeopleBook: Integration Broker, “Understanding Creating and Implementing Integrations”
This section provides some of the specifics for setting up nodes and gateways for the TCD interface. Use pages in the PeopleTools, Integration Broker, Integration Setup menu and PeopleTools, Integration Broker, Configuration menu to complete this configuration.
Defining the Local Node
This table provides the specific configuration details for this integration:
Page |
Configuration Specifics |
Node Definitions |
The Node Definition is located in PeopleTools, Integration Broker, Integration Setup, Nodes. Make sure that the Node Type is set to PIA (internal, local) and that you select both Local Node and Active Node. |
Connectors |
Make sure that you set Connector ID to PSFTTARGET because the local node always uses this value for the 8.4x tool set. |
Routings |
Routings are defined in PeopleTools, Integration Broker, Integration Setup, Services Operations, Routings. Alternatively, use PeopleTools, Integration Broker, Integration Setup, Routings to define routings. Refer to the Integration Broker PeopleBook for more details on how to set up the routings. Once the routings are set up properly, make sure to activate them. If using flat file architecture, make sure that TIME_DEVICE_XXXX service operations have both OutAsync and InAsync specified with a Status of Active. Flat files are generated by the local Node for each Flat File TCD Server. The location of output is defined on the TL Installation page and the TL General Settings page. |
Access the Node Definitions page.
Access this page from PeopleTools, Integration Broker, Integration Setup, Node Definitions. Make sure that the Node Type is set to PIA (internal, local) and that you check both Local Node and Active Node.
Access the Connectors page.
Make sure that you set Connector ID to PSFTTARGET as the local node always uses this value for the tool set.
Access the Routings page.
See Enterprise PeopleTools PeopleBook: PeopleSoft Integration Broker
If using flat file architecture make sure that TIME_DEVICE_XXXX messages have both OutAsync and InAsync specified with a Status of Active. Flat files are generated by the local Node for each Flat File TCD Server. The location of output is defined on the TL Installation Page and the TL General Settings Page.
Defining the External TCD Nodes
This table provides the specific configuration details for this integration:
Page |
Configuration Specifics |
Node Definitions |
TCD Nodes are required only for XML messaging. Make sure that the Node Type is set to External and that you select Active Node. |
Connectors |
Make sure that you set Connector ID to either PSFT81TARGET or HTTPTARGET . Note. PST81TARGET is used for external TCD servers which are compliant with 8.1x or 8.2x PeopleTools. HTTPTARGET is used for TCD servers which can support 8.4x toolset documentation. Click Ping Node to access the Ping Node Results page. |
Routings |
Make sure to specify the Time_Device_ xxxx message as outsync and Elapsed and Punch messages as inasync. Make sure to specify outbound and inbound transactions for the external node. The routing type should be implicit. |
Access the Node Definitions page.
Defining the Gateway for the PeopleSoft System
Access the Gateways page.
The gateway for the Peoplesoft local node is typically http://server/PSIGW/PeopleSoftListeningConnector.
The gateway on TCD servers that do not support 8.4x Integration Broker is http://xtnt05.peoplesoft.com/PSIGW/PS81ListeningConnector. The gateway on TCD servers that do support 8.4x Integration Broker is http://server/PSIGW/PeopleSoftListeningConnector.
See Also
Enterprise PeopleTools PeopleBook: PeopleSoft Integration Broker
Use pages in the Enterprise Components, Integration Definitions menu to complete this configuration.
This table describes the specifics for configuring enterprise components for the TCD interface:
Page |
Configuration Specifics |
Batch Publish Rules |
Note. If you are using a delivered process, only set those settings that make that process active. The TL_OUTTCD Application engine process uses Batch Publish Rules to publish the messages to TCD Servers. Activate the rules that you will use for TCD Interface. TL_OUTTCD Application engine also triggers service operations to be published. |
File Inbound |
Activate inbound file rule if you are using flat file integration. Make sure to set the Inbound File to the appropriate location and set Status to Active. |
Inbound File (Publish) |
Make sure the Request ID is defined. In the Process Frequency group box, select Once if you are running the process with run control ID only one time or select Always if you are using same run control ID repeatedly. |
Access the Batch Publish Rules page.
The list that appears are the messages that you can select to configure the messages to be published.
Note. If you are using a delivered process, only set those settings that make that process active.
Access this page from Enterprise Components, Integration Definitions, Batch Publish Rules. The TL_OUTTCD Application engine process uses Batch Publish Rules to publish the messages to TCD Servers. Activate the rules, which you will use for TCD Interface. TL_OUTTCD Application engine also triggers Messages to be published.
Inbound File Rules
Access the File Inbound page.
Access this page from Enterprise Components, Integration Definitions, Inbound File Rule. Activate inbound file rule if you are using flat file integration. Make sure to set the Inbound File to the appropriate location and set Status to Active.
Inbound File Publish
Access the Inbound File (publish) page.
Access this page from Enterprise Components, Integration Definitions, Initiate Processes, Inbound File Publish. Make sure the Request ID is defined. And in the Process Frequency group box, select either Once (if you are running the process with Run Control ID only one time, or select Always if you are using same Run Control ID repeatedly.)
See Also
Enterprise Components for PeopleSoft Enterprise HRMS and Campus Solutions PeopleBook
The following lists possible issues that may arise:
Question |
Answer |
Outgoing Messages from the PeopleSoft server to the TCD server: TL_OUTTCD is successful: No messages generated. |
Make sure that: —Queues are in Run mode. —Routings are specified..in the service operations. —Service operations are active. —Batch Publish Rule is selected. —External Node and Transaction Routing Type is specified as Explicit, instead of Implicit. |
Incoming messages from the TCD server to the PeopleSoft server. This error message appeared: “<?xml version="1.0" ?><reply><operations><exception><title>Publish Subscribe Message Exception</title><defaultmsg>psft.pt8.gateway.PublicationHandlerException: </defaultmsg><msgset>94</msgset><msgid>1</msgid><parameters count="1"><parm>psft.pt8.gateway.PublicationHandlerException: </parm></parameters></exception></operations></reply> <?xml version="1.0" ?><reply><operations><exception><title>Publish Subscribe Message Exception</title><defaultmsg>psft.pt8.gateway.PublicationHandlerException: </defaultmsg><msgset>94</msgset><msgid>1</msgid><parameters count="1"><parm>psft.pt8.gateway.PublicationHandlerException: </parm></parameters></exception></operations></reply>” |
This error message signifies that the transaction is not specified for that TCD Server node. |
Ping does not work from the People Soft server to the TCD server. |
Make sure you are using the appropriate target connector as discussed in Node configuration. |
How do I purge message details? |
DELETE FROM PSAPMSGPUBHDR; DELETE FROM PSAPMSGPUBDATA; DELETE FROM PSAPMSGPUBCON; DELETE FROM PSAPMSGSUBCON; DELETE FROM PSAPMSGPUBCERR; DELETE FROM PSAPMSGPUBERR; DELETE FROM PSAPMSGSUBCERR; DELETE FROM PSAPMSGPUBCERRP; DELETE FROM PSAPMSGPUBERRP; DELETE FROM PSAPMSGSUBCERRP; DELETE FROM PSAPMSGARCHPC; DELETE FROM PSAPMSGARCHPD; DELETE FROM PSAPMSGARCHPH; DELETE FROM PSAPMSGARCHSC; |
Flat files were not created for outbound messages, but messages were generated in the Service Operations Monitor. |
Make sure that: Routing are defined properly in the service operations. —Handlers are active on all the service operations. —You are looking at the right location, which is specified on TL Installation page (TL General setting). —TL_OUTTCD has not generated any errors. —Your Application server and process scheduler has read and write access to the file location. |
The flat file is not empty after the Inbound File Publish process is run. |
Make sure that: —The file location is properly specified on the Inbound File Rule page. —Inbound File Rule is active. —The Inbound File process run control has Process Frequency set to Always or Once (as needed). —You are following comma delimiter for each column. —The Inbound File Rule is active. —The file name is ELAPSED_TIME*.CSV or PUNCHED_TIME*.CSV |
The messages transactions are not same as in the flat file. |
Make sure that each row in the flat file has a carriage return in the sense each transaction should be a new line in simple sense each line by hitting your return/key. |
I am getting a large message. |
When the message size exceeds the size set on the PeopleTools, Options pages, the message splits into multiple messages. For Full-sync, there would be one header followed by multiple data messages and then one trailer. |
I am receiving header and footer information only. |
Service Operations are active but probably TCD Type setup is not appropriate, or no data to publish Task elements and or time reporting elements or schedules. |
Where can I find the Message log and the Error log? |
Msg Log : http://server/PSIGW/msgLog.html and, Error Log : http://server/PSIGW/errorLog.html |
The following table addresses some frequently asked questions:
Question |
Answer |
Is a password necessary for the Node definition? |
No, it is not. If the external node wants to enforce the password , you need to specify that on the Node Definitions page of the external node. |
Do all the downloads have the TCD ID? |
Yes, each TCD will get employee population and other information. |
Will each TCD record its own employee information? |
Yes, each TCD will get employee population and other information. |
Why do I see two data messages for one full_sync publish? |
If a message exceeds the allotted size, the message is divided into multiple messages. For example, if the TCD server receives the header followed by multiple data messages and then a trailer. |
What is the Operator ID (char 8) in the Punched and Elapsed transactions? How do I validate this information? |
Oprid : can be left blank or it is up to implementation site if they want to populate with the ID of the person who is punching. |
Why don't I see the header message for TIME_DEVICE_EMPL_ATT_SYNC? |
Empl Att sync will not have header and trailer as it is considered as incremental message, this is the only message which is incremental. The TCD server receives all other messages are Full Synch which will have header, data and trailer messages. |