PhenixID

PSD1114 – Visma Personec Actions for Identity Provisioning

Fact

  • PhenixID Identity Provisioning 5.2.0 or later

System Requirements

  • To send user information to Visma Personec is standardized.
  • To read information from Visma Personec, a data set to export must be set up in Visma. If your data set is different from the one we have used for the read actions, new actions must be developed based on your data set.

Situation

Use PhenixID Identity Provisioning to setup automatic user provisioning to Visma Personec and Neptune.

Solution

This document will show the steps that are necessary to configure Identity Provisioning to automatically provision users to Visma Personec and/or Neptune, and what is necessary to automatically read information from Visma Personec.

Download

To download the action package for Visma Personec, contact support@phenixid.se.

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

Action for updating users in Visma Personec and Neptune

This action sends users to Visma Personec and/or Neptune to create or update the user.

Version 1.0

Parameter

Description

Example

Endpoint

[Optional] The endpoint for the web service. Default is using the global parameter VismaPersonecEndpoint. Supports GLOBAL().

https://company.visma.se/Services/VismaExternalServices/
WcfPBSExternalServicePackage/WcfPBSExternalServicePackage.svc

Authkey

[Optional] The authkey for the web service. Default is using the global parameter VismaPersonecAuthkey. Supports GLOBAL().

CUSTOMER_AUTHKEY

Attributes for Personec

[Optional] The attributes to send to Personec. Format: personecAttributeName1|sessionAttributeName1, personecAttributeName2|sessionAttributeName2. See Visma documentation for attribute names and mandatory attributes. Leave empty to not update Personec.

sign|vismasign,insuranceid|personnummer

Attributes for Neptune

[Optional] The attributes to send to Neptune. Format: neptuneAttributeName1|sessionAttributeName1, neptuneAttributeName2|sessionAttributeName2. See Visma documentation for attribute names and mandatory attributes. Leave empty to not update Neptune.

loginname|vismalogin

ErrorAttributeName

[Optional] The name of the session attribute that will be created if any error occurs. Leave empty to not create any error attribute.

vismaerror

Actions for reading information from Visma Personec

To read information from Visma, a data set to export must be set up in Visma. If your data set is different from the one we have used for these actions, new actions must be developed based on your data set.

Visma Personec Get All Users

Fetches persons from Visma and creates a Session Object for each person.

Version 1.1

Parameter

Description

Example

Endpoint

[Optional] The endpoint for the web service. Default is using the global parameter VismaPersonecEndpoint. Supports GLOBAL().

https://company.visma.se/Services/VismaExternalServices/
WcfPBSExternalServicePackage/WcfPBSExternalServicePackage.svc

Authkey

[Optional] The authkey for the web service. Default is using the global parameter VismaPersonecAuthkey. Supports GLOBAL().

CUSTOMER_AUTHKEY

Export name

[Optional] The three letter code in the export name, XXX_01. Default is using the global parameter VismaPersonecExportName. Supports GLOBAL().

ABC_01

From Date

[Optional] From date in format YYYYMMDD. Leave empty to not use a from date.

20180101

To Date

[Optional] To date in format YYYYMMDD. Leave empty to not use a to date.

20180131

Attributes to Fetch

[Mandatory] Comma separated list of attributes to fetch from the person object. Attribute names are available in STR_01.xml, the XML file that defines your export. Attribute names are case sensitive.

PERSOID,FOERNAMN,EFTERNAMN

Visma Personec Get All Employments

Fetches employments from Visma and creates a Session Object for each employment.

Version 1.1

Parameter

Description

Example

Endpoint

[Optional] The endpoint for the web service. Default is using the global parameter VismaPersonecEndpoint. Supports GLOBAL().

https://company.visma.se/Services/VismaExternalServices/
WcfPBSExternalServicePackage/WcfPBSExternalServicePackage.svc

Authkey

[Optional] The authkey for the web service. Default is using the global parameter VismaPersonecAuthkey. Supports GLOBAL().

CUSTOMER_AUTHKEY

Export name

[Optional] The three letter code in the export name, XXX_01. Default is using the global parameter VismaPersonecExportName. Supports GLOBAL().

ABC_01

From Date

[Optional] From date in format YYYYMMDD. Leave empty to not use a from date.

20180101

To Date

[Optional] To date in format YYYYMMDD. Leave empty to not use a to date.

20180131

Attributes to Fetch

[Mandatory] Comma separated list of attributes to fetch from the employment object. Attribute names are available in STR_01.xml, the XML file that defines your export. Attribute names are case sensitive.

AVTALTXT

Attributes to Add From Person

[Optional] Comma separated list of attributes to add from the overhead person object.Attribute names are available in STR_01.xml, the XML file that defines your export. Attribute names are case sensitive.

PERSOID,FOERNAMN,EFTERNAMN

Visma Personec Get All Employment Costs

Fetches employment costs from Visma and creates a Session Object for each cost.

Version 1.1

Parameter

Description

Example

Endpoint

[Optional] The endpoint for the web service. Default is using the global parameter VismaPersonecEndpoint. Supports GLOBAL().

