CRM Educacional sells its software under the Wakeme name. This connector reads the integration API of Wakeme PRO and Wakeme Essencial. Wakeme One is a different system, with its own application and API, and is not covered by this connector.
Configuring CRM Educacional as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the CRM Educacional option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
CRM Educacional authenticates with the user name and password of an integration user (Usuário de Integração), which the institution creates inside its own CRM. The connector exchanges them for a temporary token on every run, so nothing has to be copied or renewed by hand.Create the integration user in the CRM before setting the source up — the vendor documents the steps under Usuário de Integração in its API documentation. A regular Dynamics CRM user also works, but it has to be declared as such in the Authentication type setting below.
-
API URL: the address of your institution’s CRM Educacional API, for example
https://yourschoolapi.crmeducacional.com. You can find it in the CRM under Configurações > CRM Educacional > aba Captação > “Endereço da Api Ficha de Inscrição”. Required. - Username: the user name of the integration user. Required.
- Password: the password of that user. Required.
-
Authentication type: which kind of user is signing in —
APICRMEducacionalfor an integration user (recommended) orCRMfor a Dynamics CRM user. Defaults toAPICRMEducacional. - Initial sync date: the earliest record change to sync. Records modified before this date are not read. Defaults to 2020-01-01.
- Page size: how many records are requested per page. The CRM caps a page at 5000; the default is 1000.
- Requests per minute: how fast the connector may call the API. CRM Educacional documents 50 requests per minute per user, which is the default. Lower it if the same integration user is shared with another integration.
2. Select streams
Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.Tip: The stream can be found more easily by typing its name.
Candidate Registrations and Leads are the largest streams on an institution’s account. The first extraction reads the whole history from the initial sync date; the runs after it only read what changed.
3. Configure data streams
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.- Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
- Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
- Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
- Sync Type: every stream supports INCREMENTAL, replicated on the timestamp of the last change to the record. Read more about Sync Types here.
4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:- Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
- Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
5. Check your new source
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.Streams and Fields
Available streams
The identifiers that join these tables are the CRM’s own GUIDs:
cad_clientepotencialid on a registration points at leadid, cad_concursoid at a selection process, cad_ofertaid at an offer, and cad_inscricaocandidatoid on payments, evaluations and classifications points back at the registration.
Fields by stream
Below you’ll find all available data streams from CRM Educacional and their corresponding fields:Leads
Leads
Every prospective student registered in the CRM, whether or not they went on to apply. This is the top of the admissions funnel: where the person came from, how to reach them, and which selection process and offer they are currently engaged with.
Candidate Registrations
Candidate Registrations
The heart of the funnel: one row per application. It carries the lead who applied, the selection process and the offers chosen, and where the application stands — its status in the process, whether the fee was paid and whether the candidate has been evaluated.
Selection Processes
Selection Processes
The intakes candidates apply to — a traditional entrance exam, an ENEM-based intake, a scheduled exam, graduate admissions, and so on — with the academic term they admit into and the date of the exam.
Offers
Offers
One course/campus/shift combination offered inside a selection process, with its seat counts, its price in instalments and the codes that tie it to the institution’s academic system.
Payments
Payments
The registration-fee charges raised against an application: the boleto or card transaction, when it was due, when it was processed and when it was paid.
Evaluations
Evaluations
One score per evaluation factor of a registration — the essay, the objective test, and any other factor the process is composed of.
Classifications
Classifications
Where a candidate ranked in a call (admission round) for a given offer, with the final score used to rank them.
Exam Schedules
Exam Schedules
The slots a scheduled exam is booked into, with the date, time, room and unit of the exam.
Accounts
Accounts
The institutional accounts (institution or campus) registrations belong to, with the permissions configured for each.