Configuration
Lime Bootstrap App
The following parameters are possible to configure in the instantiation of the Lime Bootstrap App.
Parameter | Values | Default Value | Comment |
---|---|---|---|
view | 'actionpad' or 'dashboard' |
'actionpad' |
'actionpad' will show the buttons and 'dashboard' will show the graph. |
groups | Array of strings | undefined | Specify an array of strings with the names of the LISA groups. If undefined, all users have permission to the ERP Connector. |
activeAddons | Array of strings | undefined | Specify an array of strings with the names of the ERP Connector add-ons that are active in this solution. Only valid string at this moment is 'erpmaster' . |
logLevel | 'debug' or 'info' |
'info' |
Set to 'debug' to increase logging to the Info Log tab when making calls to the Syncify services. |
dev | true or false |
false |
Set to true if calls should be made to the test environment for Syncify's cloud service. |
VBA Module
In the VBA module, there are Consts
at the top of the file for settings for the communication with the Syncify services. How to use them is described in the installation instructions.
Parameter | Values | Comment |
---|---|---|
m_sErpSystem | One String of "vismaadministration" , "vismabusiness" , "navision" , "fortnox" , "economic" , "vismanet" , "bladministration" , "businesscentral" , "powerofficego" , "vismaeekonomi" , "exactonline" , "uniconta" or "tripletex" |
Has implications on ERP Master behavior and localization texts. |
m_localErpUrl | String | Only used for on-premise ERP systems. Url to the server where the Syncify service is installed. It should be on the format http://erpserver:8080/api/customer . |
m_accessKey | String | Only used for cloud ERP systems. Set according to internal Lime Technologies documentation. |
m_secretKey | String | Only used for cloud ERP systems. Set according to internal Lime Technologies documentation. |
m_clientId | String | Only used for cloud ERP systems. A GUID. Set according to what Syncify has provided. |
Lime Admin
If the ERP Connector should be used from the web client, then configuration must be added in Lime Admin as well.
Add-on Configuration
Common Parameters
Parameter | Values | Comment |
---|---|---|
instanceId | String | Your unique id for the instance, eg company-fortnox |
system | String | One of vismaadministration , vismabusiness , navision , fortnox , economic , vismanet , bladministration , businesscentral , powerofficego , vismaeekonomi , exactonline , uniconta or tripletex |
systemDisplayName | String | Custom name used on the button in the web client. If left empty, the default name of the system will be used |
groups | Array | List of group names that should have access to the button on the company. |
Cloud Parameters
The following parameters can be used only when integrating towards a cloud based ERP system.
Parameter | Values | Comment |
---|---|---|
accessKey | String | Set according to internal Lime Technologies documentation. |
secretAccessKey | String | Set according to internal Lime Technologies documentation. |
clientId | String | A GUID. Set according to what Syncify has provided. |
url | String | Url to Syncify cloud service. For production, use api.syncify.se . For test, use testapi.syncify.se . |
limetype | String | Name of the Limetype for Company. |
erpid | String | Name of ERP id property. |
name | String | Name of name property. |
organisationnumber | String | Name of Organisation Number property. |
String | This is part of the Syncify API for future considerations. Will not be passed on to the ERP system. | |
emailinvoice | String | Name of Invoice email property. |
fax | String | This is part of the Syncify API for future considerations. Will not be passed on to the ERP system. |
telephone | String | Name of Telephone property. |
address1 | String | Name of Address (1) property. |
address2 | String | Name of Address (2) property. |
city | String | Name of City property. |
zipcode | String | Name of Zip code property. |
country | String | Name of Country property. |
deliveryaddress | String | Name of Delivery Address (1) property. |
deliveryaddress2 | String | Name of Delivery Address (2) property. |
deliverycity | String | Name of Delivery City property. |
deliveryzipcode | String | Name of Delivery Zip Code property. |
visitingaddress | String | Name of Visiting Address (1) property. |
visitingaddress2 | String | Name of Visiting Address (2) property. |
visitingcity | String | Name of Visiting City property. |
visitingzipcode | String | Name of Visiting Zip code property. |
reference | String | Name of reference Co-worker property. |
Example Add-on Configuration
The following example is for a Lime CRM Base Solution integrated towards a cloud based ERP system, in this case Fortnox.
{
"cloud": [
{
"instanceId": "<SET YOUR OWN UNIQUE ID>",
"system": "fortnox",
"systemDisplayName": "<OPTIONAL CUSTOM SYSTEM NAME>",
"groups": [
"Administrators",
"Superusers",
"Users"
],
"accessKey": "<SOME SECRET STRING>",
"secretAccessKey": "<SOME SECRET STRING>",
"clientId": "<SOME SECRET STRING>",
"url": "api.syncify.se",
"limetype": "company",
"erpid": "erpid",
"name": "name",
"organisationnumber": "registrationno",
"email": "",
"emailinvoice": "emailinvoice",
"fax": "",
"telephone": "phone",
"address1": "invoiceaddress1",
"address2": "invoiceaddress2",
"city": "invoicecity",
"zipcode": "invoicezipcode",
"country": "country",
"deliveryaddress": "visitingaddress1",
"deliveryaddress2": "visitingaddress2",
"deliverycity": "visitingcity",
"deliveryzipcode": "visitingzipcode",
"visitingaddress": "visitingaddress1",
"visitingaddress2": "visitingaddress2",
"visitingcity": "visitingcity",
"visitingzipcode": "visitingzipcode",
"reference": "coworker"
}
]
}
View Configuration
The following needs to be added to the views in the Web Client.
Company
Card
Add the below under the section for Addresses:
{
"property": "invoiceaddress1"
},
{
"property": "invoicezipcode"
},
{
"property": "invoicecity"
}
Add the below under the section for Additional Info:
{
"property": "emailinvoice"
}
Add a new section for the ERP information.
{
"title": "ERP Information",
"controls": [
{
"property": "erpid",
"readonly": true
},
{
"property": "erp_turnover_yearnow",
"readonly": true
},
{
"property": "erp_turnover_lastyear",
"readonly": true
}
]
}
For Lime CRM server version 2020.3 or later: Add ERP Connector's web component to the card view configuration as below or add lwc-limepkg-erp-connector
to the web component slot in the UI of Lime admin.
"components": [
{
"name": "lwc-limepkg-erp-connector"
}
]
List
If you want the ERP id to be shown in the lists of related objects, set your header to for example this:
"header": [
{
"property": "name"
},
{
"property": "buyingstatus"
},
{
"property": "erpid"
},
{
"property": "coworker"
}
],
Search
If you want the ERP id to be shown in the search results, set your header to for example this:
"header": [
{
"property": "name"
},
{
"property": "buyingstatus"
},
{
"property": "erpid"
},
{
"property": "coworker"
}
],
Table
Add the below to the table config for company.
{
"property": "erpid",
"isDefault": true
},
{
"property": "erp_turnover_yearnow",
"isDefault": false
},
{
"property": "erp_turnover_lastyear",
"isDefault": false
},
{
"property": "emailinvoice",
"isDefault": false
}
Invoice
Invoice is a new table added by the ERP Connector and it will not have any view config.
Card
{
"header": [
{
"property": "invoice_number"
}
],
"sections": [
{
"title": null,
"controls": [
{
"property": "invoice_number",
"readonly": true
},
{
"property": "company",
"readonly": true
},
{
"property": "customerid",
"readonly": true
},
{
"property": "customer_reference",
"readonly": true
},
{
"property": "coworker",
"readonly": true
},
{
"property": "invoice_type",
"readonly": true
},
{
"property": "invoice_date",
"readonly": true
},
{
"property": "invoice_expires",
"readonly": true
},
{
"property": "currency",
"readonly": true
}
]
},
{
"title": "Payment",
"controls": [
{
"property": "invoice_sum",
"readonly": true
},
{
"property": "invoice_vat",
"readonly": true
},
{
"property": "invoice_total_sum",
"readonly": true
},
{
"property": "invoice_balance",
"readonly": true
},
{
"property": "paid",
"readonly": true
},
{
"property": "paid_date",
"readonly": true
},
{
"property": "invoice_shredded",
"readonly": true
}
]
}
],
"relations": [
{
"property": "invoicerow"
}
]
}
List
{
"header": [
{
"property": "company"
},
{
"property": "invoice_number"
},
{
"property": "invoice_sum"
}
],
"subheader": [
{
"property": "coworker"
},
{
"property": "currency"
},
{
"property": "paid"
}
]
}
Search
{
"header": [
{
"property": "company"
},
{
"property": "invoice_number"
},
{
"property": "invoice_sum"
}
],
"subheader": [
{
"property": "coworker"
},
{
"property": "currency"
},
{
"property": "paid"
}
]
}
Table
{
"actions": [
],
"columns": [
{
"property": "company",
"isDefault": true
},
{
"property": "invoice_number",
"isDefault": true
},
{
"property": "customerid",
"isDefault": true
},
{
"property": "customer_reference",
"isDefault": false
},
{
"property": "coworker",
"isDefault": true
},
{
"property": "invoice_type",
"isDefault": false
},
{
"property": "invoice_date",
"isDefault": true
},
{
"property": "invoice_expires",
"isDefault": false
},
{
"property": "currency",
"isDefault": true
},
{
"property": "invoice_sum",
"isDefault": true
},
{
"property": "invoice_vat",
"isDefault": false
},
{
"property": "invoice_total_sum",
"isDefault": false
},
{
"property": "invoice_balance",
"isDefault": false
},
{
"property": "paid",
"isDefault": true
},
{
"property": "paid_date",
"isDefault": true
},
{
"property": "invoice_shredded",
"isDefault": false
}
],
"enabled": true
}
Invoice Row
Invoice row is a new table added by the ERP Connector and it will not have any view config.
Card
{
"header": [
{
"property": "invoice"
}
],
"sections": [
{
"title": null,
"controls": [
{
"property": "invoice",
"readonly": true
},
{
"property": "company",
"readonly": true
},
{
"property": "item",
"readonly": true
},
{
"property": "description",
"readonly": true
},
{
"property": "units",
"readonly": true
},
{
"property": "row_margin",
"readonly": true
},
{
"property": "row_value",
"readonly": true
}
]
}
],
"relations": [
]
}
List
{
"header": [
{
"property": "company"
},
{
"property": "invoice"
},
{
"property": "rowid"
}
],
"subheader": [
{
"property": "units"
},
{
"property": "description"
},
{
"property": "row_value"
}
]
}
Search
{
"header": [
{
"property": "company"
},
{
"property": "invoice"
},
{
"property": "rowid"
}
],
"subheader": [
{
"property": "units"
},
{
"property": "description"
},
{
"property": "row_value"
}
]
}
Table
{
"actions": [
],
"columns": [
{
"property": "company",
"isDefault": true
},
{
"property": "invoice",
"isDefault": true
},
{
"property": "item",
"isDefault": true
},
{
"property": "description",
"isDefault": true
},
{
"property": "units",
"isDefault": true
},
{
"property": "row_margin",
"isDefault": false
},
{
"property": "row_value",
"isDefault": true
},
{
"property": "rowid",
"isDefault": false
}
],
"enabled": true
}