REG - Employee registrations

From Host

Transaction type REG is used to import employee registrations from HOST (ERP system) to ProMark

FieldDescriptionData TypeMandatoryComment
1EmpNumberTextX

Identification of employee. Can be either Card Number or Employee Number depending on the system set-up

2RegTypeTextX

Registration Type

See Note 1

3TermKeyIdText(X)

It is used in connection with job registrations. This corresponds to a job terminal key; if not given the general registration element is used.

4ActDateTimeText

The actual date/time when the registration occurred. This should be entered in format YYYY-MM-DDTHH:MM:SS ex. 2014-05-02T08:45:00

5RegDateTimeTextX

The entered date/time of the registration. This should be entered in format YYYY-MM-DDTHH:MM:SS ex. 2014-05-02T08:45:00

6ReasonTypeText

Reason type if neede for registration type

See Note 1

7ReasonCodeText

Reason code if needed

8TextMsgText

Used in connection with RegType = TX

9StringValueText

A supplementary text used for instance in connection with number supplements.

10GenIDText(X)

A general ID used for instance with change of group, change of department, time supplement and number supplement.
It is also used to define partial absence type with interval like 2: start of the day, 3: end of the day, 4: any time of the day and so on.

11GenId2Text(X)

A general ID used for instance with "Move break" registrations. If break number is defined for 'Cancel break' with empty GenId field, it creates cancel break registration based on defined break number. If GenId2 is defined as 1, first break is cancelled, if 2 then second break is cancelled and so on. If it is defined as ?, first coming break is cancelled.
Partial absence with interval: It can be used to define end time for absence interval.

12DecValueDecimal number

A general decimal value. Used with time, number supplement and partial absence with abssence interval. On partial absence, it is used to define partial absence time or can be used to define absence percentage for work free days.

13TerminalNoInteger

Terminal number

14ProjectText

Project id. Used for Project dimensions on registrations types : AH, ABH, AN, AT

15ActivityText

Activity id. Used for Project dimensions on registrations types : AH, ABH, AN, AT

16PieceworkText

Piecework id. Used for Project dimensions on registrations types : AH, ABH, AN, AT

17Time TypeText

Time type id. Used for Project dimensions on registrations types : AH, ABH, AN, AT

18Extra info 1Text

Extra info. Used for Project dimensions on registrations types : AH, ABH, AN, AT. Must respect format "ExtrainfoId=ExtraInfoValue"

19Extra info 2Text

Extra info. Used for Project dimensions on registrations types : AH, ABH, AN, AT. Must respect format "ExtrainfoId=ExtraInfoValue"

20Extra info 3Text

Extra info. Used for Project dimensions on registrations types : AH, ABH, AN, AT. Must respect format "ExtrainfoId=ExtraInfoValue"

21Extra info 4Text

Extra info. Used for Project dimensions on registrations types : AH, ABH, AN, AT. Must respect format "ExtrainfoId=ExtraInfoValue"

22Extra info 5Text

Extra info. Used for Project dimensions on registrations types : AH, ABH, AN, AT. Must respect format "ExtrainfoId=ExtraInfoValue"

23DivisionText

Division Id. Used for Project dimensions on registrations types : AH, ABH, AN, AT.

24ActionInteger

0: Create registration, 1: Delete registration. Default value 0 is used if nothing is defined.
Deletion is supported for following registration types:
All-day Absence (AB)
Partial Absence (ABH)
Present (AI), Cancel Break (CB)
Text Message (TX)
Number Supplement (AN)
Time Supplement (AT)
Change Group (CE)
Change Department (CD)

Notes

IdText
1Supported registration Type definitions:
1. Clock-in
RegType: CI
ReasonTypes:
- CIE (Clock-in early)
- CIL (Clock-in late)
- CIA (Clock-in again)
- CIS (Clock-in with fixed reason)

2. Clock-in, overtime
RegType: CI,O
Note: Corresponds to using the overtime key on a terminal

