Position Opening Adapter

Transcription

1 Position Opening Adapter

2 Position Opening Adapter Contents Position Opening Adapter 2 Commercial In Confidence 3 Position Opening Adapter 4 Overview 4 Events 4 OAGIS Message 4 Foreign Keys 5 Concurrent Updates 5 Methods 5 Get 5 Get Message Mapping 5 Notes 5 Show Message Mapping 5 Message Examples 8 Get 8 Show 9

3 Commercial In Confidence Copyright 2018 ABB All Rights Reserved Confidential and Proprietary Legal Disclaimer The product described in this documentation may be connected to, and/or communicate information and data via, a network interface, which should be connected to a secure network. It is your sole responsibility to ensure a secure connection to the network and to establish and maintain appropriate measures (such as but not limited to the installation of firewalls, application of authentication measures, encryption of data, installation of antivirus programs, etc.) to protect the product, the network, your systems, and the interface against any kind of security breach, unauthorised access, interference, intrusion, leakage, damage, or corruption or theft of data. We are not liable for damages or losses related to any such security breach, unauthorised access, interference, intrusion, leakage, damage, or corruption or theft of data.

4 Position Opening Adapter Overview Positions define roles within the hierarchy of an organisation. When a profile of the optimum work force is built, position requirements are used to declare the resource types (skills, etc.) required for position occupants. Each resource type may have a competency level associated with it, as well as an indicator of whether or not it is mandatory. This information is used as a comparison for new recruits, to determine training where a skills gap is revealed, and as a basis for succession and development of employees. Positions have two other important aspects: Security profiles are attached to positions. Positions may have multiple incumbents, and employees can occupy more than one position. Employees may be assigned a Primary position, and may also have secondary and higher duty positions. The occupant of a position inherits the security and authorisation characteristics of that position. For example, authority levels are set for each position, with a number of criteria governing items such as the upper and lower limit, the level of checking and who it is referred to for authorisation if not passed at this level. When an employee is attached to a position, it is possible to grant a percentage of the authority level that this particular employee is entitled to exercise. Also, an employee can be provided with a security profile that overrides the position profile, if needed. Partial authorities can be recorded, where appropriate. This is best illustrated in the situation where an employee relieves in a position for a percentage of their time. The employee still performs his or her own duties but is authorised to perform some of the relieving position duties and a percentage of the authority levels. For the Position Opening adapter, the Ellipse business elements outlined below can be accessed: Position The information contained within the position entity covers: Attributes Reporting Codes Authorities Details Evaluation Details Duties Selection Criteria Requirements Context Objectives Note To obtain Requirements (Competencies) related to a Position, refer to the Position Requirements adapter. The OAGIS request messages to be processed by the Position adapter will be obtained from the MIB.COMMMON.GW queue. The OAGIS response messages returned from the Position adapter will be output to the MIB.COMMON.REPLY queue. Events Where the property mib.positionhierarchy.eventsenabled is set to true (refer EIP Console, Runtime menu, Configuration option), event processing will be handled for Position data. The event processing will be triggered by a change to the Position table (MSF870). The specific change will be where the Position table has a record created or updated. An event message for the Position table will be generated and passed to EIP. EIP maintains the named subscription Position1 under the EllipseServices topic to process these event messages. This will result in GetPositionOpening messages being generated and processed for the specified Position, with ShowPositionOpening messages then being output to the queue MIB.Common.Reply, for consumption by an external system. OAGIS Message PositionOpening noun The OAGIS standard DOES NOT contain any suitable nouns to represent Ellipse Positions. Therefore the following noun has been created: PositionOpening

