Organization
Recommendation, 2007 April 15
Editor:
Tim Farlow, Authoria, Inc.
Kim Bartkus, HR-XML Consortium, Inc.
Kathi Dolan, Manpower
Laurie Hertz, Manpower
Contributors:
Members of CPO workgroup
Copyright © 2007 HR-XML Consortium, Inc.
Abstract
Many HR-XML standards reference organizations and their components. This document defines a standard way in HR transactions of representing these objects, including companies, subsidiaries, departments, business units, and project teams.
Table of Contents
1.3.2 Items Within the Design Scope
1.3.3 Items Outside the Design Scope. 4
2 Supported Business Processes
2.3 Usage Examples of Identifiers
3.1.2 Schema Elements Explained
3.2.2 Schema Elements Explained
4 Implementation Considerations
5 Appendix A - Document Version History
6 Appendix B – Related Documents
1 Overview
1.1 Objective
The objective of the specification is to provide a schema for organizations and organizational units. Organizations are legally recognized entities such as Company and Subsidiary, and organizational units are internally defined entities like Department, Cost Center, and Project Team.
1.1.1 Domain Issues
References to organizations and organizational units occur throughout HR transactions. For example, companies identify themselves, and positions often “belong” to a department.
1.1.2 Business Reasons
Having standard ways of encoding organizations and organizational units into HR transactions minimizes the effort standards users need to encode and decode references to these objects.
1.2 Design Requirements
· Syntax must be self-documenting
· Schema must be easy to understand and use
· Schema must be usable when detailed descriptions of organizations need to be passed.
· Schema must be usable when minimal descriptions of organizations need to be passed.
- Schema must be deployable in existing HR-XML Schemas.
1.3 Scope
1.3.1 Major Components
· Legal organizational units including for profit companies, non-profit companies, and governmental entities
- Organizational units that are internal to legal units, including departments, project teams, and cost centers
1.3.2 Items Within the Design Scope
- Organizational business, legal, and tax related identifiers used in HR transactions
- Relationships between organizations and their parts
- Documentation of the legal structure of an organization
- People and their roles within and organizational unit
1.3.3 Items Outside the Design Scope
- Schema needed to describe the query, add, modify, and delete actions needed for a complete organization description (i.e. org chart) facility
- Enumeration of all possible organizational structure types in all countries
- Military organizational structures
2 Supported Business Processes
2.1 Vocabulary Requirements
This specification refers to all legally recognized entities as “organizations”. This includes commercial, non-profit, and governmental legal entities. All components of an organization that are not themselves legally recognized entities are considered “organizational units”.
2.2 Trading Partner Roles
Because this is a Cross-Process Object, and not a transaction itself, the roles of trading partners in using this specification will be those of the business processes that pass organizations and organizational units. There are a relatively small number of common patterns for trading partner use of these entities, and these are outlined in the use cases in the next section.
2.3 Usage Examples of Identifiers
2.3.1 Summary
Since we are discussing the general topic of organization usage, rather than documenting a specific business process, we will deal in generalities. There are a limited number of patterns of usage that cover the vast majority of cases. Any real business process will only correspond to a few of these patterns.
2.3.2 Use Case Scenarios
We will examine several different cases that one might like to support.
Passing the name of an organization or organizational unit
Many HR transactions simply require passing the name of an organization. For example, many resumes and CVs contain the names of prior employers. Often no further identification or description of the organization is available or needed.
Some HR transactions simply require passing the name of a department or business unit. For example, many internal job postings contain the names of a department or group. Often no further identification or description is needed.
Passing a reliable identifier of an organization or organizational unit
Many HR transactions between established trading partners simply require passing a previously agreed upon identifier of an organization or organizational unit. For example, payroll feeds may include only an organization’s customer ID to identify the organization that is passing payroll data.
Passing an organization or organizational unit with detailed descriptive information
Some HR transactions involve passing detailed information about a particular organization. For example, when setting up a new client, an outsourcer may require industry classification codes like SIC numbers, size, a high level description of the nature of the business in which the organization is engaged, contact information, locations, etc.
The same holds true for organizational units. For example, an org charting facility may deliver department headcount.
Passing an organization with information about legally related organizations
Some companies are subsidiaries. When passing information about such an organization it may be important to identify the parent organization and the nature of the relationship. This becomes more complex when an organization is the subsidiary of a subsidiary, or is partially owned by more than one other organization. Information about related organizations matters to many HR outsourcers, since they may deliver summary reporting and other services across subsidiaries.
Passing an internal organizational structure
Departments, groups, and teams, are all part of an internal organizational structure. Some HR transactions pass this structure. Internal organizational structures vary widely and can be quite complex. For example, org charting facilities deliver information about organizational units, their relationships to each other, and the roles exist within each of them.
3 DTD/Schema Design
3.1 Organization
3.1.1 Schema Diagram
3.1.2 Schema Elements Explained
|
Component Name [Global types listed at the end of the table.] |
ContentModel* All (minOccurs/maxOccurs) |
Definition |
|
/ |
OrganizationType - S (1/1) OrganizationName
- xsd:string - S
(0/1) |
Contains information about the organization. |
|
/
Organization/ |
- xsd:string - S (0/1) |
The name by which an organization or enterprise is known as established under the laws of a country, state, province or ruling governmental body for the purpose of conducting business transactions. |
|
/
Organization/ |
- EntityIdType - S (0/*) |
Unique identifier for the organization. It may be an internal identifier assigned by the sender. |
|
/
Organization/ |
- EntityIdType - S (0/*) |
A unique externally issued company identifier. |
|
/
Organization/ |
- EntityIdType - S (0/*) |
A unique legal identifier for an entity. |
|
/
Organization/ |
- DunsNumberType - S (0/*) |
A unique identifier issued by Dun and Bradstreet. |
|
/
[OrganizationType]/ |
- xsd:boolean - S (0/1) |
A Boolean value to indicate if the company is publicly held. |
|
/
[OrganizationType]/ |
- StockType - S (0/*) |
Contains
information to uniquely identify the stock for a company. |
|
/
[OrganizationType]/ Stock/ |
- EntityIdType - S (0/1) |
A unique identifier used to reference the entity. The Id is associated with the higher level element. |
|
/
[OrganizationType]/ Stock/ |
- xsd:string - S (0/1) |
A system of letters used to uniquely identify a stock or mutual fund. The ticker symbol for the stock. |
|
/
[OrganizationType]/ Stock/ |
- xsd:string - S (0/1) |
The exchange on which the shares of stock and stock equivalents are bought and sold. |
|
/
[OrganizationType]/ |
- xsd:string - S (0/1) |
A statement defining the mission of an organization. |
|
/
[OrganizationType]/ |
- xsd:string - S (0/1) |
A statement defining the values of an organization. |
|
/ Organization/ |
- InternetDomainNameType - S (0/*) |
This is a domain name intended as a practical identifier for the organization. When used in OrganizationType, it designates a domain typically used for web and e-mail. It is not intended as a web address (URL). It is a string that meets the requirements for domain names as described in the IETF's RFC 1035. Examples include "microsoft.com", "bund.de", "google.com". |
|
/
Organization/ |
- LanguageDependentTextType - S (0/*) |
The name by which an organization or enterprise is commonly known in the capacity of conducting business transactions within a geographical area. |
|
/
Organization/ |
OrganizationLegalClassificationType - S (0/*)
xsd:extension base: xsd:string |
The content of this element is the name of a business structure classification legally recognized in the country designated by the country attribute. Examples include "C Corporation" (in US), "Sole Proprietorship" (in US), "Société Anonyme" (in France), and "Vennootschap onder Firma" (in the Netherlands). |
|
/
[OrganizationLegalClassificationType] / |
- CountryCodeType - |
Contains the ISO 3166-1 two-character country code. |
|
/
[OrganizationLegalClassificationType] / |
- OrganizationLegalOwnershipType - |
An extensible enumeration describing the general ownership type of the organization. The enumeration has the values "Public", "Private", and "Government". It can be extended using strings that start with "x:", for example "x:Quasi-governmental". |
|
/
Organization/ |
- IndustryCodeType - S (0/*) |
A code that specifies the type of industry or industries to which the Organization belongs. |
|
/
Organization/ |
- xsd:nonNegativeInteger - S (0/*) |
A simple total headcount. Composition of headcount is defined by trading partner agreement. More complete treatment of headcount will occur in later version. |
|
/
Organization/ |
- xsd:string - S (0/1) |
Describes additional information about the organization or organizational unit. For example, a mission, purpose or responsibility as it relates to the transaction context. |
|
/
Organization/ |
- WorkSiteType - S (0/*) |
Contains common Work Site information, including name, address special considerations, travel directions, and parking instructions. |
|
/
Organization/ |
OrganizationContactType - S (0/*)
ContactName
- PersonNameType - S
(0/1)
|
The name and contact information for persons within the organization as they are related to the transaction. |
|
/
[OrganizationContactType] / |
- OrganizationContactPurposeType - |
The context the Contact has in the organization for purpose of the transaction. |
|
/
Organization/ ContactInfo/ |
- PersonNameType - S (0/1) |
The name of the person to contact. |
|
/
Organization/ ContactInfo/ |
- EntityIdType - S (0/1) |
Unique identifier for the contact. |
|
/
Organization/ ContactInfo/ |
- ContactMethodType - S (0/1) |
Contact information, such as work or home telephone number. |
|
/
Organization/ |
RelatedOrganizationType - S (0/*) xsd:extension base: OrganizationType |
Allows other organizations to be associated with the organization considered primary for the purpose of the transaction. |
|
/
[RelatedOrganizationType] / |
- OrganizationRelationshipType - |
Describes the relationship between two organizations. Examples include subsidiaries or parent companies. |
|
/
Organization/ |
- OrganizationalUnitType - S (0/*) |
Contains information about a sub-entity or entities within an organization that have no unique legal identification or designation. |
|
/
OrganizationalUnit/ |
- UserAreaType - S (0/*) |
Open Applications Group definition: Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS. HR-XML usage definition: These UserAreas are available at almost every level of the OAGIS payload. They should be used to extend the standard with various SIDES modules as appropriate. |
|
Global simpleTypes: |
|
|
|
/ |
- [Union]: BasicOrganizationRelationshipType,xStringPatternExtensionType |
Globally scoped data type. See element or attribute declaration for definition. |
|
/ |
xsd:restriction base: xsd:string [Enumerations]: Child, Parent, Ultimate Parent, Domestic Parent |
1. Child - Applies to an organization that is directly below the current organization in the relationship hierarchy being described. For example, if the related organization is a subsidiary, it is a Child. 2. Parent - Applies to an organization that is directly above the current organization in the relationship hierarchy being described. For example, if the current organization is a subsidiary, then the related organization of which it is a subsidiary is a Parent. 3. Ultimate Parent - Applies to an organization that is at the root of the relationship hierarchy being described. For example, if the current organization is a subsidiary of a subsidiary of the related organization, and the related organization has no Parent, then the related organization is an Ultimate Parent. 4. Domestic Parent - Applies to an organization that is at the highest level within one country in the relationship hierarchy being described. For example, if the current organization is a subsidiary of a subsidiary of the related organization, and the current organization is in the same country, and the related organization has a Parent outside that country, then the related organization is a Domestic Parent. When a related organization meets the criteria for more than one relationship type, the following precedence should be used to choose which relationship type to use. Precedence order: Child, Parent, Ultimate Parent, Domestic Parent. |
|
/ |
- [Union]: BasicOrganizationLegalOwnershipType,xStringPatternExtensionType |
Globally scoped data type. See element or attribute declaration for definition. |
|
/ |
xsd:restriction base: xsd:string [Enumerations]: Public, Private, Government |
1. Public - Applies when the organization has publicly traded stock. 2. Private - Applies when individuals or other non-governmental organizations own an organization, and the organization does not have publicly traded stock. 3. Government - Applies when an organization is a local, regional, national, or international government. |
|
/ |
- [Union]: BasicOrganizationContactPurposeType,xStringPatternExtensionType |
Globally scoped data type. See element or attribute declaration for definition. |
|
/ |
xsd:restriction base: xsd:string [Enumerations]: Headquarters, Sales, Support, Billing, Legal, Human Resources |
Globally scoped data type. See element or attribute declaration for definition. |
3.2 Organizational Unit
3.2.1 Schema Diagram
3.2.2 Schema Elements Explained
|
Elements and Attributes [Global types listed alphabetically in following table.] |
ContentModel* |
Definition |
|
/ |
- OrganizationalUnitType
- S (0/*) |
Contains information about a sub-entity or entities within an organization that have no unique legal identification or designation. |
|
/ [OrganizationalUnitType] / |
- xsd:string - |
Describes the type of organizational unit. For example, a department, team or branch. |
|
/ [OrganizationalUnitType] / |
- HierarchicalRoleType - |
Describes the way the organizational unit is constructed. A logical organizational unit might be a container for rolled up cost reporting purposes, whereas a functional organizational unit actually has employees and projects associated with it. |
|
/ OrganizationalUnit/ |
- xsd:string - S (0/1) |
The name by which an organizational unit is known as established by its owning organization. |
|
/ OrganizationalUnit/ |
- EntityIdType - S (0/*) |
Unique identifier for the organizational unit. This may be an internal identifier assigned by the sender. |
|
/ OrganizationalUnit/ |
- EntityIdType - S (0/1) |
Unique identifier for the organization. It may be an internal identifier assigned by the sender. |
|
/ OrganizationalUnit/ |
- xsd:string - S (0/1) |
Describes the contextual information
relating to a specific element. |
|
/ OrganizationalUnit/ |
- IndustryCodeType - S (0/*) |
A code that specifies the type of
industry to which the entity belongs. |
|
/ OrganizationalUnit/ |
- AccountingCodeType
- S (0/*) |
Describes a unique code for the purpose of financial tracking, billing or reporting. |
|
/
[AccountingCodeType] / |
- xsd:string - |
This optional attribute is available to provide additional information. |
|
/ OrganizationalUnit/ |
- WorkSiteType - S (0/*) |
Contains common Work Site information, including name, address travel directions, and parking instructions. |
|
/ OrganizationalUnit/ |
- RelatedOrganizationalUnitType
- S (0/*) |
Allows other organizational units to be hierarchically associated with the organizational unit considered primary for the purpose of the transaction. |
|
/ [RelatedOrganizationalUnitType]
/ |
- OrganizationalUnitRelationshipType - |
Describes the nature of the relationship
or connection between two elements or entities. |
|
/ [RelatedOrganizationalUnitType]
/ |
- OrganizationalUnitStructureType - |
Describes the nature of the relationship
between the primary organizational unit and the related one. |
|
/ OrganizationalUnit/ |
- OrganizationalUnitPersonMemberType
- S (0/*) |
Contains information about members of a particular organizational unit in the context of the transaction. |
|
/ OrganizationalUnit/
PersonMember/ |
- PersonNameType - S (0/1) |
The name of a person. |
|
/ OrganizationalUnit/
PersonMember/ |
- EntityIdType - S (0/*) |
A unique identifier for a person. |
|
/ OrganizationalUnit/
PersonMember/ |
- OrganizationalUnitPersonMemberRoleType
- S (0/*) |
Describes the role of the person within the context of that particular organizational unit. |
|
/ [OrganizationalUnit
PersonMemberRoleType] / |
- xsd:boolean - |
Indicates whether the person member's role is one of leadership, in the context of the organizational unit. |
|
/ OrganizationalUnit/
PersonMember/ PersonRole/ |
- xsd:string - S (0/1) |
Descriptive name for the role of the person member. |
|
/ OrganizationalUnit/
PersonMember/ PersonRole/ |
- EntityIdType - S (0/1) |
A unique identifier for the person member's role. |
|
/ OrganizationalUnit/
PersonMember/ PersonRole/ |
- xsd:string - S (0/1) |
Describes the contextual
information relating to a specific element. |
|
/ OrganizationalUnit/
PersonMember/ |
- ContactMethodType - S (0/*) |
Defines the methods of contacting
a person or organizations. |
|
/ OrganizationalUnit/ |
- UserAreaType - S (0/1) |
Allows the user to extend the specification in order to provide additional information that is not captured in the standard. |
|
Global
types |
ContentModel* |
Definition |
|
/ |
- [Union]: BasicHierarchicalRoleType, xStringPatternExtensionType |
Globally scoped data type. See element or attribute declaration for definition. |
|
/ |
xsd:restriction base: xsd:string [Enumerations]: Functional, Logical |
Globally scoped data type. See element or attribute declaration for definition. |
|
/ |
- [Union]: BasicOrganizationalUnitRelationshipType, xStringPatternExtensionType |
Globally scoped data type. See element or attribute declaration for definition. |
|
/ |
xsd:restriction base: xsd:string [Enumerations]: Child, Sibling, Parent, Ultimate Parent |
Globally scoped data type. See element or attribute declaration for definition. |
|
/ |
- [Union]: BasicOrganizationalUnitStructureType, xStringPatternExtensionType |
Globally scoped data type. See element or attribute declaration for definition. |
|
/ |
xsd:restriction base: xsd:string [Enumerations]: Reporting, Legal, Fiduciary, Structural, Project |
Globally scoped data type. See element or attribute declaration for definition. |
4 Implementation Considerations
All elements in the schemas are optional; this provides the maximum flexibility for reuse. Receiving systems must perform their own integrity checking and validation.
5 Appendix A - Document Version History
|
Date |
Description |
|
2003-Feb-26 |
Approved recommendation by HR-XML Consortium. The default and targetNamespaces of all HR-XML schemas have been standardized to "http://ns.hr-xml.org". This recommendation is available as part of the HR-XML 2_0 architecture. |
|
2004-Jun-07 |
Bug Fix. Added description attribute to AccountingCode. Changed structure to a global type. |
|
2005-Aug-09 |