PhenixID

PSD1126 – Tieto Education Actions for Identity Provisioning

Fact

  • PhenixID Identity Provisioning 6.1.0 or later
  • License Key for Tieto Education

Situation

This document will describe the actions that can be used to get persons and groups from Tieto Education.

Solution

Download and install the action package

Download the Tieto Education Action Package:
tieto-education-organization.jar
Place the jar file in folder /actionpackages/customer.

Restart Identity Provisioning.

Attributes for persons

For persons, these attributes will be created if they contain any value.

Session Attribute

Description

Example Value

sourcedid.id

The GUID for the person. The value is unique  in Tieto Education, and persistent.

{EF97F8DE-ED1A-49E8-BF12-F5D2A8CD9908}

userid

A list of user ids for the person. Each value contains both the id and the id type, separated by semi-colon.

{EF97F8DE-ED1A-49E8-BF12-F5D2A8CD9908};GUID

198901010123;PID

name.fn

The full name for the person, in format [middle name] [lastname], [firstname]

Björk Svensson, Anna

name.n.given

The givenname for the person.

Anna

name.n.partname

A list of partnames for the person. Each value contains both the name and the partname type, separated by semi-colon.

Björk;Middle

name.n.family

The family name for the person.

Svensson

emailhome

The personal email address for the person.

anna.svensson@hotmail.com

emailworkschool

The school email address for students, and the work email address for staff.

anna.svensson@school.com

tel

A list of phone numbers for the person. Each value contains both the number and the number type, separated by semi-colon.

Number types are Mobile, Work, Voice, where Voice is the home phone.

070-1234567;Mobile

08-123456;Work

adr.pcode

The postal code for the person.

12345

adr.street

The street address for the person.

Storgatan 5

adr.locality

The city for the person.

Småstaden

adr.extadd

C/O address for the person.

Karlsson

demographics.bday

The birthdate for the person.

1989-01-01

demographics.gender

The gender for the person.

The genders are Female, Male.

Female

institutionrole

A list of institution roles for the person. Each value contains both the role and the word Yes och No depending on if the role is primary or not. The two parts are separated by semi-colon.

The roles are Student, Staff, Contact, Child.

Staff;Yes

Contact;No

systemrole.systemroletype

The system role type for the person.

None

datasource

The source for the data.

SKV

privacy

If the person has restrictions.

Values are None, Level1, where Level1 means privacy highlighted by Skatteverket.

sourcedid.id

geographickeycode

The geographic key code for the person.

420000

municipalitycode

The municipality code from SKL for the person.

0180

municipalityname

The municipality name for the person.

Stockholm

timestamp

Date and time for when the person was created, updated or deleted.

2019-01-14 10:57

status

The status for the person.

The status can be:
Normal – The person is alive and lives in Sweden
Deceased – The person is deceased
Emigrated – The person has emigrated

Normal

residentstatus

The resident status for the person.

Values can be AsylumSeeker, EuEssSwitzerlandCitizen, NordicCitizen, ExchangeStudent, SwedishForeign, OtherForeignCitizen, DiplomatChildrenWithinEuEssSwitzerland, DiplomatChildrenOutsideEuEssSwitzerland, PermitApplicationSeeker, Unknown

ExchangeStudent

nativelanguage

The native language for the person.

Engelska

altadr.pcode

The postal code for the alternative address for the person.

23456

altadr.street

The street address for the alternative address for the person.

Kungsgatan 3

altadr.locality

The city for the alternative address for the person.

Grantorp

altadr.extadd

C/O address for the alternative address for the person.

Holmberg

Relationship Attributes for Persons

Relationship attributes always contains the GUID for the person or group that the person is related to. The attributes can contain one or more values, and will only be created if they contain at least one value.

Session Attributes that will contain the GUID to another persons:
Guardian, Mentor, Contact, GradeAuthority, Instructor, Child, Student, GuardianFor

Session Attributes that will contain the GUID to groups:
Unit, Class

Attributes for groups

For groups, these attributes will be created if they contain any value. Some of the attributes only apply to class groups, others to unit groups etc.

Session Attribute

Description

Example Value

sourcedid.id

The GUID for the group. The value is unique  in Tieto Education, and persistent.

{EF97F8DE-ED1A-49E8-BF12-F5D2A8CD9908}

description.short

Group code or name.

Skogsskolan

grouptype.typevalue

The type of group.

Values can be Unit, Class, OtherGroup, EducationGroup, ScheduleGroup, ContactGroup, MentorGroup, Department, DepartmentGroup

Unit

timeframe.begin

Defines the start of when a group is intended to be available.

2018-07-01

timeframe.end

Defines the end of when a group is intended to be available.

9999-12-31

timestamp

Date and time for when the group was created, updated or deleted.

