GetPersonnel schema, example, validation rules, validation stylesheet

GetPersonnel type: GetPersonnel

The purpose of the GetPersonnel is to request Personnel data for a worker.

GetPersonnel extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetPersonnelDataArea

Is where the information that the BOD message carries is provided, in this case GetPersonnel. The information consists of a Verb and one or more Nouns. The verb (Get) indicates the action to be performed on the Noun (Personnel).

GetPersonnelDataArea extends: DataArea
Structure:
Elements:
Name Type Description
Get reference
Personnel reference

GetPersonnel Scenario Diagram

Get schema

Get type: Get

The GET verb is to communicate to a business software component a request for an existing piece of information to be returned. The GET may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the SHOW verb. The behavior of a BOD with a GET verb is quite predictable across most of the nouns it may be paired with.The GET is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The GET verb is not used to request several documents at once. The GETLIST verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the GET verb.1) The first selection capability is called Field-Based Selection. Within a GET-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for GET-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the GET verb. The Data Types are identified for retrieval within the GET instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the GET request and this will signify to the responding component that the Data Type is not to be returned.

Get extends: RequestVerb
Structure:
Attributes:
Name Type Usage Description
show xs:string

Personnel schema

Personnel type: Personnel

Personnel extends: Noun

Personnel information is the human resource information maintained for each employee. It includes such data as job code, employee status, department or place in the organization, and job-related skills. Although generally maintained in a Human Resource Management System (HRMS), this information may also be needed and updated by manufacturing applications (workforce scheduling) or project management (resource allocation).

Structure:
Elements:
Name Type Description
Attachments reference
EffectivePeriod TimePeriodAny

Indicates the time in which the person works for the company. Typically the Start date is date in which the persons employment is effective and the Finish date is the the date in which the employee is terminated.

Employee reference
EmployeeAssignment reference

JobCode Code

Grouping of similar job descriptions

Base type for a Code of any kind

Note reference

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

OverTimeEligibleInd Indicator

This indicates if the personnel is eligible to work overtime

Indicates if the semantic name is needed or not.

Restriction Restriction

This indicates any limitations to complete a job assignment based on physical, mental, legal or any other conditions

UserArea reference

Verb Common Files

Verb.xsd schema

AcknowledgableVerb extends: ConfirmableVerb
Structure:
Attributes:
Name Type Usage Description
acknowledge AcknowledgementType

AcknowledgementType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

ConfirmableVerb extends: Verb
Structure:
Attributes:
Name Type Usage Description
confirm ConfirmType

ConfirmType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

Expression restricts: xs:string

ExpressionCriteria
Structure:
Elements:
Name Type Description
SelectExpression Expression

Allows the 1-n number of selection expressions for the information to be returned.

Attributes:
Name Type Usage Description
expressionLanguage xs:string optional

RequestVerb extends: ConfirmableVerb
Structure:
Elements:
Name Type Description
ReturnCriteria

Allows the initator of the BOD to indicate the information (down to the field level) that is requested to be returned. The expressionLanguage indicates the expression language being used.

VerbBase.xsd schema

Verb type: Verb

Verb
Structure:

Noun Common Files