Model: relation/PexipServer

PexIP Server

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

For an overview, see: Pexip Conferencing Overview.

Choose Apps Management > Pexip Conferencing > Pexip Server.

Click Add.

Complete, at minimum, the mandatory fields as in the field reference table.

Click Save.

Title	Field Type	Description
Server name*	name	The descriptive server name used to identify.
Description	description	Additional details to describe the server.
Host Name*	host	The host name or IP address of the server.
Version*	version	Version. Default: 1.0.0
User Name*	username	The administrator user name.
Password*	password	The password for the administrator.
Sync on Create/Update	sync	A full Pull Sync from the Pexip Server is run if enabled.

Title

Field Type

Description

Server name*

name

The descriptive server name used to identify.

Description

description

Additional details to describe the server.

Host Name*

host

The host name or IP address of the server.

Version*

version

Version. Default: 1.0.0

User Name*

username

The administrator user name.

Password*

password

The password for the administrator.

Sync on Create/Update

sync

A full Pull Sync from the Pexip Server is run if enabled.

When a Pexip server is created, the following are also created:

On the Data Sync menu:

A pull sync instance of data sync with the name format: SyncPexip_<Pexip server name>.
A purge sync instance of data sync with the name format: PurgePexip_<Pexip server name>.

On the Scheduling menu:

An inactive schedule instance with the name format: SchedulePexip_<Pexip server name>.

When the schedule is set to be active, it executes the SyncPexip_<Pexip server name> pull data sync.

To test the connection to the Pexip server, choose Test Connection action on the menu.

To modify the server, select it and update the fields as needed.

To delete the server, select it from the list and then select Delete.

Virtual Meeting Rooms are set up as a part of User management - see:

Set Up and Manage Pexip Virtual Meeting Rooms (VMR) and Conferencing

Provision the PexIP Conference Service

This relation implements the workflows to manage PexIP Server connection parameters.

Model Details: relation/PexipServer

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title		Description	Details
Server Details		Group Assigned by FDP	Field Name: Server Details Type: Object
	Server Name *	Name of the PexIP Server	Field Name: Server Details.name Type: String
	Description	Description of the PexIP Server	Field Name: Server Details.description Type: String
	Host Name *	Host Name	Field Name: Server Details.host Type: String
	Version *	Version Default: 1.0.0	Field Name: Server Details.version Type: String Default: 1.0.0 Choices: ["1.0.0"]
	User Name *	User Name	Field Name: Server Details.username Type: String
	Password *	Password	Field Name: Server Details.password Type: String Is Password: True
	Sync on Create/Update	Sync server on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the PexIP Server	Field Name: Server Details.sync Type: Boolean