5 The OAGIS verbs get and show will be supported. Foreign Keys N/A Concurrent Updates The potential exists for Position entity attributes to be updated by both Ellipse and the 3rd party system. In these cases, the last update wins, meaning if the 3rd party system sends updates after Ellipse has performed an update, the 3rd party system updates will be applied (and vice versa). Methods Get The get method calls the following Ellipse services to process the data passed: Position A specific Position Id value can be provided (Ellipse Id). In this case the Position service will read the database for the specified Id value. Note Any other search criteria provided will NOT be used. General search criteria can also be provided. In this case the Position service will search the database using the specified criteria. For each Position returned, the related details from the Position file (MSF870) will be returned. Get Message Mapping Mapping of ABB GetPositionOpening message attributes to Ellipse web service: Field Description Validation Service Attribute <DocumentID> <ID>string Position Id value. Position position </DocumentID> <ChangedSince>Date Last modified date. lastrundatetime Notes Multiple Position Entries Multiple Position search requests can be processed via a single GetPositionOpening message. Use of this facility though is not recommended practice. Processing multiple Position search requests in a single GetPositionOpening message will elongate the time taken to process the message. This can lead to adapter processing times exceeding the Ellipse transaction timeout period, causing the message processing to fail. Where that occurs no Show response message will be returned. In addition large result sets will result in large XML messages which will impact the amount of memory available for the JVM, this can then result in server processing failures. Search Limit Where a search is required to return all matching position entries for the specified search criteria, the result set will be limited to a specified number. The number is set via the property ellipse.defaultmaxinstances (refer EIP Console, Runtime > Configuration). This property applies to search processing for all adapters. As per Multiple Position Entries, large result sets will result in large XML messages which will impact the amount of memory available for the JVM, this can then result in server processing failures. Show Message Mapping Mapping of ABB ShowPositionOpening message attributes to Ellipse web service: Field Service Attribute <DocumentID> <ID>string Position position <Status> <Code>string status statusdesc </Status> <EffectiveTimePeriod> <ValidFrom>Date effectivedate

6 <ValidTo>Date reviewdate </EffectiveTimePeriod> <PostingRequester> <PartyID>String approvedby <PartyName>String approvedbyname </PostingRequester> <PositionProfile> position <JobCategoryCode name=occupationcodedesc>string occupationcode <JobGradeCode name=salarygradedesc>string salarygrade <OfferedRemunerationPackage> <RemunerationRange> <RemunerationMaximumAmount>String maximumsalary <RemunerationMinimumAmount>String minimumsalary <MinimumRate> minimumratedesc <Frequency>String minimumratefreq <Reference>String minimumrateref <Value>String minimumratevalue </MinimumRate> <MaximumRate> maximumratedesc <Frequency>String maximumratefreq <Reference>String maximumrateref <Value>String maximumratevalue </MaximumRate> </RemunerationRange> <RemunerationEvaluation> <MidPoint>String salarymidpoint <MinimumSalary> salarymin <MaximumSalary> salarymax <PolicyLine>String policyline <PolicyLineDesc>String policylinedesc </RemunerationEvaluation> </OfferedRemunerationPackage> <OfficialPositionClassification> <USPositionClassification> <AffirmativeActionPlanJobGroupID name=jobgroupdesc>string jobgroup <EEOCJobCategoryCode name=eeocjobcatdesc>string eeocjobcategory </USPositionClassification> </OfficialPositionClassification> <PositionLocation> <LocationID>String worklocation <LocationName>String worklocationdesc <FaxNumber>String faxnumber <MobileNumber>String mobilephone <WorkExtension>String workextension <WorkNumber>String workphone <PayLocation> paylocation paylocationdesc </PayLocation> </PositionLocation> <PositionTitle>String positiontitle <AssociatedPosition id="1"> Position assocposition1 assocposition1title </AssociatedPosition> <AssociatedPosition id="2"> assocposition2 assocposition2title </AssociatedPosition> <AwardCode name=awardcodedesc>string awardcode <Classification number=1-8> (populated from PostionClass fields 1 through 8) <ClassificationCode>String positionclass1 -> positionclass8 <ClassificationDescription>String positionclassdesc1 -> positionclassdesc8 <ClassificationName>String positionclassname1 -> positionclassname8 </Classification> <Defaults> <Distribution> <EnterpriseUnit>