https://company.visma.se/Services/VismaExternalServices/
WcfPBSExternalServicePackage/WcfPBSExternalServicePackage.svc

Authkey

[Optional] The authkey for the web service. Default is using the global parameter VismaPersonecAuthkey. Supports GLOBAL().

CUSTOMER_AUTHKEY

Export name

[Optional] The three letter code in the export name, XXX_01. Default is using the global parameter VismaPersonecExportName. Supports GLOBAL().

ABC_01

From Date

[Optional] From date in format YYYYMMDD. Leave empty to not use a from date.

20180101

To Date

[Optional] To date in format YYYYMMDD. Leave empty to not use a to date.

20180131

Attributes to Fetch

[Mandatory] Comma separated list of attributes to fetch from the employment cost object. Attribute names are available in STR_01.xml, the XML file that defines your export. Attribute names are case sensitive.

KONTO

Attributes to Add From Person

[Optional] Comma separated list of attributes to add from the overhead person object.Attribute names are available in STR_01.xml, the XML file that defines your export. Attribute names are case sensitive.

PERSOID,FOERNAMN,EFTERNAMN

Attributes to Add From Employment

[Mandatory] Comma separated list of attributes to add from the overhead employment object. Attribute names are available in STR_01.xml, the XML file that defines your export. Attribute names are case sensitive.

AVTALTXT

Visma Personec Add From User

Fetches persons with the given insuranceId from Visma and adds attributes to the Session Object.

Version 1.1

Parameter

Description

Example

Endpoint

[Optional] The endpoint for the web service. Default is using the global parameter VismaPersonecEndpoint. Supports GLOBAL().

https://company.visma.se/Services/VismaExternalServices/
WcfPBSExternalServicePackage/WcfPBSExternalServicePackage.svc

Authkey

[Optional] The authkey for the web service. Default is using the global parameter VismaPersonecAuthkey. Supports GLOBAL().

CUSTOMER_AUTHKEY

Export name

[Optional] The three letter code in the export name, XXX_01. Default is using the global parameter VismaPersonecExportName. Supports GLOBAL().

ABC_01

InsuranceId Attribute

[Mandatory] The name of the session attribute that contains the insuranceId.

personnummer

Attributes to Fetch

[Mandatory] Comma separated list of attributes to fetch from the person object. Attribute names are available in STR_01.xml, the XML file that defines your export. Attribute names are case sensitive.

FOERNAMN,EFTERNAMN

ErrorAttributeName

[Optional] The name of the session attribute that will be created if any error occurs. Leave empty to not create any error attribute.

vismaerror

Visma Personec Get Employments for User

Fetches employments for the given insuranceId from Visma and creates new Session Objects for the employments.

Version 1.1

Parameter

Description

Example

Endpoint

[Optional] The endpoint for the web service. Default is using the global parameter VismaPersonecEndpoint. Supports GLOBAL().

https://company.visma.se/Services/VismaExternalServices/
WcfPBSExternalServicePackage/WcfPBSExternalServicePackage.svc

Authkey

[Optional] The authkey for the web service. Default is using the global parameter VismaPersonecAuthkey. Supports GLOBAL().

CUSTOMER_AUTHKEY

Export name

[Optional] The three letter code in the export name, XXX_01. Default is using the global parameter VismaPersonecExportName. Supports GLOBAL().

ABC_01

InsuranceId Attribute

[Mandatory] The name of the session attribute that contains the insuranceId.

personnummer

Attributes to Fetch

[Mandatory] Comma separated list of attributes to fetch from the employment object. Attribute names are available in STR_01.xml, the XML file that defines your export. Attribute names are case sensitive.

AVTALTXT

Attributes to Add From Person

[Optional] Comma separated list of attributes to add from the overhead person object. Attribute names are available in STR_01.xml, the XML file that defines your export. Attribute names are case sensitive.

FOERNAMN,EFTERNAMN

Replace Original Session Objects

[Optional] If the original session objects should be replaced by the new employment session objects, or if the new session objects should be added to the list of session objects. (true/false) Default: true.

true

Attributes to Copy from Original Session Object

[Optional] Comma separated list of session attributes to copy from the original session object to the new employment session object.

title,description

ErrorAttributeName

[Optional] The name of the session attribute that will be created if any error occurs. Leave empty to not create any error attribute.

vismaerror

Visma Personec Get Employment Costs for User

Fetches employment costs for the given insuranceId from Visma and creates new Session Objects for the costs.

Version 1.1

Parameter

Description

Example

Endpoint

[Optional] The endpoint for the web service. Default is using the global parameter VismaPersonecEndpoint. Supports GLOBAL().

https://company.visma.se/Services/VismaExternalServices/
WcfPBSExternalServicePackage/WcfPBSExternalServicePackage.svc

Authkey

[Optional] The authkey for the web service. Default is using the global parameter VismaPersonecAuthkey. Supports GLOBAL().

CUSTOMER_AUTHKEY

Export name

[Optional] The three letter code in the export name, XXX_01. Default is using the global parameter VismaPersonecExportName. Supports GLOBAL().

ABC_01

InsuranceId Attribute

