Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Introduction

The HISinOne Data Provider allows you to import Core Identities over the HISinOne SOAP interface.

Connection Info

For all entity parts you need to specify the connection information which contains the following parameters.

Parameter

Mandatory

Example

Description

ApiLocation

https://myhisinone.customer.com/quiserver/services2

The API Url to the SOAP Service

Username

myuser

The username used to establish the connection

Password

🔑 * * * * * * * *

The password used to establish the connection

SecurityBindingConfiguration

AllowInsecureTranspor = true
EnableUnsecuredResponse = true
IncludeTimestamp = false

SecurityBindingConfiguration class used to configure the binding

TransportBindingConfiguration

HostNameComparisonMode = 2
MaxReceivedMessageSize = 4194304
UnsafeConnectionNtlmAuthentication = true

TransportBindingConfiguration class used to configure the binding

Sample configuration

<ConnectionParameters>
  <ApiLocation>https://myhisinone.customer.com/quiserver/services2</ApiLocation>
  <Username>your username</Username>
  <Password>your password</Password>
  <SecurityBindingConfiguration>
    <AllowInsecureTransport>true</AllowInsecureTransport>
    <EnableUnsecuredResponse>true</EnableUnsecuredResponse>
    <IncludeTimestamp>false</IncludeTimestamp>
  </SecurityBindingConfiguration>
  <TransportBindingConfiguration>
    <HostNameComparisonMode>2</HostNameComparisonMode>
    <MaxReceivedMessageSize>4194304</MaxReceivedMessageSize>
    <UnsafeConnectionNtlmAuthentication>true</UnsafeConnectionNtlmAuthentication>
  </TransportBindingConfiguration>
</ConnectionParameters>

Find Person Filters

Within HISinOne there are various person stored. You might not want to import all of them, but only certain user groups. In this case you can leverage the FindPersonFilter. You can combine multiple of these together to define your search criterias. The available filters are:

Role

Mandatory

Example

Description

surname

==Müller

Search by surname

firstname

==John

Search by firstname

nameprefix

Search by nameprefix

academicdegree

Search by academicdegree

title

==Dr

Search by title

dateOfBirth

==19.08.1984

Search by date of birth

gender

Search by gender

nationality

==Swiss

Search by nationality

secondNationality

Search by second nationality

username

Search by username

createdAt

Search by creation date

updatedAt

Search by last updated date

email

Search by email

registrationStatus

Search by registration status

registrationsToken

Search by registration token

studystatus

Search by study status

studyTermYear

Search by study term year

studyTermType

Search by study term type

affiliationType

Search by affiliation type

affiliationValidFrom

Search by affiliation valid from

affiliationValidTo

Search by affiliation valid to

role

==student

Search by role

orgroleOrgunitLid

Search by org role unit lid

orgroleValidFrom

Search by org role valid from

orgroleValidTo

Search by org role valid to

personattributeType

Search by person attribute type

personattributeValue

Search by person attribute value

personattributeValidFrom

Search by person attribute valid from

personattributeValidTo

Search by person attribute valid to

Attributes

HISinOne will return attributes for each entitiy that has been found. The following is a list of attributes that you can use in the mapping configuration:

id
idSpecified
firstname
surname
allfirstnames
dateofbirth
dateofbirthSpecified
gender
birthname
artistname
nameprefix
namesuffix
academicdegreesuffix
academicdegree
title
birthcity
country
createdAt
createdAtSpecified
updatedAt
updatedAtSpecified
selfregistrationStatus
personinfo
personInfo.id
personInfo.idSpecified
personInfo.nationality
personInfo.secondNationality
personInfo.hasDoneService
personInfo.hasDoneServiceSpecified
personInfo.visumnumber
personInfo.healthInsuranceNumber
personInfo.familyStatus
personInfo.familystatusFrom
personInfo.familystatusFromSpecified
personInfo.religion
personInfo.healthInsurance
personInfo.healthInsuranceText
personInfo.insurantStatus
personInfo.createdAt
personInfo.createdAtSpecified
personInfo.updatedAt
personInfo.updatedAtSpecified
personInfo.objGuid
student.studentId
student.persionId
student.registrationnumber
address.STU.postaddress.street
address.STU.postaddress.postcode
address.STU.postaddress.city
address.STU.postaddress.addressaddition
address.STU.postaddress.postofficebox
address.STU.postaddress.country
address.STU.postaddress.addresstag
address.STU.postaddress.company
address.STU.postaddress.divisionName
address.STU.postaddress.state
address.STU.phone.phoneNumber
address.STU.phone.eaddresstype
address.STU.phone.addresstag
address.STU.email.emailValue
address.STU.email.eaddresstype
address.STU.email.addresstag
address.STUALL.postaddress.street
address.STUALL.postaddress.postcode
address.STUALL.postaddress.city
address.STUALL.postaddress.addressaddition
address.STUALL.postaddress.postofficebox
address.STUALL.postaddress.country
address.STUALL.postaddress.addresstag
address.STUALL.postaddress.company
address.STUALL.postaddress.divisionName
address.STUALL.postaddress.state
address.STUALL.phone.phoneNumber
address.STUALL.phone.eaddresstype
address.STUALL.phone.addresstag
address.STUALL.email.emailValue
address.STUALL.email.eaddresstype
address.STUALL.email.addresstag
address.PWRESET.email.emailValue
address.PWRESET.email.eaddresstype
address.PWRESET.email.addresstag
address.MIG.phone.phoneNumber
address.MIG.phone.eaddresstype
address.MIG.phone.addresstag
address.MIG.email.emailValue
address.MIG.email.eaddresstype
address.MIG.email.addresstag
address.MIG.hyperlink.hyperlinkValue
address.MIG.hyperlink.eaddresstype
address.MIG.hyperlink.addresstag
address.MIG.postaddress.street
address.MIG.postaddress.postcode
address.MIG.postaddress.city
address.MIG.postaddress.addressaddition
address.MIG.postaddress.postofficebox
address.MIG.postaddress.country
address.MIG.postaddress.addresstag
address.MIG.postaddress.company
address.MIG.postaddress.divisionName
address.MIG.postaddress.state
address.DOK.postaddress.street
address.DOK.postaddress.postcode
address.DOK.postaddress.city
address.DOK.postaddress.addressaddition
address.DOK.postaddress.postofficebox
address.DOK.postaddress.country
address.DOK.postaddress.addresstag
address.DOK.postaddress.company
address.DOK.postaddress.divisionName
address.DOK.postaddress.state
address.DOK.phone.phoneNumber
address.DOK.phone.eaddresstype
address.DOK.phone.addresstag
address.DOK.email.emailValue
address.DOK.email.eaddresstype
address.DOK.email.addresstag
address.DOKALL.postaddress.street
address.DOKALL.postaddress.postcode
address.DOKALL.postaddress.city
address.DOKALL.postaddress.addressaddition
address.DOKALL.postaddress.postofficebox
address.DOKALL.postaddress.country
address.DOKALL.postaddress.addresstag
address.DOKALL.postaddress.company
address.DOKALL.postaddress.divisionName
address.DOKALL.postaddress.state
address.DOKALL.phone.phoneNumber
address.DOKALL.phone.eaddresstype
address.DOKALL.phone.addresstag
address.DOKALL.email.emailValue
address.DOKALL.email.eaddresstype
address.DOKALL.email.addresstag
address.APP.postaddress.street
address.APP.postaddress.postcode
address.APP.postaddress.city
address.APP.postaddress.addressaddition
address.APP.postaddress.postofficebox
address.APP.postaddress.country
address.APP.postaddress.addresstag
address.APP.postaddress.company
address.APP.postaddress.divisionName
address.APP.postaddress.state
address.APP.phone.phoneNumber
address.APP.phone.eaddresstype
address.APP.phone.addresstag
address.APP.email.emailValue
address.APP.email.eaddresstype
address.APP.email.addresstag
address.RZ.email.emailValue
address.RZ.email.eaddresstype
address.RZ.email.addresstag

Multi Value Attributes

HISinOne uses multi value attributes in most cases.

HISinOne uses multi value attributes in most cases. However, to simplify this in the configuration, the dataprovider will always map the first valid record. Meaning if there is more than one valid record (valid from < today && valid to > today), the first one will be mapped to the attribute. This is true for attributes like address. So address.APP.postaddress.street contains the street of the first valid address in the address array retrieved from HISinOne.

  • No labels