Web Service to load Personnel Data

This Web Service is part of an API that may be used to upload personnel data and create personnel service records from data recorded in third party system. Note that the use of the Web Service is one of the steps in the process and the process are as follows:

Use the Web Service (from the relevant external system)

The Web Service will perform a minimum set of validations on the data to be uploaded, perform the transformation of data items as set-up in the External Conversion Rules of the Web Service (described below) and load the data a into a "Staging Area"

The data in the "Staging Area" may be queried and updated using "Maintain Web Service Appointments" {PWEBM-11}
A full set of validations as well as the final loading of the data in the "Staging Area" into the Personnel System may be done using functionality in"Maintain Web Service Appointments" { PWEBM-11}

The system operates under the following constraints and rules:

Service Records {PBOP-2} to be created by this functionality must have an end date.
For existing personnel members, no appointments will be allowed if a Service Record in the Personnel System already exists where the existing Service Record has no end date or the end date of the existing Service Record is after the start date of the Service Record to be loaded.
A Secondary Appointment Contract {PAOP-2} will automatically be created for every Service Record {PBOP-2} where the Appointment Type {PACS-1} is indicated as (S)alaried. For Service Records where the Appointment Type is indicated as (C)laims, data for a Secondary Appointment Contract must be included with the upload.

The technical documentation (Service Description or WSDL) of the Web Service and a test facility is available on the Application Server at the following URL

http://<Application Server IP Address : Port> /itsp09ws/p09SoapHttpPort

The table below contains descriptions for the items that appear in the WSDL as well as the External Conversion Code Description Value.

The external conversion code description values may be used to convert (transform) data items from the format and values of the external system to the fomat and values of the ITS Personnel System. Conversion rules are entered in External Conversion Codes {GOPS-21} and the Web Service will apply

The External Body for all tags is "IHR - Import Extarnal HR Data"
The External Code Type for all tags is "WSC - Web Service Conversion Codes"
The rules for each individual tag is identified by the External Conversion Code Description Values in the table below, entered into the Description field in External Conversion Codes {GOPS-21}.
For each value in the external system to be converted, a record should be created with the value of the external system in the "External Code" - field and the value that it should be converted to in the "Internal Code" - field.
For tags where no conversion rules are entered, no conversion will be done, that is, the data as supplied will be used as is
For tag values where conversion rules are entered for the tag, but where no rule exists for the specific tag value no conversion will be done, that is, the data as supplied will be used as is.

Tags	Description	Mandatory field	External Conversion Code Description Value
personnelexternalnumber	The personnel number of the person as in the third party system	Y	personnelExternalNumber
personneltitle	Title	Y	personnelTitle
personnelinitials	Initials	Y	personnelInitials
personnelfirstname	First name	Y	personnelFirstName
personnelsurname	Surname	Y	personnelSurname
personnelmaidenname	Maiden name		personnelMaidenName
personnelidnumber	ID Number	Y	personnelIDNumber
personnelbirthdate	Birth date	Y	personnelBirthDate
personnelpassportnumber	Passport		personnelPassportNumber
personnelmaritalstatus	Marital Status	Y	personnelMaritalStatus
personnelpreferredlanguage	Preffered Language	Y	personnelPreferredLanguage
personnelethnicgroup	Ethnic group		personnelEthnicGroup
personnelcitizenship	Citizenship		personnelCitizenship
paypoint	Paypoint - Refer to Fixed Salary Detail {FPRI-1}		payPoint
paydate	Paydate - Refer to Fixed Salary Detail {FPRI-1}		payDate
paycalcnumber	Salary Calculation Number - Refer to Fixed Salary Detail {FPRI-1}		payCalcNumber
paybonusmonth	Bonus month - Refer to Fixed Salary Detail {FPRI-1}		payBonusMonth
paymethod	Method of payment - Refer to Fixed Salary Detail {FPRI-1}		payMethod
bankcode	Bank code - Refer to Fixed Salary Detail {FPRI-1}		bankCode
bankbranch	Branch Code		bankBranch
bankaccounttype	Bank account type		bankAccountType
bankaccountnumber	Bank account number		bankAccountNumber
appointsupervisor	Personnel number of direct supervisor		appointSupervisor
personnelgender	Gender	Y	personnelGender
appointnotch	Annual Salary Notch value - Refer to Fixed Salary Detail {FPRI-1}		appointNotch
appointleavepackge	Leave package - Refer to Service Records {PBOP-2}		appointLeavePackge
rortaxbonusinterval	Tax on Bonus Monthly or Annually - Refer to Fixed Salary Detail {FPRI-1}		rorTaxBonusInterval
rorreceiverrevenue	Receiver of Revenue office - Refer to Fixed Salary Detail {FPRI-1}		rorReceiverRevenue
rorincometaxnumber	Income tax reverence number- Refer to Fixed Salary Detail {FPRI-1}		rorIncomeTaxNumber
referencenumber	Reverence number		referenceNumber

homeaddressline1	Physical Address line 1	Y	homeAddressLine1
homeaddressline2	Physical Address line 2	Y	homeAddressLine2
homeaddressline3	Physical Address line 3		homeAddressLine3
homeaddressline4	Physical Address line 4		homeAddressLine4
homeaddresspostcode	Postal code		homeAddressPostCode

postaddressline1	Postal Address line 1	Y	postAddressLine1
postaddressline2	Postal Address line 2	Y	postAddressLine2
postaddressline3	Postal Address line 3		postAddressLine3
postaddressline4	Postal Address line 4		postAddressLine4
postaddresspostcode	Postal Code	Y	postAddressPostCode

personnelemail	Email Address	Y	personnelEmail
personnelhometelephone	Home telephone number	Y	personnelHomeTelephone
personnelworktelephone	Work Telephone number	Y	personnelWorkTelephone