7 <CostCenterID name=defaultaccountdesc>string defaultaccountcode </EnterpriseUnit> </Distribution> <DocumentReference> <DocumentID> defaultworkorder </DocumentID> defaultworkorderdesc </DocumentReference> <PlantReference> defaultplantref defaultplantdesc </PlantReference> <Project> defaultproject defaultprojectdesc </Project> <Reference>String defaultreference <SLCode> defaultslcode <Description> defaultsldesc </SLCode> </Defaults> <Distribution> <EnterpriseUnit> <GLEntityID name=labourcostingdistrictdesc>string labourcostingdistrict </EnterpriseUnit> <HomeCostCenter name=homecostcenterdesc>string homecostcentre <LabourClass name=labourclassdesc>string labourclass <LabourCost>String incumblabourcostind </Distribution> <EntitlementID>string entitlementidescription <Evaluation> <EvaluationFactor number=1-8> (up to 8 occurrences) <CodeA>String evalfactorcodea1 -> evalfactorcodea8 <CodeB>String evalfactorcodeb1 -> evalfactorcodeb8 <CodeC>String evalfactorcodec1 -> evalfactorcodec8 <Points>String evalfactorpoints1 -> evalfactorpoints8 <UserDefined>String evalfactoruserdef1 -> evalfactoruserdef8 </EvaluationFactor> <Notes>String evalstdtextref <Reason name=evaluationreasondesc>string evaluationreason <RecentEvaluationDate>String evaluationdate <TotalPoints>String evaltotalpoints </Evaluation> <Incumbents> <Actual>String currentactualincumbents <Authorised>String currentauthorisedincumbents <Budget>String currentbudgetincumbents </Incumbents> <Notes>String genstdtextref <Occupancy> <Reason name=occupancyreasondesc>string occupancyreason <Status name=occupancystatusdesc>string occupancystatus <Strategy name=occupancystrategydesc>string occupancystrategy </Occupancy> <Occupation> <Type>String occupationtype occupationtypedesc </Occupation> <PerformanceAppraisal>string perfappraisal <PositionCategory name=positioncategorydesc>string positioncategory <PositionReference>string reference <PositionReportingCode number=9-18> (populated from PostionClass fields 9 through 18) <ReportingCode>String positionclass9 -> positionclass18 <ReportingCodeDescription>String positionclassdesc9 -> positionclassdesc18 <ReportingCodeName>String positionclassname9 -> positionclassname18 </PositionReportingCode> <PrimaryReportingCode>String primrepcode <ResourceType>String resourcetypes <StaffCategory name=staffcategorydesc>string staffcategory </PositionProfile> <EffectiveTimePeriod> <ValidFrom>Date detaileffdate </EffectiveTimePeriod> <StatusReason>

8 <Code>String </StatusReason> statusreason statusreasondesc Message Examples Get Obtain details for a specific Position Id: <?xml version="1.0" encoding="utf-8"?> <GetPositionOpening xmlns:xsi=" xmlns:ip=" xsi:nonamespaceschemalocation="file:///c:/git-clones/mib/mib-common/schema/ip/1_0_0/bods/getpositionopening.xsd"> <ApplicationArea> <ip:sender> <ip:logicalid>testing</ip:logicalid> <ip:taskid>getpositionopening</ip:taskid> <ip:referenceid>positionopening</ip:referenceid> </ip:sender> <ip:creationdatetime> t11:17:03</ip:creationdatetime> <ip:bodid>junit Test</ip:BODID> <ip:extension> <ip:anyextension> <ip:servicecontext> <ip:servicename>getpositionopening</ip:servicename> <ip:serviceversion>1.0</ip:serviceversion> <ip:messagetype>positionopening</ip:messagetype> </ip:servicecontext> <ip:authorizationcontext> <ip:proxy> <ip:userid>integrat</ip:userid> <ip:orgid>r100</ip:orgid> <ip:role>integrat</ip:role> </ip:proxy> </ip:authorizationcontext> </ip:anyextension> </ip:extension> </ApplicationArea> <DataArea> <Get/> <PositionOpening> <!-- Position Id --> <DocumentID> <ID>SYSAD</ID> </DocumentID> </PositionOpening> </DataArea> </GetPositionOpening> Obtain Positions changed since last extract: <?xml version="1.0" encoding="utf-8"?> <GetPositionOpening xmlns:xsi=" xmlns:ip=" xsi:nonamespaceschemalocation="file:///c:/git-clones/mib/mib-common/schema/ip/1_0_0/bods/getpositionopening.xsd"> <ApplicationArea> <ip:sender> <ip:logicalid>testing</ip:logicalid> <ip:taskid>getpositionopening/ip:taskid> <ip:referenceid>positionopening</ip:referenceid> </ip:sender> <ip:creationdatetime> t11:17:03</ip:creationdatetime> <ip:bodid>junit Test</ip:BODID> <ip:extension> <ip:anyextension> <ip:servicecontext> <ip:servicename>getpositionopening</ip:servicename> <ip:serviceversion>1.0</ip:serviceversion> <ip:messagetype>positionopening</ip:messagetype> </ip:servicecontext> <ip:authorizationcontext> <ip:proxy>

