Mapsly is a standalone software platform that uses Creatio API to automatically import new and updated data from your Creatio and sync data that was created, updated and removed in Mapsly back to Creatio. To automatically remove in Mapsly data that has been deleted in your Creatio, Mapsly uses an extension for Creatio.
This guide will walk you through setting up a new Mapsly account and connecting your Creatio to it.
1- Sign up for a Mapsly account and connect your Creatio to it
Go to https://app.mapsly.com/signup/creatio and follow instructions in the sign-up wizard to create your Mapsly account.
A detailed walkthrough for the sign-up wizard is available here; on its step #3 "Access to data" you'll be prompted to enter your Creatio administrator's login and password, as well as your full Creatio domain including "https://" (for example: https://083952-crm-bundle.creatio.com):
Note! While you can use admin credentials and it will work perfectly, Creatio recommends adding a new user and adjusting its permissions (read/write for objects). Any user who is listed in “Operation permissions à Access to OData” can have access to data. System administrators can configure access permissions for every user or a group of users. These permissions apply throughout the application including DataService and OData.
Note! If there is an issue concerning authentication while entering your Creatio login and password, please reset the password in your Creatio account. See the steps below:
2- Check your Creatio version and enable API optimization feature
If you are using Creatio version earlier that 7.18.1 AND intend to import more than 50,000 records to Mapsly, you need to enable the UseEsqOffsetPagingInEntityQueryProvider feature, which optimizes data exchange via Creatio API:
If you are using a cloud instance of Creatio, please contact Creatio support, and they will enable this feature for you.
If you are using on-site instance of Creatio, please contact your Creatio administrator to enable this feature using the following instruction:
1. Open the file located at: [app_address]\Terrasoft.WebApp\Web.config
2. Find the line that says
<add key="Feature-UseEsqOffsetPagingInEntityQueryProvider" value="false" />
3. Replace false with true
4. Save the file
3- Install Mapsly extension for Creatio
Mapsly extension (application) for Creatio serves two purposes:
When you remove a record in Creatio, the extension calls Mapsly API to remove this record from Mapsly.
It adds Mapsly tab to your left panel, so you can open Mapsly inside Creatio in 1-click. (You will also be able to log into Mapsly at https://app.mapsly.com.)
To install the Mapsly extension in your Creatio:
1- In a new browse tab, go to https://marketplace.creatio.com/app/mapsly-connector-creatio (keep the Mapsly browser tab - you will need it later to generate the API key).
2- Click at the Install button:
3- On the page that will open, paste the domain URL of your Creatio app (for example https://101656-crm-bundle.creatio.com/) as shown on the screenshot and click Install:
4- On the installation confirmation screen, click Install again:
5- Once the application installation is completed, you will see the confirmation screen:
4- Generate Mapsly API key and add it to your Creatio settings
To remove records in Mapsly, the extension will use your Mapsly API key that this section will help you generate and add to your Creatio settings.
1- Go to System settings:
2- Find and open Mapsly adapter API key setting:
3- Now let's generate the API key in Mapsly:
switch to your Mapsly browser tab,
go to Setup in the main menu:
In the context menu of your data source, go to General properties:
Generate the API key, copy in to Clipboard and click Save:
4- Switch to Creatio browser tab and paste the API key to the Default value of the Mapsly adapter API key setting:
Your installation is now complete.
Important #1: Users with Creatio version below 7.18.3 need to recompile their Creatio instance manually when setting up OData integration in sections created in the Section Wizard.
Important #2: Creatio OData API does not support fields that have special symbols in their names. Fields with special symbols like "_" will be skipped by Mapsly during the import. In order to use such fields, you need to rename these fields first.
Important #3: Creatio API returns responses in the user's timezone and not UTC. Because of that, when connecting Creatio to Mapsly, it is important to select the same timezone as the timezone of your Creatio user.
To read more about Odata and setting up sections using Section Wizard please check the following articles:
How to log into Mapsly
You can open Mapsly either by going to https://app.mapsly.com or by clicking the Mapsly tab on the left panel in your Creatio:
When prompted, enter your Mapsly login (email) and password into the Mapsly login form.
How to add Creatio as a data source to an existing Mapsly account
If you already have an a Mapsly account, you can add your Creatio CRM as a data source to it:
Go to Setup in the Mapsly main menu:
Click the + button, select Creatio and follow instructions on the screen:
How to add more users to Mapsly
Please note that you will need to add to Mapsly only those users who will actually be using Mapsly (not all Creatio users).
Also, it is possible to add users to Mapsly who are not Creatio users.
How to re-compile your Creatio instance
In order to recompile your Creatio instance please follow this guide.
More useful articles
If you'd like to see on the map only standard objects like contacts, the wizard's instructions are self-explanatory. In more complex scenarios when you'd like to see other objects in Mapsly as well or use coordinates instead of an object's address, please refer to these articles:
how to use an object's coordinates stored in the CRM instead of its address in Mapsly (how to skip geocoding for locations that cannot be described by an address or those for which you already have GPS coordinates in your CRM);