Fact
- PhenixID Identity Provisioning 5.2.0 or later.
System Requirements
- Access to Visma Enterprise HRM Web Service URL
- Access to Visma Enterprise HRM Web Service Username
- Access to Visma Enterprise HRM Web Service Password
Situation
Use PhenixID Identity Provisioning to get data from Visma Enterprise HRM.
Solution
This document will show the steps that are necessary to configure Identity Provisioning to automatically read information from Visma Enterprise HRM.
Download
To download the action package for Visma Enterprise HRM, contact support@phenixid.se.
Place the action jar-file in the folder actionPackages/customer/
Visma HRM Add From Person by Person Id
Find a person in Visma Enterprise HRM by their person ID, and add their information as session attributes to the existing session object.
Version 1.3
|
Parameter |
Description |
Example |
|
Visma Enterprise HRM WebService URL |
[Mandatory] The URL to the Visma Enterprise HRM web service. Ex. https://visma.company:443/hrm_ws Leave blank to use the value in global parameter VISMA_ENTERPRISE_HRM_WSURL. Supports GLOBAL(). |
https://visma.company.local/hrm_ws |
|
Visma Enterprise HRM Username |
[Mandatory] The username for the web service user for Visma Enterprise HRM. Leave blank to use the value in global parameter VISMA_ENTERPRISE_HRM_USERNAME. Supports GLOBAL(). |
HRM-USER |
|
Visma Enterprise HRM Password |
[Mandatory] The password for the web service user for Visma Enterprise HRM. Leave blank to use the value in global parameter VISMA_ENTERPRISE_HRM_PASSWORD. Supports GLOBAL(). |
password |
|
Person ID Attribute |
[Mandatory] The attribute with the person id for the person. |
serialNumber |
|
Attribute Prefix |
[Optional] The prefix for the names of the attributes, created with information from Visma. Ex. visma_ to name the attribute givenName visma_givenName. Leave blank to not use any prefix. |
visma_ |
|
Error Message Attribute Name |
Optional] The name of the session attribute that will contain the error message, if any. If no error, this attribute will be empty. Leave blank to let the action fail instead of creating any attribute if any error occurs. Default is blank. |
vismaerror |
|
Read Timeout |
[Optional] The timeout in milliseconds when waiting for the result from the Visma Enterprise HRM web service. If left blank, the value in global parameter VISMA_ENTERPRISE_HRM_READTIMEOUT will be used if available, otherwise the default is 240000. Supports GLOBAL(). |
900000 |
Visma HRM Get Persons by Department
Get all persons from Visma Enterprise HRM by department id. Each person will result in a new session object.
Version 1.3
|
Parameter |
Description |
Example |
|
Visma Enterprise HRM WebService URL |
[Mandatory] The URL to the Visma Enterprise HRM web service. Ex. https://visma.company:443/hrm_ws Leave blank to use the value in global parameter VISMA_ENTERPRISE_HRM_WSURL. Supports GLOBAL(). |
https://visma.company.local/hrm_ws |
|
Visma Enterprise HRM Username |
[Mandatory] The username for the web service user for Visma Enterprise HRM. Leave blank to use the value in global parameter VISMA_ENTERPRISE_HRM_USERNAME. Supports GLOBAL(). |
HRM-USER |
|
Visma Enterprise HRM Password |
[Mandatory] The password for the web service user for Visma Enterprise HRM. Leave blank to use the value in global parameter VISMA_ENTERPRISE_HRM_PASSWORD. Supports GLOBAL(). |
password |
|
Company id |
[Mandatory] The id of the company. Supports SESSION(), but will only use the value from the first Session Object. |
1 |
|
Deparment Start id |
[Mandatory] The id of the start department. Ex. 000000000003. Supports SESSION(), but will only use the value from the first Session Object. |
000000000001 |
|
Deparment End id |
[Mandatory] The id of the end department. Ex. 000000000020. Supports SESSION(), but will only use the value from the first Session Object. |
000000000010 |
|
Replace Any Exsisting Session Objects |
[Optional] If any existing session objects should be replaced (true) or added (false) to the list of session objects. (true/false). Default: true. |
true |
|
Error Message Attribute Name |
[Optional] The name of the session attribute that will contain the error message, if any. If no error, this attribute will be empty. Leave blank to let the action fail instead of creating any attribute if any error occurs. The error message attribute will only be created if any original session object is to be kept. Default is blank. |
vismaError |
|
Read Timeout |
[Optional] The timeout in milliseconds when waiting for the result from the Visma Enterprise HRM web service. If left blank, the value in global parameter VISMA_ENTERPRISE_HRM_READTIMEOUT will be used if available, otherwise the default is 240000. Supports GLOBAL(). |
900000 |
Visma HRM Get Persons by Employee Id
Get all persons from Visma Enterprise HRM by employee id. Each person will result in a new session object.
Version 1.3
|
Parameter |
Description |
Example |
|
Visma Enterprise HRM WebService URL |
[Mandatory] The URL to the Visma Enterprise HRM web service. Ex. https://visma.company:443/hrm_ws Leave blank to use the value in global parameter VISMA_ENTERPRISE_HRM_WSURL. Supports GLOBAL(). |
https://visma.company.local/hrm_ws |
|
Visma Enterprise HRM Username |
[Mandatory] The username for the web service user for Visma Enterprise HRM. Leave blank to use the value in global parameter VISMA_ENTERPRISE_HRM_USERNAME. Supports GLOBAL(). |
HRM-USER |
|
Visma Enterprise HRM Password |
[Mandatory] The password for the web service user for Visma Enterprise HRM. Leave blank to use the value in global parameter VISMA_ENTERPRISE_HRM_PASSWORD. Supports GLOBAL(). |
password |
|
Company id |
[Mandatory] The id of the company. Supports SESSION(), but will only use the value from the first Session Object. |
1 |
|
Employee Start id |
[Mandatory] The start employee id. Ex. 12345678. Supports SESSION(), but will only use the value from the first Session Object. |
12 |
|
Employee End id |
[Mandatory] The end employee id. Ex. 12345678. Supports SESSION(), but will only use the value from the first Session Object. |
100 |
|
Replace Any Exsisting Session Objects |
[Optional] If any existing session objects should be replaced (true) or added (false) to the list of session objects. (true/false). Default: true. |
true |
|
Error Message Attribute Name |
[Optional] The name of the session attribute that will contain the error message, if any. If no error, this attribute will be empty. Leave blank to let the action fail instead of creating any attribute if any error occurs. The error message attribute will only be created if any original session object is to be kept. Default is blank. |
vismaError |
|
Read Timeout |
[Optional] The timeout in milliseconds when waiting for the result from the Visma Enterprise HRM web service. If left blank, the value in global parameter VISMA_ENTERPRISE_HRM_READTIMEOUT will be used if available, otherwise the default is 240000. Supports GLOBAL(). |
900000 |
Visma HRM Get Persons Not Started
Get all persons from Visma Enterprise HRM who has not yet started their employment. Each person will result in a new session object.
Version 1.3
|
Parameter |
Description |
Example |
|
Visma Enterprise HRM WebService URL |
[Mandatory] The URL to the Visma Enterprise HRM web service. Ex. https://visma.company:443/hrm_ws Leave blank to use the value in global parameter VISMA_ENTERPRISE_HRM_WSURL. Supports GLOBAL(). |
https://visma.company.local/hrm_ws |
|
Visma Enterprise HRM Username |
[Mandatory] The username for the web service user for Visma Enterprise HRM. Leave blank to use the value in global parameter VISMA_ENTERPRISE_HRM_USERNAME. Supports GLOBAL(). |
HRM-USER |
|
Visma Enterprise HRM Password |
[Mandatory] The password for the web service user for Visma Enterprise HRM. Leave blank to use the value in global parameter VISMA_ENTERPRISE_HRM_PASSWORD. Supports GLOBAL(). |
password |
|
Company id |
[Mandatory] The id of the company. Supports SESSION(), but will only use the value from the first Session Object. |
1 |
|
Earliest Start Date |
[Mandatory] The earliest start date in format yyyy-MM-dd. Ex. 2019-10-15. Supports SESSION(), but will only use the value from the first Session Object |
2020-01-01 |
|
Last Start Date |
[Mandatory] The last start date in format yyyy-MM-dd. Ex. 2019-12-31. Supports SESSION(), but will only use the value from the first Session Object. |
2020-12-31 |
|
Replace Any Exsisting Session Objects |
[Optional] If any existing session objects should be replaced (true) or added (false) to the list of session objects. (true/false). Default: true. |
true |
|
Error Message Attribute Name |
[Optional] The name of the session attribute that will contain the error message, if any. If no error, this attribute will be empty. Leave blank to let the action fail instead of creating any attribute if any error occurs. The error message attribute will only be created if any original session object is to be kept. Default is blank. |
vismaError |
|
Read Timeout |
[Optional] The timeout in milliseconds when waiting for the result from the Visma Enterprise HRM web service. If left blank, the value in global parameter VISMA_ENTERPRISE_HRM_READTIMEOUT will be used if available, otherwise the default is 240000. Supports GLOBAL(). |
900000 |
Visma HRM Get Persons Terminated
Get all persons from Visma Enterprise HRM who has terminated or will terminate their employment. Each person will result in a new session object.
Version 1.3
|
Parameter |
Description |
Example |
|
Visma Enterprise HRM WebService URL |
[Mandatory] The URL to the Visma Enterprise HRM web service. Ex. https://visma.company:443/hrm_ws Leave blank to use the value in global parameter VISMA_ENTERPRISE_HRM_WSURL. Supports GLOBAL(). |
https://visma.company.local/hrm_ws |
|
Visma Enterprise HRM Username |
[Mandatory] The username for the web service user for Visma Enterprise HRM. Leave blank to use the value in global parameter VISMA_ENTERPRISE_HRM_USERNAME. Supports GLOBAL(). |
HRM-USER |
|
Visma Enterprise HRM Password |
[Mandatory] The password for the web service user for Visma Enterprise HRM. Leave blank to use the value in global parameter VISMA_ENTERPRISE_HRM_PASSWORD. Supports GLOBAL(). |
password |
|
Company id |
[Mandatory] The id of the company. Supports SESSION(), but will only use the value from the first Session Object. |
1 |
|
Earliest Termination Date |
[Mandatory] The earliest termination date in format yyyy-MM-dd. Ex. 2019-10-15. Supports SESSION(), but will only use the value from the first Session Object. |
2020-01-01 |
|
Last Termination Date |
[Mandatory] The last termination date in format yyyy-MM-dd. Ex. 2019-12-31. Supports SESSION(), but will only use the value from the first Session Object. |
2020-12-31 |
|
Replace Any Exsisting Session Objects |
[Optional] If any existing session objects should be replaced (true) or added (false) to the list of session objects. (true/false). Default: true. |
true |
|
Error Message Attribute Name |
[Optional] The name of the session attribute that will contain the error message, if any. If no error, this attribute will be empty. Leave blank to let the action fail instead of creating any attribute if any error occurs. The error message attribute will only be created if any original session object is to be kept. Default is blank. |
vismaError |
|
Read Timeout |
[Optional] The timeout in milliseconds when waiting for the result from the Visma Enterprise HRM web service. If left blank, the value in global parameter VISMA_ENTERPRISE_HRM_READTIMEOUT will be used if available, otherwise the default is 240000. Supports GLOBAL(). |
900000 |
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