9 <ip:userid>integrat</ip:userid> <ip:orgid>r100</ip:orgid> <ip:role>integrat</ip:role> </ip:proxy> </ip:authorizationcontext> </ip:anyextension> </ip:extension> </ApplicationArea> <DataArea> <Get/> <PositionOpening> <!-- Last Modified Date --> <ChangedSince> </ChangedSince> </PositionOpening> </DataArea> </GetPositionOpening> Show Show details for a requested Position Id: <?xml version="1.0" encoding="utf-8"?> <ShowPositionOpening xmlns:ip=" xmlns:xsi=" xsi:nonamespaceschemalocation="file:///c:/git-clones/mib/mib-common/schema/ip/1_0_0/bods/showpositionopening.xsd"> <ApplicationArea> <ip:sender> <ip:logicalid>ellipse</ip:logicalid> <ip:componentid>positionopening</ip:componentid> <ip:taskid>showpositionopening/ip:taskid> <ip:referenceid>getresponse</ip:referenceid> <ip:authorizationid/> </ip:sender> <ip:receiver> <ip:logicalid/> </ip:receiver> <ip:creationdatetime> t15:12:10</ip:creationdatetime> <ip:bodid>10af832d-ca53-4f3f-9fbc-576eb64b3567</ip:bodid> <ip:extension> <ip:anyextension> <ip:servicecontext> <ip:servicename>showpositionopening</ip:servicename> <ip:serviceversion>1.0</ip:serviceversion> <ip:messagetype>positionopening</ip:messagetype> </ip:servicecontext> <ip:authorizationcontext> </ip:authorizationcontext> </ip:anyextension> </ip:extension> </ApplicationArea> <DataArea> <Show> <oa:responsecriteria xmlns:oa=" <oa:responseexpression expressionlanguage="xpath" actioncode="accepted">[*]</oa:responseexpression> <oa:changestatus> <oa:code>ok</oa:code> <oa:description>retrieved 1 positions.</oa:description> <oa:reasoncode>getposition</oa:reasoncode> <oa:reason/> </oa:changestatus> </oa:responsecriteria> </Show> <PositionOpening> <DocumentID> <ID>SYSAD</ID> </DocumentID> <Status> <Code/> </Status> <EffectiveTimePeriod> <ValidFrom> </ValidFrom> <ValidTo/> </EffectiveTimePeriod> <PostingRequester> <PartyID/> <PartyName/> </PostingRequester> <PositionProfile> <ID>SYSAD</ID> <JobCategoryCode name=""/> <JobGradeCode name=""/> <OfferedRemunerationPackage> <RemunerationRange> <RemunerationMaximumAmount>0</RemunerationMaximumAmount> <RemunerationMinimumAmount>0</RemunerationMinimumAmount> <MinimumRate> <Frequency/> <Reference/> <Value>0</Value> </MinimumRate> <MaximumRate> <Frequency/> <Reference/> <Value>0</Value> </MaximumRate> </RemunerationRange> <RemunerationEvaluation>

