Configuration - Creditsafe¶

This section describes how you configure ACD for Creditsafe. You need to configure ACD in these places:

Runtime configuration
Application configuration
If Lime CRM web client:
- View configuration

Runtime Configuration¶

ACD uses Creditsafe Connect API 1.3 to provide company data. It's a one-to-one mapping between Lime CRM's company limetype and Creditsafe's /companies endpoint.

To see available mapping properties, head over to Creditsafe Connect specification and on the right side a response sample is available to explore. Don't forget the leading company. when mapping, as in the example below. There's also a Swagger documentation if you prefer that.

Countries¶

The handling of countries with Creditsafe is described in how it works. You must configure which countries ACD should search in as default. This is done via the countries parameter and it should be added as a comma separated string with ISO-2 country codes. Chosen countries should be activated in your agreement with Creditsafe.

Exact hits¶

The default behavior in Creditsafe is to not use exact hits. ACD can be configured to use exact hits by default with the onlyShowExactHits option. Set to true if the default behavior should be only exact hits. Please read in how it works to understand how this affects searches.

Example¶

This is a complete Creditsafe provider specific configuration for ACD. See general configuration for a description of each parameter.

{
  "creditsafe": {
    "countries": "SE,DK",
    "onlyShowExactHits": false,
    "onlyShowActive": true
  },
  "mapping": [
    {
      "limeProperty": "name",
      "providerProperty": "company.report.companySummary.businessName"
    },
    {
      "limeProperty": "postaladdress1",
      "providerProperty": "company.report.contactInformation.mainAddress.street"
    },
    {
      "limeProperty": "postalzipcode",
      "providerProperty": "company.report.contactInformation.mainAddress.postalCode"
    },
    {
      "limeProperty": "postalcity",
      "providerProperty": "company.report.contactInformation.mainAddress.city"
    },
    {
      "limeProperty": "country",
      "providerProperty": "company.report.contactInformation.mainAddress.country"
    },
    {
      "limeProperty": "phone",
      "providerProperty": "company.report.contactInformation.mainAddress.telephone"
    },
    {
      "limeProperty": "registrationno",
      "providerProperty": "company.report.companySummary.companyRegistrationNumber"
    },
    {
      "limeProperty": "acd_unittype",
      "providerProperty": "company.report.groupStructure.ultimateParent.officeType"
    },
    {
      "limeProperty": "acd_unitstatus",
      "providerProperty": "company.report.companySummary.companyStatus.status"
    },
    {
      "limeProperty": "acd_maintradecode",
      "providerProperty": "company.report.companySummary.mainActivity.code"
    },
    {
      "limeProperty": "acd_maintrade",
      "providerProperty": "company.report.companySummary.mainActivity.description"
    },
    {
      "limeProperty": "acd_legalname",
      "providerProperty": "company.report.companyIdentification.basicInformation.registeredCompanyName"
    },
    {
      "limeProperty": "acd_legalform",
      "providerProperty": "company.report.companyIdentification.basicInformation.legalForm.description"
    },
    {
      "limeProperty": "acd_vatno",
      "providerProperty": "company.report.companyIdentification.basicInformation.vatRegistrationNumber"
    },
    {
      "limeProperty": "acd_turnover",
      "providerProperty": "company.report.companySummary.latestTurnoverFigure.value"
    },
    {
      "limeProperty": "acd_turnovercurrency",
      "providerProperty": "company.report.companySummary.latestTurnoverFigure.currency"
    },
    {
      "limeProperty": "acd_groupname",
      "providerProperty": "company.report.groupStructure.ultimateParent.name"
    },
    {
      "limeProperty": "acd_creditratingvalue",
      "providerProperty": "company.report.creditScore.currentCreditRating.commonValue"
    },
    {
      "limeProperty": "acd_creditratingdescription",
      "providerProperty": "company.report.creditScore.currentCreditRating.commonDescription"
    }
  ],
  "propertiesToPopulateSearchWith": {
    "searchText": [
      "name"
    ],
    "city": [
      "postalcity"
    ]
  },
  "limetypeCompany": "company",
  "propertyProviderId": "acd_id",
  "propertyLastUpdated": "acd_lastupdated",
  "propertyResponsible": "coworker",
  "provider": "creditsafe",
  "customCommandId": "",
  "propertyName": "name"
}

Application Configuration¶

ACD is using the application level configuration in order to configure API credentials for Creditsafe.

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 following to the application_config.yaml file:

<application-name>:
  secrets:
    addon-acd:
      creditsafe:
        credentials:
          client_id: <creditsafe-username>
          secret: <creditsafe-password>

Restart the web server

Cloud¶

For Cloud installations, the application level configuration is configured in CAFE (Cloud Administration).

Add following to the Secret box in the application configuration in CAFE:

addon-acd:
  creditsafe:
    credentials:
      client_id: <creditsafe-username>
      secret: <creditsafe-password>

View Configuration¶

If Lime CRM web client: Add ACD's web component and ACDs' fields to the company view configuration as described below.

Company¶

Card¶

Add ACD's web component to the card view configuration as below or add acd-update-object to the web component slot in the UI of Lime admin.

"components": [
    {
      "name": "acd-update-object"
    }
]

Add the following as a section to your card view configuration.

    {
      "title": "Creditsafe Information",
      "controls": [
        {
          "property": "acd_id",
          "readonly": true
        },
        {
          "property": "acd_unitstatus",
          "readonly": true
        },
        {
          "property": "acd_maintradecode",
          "readonly": true
        },
        {
          "property": "acd_maintrade",
          "readonly": true
        },
        {
          "property": "acd_legalname",
          "readonly": true
        },
        {
          "property": "acd_legalform",
          "readonly": true
        },
        {
          "property": "acd_vatno",
          "readonly": true
        },
        {
          "property": "acd_groupname",
          "readonly": true
        },    
        {
          "property": "acd_turnover",
          "readonly": true
        },
        {
          "property": "acd_turnovercurrency",
          "readonly": true
        },    
        {
          "property": "acd_creditratingvalue",
          "readonly": true
        },
        {
          "property": "acd_creditratingdescription",
          "readonly": true
        }
      ]
    }

Table¶

Add the following as column properties to the table view configuration.

    {
      "property": "acd_id",
      "isDefault": false
    },
    {
      "property": "acd_lastupdated",
      "isDefault": false
    },
    {
      "property": "acd_unitstatus",
      "isDefault": false
    },
    {
      "property": "acd_maintradecode",
      "isDefault": false
    },
    {
      "property": "acd_maintrade",
      "isDefault": false
    },
    {
      "property": "acd_legalname",
      "isDefault": false
    },
    {
      "property": "acd_legalform",
      "isDefault": false
    },
    {
      "property": "acd_vatno",
      "isDefault": false
    },
    {
      "property": "acd_groupname",
      "isDefault": false
    },
    {
      "property": "acd_turnover",
      "isDefault": false
    },
    {
      "property": "acd_turnovercurrency",
      "isDefault": false
    },
    {
      "property": "acd_creditratingvalue",
      "isDefault": false
    },
    {
      "property": "acd_creditratingdescription",
      "isDefault": false
    }