3. Clock-out
RegType: CO
ReasonTypes:
- COE (Clock-out early)
- COL (Clock-out late)
- COS (Clock-out with fixed reason)

4. Clock-out, overtime
RegType: CO,O
Note: Corresponds to using the overtime key on a terminal

5. Absence All-day
RegType: AB
ReasonType: AA
Note: The absence date should be kept in the date part of the RegDateTime field. The time is ignored.

6. Absence interval
RegType: ABI
ReasonType: AA
Note: The first absence date must be placed in the date part of the RegDateTime field (the time is ignored). The last absence date must be placed in the GenId field as a date string in ISO format (YYYY-MM-DD).

7. Absence All-day and partial
RegType: ABH
ReasonType: AA
Note: See note 1

8. Present
RegType: AI

9. Break begin/end
RegType: BR
ReasonType variants:
- Begin (The string "ON" must be placed in the GenId field)
- End (The string "OFF" must be placed in the GenId field)

10.Cancel break
RegType: CB
Note: The break's starting time must be placed in the GenId field using one of the formats HH:MM, HH.MM or SSSSS (seconds since midnight); if this field is left blank, the time part from RegDateTime will be used.

11.Move break
RegType: BM
Note: The original break's starting time must be placed in the GenId field using one of the formats HH:MM, HH.MM or SSSSS (seconds since midnight); if this field is left blank, the time part from RegDateTime will be used. The time to where the break is moved must be placed in the GenId2 field (same format options).

12.Text message
RegType: TX
Note: The message is stored in TextMsg.

13.Number Supplement
RegType: AN
Note: The id of the number supplement is stored in GenID. The "number" is stored in DecValue. An optional comment can be supplied via the StringValue field.

14.Time Supplement
RegType: AT
Note: The id of the time supplement is stored in GenID. The time is stored in DecValue as seconds. An optional comment can be supplied via the StringValue field.

15.Change group
RegType: CE
Note: CE=Change Employee group. The id of the new group is stored in GenID

16.Change department
RegType: CD
Note: The id of the department is stored in GenID

17.Change condition
RegType: OC
Note: Order ID must be placed in the GenId field while Operation ID must be place in GenId2. The condition ID must be placed in the StringValue field; to report the operation "finished", this field must be either "" or ":FINISHED".

18.Job in
RegType: OI
Note: Order ID must be placed in the GenId field while Operation ID must be place in GenId2.

19.Job out
RegType: OO
Note: Order ID must be placed in the GenId field while Operation ID must be place in GenId2.

20.Number report
RegType: ON
Note: Order ID must be placed in the GenId field while Operation ID must be place in GenId2. Furthermore, the relative number of approved and/or scrapped quantity must be placed in the StringValue field. The approved/rejected will be delimited by colon (colon). See note 2.

Note 1:
Absence, All-day and partial. In RegDateTime the date part of the field is the absence date; the time part is ignored. Partial absence is given in seconds (hours * 3600) in DecValue. The value must be zero if the absence reason is configured with a percentage value.
GenID is the absence type and corresponds to filed #5 for host transaction type 374.The same constraints and considerations that apply to the host transactions also apply to offline transactions. They are as follow:
1. All-day absence
2. Part-day at clock-in
3. Part-day at clock-out
4. Part-day "any time"
5. All-day absence or part-day "any time"
6. Absence covering a full shift

If DecValue = 0 then it will consider the absence as a percent and will try to take the value from the absence reason. If DecValue is not 0 it will look at GenId2 too. If both are different from 0 It will be considerd an interval with DecValue as interval start and GenId2 as interval end . If GenId2 is 0 then it will consider DecValue as absence time.

Note 2:
Quantity for number reporting registrations (method-1). Values for approved and/or scrapped quantity are given together in the StringValue field in the format approved:rejected.
For instance,
17:12 - signifies 17 approved and 12 scrapped
17 - signifies 17 approved and none scrapped
:12 - signifies 12 scrapped and none approved
17: signifies 17 approved and none scrapped