SIDES Reusable Modules
Recommendation, 2007 April 15
Editors:
Kim Bartkus, HR-XML Consortium
Contributors:
Gail Bubsey (Kelly Services ), Kim Bartkus (HR-XML Consortium), Barbara Johnson (Adecco NA), Tara Ryan (Adecco), Kazuko Sugamura (Manpower Japan), Takahiro Fujiwara (EAST Co., Ltd.), Magali Munoz (Manpower France), Bruno Alcotte (Manpower France), Rémy Bailly (Randstad), Yves Berdah (VidiorBis), Serguei Dounaevetski (Manpower France), Patrice Aranega (Adecco France)
Copyright © 2007 HR-XML Consortium, Inc.
Abstract
The HR-XML SIDES Workgroup has produced 7 major schemas and several reusable modules to allow for transmission of Staffing Industry information between trading partners. This document describes the Staffing Order schema, its expected usage, and the business processes meant to be supported.
Table of Contents
3 Customer Reporting Requirements. 5
8 Implementation Considerations
9 Appendix A - Document Version History
10 Appendix B – Related Documents
1 Overview
Changes were made to the base SIDES specification based on feedback from the European and Japanese Chapters. If available, localized items are documented in section 4 Implementation Considerations or in individual country documentation. Refer to Appendix A - Document Version History for details.
1.1 Objective
Several reusable modules are used to exchange details within the framework of SIDES. This document describes the purpose and details of each of the six reusable modules:
- Contact Info, Entity Contact Info
- Customer Reporting Requirements
- Rates
- Resource Screening
- Staffing Shift
- Staffing Contact Type
1.2 Scope
The six reusable modules will be divided into separate chapters, with an overview, diagram, and definitions for each chapter.
2 Contact Info
2.1 Overview
The ContactInfo schema contains two data types to allow for contacting an individual or an organization: ContactInfoType and EntityContactInfoType. The ContactInfoType incorporates the PersonName and ContactMethod. Whereas, the EntityContactInfo also includes an EntityName to allow for organization, company, department, etc. The ContactMethod schema provides for a variety of contact methods such as telephone, fax, e-mail, web, and postal address.
2.2 Schema Diagrams
2.3 Data Dictionary
|
Elements and Attributes [Global types listed alphabetically in following table.] |
ContentModel* |
Definition |
|
/ |
- ContactInfoType - (1/1) |
Contains information to contact a
person or entity. |
|
/ ContactInfo/ |
- ContactMethodType - S (1/*) |
Defines the methods to contact a
person or organizations. |
|
/ ContactInfo/ |
- EntityIdType - S (0/1) |
Unique identifier for the contact. |
|
Elements and Attributes [Global types listed alphabetically in following table.] |
ContentModel* |
Definition |
|
/ |
- EntityContactInfoType - (1/1) |
Container for entity contact information. |
|
/ EntityContactInfo/ |
- xsd:string - S (1/1) |
Name of entity that is contacted. This would typically be the organization. |
|
/ EntityContactInfo/ |
- ContactMethodType - S (1/*) |
Defines the methods to contact a
person or organizations. |
3 Customer Reporting Requirements
3.1 Overview
Staffing customers require specialized reporting and data tracking. For example, it is very common for customers to require purchase order numbers, supervisor names, or department numbers, etc. to appear on reports, invoicing, documents or correspondence. A list common customer requirements was developed to accommodate this requirement. Many of these fields may be used differently by each staffing customer and the list may not satisfy every situation. Research indicates that the CustomerReportingRequirements Module attributes satisfy 80% of common reporting situations.
In the list of data fields you will find "CostCenterCode" and "LocationCode". The specific use of these two codes is up to the staffing customer. One customer may require their cost center data to appear on a report and another customer may require their location code to appear on a report. Other staffing customers may have both fields. The analysis and research showed there were enough occurrences of each field to justify the existence of both.
It is assumed that there will be exceptions and extensions to the list and some customers will require additional data elements. Accordingly, an unbounded named value pair is provided for reporting requirements that do not fit into the predefined fields.
Why not just use generic additional data elements?
The question may be asked as to why a generic 'additional data' element with enumerated types is not used rather than a predefined list? The specification could be implemented this way, but this method would not provide a ‘mapable’ data tag for items such as PO#, Cost Center, Manager Name, etc. within the HR-XML SIDES Standard itself. Without the specific tags, suppliers are forced to build extensions to the schemas to accommodate this additional data. Since the data is intended to be reused within several of the SIDES schemas, the pre-defined tags will ensure consistency between schemas. The CustomerReportingRequirements Module is referenced within StaffingCustomer, Order, Position, Assignment, Extended Timecard and Invoice schemas.
Department Code versus Department Name
Within the list of CustomerReportingRequired fields, there is a difference between DepartmentCode and DepartmentName, LocationCode and LocationName, etc. These fields are independent and mutually exclusive. These fields should not be confused with lookup tables or named value pairs. One staffing customer may want to report on codes, whereas another customer may want to track descriptive names or text.
3.2 Schema Diagram
3.3 Data Dictionary
|
Elements and Attributes [Global types listed alphabetically in following table.] |
ContentModel* |
Definition |
|
/ |
- CustomerReportingRequirementsType - (1/1) ManagerName
- xsd:string - S
(0/1) |
List of customer-wide reporting field requirements. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
Manager
name. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
Work assignment supervisor's name, used for reporting. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
The name of the person to contact. |
|
/ CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
Purchase
order number. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
A
department code. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
A
department name. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
Location
code. |
|
/ CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
Location
name. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
Cost
center code. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
Cost
center name. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
Staffing
customer job code. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
Job
description. |
|
/ CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
An
account code or identifier. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
A
project code. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
External
order number. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
External
request number. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
A person, company or other organization. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
Customer
organizational designation. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
Work shift as it pertains to a particular work engagement . |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
Reference
number. |
|
/
CustomerReportingRequirements/ |
xsd:extension base: xsd:string |
Any other customer required item. |
|
/
CustomerReportingRequirements/ AdditionalRequirement/ |
- xsd:string - |
Title or name used by the customer for the additional reporting requirement. |
|
/
CustomerReportingRequirements/ |
- xsd:string - S (0/1) |
Purchase
Order Line Item Number associated with the reporting requirement. |
4 Rates
4.1 Overview
The rates module is a flexible schema that allows for the transmission of a wide variety of pay, bill and expense rate structures. It provides for multiple instances of rates for a single assignment and can associate a shift with each rate. The Rates module is also used in the StaffingOrder schema to capture a customer-specified bill rate range, and in the HumanResource to capture a specific charge rate for an individual in relation to a particular position.
4.2 Schema Diagram
4.3 Data Dictionary
|
Elements and Attributes [Global types listed alphabetically in following table.] |
ContentModel* |
Definition |
|
/ |
- RatesType - (1/1) |
Container for rate information. |
|
/ Rates/ |
- EntityIdType - S (0/1) |
Reference to an external rate, or collection of contractual rates. |
|
/ Rates/ |
xsd:extension base: xsd:decimal |
The monetary value of the
associated item. |
|
/ Rates/ Amount/ |
- AmountPeriodType - |
The time interval or other increment in which the rate is charged or paid. May extend to provide for bonus or commission payments. |
|
/ Rates/ Amount/ |
xsd:restriction base: xsd:string |
A three-letter code identifying
the currency of a monetary amount. |
|
/ Rates/ |
- xsd:string - S (1/1) |
Classification or designation for
the rate. |
|
/ Rates/ |
- EntityIdType - S (0/1) |
Shift identifier with which the rate is associated. |
|
/ Rates/ |
xsd:extension base: xsd:decimal |
A multiplier to be applied to the
related amount, rate, or variable. |
|
/ Rates/ Multiplier/ |
- xsd:boolean - |
Flag to indicate if the multiplier provided is a percentage of the original number. |
|
/ Rates/ |
- AnyDateTimeNaType - S (1/1) |
Contains the (inclusive) date,
period, or interval the event becomes active or begins. |
|
/ Rates/ |
- AnyDateTimeNkType - S (0/1) |
Contains the (inclusive) date,
period, or interval the event becomes inactive or ends. |
|
/ Rates/ |
- xsd:string - S (0/1) |
Describes the contextual
information relating to a specific element. |
|
/ Rates/ |
- EntityIdType - S (0/1) |
A unique identifier for an individual agreed upon rate. |
|
/ Rates/ |
- EntityIdType - S (0/1) |
Identifier allowing customer rates to be grouped for reporting purposes. |
|
/ Rates/ |
xsd:extension base: xsd:decimal |
A multiplier specifically used to calculate the invoice amount using the paid amount. |
|
/ Rates/ BillingMultiplier/ |
- xsd:boolean - |
Flag to indicate if the multiplier provided is a percentage of the original number. |
|
/ Rates/ |
- TimeRoundingRuleType - S (0/*) |
Contains rounding requirements to round the time worked. |
|
Global
types |
ContentModel* |
Definition |
|
/ |
summaryCycle - FrequencyType
- |
Globally scoped data type. See element or attribute declaration for definition. |
|
/ [TimeRoundingRuleType] / |
- FrequencyType - |
Describes the cycle of time worked for rounding purposes. |
|
/ [TimeRoundingRuleType]/ |
xsd:extension base: xsd:decimal |
A container used to report the duration and type of a work for a specified time period. |
|
/ [TimeRoundingRuleType]/
TimeInterval/ |
- RoundingRuleEnumType - |
The methodology used for
rounding. |
|
/ [TimeRoundingRuleType]/
TimeInterval/ |
- xsd:string - |
Time increment in which the event
is measured. |
|
/ |
xsd:restriction base: xsd:string [Enumerations]: RoundDown, RoundHalfDown, RoundUp, RoundHalfUp, RoundHalfEven, RoundCeiling, RoundFloor |
Globally scoped data type. See element or attribute declaration for definition. |
5 Resource Screening
5.1 Overview
This reusable module allows staffing suppliers to report basic screening information pertaining to a staffing resource.
5.2 Schema Diagram
5.3 Data Dictionary
|
Elements and Attributes [Global types listed alphabetically in following table.] |
ContentModel* |
Definition |
|
/ |
- ResourceScreeningType
- (1/1) |
Container for screening or testing data about the candidate. |
|
/ [ResourceScreeningType] / |
- StaffingScreeningType - |
Type of screening required and reported on. |
|
/ ResourceScreening/ |
- xsd:string - S (1/1) |
Result of the screening report. This is generally limited to noting if the requirement was met or not met. |
|
/ ResourceScreening/ |
- xsd:string - S (0/1) |
Comments regarding the report. |
|
Global
types |
ContentModel* |
Definition |
|
/ |
xsd:restriction base: xsd:string [Enumerations]: abuse, address, awards, credit, criminal, drug, earnings, education, employment, license, name, phone, reference, workcomp |
Globally scoped data type. See element or attribute declaration for definition. |
|
/ |
- [Union]: KnownScreeningType,xsd:string |
Globally scoped data type. See element or attribute declaration for definition. |
6 Staffing Shift
6.1 Overview
The StaffingShift schema provides a mechanism for exchanging information on shifts or specific working hours between trading partners and within internal applications. Staffing suppliers require shift information to describe position-specific requirements and rate related assignment information within an order.
6.2 Schema Diagram
6.3 Data Dictionary
|
Elements and Attributes [Global types listed alphabetically in following table.] |
ContentModel* |
Definition |
|
/ |
- StaffingShiftType
- (1/1) |
A mechanism for exchanging information on shifts or specific working hours. |
|
/ [StaffingShiftType]
/ |
xsd:restriction base: xsd:string [Enumerations]: monthly, weekly, daily, 1, 2, 3, 4, 5, 6, 7, event |
The
period the shift occurs. Annotation: Numeric values conform to: ISO 8601
2nd Edition; ISO8601:2000(E); pub 2000-12-15, Data elements and interchange
formats, Information interchange, Representation of dates and times,
http://www.iso.ch/cate/d26780.html/ 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4
= Thursday, 5 = Friday, 6 = Saturday, 7 = Sunday |
|
/ StaffingShift/ |
- EntityIdType - S (1/1) |
A unique identifier used to reference the entity. The Id is associated with the higher level element. |
|
/ StaffingShift/ |
- xsd:string - S (0/1) |
A descriptive identifier within
the given context. |
|
/ StaffingShift/ |
- xsd:decimal - S (0/1) |
The number of hours specified for an event or work period. |
|
/ StaffingShift/ |
- LocalTimeNkNaType - S (0/1) |
The time the interval or event started. |
|
/ StaffingShift/ |
- LocalTimeNkNaType - S (0/1) |
The time the interval or event ended. |
|
/ StaffingShift/ |
- xsd:string - S (0/1) |
Specific type of work hours. |
|
/ StaffingShift/ |
- xsd:string - S (0/1) |
Allows for textual comments. |
|
/ StaffingShift/ |
- EntityIdType - S (0/1) |
Allows a reference to an external staffing shift, or collection of contractual staffing shifts. |
7 Staffing Contact Type
7.1 Overview
This module defines the type of contact information consistent across the Assignment, and StaffingAction modules. To ensure this consistency, a value list (enumerations) was created for use in those two modules.
7.2 Data Dictionary
|
Global
types |
ContentModel* |
Definition ** |
|
/ |
xsd:restriction base: xsd:string [Enumerations]: placed by, placed on behalf of, confirm to, authorized by, interviewer, supervisor, time approver, submitted by, created by, sent to, first day contact, customer complaints, supplier manager, supplier complaints, deputy time approver |
Globally scoped data type. See element or attribute declaration for definition. |
|
/ |
- [Union]: KnownContactType,xsd:string |
Globally scoped data type. See element or attribute declaration for definition. |
8 Implementation Considerations
8.1 Data Privacy
Human resources data, by its very nature, is personal data. The laws of many jurisdictions as well as codes of fair information practice require organizations to handle personal data in a way that protects individuals from loss of privacy.
The data exchange specifications developed by the HR-XML Consortium are designed to be useful across many jurisdictions and within a variety of business contexts. It is not feasible for the HR-XML Consortium to develop specific privacy guidance for every jurisdiction or business context in which the Consortium's specifications might be implemented. When implementing data exchanges using the HR-XML Consortium's data definitions (or, for that matter, using any other type of data exchange mechanism), organizations are advised to examine the privacy protections that may be required under applicable law and codes of fair information practice.
For information on protecting personal data, general references include: European Union Data Protection Directive (95/46/EC); the Association Computing Machinery Code of Ethics (1992); Canadian Standards Association Model Code for the Protection of Personal Information (1995 – PIPEDA); and U.S.-EU Safe Harbor Principles and FAQs (2000).
9 Appendix A - Document Version History
|
Date |
Description |
|
2004-Mar-03 |
Initial Draft |
|
2004-Mar-29 |
Updated tables, added info to overview/scope sections. |
|
2004-Apr-07 |
Added reference examples. |
|
2004-May-06 |
Changed percentage to percentIndicator |
|
2004-Jun-08 |
Changed Contact Method to multiple occurrence. Added xml:lang to root of Rates, ResourceScreening, and StaffingShift. |
|
2004-Aug-02 |
Approved by membership. |
|
2006-Feb-28 |
Approved by Consortium |
|
2006-July-08 |
Added ContactId to ContactInfo schema. Added TimeWorkedRounding to Rates schema. Added 'first day contact', ' customer complaints', 'supplier manager', 'supplier complaints', and 'deputy time approver' enumerations to ContactType within StaffingContactType schema. Added 'event' enumeration to shiftPeriod within StaffingShift schema. |
|
2007-Apr-15 |
Approved by Consortium. |
10 Appendix B – Related Documents