HR-XML 3.0 Standards, 2009 September 23.
Menu: [ Guidelines | BODs | Nouns | Global Elements | WSDL | Packages | Code Lists | Master Index ]
Table of Contents
- Package Summaries
- Package Name: AssessmentCatalog_SupplierPackage
- Package Name: AssessmentCatalog_RequesterPackage
- Package Name: AssessmentOrder_SupplierPackage
- Package Name: AssessmentReport_RequesterPackage
- Package Name: Candidate_RequesterPackage
- Package Name: Candidate_SupplierPackage
- Package Name: CompetencyDefinitions_RelyingSystemPackage
- Package Name: DevelopmentPlan_RelyingSystemPackage
- Package Name: EPMParticipant_EPMSystemPackage
- Package Name: EPMResult_RelyingSystemPackage
- Package Name: HRMasterData_RelyingSystemPackage
- Package Name: HRMasterData_SystemOfRecordPackage
- Package Name: IndicativeData_RelyingSystemPackage
- Package Name: IndicativeData_SystemOfRecordPackage
- Package Name: ObjectivesPlan_RelyingSystemPackage
- Package Name: ObjectivesResult_RelyingSystemPackage
- Package Name: OrganizationChart_RelyingSystemPackage
- Package Name: OrganizationChart_SystemOfRecordPackage
- Package Name: PositionCompetencyModel_RelyingSystemPackage
- Package Name: PositionOpening_JobBoardPackage
- Package Name: SavingsPlan_InvestmentCompanyPackage
- Package Name: Screening_SupplierPackage
- Package Name: Screening_RequesterPackage
- Package Name: ScreeningPackage_SupplierPackage
- Package Name: ScreeningPackage_RequesterPackage
- Package Name: StaffingOrder_SupplierPackage
- Package Name: StaffingOrder_RequesterPackage
- Package Name: StaffingResource_SupplierPackage
- Package Name: StaffingResource_RequesterPackage
- Package Name: StaffingAssignment_SupplierPackage
- Package Name: StaffingAssignment_RequesterPackage
- Package Name: StockOptionExerciseOrder_BrokerPackage
- Package Name: StockOptionGrant_SystemOfRecordPackage
- Package Name: StockOptionProgram_RelyingSystemPackage
- Package Name: StockSaleConfirmation_RelyingSystemPackage
- Package Name: StockPlanMaintenance_PlanAdministratorPackage
- Package Name: TimeCard_RelyingSystemPackage
- Package Name: TimeCard_SystemOfRecordPackage
- Package Name: USEnrollment_SystemOfRecordPackage
- Package Name: USEnrollment_RelyingSystemPackage
- Package Name: UserAccount_SystemOfRecordPackage
The following are a list of "Packages". Each of these "Packages" combine several schemas into a single flattened schema. They were prepared in contemplation of common or typical services implementers may want to support. Each package contains an example WSDL that may be used as a starting point for implementers deploying related services. You may browse and download individual packages from the sections below, or download all of them in a distribution file.
Note
HR-XML packages currently are specified using a very simple request-response message exchange pattern (MEP). This type of MEP most clearly represents the business intentions associated with message exchange. However, services may be designed with many different MEP approaches based on the business requirements associated with particular implementations. Thus, the packages provided within the library are intended as illustrative starting points for service compositions customized around the particular requirements of trading partners.
Description: A service that an assessment supplier would host to handle requests to retrieve assessment catalog content. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
GetAssessmentCatalog.xsd;
ShowAssessmentCatalog.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part II, “Assessments”
Description: A service that an assessment requester would host to be supplied with new and changed assessment catalog content. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncAssessmentCatalog.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part II, “Assessments”
Description: A service that an assessment supplier would host to process assessment orders and cancelations. Also includes an operation to fulfill an order through retrieval of an assessment report. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
ProcessAssessmentOrder.xsd;
AcknowledgeAssessmentOrder.xsd;
CancelAssessmentOrder.xsd;
GetAssessmentReport.xsd;
ShowAssessmentReport.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part II, “Assessments”
Description: A service that an assessment customer or requester would host to be notified of test results when ready. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
NotifyAssessmentReport.xsd;
AcknowledgeAssessmentReport.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part II, “Assessments”
Description: A service that an applicant tracking system or recruiting system would host to handle "Sync" and "Notify" operations with a candidate supplier, such as a job board. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncCandidate.xsd;
NotifyCandidate.xsd;
AcknowledgeCandidate.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part VI, “Recruiting”
Description: A service that a job board or other candidate source would host to handle "read" requests for candidate data. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
GetCandidate.xsd;
ShowCandidate.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part VI, “Recruiting”
Description: A service that a relying system would host to handle "Sync" operations with a system of record. The system of record would be the supplier of the competency content whereas the relying system might be another talent management system (recruiting, employee performance management, etc.). This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncCompetencyDefinitions.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part IV, “Talent Management Provisioning”
Description: A service that a talent management or learning management system would host to handle "Sync" operations with a system of record for a development or learning plan. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncDevelopmentPlan.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part V, “Employee Performance Management”
Description: A service that an employee performance management (EPM) system or other talent management system would host to handle "Sync" operations with a core HR system. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncEPMParticipant.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part IV, “Talent Management Provisioning”
Description: A service that a talent management or learning management system would host to handle "Sync" operations with an employee performance management system or other system of record. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncEPMResult.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part V, “Employee Performance Management”
Description: A service that a "relying system" would host to handle "Sync" operations with a system of record. Enables a system such as a core HR system to sync HR master data with other systems. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncHRMasterData.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part III, “Provisioning HR, Benefits, and Payroll Systems”
Description: A service that a system of record would host to handle data management requests regarding HR master data from a relying system (a system that is not the owner of the data). This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
ProcessHRMasterData.xsd;
AcknowledgeHRMasterData.xsd;
GetHRMasterData.xsd;
ShowHRMasterData.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part III, “Provisioning HR, Benefits, and Payroll Systems”
Description: A service which enables a system of record, such as a core HR system, to sync indicative data with a relying system, such as a payroll or benefits outsourcer. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncIndicativeData.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part III, “Provisioning HR, Benefits, and Payroll Systems”
Description: A service that a system of record, such as a core HR system, would host to handle data management requests from a relying system, such as a payroll or benefits outsourcer. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
ProcessIndicativeData.xsd;
AcknowledgeIndicativeData.xsd;
GetIndicativeData.xsd;
ShowIndicativeData.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part III, “Provisioning HR, Benefits, and Payroll Systems”
Description: A service that a talent management or learning management system would host to handle "Sync" operations with an objectives-management system of record, for example an employee performance management system. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncObjectivesPlan.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part V, “Employee Performance Management”
Description: A service that a talent management or learning management system would host to handle "Sync" operations with an objectives-management system of record, for example an employee performance management system. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncObjectivesResult.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part V, “Employee Performance Management”
Description: A service that a relying system would host to "Sync" organization chart data with a system of record. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncOrganizationChart.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part IV, “Talent Management Provisioning”
Description: A service that a system of record would host to handle "read" requests for organization chart data from a relying system. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
GetOrganizationChart.xsd;
ShowOrganizationChart.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part IV, “Talent Management Provisioning”
Description: A service that a relying system would host to handle "Sync" operations with a system of record. The system of record would be the supplier of position competency model content whereas the relying system might be another talent management system (recruiting, employee performance management, etc.). This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncPositionCompetencyModel.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part IV, “Talent Management Provisioning”
Description: A service that a job board or similar system would host to handle requests relating to the processing of position openings. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
ProcessPositionOpening.xsd;
CancelPositionOpening.xsd;
AcknowledgePositionOpening.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part VI, “Recruiting”
Description: This is a service that might be hosted by an investment company (or other firm managing savings plan accounts) to process and manage savings plan enrollments. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
ProcessSavingsPlanEnrollment.xsd;
AcknowledgeSavingsPlanEnrollment.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part VII, “Savings Plans”
Description: A service that a screening supplier would host to process and manage order requests and read operations from customers. Note that an incoming order often would be disaggregated upon receipt into component screenings (driver motor vehicle records, criminal records, employment verification, etc.), which might be separately fulfilled. So for any ScreeningOrder, there may be multiple associated ScreeningReport messages. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
ProcessScreeningOrder.xsd;
AcknowledgeScreeningOrder.xsd;
CancelScreeningOrder.xsd;
GetScreeningReport.xsd;
ShowScreeningReport.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part VIII, “Screening (Background Checks)”
Description: A service that a screening requester would host to handle "Notify" operations with a screening service provider. Note that a ScreeningOrder often would be disaggregated upon receipt into component screenings (driver motor vehicle records, criminal records, employment verification, etc.), which might be separately fulfilled when complete. So for any ScreeningOrder, there may be multiple associated ScreeningReport messages. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
NotifyScreeningReport.xsd;
AcknowledgeScreeningReport.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part VIII, “Screening (Background Checks)”
Description: This uses the ScreeningPackageOrder and ScreeningPackageReport nouns. A service that a screening supplier would host to process and manage order requests and read operations from customers. Note that an incoming order often would be disaggregated upon receipt into component screenings (driver motor vehicle records, criminal records, employment verification, etc.), which might be separately fulfilled. So for any ScreeningOrder, there may be multiple associated ScreeningReport messages. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
ProcessScreeningPackageOrder.xsd;
AcknowledgeScreeningPackageOrder.xsd;
CancelScreeningPackageOrder.xsd;
GetScreeningPackageReport.xsd;
ShowScreeningPackageReport.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part VIII, “Screening (Background Checks)”
Description: This uses the ScreeningPackageOrder and ScreeningPackageReport nouns. A service that a screening requester would host to handle "Notify" operations with a screening service provider. Note that a ScreeningOrder often would be disaggregated upon receipt into component screenings (driver motor vehicle records, criminal records, employment verification, etc.), which might be separately fulfilled when complete. So for any ScreeningOrder, there may be multiple associated ScreeningReport messages. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
NotifyScreeningPackageReport.xsd;
AcknowledgeScreeningPackageReport.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part VIII, “Screening (Background Checks)”
Description: A service that a staffing supplier would host to process "request for quotes" (RFQ), quotes, and staffing orders. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios. Note: StaffingRFQ and StaffingQuote use the StaffingOrder noun with a StaffingOrderTypeCode to differentiate the type of order.
BODs included:
ProcessStaffingOrder.xsd;
AcknowledgeStaffingOrder.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part IX, “Staffing”
Description: A service that a staffing customer or requester would host to handle responses to "request for quotes" (RFQ), and to receive quotes. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios. Note: StaffingRFQ and StaffingQuote use the StaffingOrder noun with a StaffingOrderTypeCode to differentiate the type of order.
BODs included:
NotifyStaffingOrder.xsd;
AcknowledgeStaffingOrder.xsd;
ProcessStaffingOrder.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part IX, “Staffing”
Description: A service that a staffing supplier would host to handle interactions following or related to the submission of proposed staffing resources to fill a staffing customer requisition. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios. Note: StaffingAction is not included in this 3.0 release and is only used here to describe one possible business interaction.
BODs included:
NotifyStaffingResource.xsd;
AcknowledgeStaffingResource.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part IX, “Staffing”
Description: A service that a staffing customer or intermediary system would host to manage submissions by staffing suppliers of proposed staffing resources. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios. Note: StaffingAction is not included in this 3.0 release and is only used here to describe one possible business interaction.
BODs included:
ProcessStaffingResource.xsd;
AcknowledgeStaffingResource.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part IX, “Staffing”
Description: A service that a staffing supplier would host to handle interactions following or related to a staffing assignment with a staffing customer. The StaffingAssignment sets out the terms under which a resource will fill a requisition. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
NotifyStaffingAssignment.xsd;
AcknowledgeStaffingAssignment.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part IX, “Staffing”
Description: A service that a staffing customer or intermediary system would host to manage assignment documents submitted by staffing suppliers. The StaffingAssignment sets out the terms under which a resource will fill a requisition. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
ProcessStaffingAssignment.xsd;
AcknowledgeStaffingAssignment.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part IX, “Staffing”
Description: A service that a broker would host to manage stock option exercise orders from an employer or stock plan administrator system. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
ProcessStockOptionExerciseOrder.xsd;
AcknowledgeStockOptionExerciseOrder.xsd;
CancelStockOptionExerciseOrder.xsd;
GetStockOptionExerciseConfirmation.xsd;
ShowStockOptionExerciseConfirmation.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part X, “Stock”
Description: A service that the stock option plan administrator or record keeper would host to manage stock option grants created by the sponsoring company. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
ProcessStockOptionGrant.xsd;
CancelStockOptionGrant.xsd;
AcknowledgeStockOptionGrant.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part X, “Stock”
Description: A service that relying systems would use to handle "Sync" operations with the program administrator or system of record. There are a variety of actors that participate in stock option programs that require current program data to carry out their respective roles within the program. These actors are not the owners or maintainers of such data, but rely upon it. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncStockPlan.xsd;
SyncStockPlanParticipant.xsd;
SyncStockOptionGrant.xsd;
SyncStockOptionExerciseConfirmation.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part X, “Stock”
Description: A service that relying systems would use to handle "Sync" operations with the program administrator or system of record. An Employee Stock Purchase Plan participant may deal in his or her stock directly with the broker. This type of direct interaction is outside the scope of HR-XML's stock plan specifications. However, in some contexts it may be necessary for the broker to report certain stock dispositions back to the stock plan administrator. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncStockSaleConfirmation.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part X, “Stock”
Description: A service that a plan administrator/record keeper would use to process new and updated stock plan and participant data from an employer system. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
ProcessStockPlan.xsd;
ProcessStockPlanParticipant.xsd;
GetStockPlanParticipant.xsd;
ShowStockPlanParticipant.xsd;
AcknowledgeStockPlan.xsd;
AcknowledgeStockPlanParticipant.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part X, “Stock”
Description: A service that a relying system would host (one that did not own or serve as the authoritative source of time card data) to sync time card data with the time card data system of record. This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncTimeCard.xsd;
NotifyTimeCard.xsd;
AcknowledgeTimeCard.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part XI, “Time Card”
Description: A service that a system of record would host (one that owns or serves as the authoritative source of time card data). This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
ProcessTimeCard.xsd;
AcknowledgeTimeCard.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part XI, “Time Card”
Description: A service that a system of record would host (the plan record keeper or system that serves as the authoritative source of enrollment data). This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
ProcessUSEnrollment.xsd;
AcknowledgeUSEnrollment.xsd;
GetUSEnrollment.xsd;
ShowUSEnrollment.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part XII, “US Enrollment”
Description: A service that a relying system would host (for example, a carrier working with a plan administrator). This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
SyncUSEnrollment.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part XII, “US Enrollment”
Description: A service that a system of record would host to handle data management requests related to user accounts from a relying system. For example, an applicant tracking system may request adds, deletes, and changes to users (hiring managers, HR staff) of a partner system (for example, a screening service provider). This package includes a collection of BODs in a single, flattened schema with an accompanying WSDL. It is intended as a pre-packaged resource to support common integration scenarios.
BODs included:
ProcessUserAccount.xsd;
AcknowledgeUserAccount.xsd;
GetUserAccount.xsd;
ShowUserAccount.xsd;
ConfirmBOD.xsd.
Download in the Standalone distribution files:
Related documentation: Part III, “Provisioning HR, Benefits, and Payroll Systems”