Configuration - Proff¶

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

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

Runtime Configuration¶

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

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

Example¶

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

{
  "mapping": [
    {
      "limeProperty": "name",
      "providerProperty": "company.name"
    },
    {
      "limeProperty": "postaladdress1",
      "providerProperty": "company.postalAddress.addressLine"
    },
    {
      "limeProperty": "postalzipcode",
      "providerProperty": "company.postalAddress.zipCode"
    },
    {
      "limeProperty": "postalcity",
      "providerProperty": "company.postalAddress.postPlace"
    },
    {
      "limeProperty": "visitingaddress1",
      "providerProperty": "company.visitorAddress.addressLine"
    },
    {
      "limeProperty": "visitingzipcode",
      "providerProperty": "company.visitorAddress.zipCode"
    },
    {
      "limeProperty": "visitingcity",
      "providerProperty": "company.visitorAddress.postPlace"
    },
    {
      "limeProperty": "www",
      "providerProperty": "company.homePage"
    },
    {
      "limeProperty": "phone",
      "providerProperty": "company.phoneNumbers.telephoneNumber"
    },
    {
      "limeProperty": "registrationno",
      "providerProperty": "company.organisationNumber"
    },
    {
      "limeProperty": "acd_unitstatus",
      "providerProperty": "company.status.statusFlag"
    },
    {
      "limeProperty": "acd_email",
      "providerProperty": "company.email"
    },
    {
      "limeProperty": "acd_legalform",
      "providerProperty": "company.companyType"
    },
    {
      "limeProperty": "acd_groupname",
      "providerProperty": "company.corporateStructure.parentCompanyName"
    }
  ],
  "propertiesToPopulateSearchWith": {
    "searchText": [
      "registrationno"
    ]
  },
  "proff": {
    "hideManualUpdateButton": true,
    "countries": [
      "SE",
      "NO",
      "DK"
    ],
    "defaultCountry": "SE"
  },
  "limetypeCompany": "company",
  "propertyProviderId": "acd_id",
  "propertyLastUpdated": "acd_lastupdated",
  "propertyResponsible": "coworker",
  "propertySavingError": "acd_errormessage",
  "provider": "proff",
  "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 Proff and enable automatic updates via a nightly job.

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

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¶

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": "Proff Information",
      "controls": [
        {
          "property": "acd_id",
          "readonly": true,
          "visibleOnCreate": false
        },
        {
          "property": "acd_unitstatus",
          "readonly": true,
          "visibleOnCreate": false
        },
        {
          "property": "acd_email",
          "readonly": true,
          "visibleOnCreate": false
        },
        {
          "property": "acd_legalform",
          "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_email",
      "isDefault": false
    },
    {
      "property": "acd_legalform",
      "isDefault": false
    },
    {
      "property": "acd_groupname",
      "isDefault": false
    }