Skip to main content

SigmaApp Integration

Native integration of ACCELERO with the SigmaApp application, used by residents/those responsible to schedule visits and grant access to visitors. Through the app, the visit is scheduled; ACCELERO generates the visitor's access QRCode and, as the pass happens, informs SigmaApp of the visit progress.

Requires licensing

SigmaApp is a licensed module (Integrations category). The configuration screen and the integration are only available when the sigmaapp module is enabled in the license. See Licensing.

How it works

The integration is bidirectional:

  • From SigmaApp to ACCELERO: the app registers/updates visitors and schedules visits, and requests the QRCode of the visitor's current visit. These calls are authenticated by the configured Access Key (sent in the ACCESSKEY header of each request).
  • From ACCELERO to SigmaApp: on each recorded access pass, ACCELERO updates the visit in SigmaApp, signaling when it was started and when it was completed (visit check-out).

Each visit scheduled in SigmaApp becomes an event in ACCELERO. The applied event type depends on the configured mapping (see below), and the visitor receives a QRCode to present at entry.

Configuration

Navigation path: Settings > Applications - SigmaApp

The configuration screen has two tabs: General and Event types.

TODO: Add Screenshot

Screen Settings > Applications - SigmaApp, General tab, showing the Operator, Require escort for new visitors, Authentication token (Access Key), and SigmaApp URL fields.

General tab

FieldRequiredDescription
OperatorYesOperator on whose behalf the visit events are created in ACCELERO
Require escort for new visitorsWhen enabled, the visitors created by the integration already come marked to require escort
Authentication token (Access Key)YesKey that authenticates the calls between SigmaApp and ACCELERO. It must match the key configured in SigmaApp
SigmaApp URLYesAddress of the SigmaApp API that ACCELERO calls to update the visits

Event types tab

In this tab you define the global event type mapping: for each SigmaApp visit category, choose the corresponding event type in ACCELERO. All are required.

Category in SigmaAppFieldMaps to
VisitSigmaApp Event "Visit"An ACCELERO event type
EventSigmaApp Event "Event"An ACCELERO event type
Service provisionSigmaApp Event "Service provision"An ACCELERO event type
OtherSigmaApp Event "Other"An ACCELERO event type
Create the event types first

Register in Events the types that will represent each category (for example, a "Visit" type and a "Service provision" type) before doing the mapping.

Mapping by company/division

In addition to the global mapping, each company/division can have its own event type mapping, overriding the global one only for it. In the company/division editing, the Event type mapping section repeats the four categories (Visit, Event, Service provision, Other); leave it blank to inherit the global mapping.

See Companies for the registration of companies and divisions.

Resident synchronization

An ACCELERO person can be synchronized as a resident in SigmaApp. The synchronization is done in the person editing.

Navigation path: People > All > [edit person] > SigmaApp

  • Synchronize SigmaApp — creates the resident in SigmaApp and stores the returned resident token in the person record.
  • Remove SigmaApp — undoes the synchronization (the resident is marked as removed in SigmaApp) and clears the token.
Phone required with 11 digits

To synchronize, the person needs a mobile phone with exactly 11 digits (area code + number). Without this, the synchronization is refused.

Do not delete a synchronized person

A person synchronized with SigmaApp cannot be deleted directly — perform the synchronization removal first. The SigmaApp - Resident token field is for reference only; changing it manually can break the integration.

TODO: Add Screenshot

SigmaApp section in the person editing, showing the Synchronize/Remove SigmaApp buttons and the Resident token field.

Typical flow

  1. The resident schedules the visit through SigmaApp and enters the visitor's data.
  2. SigmaApp sends the schedule to ACCELERO, which creates the visit event using the event type mapped for the category.
  3. The visitor receives the visit QRCode to present at entry.
  4. On arrival, the pass is validated and access is granted; if the option is enabled, the visitor requires escort.
  5. ACCELERO notifies SigmaApp that the visit was started and, at the end, that it was completed.

Best practices

  • Align the Access Key on both sides: the token configured in ACCELERO must be the same expected by SigmaApp, otherwise the calls are rejected.
  • Map all event types: the four categories are required in the global mapping; use the mapping by company/division only when some unit needs different types.
  • Standardize the residents' phone: ensure the mobile phone has 11 digits before synchronizing.
  • Decide on the escort: enable Require escort for new visitors if the client's policy requires accompanying visitors.

Next Steps

  • Events — register and map the visit event types
  • Escort — understand visitor accompaniment
  • Companies — configure the mapping by company/division
  • People — synchronize residents with SigmaApp