2019-01-14 10:57

schoolyear

School year for class. In the case of a mixed class the value will be a range [startyear]-[endyear]

2

groupusage

The group usage for non-education groups.

Barn med busskort

schooltype

School type for units.

GR

csncode

CSN code for units.

12345

governedby

Who owns and manages the unit.

Values can be Private, Municipal, State

Municipal

phone

The phone number for the unit.

08-9876543

pcode

The postal code for the unit.

12345

street

The postal street address for the unit.

Box 11

locality

The city for the unit.

Småstaden

web

The web address for the unit.

www.skogsskolan.se

municipalitycode

The municipality code from SKL for the unit.

0180

municipalityname

The municipality name for the unit.

Stockholm

period

List of periods that are defined at the unit.

Values are in the format [period name];[start date];[end date];[period type]

18/19;2018-08-23;2019-06-14;Year

geographickeycode

The geographic key code for the unit.

420000

id

The unit id.

{EF97F8DE-ED1A-49E8-BF12-F5D2A8CD9908}

email

The email for the unit.

info@skogsskolan.se

officialunitname

The official name for the unit.

Skogsängsskolan

visitingaddress

The visiting address for the unit.

Knutgatan 7

organizernumber

The organizer number for the organizer of the unit.

2020201234

Relationship Attributes for Groups

Relationship attributes always contains the GUID for the person or group that the group is related to. The attributes can contain one or more values, and will only be created if they contain at least one value.

The session attribute Unit will contain the unit for the group.

The session attribute Member will contain the persons who are members of the group. The value will be in the format [GUID];[Role 1],[Role 2],[Role n].
Example: {B2395281-C9E7-4B28-B22E-B270E4F28963};Student

Common Configuration Parameters for the Actions

The following parameters are used in all the actions in the package.

Parameter

Description

WS Endpoint

[Mandatory] The endpoint for the web service. E.g https://tietoeducation.kommun.se

License Key

[Mandatory] The license key for the web service.

Service

[Mandatory] The service to use in the web service. Available services are GetPedagogicalCareOrganization, GetPreSchoolOrganization, GetLeisureTimeCentreOrganization, GetPreSchoolClassOrganization, GetCompulsorySchoolOrganization, GetCompulsorySchoolForLearningDisabilitiesOrganization, GetUpperSecondarySchoolOrganization, GetUpperSecondarySchoolForLearningDisabilitiesOrganization, GetSwedishForImmigrantsSchoolOrganization, GetMunicipalAdultSchoolOrganization, GetAdultSchoolForLearningDisabilitiesOrganization, GetHigherVocationalEducationOrganization.

Action: Tieto Education – Get Persons

Current version: 0.1

The action will make one call to Tieto Education and create a new Session Object for each person in the result. The session objects will have the person session attributes described above, and the session attributes for person relationships.

Action: Tieto Education – Get Groups

Current version: 0.1

The action will make one call to Tieto Education and create a new Session Object for each group in the result. The session objects will have the group session attributes described above, and the session attributes for group relationships.

Action: Tieto Education – Add Person Information

Current version: 0.1

This action makes a search for a person based on an ID attribute in the session object. If the person is found, the person session attributes described above will be added to the existing session object. The name of the attributes will be in the format:

[ID attribute name][counter][Tieto Education session attribute name]

The counter will start at 1, and increase with 1 for every value in the ID attribute.

Example of the attribute name for telephone numbers if the ID attribute is named Guardian: Guardian1tel.

The action will only make one call to Tieto Education and then search for the persons in the result.

The additional parameters for the action:

Parameter

Description

Person Id Attribute

[Mandatory] The name of the session attribute that contains the id(s) for the person(s).

Person Id Type

[Optional] The type of id in the id attribute. The GUID from Tieto Education (1) or the personal number in format yyyyMMddnnnn (2). Default: 1.

Action: Tieto Education – Add Group Information

Current version: 0.1

This action makes a search for a group based on an ID attribute in the session object. If the group is found, the group session attributes described above will be added to the existing session object. The name of the attributes will be in the format:

[ID attribute name][counter][Tieto Education session attribute name]

The counter will start at 1, and increase with 1 for every value in the ID attribute.

Example of the attribute name for description.short if the ID attribute is named Class: Class1description.short.

The action will only make one call to Tieto Education and then search for the groups in the result.

The additional parameters for the action:

Parameter

Description

Group Id Attribute

[Mandatory] The name of the session attribute that contains the id(s) for the group(s).


DISCLAIMER
Information provided in this document is for your information only. PhenixID makes no explicit or implied claims to the validity of this information. Any trademarks referenced in this document are the property of their respective owners.

The origin of this information may be internal or external to PhenixID. PhenixID makes all reasonable efforts to verify this information.

PhenixID - support.phenixid.se