You are here: Administration > Maintenance > Bulk import/export of ADPs

Bulk import/export of Automatically dialed participants (ADPs)

If you want to configure your Pexip Infinity platform with a large number of Automatically Dialed Participants (APDs) you can import the configuration from a CSV file.

Note that this process is separate to the Bulk import/export of service configuration.

You can also export all of your existing ADP configuration data to a CSV file. You may want to do this for backup purposes or to transfer configuration between, for example, a test system and a production system.

Preparing the CSV file for import

Header row

A header row in the CSV file is optional. If included, it should use exactly the same text for each field name as shown in the following section, although the order of the fields may vary.

Format

The data in the CSV file must use the following format, and fields must be in the same order as shown (unless you have used a header file):

alias,remote_display_name,description,protocol,dtmf_sequence,role,streaming,keep_conference_alive,call_type,routing,presentation_url,system_location_name,conference_name

where:

alias The alias of the participant to dial when a conference starts.
remote_display_name

An optional friendly name for this participant. This may be used instead of the participant's alias in participant lists and as a text overlay in some layout configurations.

description

An optional description of the Automatically Dialed Participant.

protocol *

The protocol to use to place the outgoing call:

  • sip
  • h323
  • rtmp
  • mssip (for calls to Microsoft Lync / Skype for Business)

Default: sip

The protocol will be ignored if the routing field is set to routing_rule.

dtmf_sequence

An optional DTMF sequence to be transmitted after the call to the dialed participant starts.

If one or more commas are used in the DTMF sequence (as a 2-second pause), the entire string within the field must be contained in double quotes.

role *

The level of privileges the participant has in the conference:

  • chair — the participant has Host privileges
  • guest — the participant has Guest privileges

Default: guest

streaming *

Identifies the dialed participant as a streaming or recording device.

  • true — the participant is a streaming or recording device
  • false — the participant is not a streaming or recording device

Default: false

keep_conference_alive *

Determines whether the conference continues when all other non-ADP participants have disconnected:

  • keep_conference_alive — the conference continues to run until this participant disconnects (applies to Hosts only).
  • keep_conference_alive_if_multiple — the conference continues to run as long as there are two or more "keep_conference_alive_if_multiple" participants and at least one of them is a Host.
  • keep_conference_alive_never — the conference terminates automatically if this is the only remaining participant.

Default: keep_conference_alive_if_multiple

call_type *

Allows you to limit the media content of the call. The participant being called will not be able to escalate beyond the selected capability. For more information, see Controlling media capability. Valid values are:

  • video — main video plus presentation
  • video-only — main video only
  • audio — audio-only

Default: video

routing *

Specifies how to route the call:

  • manual — uses the requested protocol and the defaults for the specified system_location_name.
  • routing_rule — routes the call according to the configured Call Routing Rules— this means that the dialed alias must match an outgoing Call Routing Rule for the call to be placed (using the protocols and call control systems etc. as configured for that rule).

Default: manual

presentation_url

This additional parameter can be specified for RTMP calls to send the presentation stream to a separate RTMP destination.

system_location_name The location of the Conferencing Node from which to place the call.
conference_name The name of the Virtual Meeting Room or Virtual Auditorium from which this participant will be dialed automatically whenever a conference using that service starts.
* If this field is left blank, the default value will be used.

Duplicates

You can upload any number of records with the same alias field, as long as the conference_name field is different for each.

If any records in the CSV file have the same alias and conference_name fields, only one ADP for that conference that name will be created. This ADP will use the last record that was imported.

If any records in the CSV file have the same alias and conference_name as an existing ADP, the existing configuration will be overwritten by the imported ADP's configuration.

Restrictions

  • The alias field cannot be blank.
  • All non-blank fields must contain valid data, for example the dtmf_sequence field must only contain digits or commas.
  • If non-ASCII characters are used, the file must be encoded as UTF-8 text.
  • Fields with set values of True or False are not case-sensitive. All other fields are case-sensitive.

Examples

To import an ADP for Alice's endpoint (alice@example.com) that will be dialed in as a host when her VMR (meet Alice) is called, and as a guest when the sales team's Virtual Auditorium (meet Sales) is called, you would create the following CSV file:

alice@example.com,Alice Jones,,,,chair,,,,,,,meet Alice
alice@example.com,Alice Jones,,,,guest,,,,,,,meet Sales

Importing the CSV file

To import the data in the CSV file to Pexip Infinity:

  1. On the Pexip Infinity Administrator interface, go to Service configuration > automatically Dialed Participants.
  2. From the bottom of the page, select Import.
  3. Choose the CSV file to import and select Save.

Exporting existing service configuration

You can export all of your existing ADP configuration data to a CSV file. This produces a CSV file in the same format as that used for importing configuration data (described above in Preparing the CSV file for import). The file includes a header row.

To export the data:

  1. On the Pexip Infinity Administrator interface, go to Service configuration > automatically Dialed Participants.
  2. From the bottom of the page, select Export. This takes you to the Export automatically Dialed Participant configuration page.
  3. Select Download.
  4. Follow your browser's prompts to save or open the file.