appointtype	Appointment type - Refer to Service Records {PBOP-2}		appointType
appointstartdate	Start date of the appointment - Refer to Service Records {PBOP-2}		appointStartDate
appointenddate	End date of the appointment - Refer to Service Records {PBOP-2}		appointEndDate
appointpost	Post the person is appointed to - Refer to Service Records {PBOP-2}		appointPost
appointrank	The salary rank linked to the post - Refer to Service Records {PBOP-2}		appointRank
appointfixedtaxrate	Fixed tax rate apply "Y" or "N" - Refer to Service Records {PBOP-2}		appointFixedTaxRate
appointservicerecordindicator	Service record indicator - Refer to Service Records {PBOP-2}	Y	appointServiceRecordIndicator
appointnatureofperson	Nature of Person "A" a Person with an ID or Passport number, "B" No ID or Passport number etc. - Refer to Service Records {PBOP-2}		appointNatureOfPerson
appointuifstatus	UIF Status - Refer to Service Records {PBOP-2}		appointUifStatus
appointuifnoncontributereason	Reason for no contributions toward UIF fund - Refer to Service Records {PBOP-2}		appointUifNonContributeReason
appointstatscategory	Stats category - Refer to Service Records {PBOP-2}		appointStatsCategory
appointcampuscode	Campus code - Refer to Service Records {PBOP-2}		appointCampusCode
appointbuildingroom	Room - Refer to Service Records {PBOP-2}		appointBuildingRoom
appointbuildingfloor	Floor - Refer to Service Records {PBOP-2}		appointBuildingFloor
appointbuildingcode	Building - Refer to Service Records {PBOP-2}		appointBuildingCode
personnelofficerequired	Does the person require an office Y or N		personnelOfficeRequired

secondpersonnelqual	Qualification - Refer to Qualifications {PBOP-8}		secondPersonnelQual
qualificationdate	Date qualification was obtained - Refer to Qualifications {PBOP-8}		qualificationDate
secondhighestqualification	Highest Qualification "Y" or "N" - Refer to Qualifications {PBOP-8}		secondHighestQualification
secondinstitution	Institution where qualification was obtained - Refer to Qualifications {PBOP-8}		secondInstitution
majorfieldofstudy	Major field of study - Refer to Qualifications {PBOP-8}		majorFieldOfStudy
specialisation	Specialisation of study - Refer to Qualifications {PBOP-8}		specialisation

secondcontractnumber	Contract number - Refer to Secondary Appointment Contracts {PAOP-2}		secondContractNumber
secondpost	Secondary Post - Refer to Secondary Appointment Contracts {PAOP-2}		secondPost
secondearningcode	Earning or deduction code - Refer to Secondary Appointment Contracts {PAOP-2}		secondEarningCode
secondstartdate	Start date of secondary contract - Refer to Secondary Appointment Contracts {PAOP-2}		secondStartDate
secondenddate	End date of secondary contract - Refer to Secondary Appointment Contracts {PAOP-2}		secondEndDate
secondpayrate	Contract Rate - Refer to Secondary Appointment Contracts {PAOP-2}		secondPayRate
secondmaxquantity	Maximum quantity - Refer to Secondary Appointment Contracts {PAOP-2}		secondMaxQuantity
secondfixedmonthlyrate	The value of a Fixed Monthly Claim - Refer to Secondary Appointment Contracts {PAOP-2}		secondPayRate
secondtotalcontractmaxamount	Maximum Amount Allocated of the contract - Refer to Secondary Appointment Contracts {PAOP-2}		secondTotalContractMaxAmount
secondnote	A note to be entered on the Secondary Appointment Contracts {PAOP-2}		secondNote
secondbuildingcode	The Building Code to be entered on the Secondary Appointment Contracts {PAOP-2}		secondBuildingCode
secondbuildingfloor	Floor to be entered on the Secondary Appointment Contracts {PAOP-2}		secondBuildingFloor
secondbuildingroom	Room to be entered on the Secondary Appointment Contracts {PAOP-2}		secondBuildingRoom
secondcampuscode	Campus code to be entered on the Secondary Appointment Contracts {PAOP-2}		secondCampusCode
secondworkhours	The number of Hours to be entered on the Secondary Appointment Contracts {PAOP-2}		secondWorkHours
secondworktelephone	Telephone number to be entered on the Secondary Appointment Contracts {PAOP-2}		secondWorkTelephone
secondworkfaxnumber	Fax number to be entered on the Secondary Appointment Contracts {PAOP-2}		secondWorkFaxNumber
Contract_num	Contract Number to be entered on the Secondary Appointment Contracts {PAOP-2}		contractNumber

fundcode	Fund code that the person should be linked to - Refer to Medical Aid/Group Insurance {PAOP-4}		fundCode
fundjoindate	The date that the person should join the fund - Refer to Medical Aid/Group Insurance {PAOP-4}		fundJoinDate
fundleavedate	The date the person should resign from the fund - Refer to Medical Aid/Group Insurance {PAOP-4}		fundLeaveDate
fundmsalevel	Savings level of the person for the fund - Refer to Medical Aid/Group Insurance {PAOP-4}		fundMsaLevel

Tags for security detail
securityid	The Securityid will be matched against the value entered for System Operational Definition {GCS2-11} "IS" for Subsystem "HR".

History of Changes

Date	System Version	By Whom	Job	Description
16-Sep-2009	v01.0.0.0	Allie	160620	New development.
16-Oct-2009	v01.0.0.0	Charlene van der Schyff	t160620	Edit and fix links and also naming convention of the manual.
22-Mar-2011	v01.0.0.1	Precious Diale	t173888	Add a tag 'Contract_num'