Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7

...

From a functional point of view, each Exchange Partner has a specific configuration of the connectors of the Ara SaaS platform.

Referential

The User has one or more referentials which he owns.

...

  • configure the Exchange Partners desired by the Customer, and thus control the information flows that will be collected and disseminated by Ara

  • gather the real time data (stops, lines, runstrips) collected from the different Exchange Partners

  • isolate the data from other referential

  • predefine the information (stops, lines, runstrips) managed by Ara on a daily basis

Exchange Partners


Each Exchange Partner includes :

  • A selection of connectors defining the protocols (SIRI, GTFS-RT, SIRI Lite, etc.) and the types of exchanges (subscriptions, queries, etc.), available through this partner;

  • A specific setting of these connectors such as remote URLs, types of identifiers, etc;

  • The secrets used for the authentication of requests;

  • Current status of ongoing exchanges, such as active subscriptions, last transmitted reports, data caches, etc;

  • Query tracking: counting and limiting queries associated with this exchange partner.

Settings

The configuration of an exchange partner requires only four parameters:

...

  • The 'local_url' field is the URL of Ara's SIRI service that is assigned to you upstream.
    ex : https://ara-api.enroute.mobi/client/siri

  • It is completed by an identifier, filled in the section 'local_credential' which authorizes the SIRI requests transmitted to the SIRI server of the CAD/AVL.

  • The field 'remote_url' indicates the public URL of the SIRI service of your SAE CAD/AVL to transmit the requests to Ara.

  • The field 'remote_credential' is the identifier that allows the transmission of notifications from the SIRI server of the CAS CAD/AVL to Ara.

  • The field 'Connectors' refer the set of services you want to subscribe to for the exchange partner. It allows the selection of several services by checking or unchecking independently each service in the drop-down menu (icon 'check').

...

The information related to your exchange partner is available in the Partners section of your workbenchreferential. Click on the name of the Exchange Partner you have just created in the list.

...

It is possible to modify the configuration parameters of the Exchange Partner (adding a connector / SIRI service, for example) by clicking on 'Modify this Partner' in the top right-hand menu.

Status


In the main interface for each real time referential, you can view all the Exchange Partners.

...

  • The Available status shows that the exchange partner has responded positively to the activity check sent to it by Ara. Therefore, it is up and running and ready to respond to any request.

  • The Unavailable state shows that the exchange partner has not responded positively to the activity check sent to it by Ara. Ara is therefore able to communicate with this exchange partner, but it is not available or not in working condition. This unavailability of the exchange partner may be a sign of problems in the operation or setup on the side of the exchange partner.

  • The Unknown status shows either that Ara is unable to check the activity of the trading exchange partner (network issues, etc.) or that the subscribed services do not allow the status to be updated (this is a normal situation).

Note

This status indicates whether it is up and running or not, but does not indicate whether data is being exchanged between Ara SaaS and the exchange partner.