Configuration - Checkbiz¶

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

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

Runtime Configuration¶

ACD uses Checkbiz API to provide company data. It's a one-to-one mapping between Lime CRM's company limetype and Checkbiz's /companyinformation endpoint.

To see available mapping properties, head over to Checkbiz's Swagger documentation and look at the example responses on the /companyinformation endpoint. When you're mapping Checkbiz data to Lime properties in the configuration, you should be aware of that the result from Checkbiz is flattened and prefixed with company.

Example¶

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

{
  "mapping": [
    {
      "limeProperty": "name",
      "providerProperty": "company.basic.companyName"
    },
    {
      "limeProperty": "postaladdress1",
      "providerProperty": "company.basic.street"
    },
    {
      "limeProperty": "postaladdress2",
      "providerProperty": "company.basic.co"
    },
    {
      "limeProperty": "postalzipcode",
      "providerProperty": "company.basic.zipCode"
    },
    {
      "limeProperty": "postalcity",
      "providerProperty": "company.basic.city"
    },
    {
      "limeProperty": "phone",
      "providerProperty": "company.basic.phoneNumber"
    },
    {
      "limeProperty": "registrationno",
      "providerProperty": "company.basic.organizationNumber"
    },
    {
      "limeProperty": "acd_unitstatus",
      "providerProperty": "company.extended.status"
    },
    {
      "limeProperty": "acd_maintradecode",
      "providerProperty": "company.extended.registeredSNI.0.code"
    },
    {
      "limeProperty": "acd_maintrade",
      "providerProperty": "company.extended.registeredSNI.0.text"
    },
    {
      "limeProperty": "acd_legalform",
      "providerProperty": "company.basic.companyCodeText"
    },
    {
      "limeProperty": "acd_turnover",
      "providerProperty": "company.economicBasic.turnover"
    },
    {
      "limeProperty": "acd_noofemployeescompany",
      "providerProperty": "company.economicExtended.numberOfEmployees"
    },
    {
      "limeProperty": "acd_groupname",
      "providerProperty": "company.extended.groupParentCompanyName"
    },
    {
      "limeProperty": "acd_netprofit",
      "providerProperty": "company.economicBasic.resultAfterNetBalance"
    }
  ],
  "propertiesToPopulateSearchWith": {
    "searchText": [
      "name"
    ],
    "city": [
      "postalcity"
    ]
  },
  "limetypeCompany": "company",
  "propertyProviderId": "acd_id",
  "propertyLastUpdated": "acd_lastupdated",
  "propertyResponsible": "coworker",
  "propertySavingError": "acd_errormessage",
  "provider": "checkbiz",
  "customCommandId": "",
  "propertyName": "name",
  "last_checked_for_updates": "2022-06-10 07:10:03"
}

Application Configuration¶

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

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>:
  secrets:
    addon-acd:
      checkbiz:
        credentials:
          token: <checkbiz-token>

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:
  checkbiz:
    credentials:
      token: <checkbiz-token>

View Configuration¶

Add ACD's web component and the newly created 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-object as a widget on the card view configuration.

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

    {
      "title": "Checkbiz Information",
      "controls": [
        {
          "property": "acd_id",
          "readonly": true,
          "visibleOnCreate": false
        },
        {
          "property": "acd_unitstatus",
          "readonly": true,
          "visibleOnCreate": false
        },
        {
          "property": "acd_maintrade",
          "readonly": true,
          "visibleOnCreate": false
        },
        {
          "property": "acd_maintradecode",
          "readonly": true,
          "visibleOnCreate": false
        },
        {
          "property": "acd_legalform",
          "readonly": true,
          "visibleOnCreate": false
        },
        {
          "property": "acd_turnover",
          "readonly": true,
          "visibleOnCreate": false
        },
        {
          "property": "acd_netprofit",
          "readonly": true,
          "visibleOnCreate": false
        },
        {
          "property": "acd_noofemployeescompany",
          "readonly": true,
          "visibleOnCreate": false
        },
        {
          "property": "acd_groupname",
          "readonly": true,
          "visibleOnCreate": false
        }
      ]
    }

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_maintrade",
      "isDefault": false
    },
    {
      "property": "acd_maintradecode",
      "isDefault": false
    },
    {
      "property": "acd_legalform",
      "isDefault": false
    },
    {
      "property": "acd_turnover",
      "isDefault": false
    },
    {
      "property": "acd_netprofit",
      "isDefault": false
    },
    {
      "property": "acd_noofemployeescompany",
      "isDefault": false
    },
    {
      "property": "acd_groupname",
      "isDefault": false
    }