Configuration¶
Credit Info may support several providers, currently only Creditsafe's Credit Template is supported.
To enable the add-on, an instance must be configured in Lime Admin. It is possible to enable the add-on on multiple limetypes by creating additional instances. Since different providers work differently, the configuration differs a little from provider to provider.
Note that the view access that you set in the configuration in Lime Admin only applies to showing or not showing on the Object card header. The actual fields where the rating are still visible. If you want them too to be hidden for selected user groups, then you will have to add a field policy on them in LISA, according to how that is normally done in Lime CRM.
Credit Template¶
Add-on Configuration¶
Parameter | Values | Comment |
---|---|---|
instanceId | String | Your unique id for the instance, e.g., ct-company . |
groupAccess | Object | Contains information about view and update access. |
groupAccess.view | Array | List of strings of groups that will be able to view the rating on the company card. |
groupAccess.update | Array | List of strings of groups that will be able to update the rating. Note that having update access does not imply that you automatically get view access. |
onlyAllowPublicCompanies | Boolean | true only allows credit checks on public companies. |
limetype | String | Limetype name. |
propertyRegistrationNumber | String | Name of Registration number property. |
propertyLastUpdated | String | Name of Last updated property. |
propertyRating | String | Name of Rating property. |
The raw JSON format of the configuration for Credit Template is described below with example values.
{
"creditTemplate": [
{
"instanceId": "ct-company",
"groupAccess": {
"view": [
"Users",
"Administrators"
],
"update": [
"Users",
"Administrators"
]},
"onlyAllowPublicCompanies": true,
"limetype": "company",
"propertyRegistrationNumber": "registrationno",
"propertyLastUpdated": "credittemplatelastupdate",
"propertyRating": "credittemplaterating"
}
]
}
Application Config¶
Lime-credit-info is using the application level configuration in order to configure secrets
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
. If it does not already exist, just create it.
The application_config.yaml file is shared by all services.
<application-display-name>:
secrets:
limepkg-credit-info:
<Instance_id>:
userLoginName: <userLoginName>
password: <password>
templateName: <templateName>
Restart the web server and the event handler.
Cloud¶
For Cloud installations, the application level configuration is configured in CAFE (Lime CRM Cloud Administration).
Add following to the Secret box in the application configuration in CAFE:
limepkg-credit-info:
<Instance_id>:
userLoginName: <userLoginName>
password: <password>
templateName: <templateName>
Table Configuration¶
The following should be added to the Table view configuration for the object where the rating is stored (most commonly the company
table):
{
"property": "credittemplaterating",
"isDefault": false
},
{
"property": "credittemplatelastupdate",
"isDefault": false
}
Card Configuration¶
For Lime CRM server version 2020.3 or later: Add Credit Info's web component to the card view configuration for each configured limetype instance (most commonly the company
card) as below or add lwc-credit-info
to the web component slot in the UI of Lime admin.
"components": [
{
"name": "lwc-credit-info"
}
]