[Mandatory] The name of the session attribute that contains the insuranceId.

personnummer

Attributes to Fetch

[Mandatory] Comma separated list of attributes to fetch from the cost object. Attribute names are available in STR_01.xml, the XML file that defines your export. Attribute names are case sensitive.

KONTO

Attributes to Add From Person

[Optional] Comma separated list of attributes to add from the overhead person object. Attribute names are available in STR_01.xml, the XML file that defines your export. Attribute names are case sensitive.

FOERNAMN,EFTERNAMN

Attributes to Add From Employment

[Optional] Comma separated list of attributes to add from the overhead employment object. Attribute names are available in STR_01.xml, the XML file that defines your export. Attribute names are case sensitive.

AVTALTXT

Replace Original Session Objects

[Optional] If the original session objects should be replaced by the new employment session objects, or if the new session objects should be added to the list of session objects. (true/false) Default: true.

true

Attributes to Copy from Original Session Object

[Optional] Comma separated list of session attributes to copy from the original session object to the new employment session object.

title,description

ErrorAttributeName

[Optional] The name of the session attribute that will be created if any error occurs. Leave empty to not create any error attribute.

vismaerror

Visma Personec Get All Organizations

Fetches organizations from Visma and creates a Session Object for each organization.

Version 1.0

Parameter

Description

Example

Endpoint

[Optional] The three letter code in the export name, XXX_01. Default is using the global parameter VismaPersonecExportName. Supports GLOBAL(). https://company.visma.se/Services/VismaExternalServices/
WcfPBSExternalServicePackage/WcfPBSExternalServicePackage.svc

Authkey

[Optional] The authkey for the web service. Default is using the global parameter VismaPersonecAuthkey. Supports GLOBAL().

CUSTOMER_AUTHKEY

Export name

[Optional] The three letter code in the export name, XXX_02. Default is using the global parameter VismaPersonecExportName. Supports GLOBAL().

ABC_02

InsuranceId Attribute

[Mandatory] The name of the session attribute that contains the insuranceId.

personnummer

Minimum T.o.m Date

[Optional] Minimum to date in format YYYYMMDD. Will get all organizations with a t.o.m. date > entered date. Leave empty to not use a to date.

20201231

Attributes from ORGENHET

[Mandatory to have one of the attribute parameters set] Comma separated list of attributes to fetch from the ORGENHET object. Attribute names are available in documentation from Visma. Attribute names are case sensitive. To rename the attributes, use | to map the attribute name, e.g. VismaAttribute|myAttributeName.

TYP,FNR

Attributes from ORGINFO

[Mandatory to have one of the attribute parameters set] Comma separated list of attributes to fetch from the ORGINFO object. Attribute names are available in documentation from Visma. Attribute names are case sensitive. To rename the attributes, use | to map the attribute name, e.g. VismaAttribute|myAttributeName.

ADRESS

Attributes from ORGKONTO

[Mandatory to have one of the attribute parameters set] Comma separated list of attributes to fetch from the ORGKONTO object. Attribute names are available in documentation from Visma. Attribute names are case sensitive. To rename the attributes, use | to map the attribute name, e.g. VismaAttribute|myAttributeName.

KONTO

Visma Personec Add From Organization

Fetches organization with the given organizationID from Visma and adds attributes to the Session Object.

Version 1.0

Parameter

Description

Example

Endpoint

[Optional] The endpoint for the web service. Default is using the global parameter VismaPersonecEndpoint. Supports GLOBAL().

https://company.visma.se/Services/VismaExternalServices/
WcfPBSExternalServicePackage/WcfPBSExternalServicePackage.svc

Authkey

[Optional] The authkey for the web service. Default is using the global parameter VismaPersonecAuthkey. Supports GLOBAL().

CUSTOMER_AUTHKEY

Export name

[Optional] The three letter code in the export name, XXX_02. Default is using the global parameter VismaPersonecExportName. Supports GLOBAL().

ABC_02

OrganizationId Attribute

[Mandatory] The name of the session attribute that contains the organizationId.

organisationsnummer

Attributes from ORGENHET

[Mandatory to have one of the attribute parameters set] Comma separated list of attributes to fetch from the ORGENHET object. Attribute names are available in documentation from Visma. Attribute names are case sensitive. To rename the attributes, use | to map the attribute name, e.g. VismaAttribute|myAttributeName.

TYP,FNR

Attributes from ORGINFO

[Mandatory to have one of the attribute parameters set] Comma separated list of attributes to fetch from the ORGINFO object. Attribute names are available in documentation from Visma. Attribute names are case sensitive. To rename the attributes, use | to map the attribute name, e.g. VismaAttribute|myAttributeName.

ADRESS

Attributes from ORGKONTO

[Mandatory to have one of the attribute parameters set] Comma separated list of attributes to fetch from the ORGKONTO object. Attribute names are available in documentation from Visma. Attribute names are case sensitive. To rename the attributes, use | to map the attribute name, e.g. VismaAttribute|myAttributeName.

KONTO

ErrorAttributeName

[Optional] The name of the session attribute that will be created if any error occurs. Leave empty to not create any error attribute.

vismaerror

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