Configuration - Alma Talent¶
This section describes how you configure ACD for Alma Talent. You need to configure ACD in these places:
- Runtime configuration
- Application configuration
- If Lime CRM web client:
Runtime Configuration¶
ACD uses Alma Talent's API to provide company data.
The company search is performed via the /information-service/company/search/ endpoint.
Standard mapping file can be found under [Example]
You can find the available mapping options in Alma Talent's Swagger documentation. In order to access the Swagger documentation, you must be logged into your Alma Talent account here. Navigate to /api/v2/information-service/data/by-business-id/{businessId} found under company-data-set-controller-v2 to find the example payload.
Statement Info Support¶
There are support for mapping last years statement information. This is done by using the prefix statementInfo in your mapping, see example below.
Example¶
This is a complete Alma provider specific configuration for ACD. See general configuration for a description of each parameter.
{
"limetypeCompany": "company",
"propertySavingError": "acd_errormessage",
"provider": "alma",
"propertiesToPopulateSearchWith": {
"searchText": [
"name"
]
},
"mapping": [
{
"limeProperty": "name",
"providerProperty": "companyBasicInfo.officialName.value"
},
{
"limeProperty": "registrationno",
"providerProperty": "businessId.value"
},
{
"limeProperty": "postaladdress1",
"providerProperty": "companyBasicInfo.officialpostalAddress.streetAddress.value"
},
{
"limeProperty": "postalcity",
"providerProperty": "companyBasicInfo.officialpostalAddress.postOffice.value"
},
{
"providerProperty": "companyBasicInfo.officialpostalAddress.postalCode.value",
"limeProperty": "postalzipcode"
},
{
"limeProperty": "acd_status",
"providerProperty": "companyBasicInfo.status.value"
},
{
"providerProperty": "companyBasicInfo.phoneNumber.value",
"limeProperty": "phone"
},
{
"providerProperty": "statementInfo.turnover.value",
"limeProperty": "acd_turnover"
},
{
"limeProperty": "acd_companytype",
"providerProperty": "companyBasicInfo.companyForm.value"
},
{
"limeProperty": "acd_industry",
"providerProperty": "companyBasicInfo.industry.industryLevel5.value"
},
{
"providerProperty": "companyBasicInfo.personnelcategory.value",
"limeProperty": "acd_personnelcategory"
},
{
"providerProperty": "companyBasicInfo.turnovercategory.value",
"limeProperty": "acd_turnovercategory"
},
{
"providerProperty": "companyBasicInfo.language.value",
"limeProperty": "acd_language"
},
{
"limeProperty": "acd_homemunicipality",
"providerProperty": "companyBasicInfo.homeMunicipality.value"
},
{
"limeProperty": "acd_locationmunicipality",
"providerProperty": "companyBasicInfo.locationMunicipality.value"
},
{
"limeProperty": "acd_email",
"providerProperty": "companyBasicInfo.email.value"
},
{
"limeProperty": "www",
"providerProperty": "companyBasicInfo.homePage.value"
},
{
"limeProperty": "acd_customerbase",
"providerProperty": "companyBasicInfo.customerBase.value"
},
{
"limeProperty": "acd_noofemployeescompany",
"providerProperty": "statementInfo.numberOfEmployees.value"
},
{
"limeProperty": "visitingaddress1",
"providerProperty": "companyBasicInfo.officialVisitingAddress.streetAddress.value"
},
{
"limeProperty": "visitingzipcode",
"providerProperty": "companyBasicInfo.officialVisitingAddress.postalCode.value"
},
{
"limeProperty": "visitingcity",
"providerProperty": "companyBasicInfo.officialVisitingAddress.postOffice.value"
}
],
"propertyName": "name",
"propertyProviderId": "acd_id",
"propertyLastUpdated": "acd_lastupdated",
"propertyResponsible": "coworker",
"last_checked_for_updates": "2024-03-19 14:08:10"
}
Application Configuration¶
ACD is using the application level configuration in order to configure API credentials for Alma Talent.
Windows on-premise Installations¶
For Windows on-premise installations, the application level configuration is expressed in the file:
%ProgramData%\Lundalogik\LIME Pro Server\application_config.yaml
Add the following to the application_config.yaml file:
<application-name>:
config:
addon-acd:
auto_update_enabled: true
secrets:
addon-acd:
alma:
credentials:
uid: <alma-uid>
username: <alma-username>
password: <alma-password>
invoiceReference: <alma-invoiceReference>
costCenter: <alma-costCenter> (optional)
Restart the web server.
Cloud¶
For Cloud installations, the application level configuration is configured in CAFE (Cloud Administration).
Add the following to the Secret box in the application configuration in CAFE:
addon-acd:
alma:
credentials:
uid: <alma-uid>
username: <alma-username>
password: <alma-password>
invoiceReference: <alma-invoiceReference>
costCenter: <alma-costCenter> (optional)
In order to enable automatic updates, add the following to the Config box in the application configuration in CAFE:
addon-acd:
auto_update_enabled: true
View Configuration¶
If Lime CRM web client: Add the needed ACD's web component and ACD's fields to the company view configuration as described below.
Company¶
Card¶
Note
Remember to do this for all existing variants.
-
Add ACD's web component
acd-update-objectas a widget on the card view configuration.
-
Add the following as a section to your card view configuration.
{ "title": "Alma Talent Information", "controls": [ { "property": "acd_locationmunicipality", "visible": true, "visibleOnCreate": false, "layout": {}, "component": { "props": {} } }, { "property": "acd_turnover", "visible": true, "visibleOnCreate": false, "layout": {}, "component": { "props": {} } }, { "property": "acd_personnelcategory", "visible": true, "visibleOnCreate": false, "layout": {}, "component": { "props": {} } }, { "property": "acd_customerbase", "visible": true, "visibleOnCreate": false, "layout": {}, "component": { "props": {} } }, { "property": "acd_language", "visible": true, "visibleOnCreate": false, "layout": {}, "component": { "props": {} } }, { "property": "acd_status", "visible": true, "visibleOnCreate": false, "layout": {}, "component": { "props": {} } }, { "property": "acd_companytype", "visible": true, "visibleOnCreate": false, "layout": {}, "component": { "props": {} } }, { "property": "acd_noofemployeescompany", "visible": true, "visibleOnCreate": false, "layout": {}, "component": { "props": {} } }, { "property": "acd_email", "visible": true, "visibleOnCreate": false, "layout": {}, "component": { "props": {} } }, { "property": "acd_industry", "visible": true, "visibleOnCreate": false, "layout": {}, "component": { "props": {} } } ] }
Table¶
Add the following as column properties to the table view configuration.
{
"property": "acd_id",
"isDefault": false
},
{
"property": "acd_lastupdated",
"isDefault": false
},
{
"property": "acd_turnovercategory",
"isDefault": false
},
{
"property": "acd_personnelcategory",
"isDefault": false
},
{
"property": "acd_industry",
"isDefault": false
}