10 <RemunerationMidPoint>0</RemunerationMidPoint> <MinimumSalary>0</MinimumSalary> <MaximumSalary>0</MaximumSalary> <PolicyLine/> <PolicyLineDesc/> </RemunerationEvaluation> </OfferedRemunerationPackage> <OfficialPositionClassification> <USPositionClassification> <AffirmativeActionPlanJobGroupID name=""/> <EEOCJobCategoryCode name=""/> </USPositionClassification> </OfficialPositionClassification> <PositionLocation> <LocationID/> <LocationName/> <FaxNumber/> <MobileNumber/> <WorkExtension/> <WorkNumber/> <PayLocation> </PayLocation> </PositionLocation> <PositionTitle>SYSTEM ADMINISTRATOR</PositionTitle> <AssociatedPosition id="1"> </AssociatedPosition> <AssociatedPosition id="2"> </AssociatedPosition> <AwardCode name=""/> <Classification number="1"> <ClassificationCode>AA01</ClassificationCode> <ClassificationDescription>Expenses</ClassificationDescription> <ClassificationName>Job/Posn Classif</ClassificationName> </Classification> <Classification number="2"> <ClassificationCode>Y</ClassificationCode> <ClassificationDescription>Yes</ClassificationDescription> <ClassificationName>Job/Posn Classif</ClassificationName> </Classification> <Classification number="3"> <ClassificationCode>B0635</ClassificationCode> <ClassificationDescription>Building Trades Public Sector</ClassificationDescription> <ClassificationName>Job/Posn Classif</ClassificationName> </Classification> <Defaults> <Distribution> <EnterpriseUnit> <CostCenterID name=""/> </EnterpriseUnit> </Distribution> <PlantReference> </PlantReference> <Project> </Project> <Reference/> <SLCode> </SLCode> </Defaults> <Distribution> <EnterpriseUnit> <GLEntityID name="r100 - AUD/USD">R100</GLEntityID> </EnterpriseUnit>

11 <HomeCostCenter name=""/> <LabourClass name=""/> <LabourCost/> </Distribution> <EntitlementID/> <Evaluation> <EvaluationFactor number="1"> <CodeA>1A</CodeA> <CodeB>1B</CodeB> <CodeC>1C</CodeC> <Points>12</Points> <UserDefined>User Defined 1</UserDefined> </EvaluationFactor> <EvaluationFactor number="2"> <CodeA>2A</CodeA> <CodeB>2B</CodeB> <CodeC>2C</CodeC> <Points>14</Points> <UserDefined>User Defined 2</UserDefined> </EvaluationFactor> <Notes>OESYSAD</Notes> <Reason name="organisation Change">AO</Reason> <RecentEvaluationDate> </RecentEvaluationDate> <TotalPoints>26</TotalPoints> </Evaluation> <Incumbents> <Actual>0</Actual> <Authorised>1</Authorised> <Budget>1</Budget> </Incumbents> <Notes>POSYSAD</Notes> <Occupancy> <Reason name="base Establishment">ES</Reason> <Status name="vacant">v</status> <Strategy name=""/> </Occupancy> <Occupation> <Type/> </Occupation> <PositionCategory name=""/> <PositionReference/> <PositionReportingCode number="9"> <ReportingCode>1</ReportingCode> <ReportingCodeDescription>Administrative</ReportingCodeDescription> <ReportingCodeName>Position Reporting</ReportingCodeName> </PositionReportingCode> <PositionReportingCode number="10"> <ReportingCode>2</ReportingCode> <ReportingCodeDescription>Office Worker</ReportingCodeDescription> <ReportingCodeName>Position Reporting</ReportingCodeName> </PositionReportingCode> <PrimaryReportingCode name=""/> <StaffCategory name=""/> </PositionProfile> <EffectiveTimePeriod> <ValidFrom> </ValidFrom> </EffectiveTimePeriod> <StatusReason> <Code/> </StatusReason> </PositionOpening> </DataArea> </ShowPositionOpening>