Ara Partner Parameters
This page is the exhaustive reference of an Exchange Partner's parameters. To configure a partner for your case (collect/broadcast, SIRI/GTFS-RT), start with Ara Guides, which list the connectors and parameters for each scenario; this page then details each parameter.
Mandatory settings per connector type
The mandatory settings depend on the direction of the exchange — collect (Ara is the client) or broadcast (Ara is the server) — and the mode (request / subscription).
A missing mandatory setting causes a validation error when creating or updating the partner.
Legend: ✓ = mandatory · empty = not required.
SIRI connectors
Direction | Mode |
|
|
|
|
|---|---|---|---|---|---|
Collect | Request | ✓ | ✓ | ✓ |
|
Collect | Subscription | ✓ | ✓ | ✓ | ✓ |
Broadcast | Request | ✓ |
|
| ✓ |
Broadcast | Subscription | ✓ | ✓ | ✓ | ✓ |
Applies to all SIRI services: StopMonitoring, EstimatedTimetable, VehicleMonitoring, GeneralMessage, SituationExchange, FacilityMonitoring, ProductionTimetable, StopPointsDiscovery, LinesDiscovery. Discovery services exist only in Request mode.
GTFS-RT
Connector(s) | Direction |
|
|
|---|---|---|---|
GTFS-RT collector | Collect | ✓ | ✓ |
Trip Updates / Vehicle Positions / Service Alerts Broadcaster | Broadcast | ✓ |
|
GTFS-RT works by polling only (no subscription mode). local_credential is optional for broadcast (private API key).
CheckStatus
Connector |
|
|
|
|---|---|---|---|
SIRI CheckStatus Client — Ara queries the remote server status | ✓ | ✓ |
|
SIRI CheckStatus Server — Ara answers incoming CheckStatus requests |
|
| ✓ |
Other connectors
Connector |
|
|
|---|---|---|
GraphQL server |
| ✓ |
Push Collector | ✓ | ✓ |
The technical identifier of a connector (used via the API and in <connector>.xxx settings) is shown in the interface and listed in List of parameters. Example: SIRI EstimatedTimetable Request Broadcaster → siri-estimated-timetable-request-broadcaster.
Parameter format
All parameters are strings, but can be interpreted as integers, arrays, etc.
Type | Description | Example |
|---|---|---|
| Integer. An incorrect value is interpreted as |
|
| Boolean: |
|
| A string of characters. |
|
| Array of character strings separated by commas. |
|
| (Optionally signed) decimal numbers describing a duration, each with a unit. Units: |
|
List of parameters
Connection parameters
Ara makes its requests using OAuth if the 3 parameters remote_authentication.oauth.client_id, remote_authentication.oauth.client_secret and remote_authentication.oauth.token_url are defined. The remote_authentication.oauth.scopes parameter must be added if it is required by the OAuth server.
Name | Type | Description |
|---|---|---|
local_credential | string | Token identifying incoming requests; must be unique among the Partners of a given referential |
local_credentials | []string | List of tokens identifying incoming requests; each must be unique (per referential). Adds to a possible token defined in |
remote_credential | string | Token identifying Ara: |
remote_authentication.oauth.client_id | string | Identifier used to retrieve the Token for exchanges using OAuth |
remote_authentication.oauth.client_secret | string | Secret used to retrieve the Token for exchanges using OAuth |
remote_authentication.oauth.token_url | string | Address where Ara's HTTP client retrieves the Token for exchanges using OAuth |
remote_authentication.oauth.scopes | []string | List of scopes to retrieve the Token for exchanges using OAuth |
siri.credential.header | string | Name of the HTTP header in which Ara puts its credential ( |
local_url | string | Ara address sent in the SIRI |
remote_url | string | Address of the remote partner |
notifications.remote_url | string | Address to send subscription notifications to. Without this parameter, |
subscriptions.remote_url | string | Address to send subscription requests to. Without this parameter, |
subscriptions.terminate.remote_url | string | Address to send subscription termination (DeleteSubscription) requests to. Without this parameter, |
partner.status.maximum_retry | int | Number of consecutive Unknown CheckStatus before changing the partner's status to Unknown |
rate_limit_per_ip | int | Limit the number of requests per minute and per IP address received by Ara for a partner |
http.custom_headers | []string | Specific HTTP headers included in each SIRI / SIRI-Lite request of the partner. Format: |
Identifier settings
These parameters define the code spaces (identifier types) used to match the data exchanged with the partner. Each parameter can be overridden for a broadcast connector by prefixing it with the connector identifier — e.g. siri-stop-monitoring-request-broadcaster.remote_code_space.
Name | Type | Description |
|---|---|---|
remote_code_space | string | Default code space used for exchanges with the partner |
vehicle_journey_remote_code_space | []string | Code space(s) for vehicle journey identifiers |
vehicle_remote_code_space | []string | Code space(s) for vehicle identifiers |
Format parameters
The identifier generators (parameters of type string) produce the identifiers Ara places in its SIRI messages. Each is a string into which you insert %{…} variables:
%{id}— the identifier of the model concerned (e.g. a stop's id; forDataFrameRef, the model date, YYYY-MM-DD);%{type}— the SIRI type of the model (StopArea,Line,VehicleJourney…);%{uuid}— a unique identifier generated on the fly.
Example: Operator:Stop::%{id}:LOC produces Operator:Stop::1234:LOC.
%{uuid} works in all generators; %{id} and %{type} depend on the generator (“Attributes” column). If a parameter is left empty, the default value below applies.
Generator | Produces | Attributes | Default |
|---|---|---|---|
generators.message_identifier | SIRI |
|
|
generators.response_message_identifier | SIRI |
|
|
generators.data_frame_identifier | SIRI |
|
|
generators.reference_identifier | Default (catch-all) generator: any SIRI reference to a model (rewritten, or without a |
|
|
generators.reference_stop_area_identifier | References to stops (StopArea) not found in Ara |
|
|
generators.reference_vehicle_journey_identifier | References to vehicle journeys (VehicleJourney) — otherwise uses the |
| Reference generator |
generators.subscription_identifier | Subscription identifiers issued by Ara |
|
|
Name | Type | Description |
|---|---|---|
siri.envelope | string | SIRI message envelope type. |
Collection parameters
By default, collection is not restricted. To limit it to a specific scope, you define lists:
include_…: collect only the listed models;
exclude_…: collect everything except the listed models.
These lists exist for lines, stops and facilities; they also accept groups (line groups, stop groups). The identifiers used in these lists are expressed in the Partner's remote_code_space code space.
Filtering of collected models
Model | include_… (allow-list) | exclude_… (deny-list) |
|---|---|---|
Lines | collect.include_lines | collect.exclude_lines |
Line groups | collect.include_line_groups | collect.exclude_line_groups |
Stops | collect.include_stop_areas | collect.exclude_stop_areas |
Stop groups | collect.include_stop_area_groups | collect.exclude_stop_area_groups |
Facilities | collect.include_facilities | collect.exclude_facilities |
All these lists are of type []string (identifiers separated by commas).
How lists and groups combine
A group is simply a shortcut: when the configuration is loaded, Ara replaces each group with the stops (or lines) it contains, then adds those models to the corresponding list. Direct list and groups therefore feed the same list — nothing is subtracted. The same mechanism applies to lines (collect.include_lines / collect.include_line_groups).