PhenixID

Get Procapita Data

Version: 0.93

Category: Input

Download

Download the zip file:

ProcapitaActionPackage.zip

For instruction of how to install the action package, read PSD1149.

Description

This is an Action which gets input data from Procapita. It includes several read methods via the IMS Enterprise Services Web Service API for Procapita BoU. The Action rely on that a session attribute that contains a Procapita identifier exists in the session when the Action is triggered.

Parameter

Description

Example

Procapita Host

[Mandatory] The Procapita Server Address and Port Number.

http://procapita.tietoenator.com:23112

Membership Endpoint Address

[Optional] Endpoint for the membership web service. Default value=/HCW.Welfare.CustomSolutions.Integration.IISHost/V1/imsbasicservice.svc/MembershipManagementServiceSync

/HCW.Welfare.CustomSolutions.Integration.IISHost/V1/imsbasicservice.svc/MembershipManagementServiceSync

Person Endpoint Address

[Optional] Endpoint for the person web service. Default value=/HCW.Welfare.CustomSolutions.Integration.IISHost/V1/imsbasicservice.svc/PersonManagementServiceSync

/HCW.Welfare.CustomSolutions.Integration.IISHost/V1/imsbasicservice.svc/PersonManagementServiceSync

Group Endpoint Address

[Optional] Endpoint for the group web service. Default value=/HCW.Welfare.CustomSolutions.Integration.IISHost/V1/imsbasicservice.svc/GroupManagementServiceSync

/HCW.Welfare.CustomSolutions.Integration.IISHost/V1/imsbasicservice.svc/GroupManagementServiceSync

Domain ID

[Optional] If no domain is specified, the domain id may be specified here. Hudiksvall

Read Method

[Mandatory] The Procapita read method. Enter the method’s corresponding digit.
1=UpdateGroupObject
– Input: Single valued SESSION attribute as identifier, example, Unit=TIET&Domain=GY
– Output: Attributes are added to current session objects
2=CreateGroupMemberObject
– Input: Identifier example, Unit=123&Domain=456&StudentClass=901. Supports SESSION parameters.
– Output: Session objects with group attributes
3=UpdatePersonObject
– Input: Single valued SESSION attribute as identifier, example, 19880202TF08
– Output: Attributes are added to current session objects
4=UpdatePersonMemberships
– Input: Single valued SESSION attribute as identifier
– Output: Attributes are added to current session objects
5=CreateCareholderObject
– Input: Single or multivalued session attribute as identifier, example a multivalue attribute called ‘personNumbers’. Supports SESSION parameters.
– Output: Session objects for careholders and the current person attributes including it’s children (students)
6=CreatePersonsObject
– Input: A multivalued session attribute as identifier, example a multivalue attribute called ‘personNumbers’. Supports SESSION parameters.
– Output: Session objects containing persons and associated attributes.
7=ReadAllPersons
– Input: Identifier example, Unit=123&Domain=456&StudentClass=901. No identifier to read all person objects. Supports SESSION parameters.
– Output: Session objects containing persons and associated attributes.

1

Identifier

[Mandatory] The identifier for the read method. Supports SESSION parameters.

Unit=TIET&Domain=GY

Use Cases

Example 1: Update Group Object

Used to read group object information from Procapita, and add the information to the existing Session Object.

Input: Single valued SESSION attribute as identifier, example, Unit=TIET&Domain=GY

Output: Attributes are added to current session objects

Parameter

Value

Procapita Host

http://procapita.tietoenator.com:23112

Membership Endpoint Address

[BLANK]

Person Endpoint Address

[BLANK]

Group Endpoint Address

 [BLANK]

Domain ID

 [BLANK]

Read Method

 1

Identifier

SESSION(identifier)

Example 2: Create Group Object

Used to read group object information from Procapita, and create new Session Objects.

Input: Single valued SESSION attribute as identifier, example, Unit=123&Domain=456&StudentClass=901

Output: Session objects with group attributes

Parameter

Value

Procapita Host

http://procapita.tietoenator.com:23112

Membership Endpoint Address

[BLANK]

Person Endpoint Address

[BLANK]

Group Endpoint Address

 [BLANK]

Domain ID

 [BLANK]

Read Method

 2

Identifier

SESSION(identifier)

Example 3: Update Person Object

Used to read person object information from Procapita, and add the information to the Session Object.

Input: Single valued SESSION attribute as identifier, example, 19880202TF08

Output: Attributes are added to current session objects

Parameter

Value

Procapita Host

http://procapita.tietoenator.com:23112

Membership Endpoint Address

[BLANK]

Person Endpoint Address

[BLANK]

Group Endpoint Address

 [BLANK]

Domain ID

 [BLANK]

Read Method

 3

Identifier

SESSION(identifier)

Example 4: Update Person Memberships

Used to read person membership information from Procapita, and add the information to the Session Object.

Input: Single valued SESSION attribute as identifier, example, 19880202TF08

Output: Attributes are added to current session objects

Parameter

Value

Procapita Host

http://procapita.tietoenator.com:23112

Membership Endpoint Address

[BLANK]

Person Endpoint Address

[BLANK]

Group Endpoint Address

 [BLANK]

Domain ID

 [BLANK]

Read Method

 4

Identifier

SESSION(identifier)

Example 5: Create Careholder Object

Used to read careholder object information from Procapita, and create new Session Objects.

Input: Single or multivalued session attribute as identifier, example a multivalue attribute called ‘personNumbers’.

Output: Session objects for careholders and the current person attributes including it’s children (students)

Parameter

Value

Procapita Host

http://procapita.tietoenator.com:23112

Membership Endpoint Address

[BLANK]

Person Endpoint Address

[BLANK]

Group Endpoint Address

 [BLANK]

Domain ID

 [BLANK]

Read Method

 5

Identifier

SESSION(personNumbers)

Example 6: Create Persons Object

Used to read person object information from Procapita, and create new Session Objects.

Input: A multivalued session attribute as identifier, example a multivalue attribute called ‘personNumbers’.

Output: Session objects containing persons and associated attributes.

Parameter

Value

Procapita Host

http://procapita.tietoenator.com:23112

Membership Endpoint Address

[BLANK]

Person Endpoint Address

[BLANK]

Group Endpoint Address

 [BLANK]

Domain ID

 [BLANK]

Read Method

 6

Identifier

SESSION(personNumbers)

Example 7: Read All Persons

Used to read all person objects information from Procapita, and create new Session Objects.

Input: Identifier to read all persons in a group, example, Unit=123&Domain=456&StudentClass=901. No identifier to read all person objects.

Output: Session objects containing persons and associated attributes.

Parameter

Value

Procapita Host

http://procapita.tietoenator.com:23112

Membership Endpoint Address

[BLANK]

Person Endpoint Address

[BLANK]

Group Endpoint Address

 [BLANK]

Domain ID

 [BLANK]

Read Method

 7

Identifier

SESSION(identifier)

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