Collect real-time data with Ara via SIRI interface

This guide describes how to configure an Exchange Partner so that Ara can collect real-time data from a CAD/AVL via SIRI. For Ara’s role and the common concepts (exchange directions, RequestorRef / ProducerRef credentials), see the Ara Guides page.

Principle of a SIRI collection

Ara SaaS can collect real-time data in several ways. The most appropriate configuration is to use the SIRI protocol to continuously collect the status of stops and their scheduled calls.

Open

The simplest configuration combines the following three standard SIRI services:

• CheckStatus: to continuously monitor the status of the CAD/AVL’s SIRI server;

• StopPointsDiscovery: to continuously know the set of stops that can be collected in real time;

• StopMonitoring (in subscription mode): to continuously collect the status of stops and their scheduled calls.

To configure this Exchange Partner, three settings are required:

• the public URL of the CAD/AVL’s SIRI service (remote_url);

• Ara’s identity, sent as RequestorRef in requests (remote_credential);

• the partner’s identity, expected as ProducerRef in its notifications (local_credential).

Open

SIRI notifications are sent by the CAD/AVL’s SIRI server to Ara on the public URL: https://ara-api.enroute.mobi/<referential>/siri. This URL is transmitted in each SIRI subscription request made by Ara (so it does not necessarily require any configuration).

Example Exchange Partner configuration

The following corresponds to the default configuration of a new Exchange Partner collecting in SIRI StopMonitoring:

Connectors

• SIRI CheckStatus Client

• SIRI CheckStatus Server

• SIRI StopMonitoring Subscription Collector

• SIRI StopPointsDiscovery Request Collector

Settings

• local_credential: ProducerRef used by the CAD/AVL’s SIRI server in its notifications/responses to Ara (the partner’s identity, used to identify it)

• remote_credential: RequestorRef used by Ara to query the remote SIRI server (Ara’s identity)

• remote_url: the public URL of the remote SIRI server

• remote_code_space: the type of identifier to use for the collected data (in relation with the other Exchange Partners defined in Ara)

• collect_use_discovered_stop_areas: true (to collect only the stops discovered via SIRI StopPointsDiscovery)

For the full description of all parameters, see Ara Partner Parameters.