Reference13r2:Concept App Service Users

The App Services Users is an App Service which can be installed on an innovaphone App Platform. It is used to administrate the users on a innovaphone PBX and also stores additional profile information. It provides Apps for users and for admins for various purposes.

Applies To

• innovaphone PBX from version 13r1

Technical Overview

Apps

innovaphone-profile

This is an App, where the user can edit his own profile data. Here the personal data, the profile picture, the privacy filters and the call forwarding can be edited. Also leave and join groups is possible from this app. The provisioning of Phones, Softphones and Hostdesking can be done too.

Parameters:

Websocket

to establish the connection with the PbxAdminApi

TableUsers

gives access to the replication of users from and to the PBX

Admin

gives access to the PbxAdminApi, needed to get data from the PBX such as the config templates, the DNS name of the PBX, the current domain...

Services

needed to use the Devices API (com.innovaphone.devices), so the phones can be provisioned

Devices-API

gives access to the Devices App, which is needed for the provisioning of phones

innovaphone-users

This is an App, where all the users on the App Service Database are displayed (except the ones that have unchecked the Visible attribute on Profile for the current domain).

innovaphone-usersadmin

This is the administation app for the App Service. There all the users and unverified users on the current App Service can be managed. The provisioning of Phones, Softphones and Hostdesking can also be done here for several users at once. The configuration parameters can also be set here (i.e. the password policy, SMTP settings, privacy settings...).

innovaphone-usersapis

This is a hidden App, which provides the Search API (com.innovaphone.search) and the Avatar API (com.innovaphone.avatar). The Search API is used by Phone, Softphone and Chat to search users from the App Service Database. The Avatar API is used by myApps, Phone, Softphone, Chat, Users and Fax to obtain the profile pictures.

Parameters:

Hidden

UsersAPIs must be a hidden App

Websocket

to establish the authentication parameters for the Avatar API (com.innovaphone.avatar)

PBX Manager Plugins

Users

With the Users plugin App objects can be created, edited and deleted for Users, UsersAdmin, UsersAPIs and Profile Apps on the PBX. Some configuration parameters can be edited here too on "Change Configuration". These are:

Which Profile App use as default

if there is more than one Profile App, the one selected here will be linked to the "Edit Profile" button on myApps.

Allow to create a user account using a web registration form

if this option is enable, on myApps Login the link to the registration form will be displayed.

Allow users to reset the password using a web form

if this option is enable, on myApps Login the link to the password forgotten form will be displayed.

Allow users to delete their own accounts

if this option is enable, a "Delete account" button will be displayed on Profile.

Import/Export with CSV/XML on Users Admin App

CSV

The CSV import file expects a semicolon ; as field separator. The column/field association can be controlled by a special header line that starts with an ampersand &. In such a line, each column contains a designator which defines the field that the subsequent column values are assigned to. Here is the list of designators:

Designator	Field	Example	Remark
&n	ID	Mario Rossi	Must be unique
&h323	Username	mro	Use as key, must be unique
&fn	First name	Mario
&ln	Last name	Rossi
&e164	Extension	13	Must be unique within the node
&config	Config Template	Config User
&node	Node	root
&pbx	PBX Name	hq
pseudo/&type	Executive/Secretary
&dn	Display Name	Dottore Mario Rossi
&em	E-Mail	mario.rossi.dvl-ckl2@class.local	Must be unique
grp/&name	Group name	group1
grp/&mode	Group mode	active	Either "active" or "" (empty)
grp/&dyn	Dynamically in, out or static	in	Either "in" (user is currently in the group), "out" (user is currently off the group) or "" (empty, user is statically in the group)
grp/&active	Group active	true	Either "true" (active member), "false" (not active member) or "" (empty, same as "false")
device/&hw	Hardware Id	0090333e407e
device/&text	Name	Phone IP112
device/&app	App	phone
device/&admin	PBX Pwd	true	Either "true" (checked), "false" (not checked) or "" (empty, same as false)
device/&nofilter	No IP Filter	true	Either "true" (checked), "false" (not checked) or "" (empty, same as false)
device/&tls	TLS Only	true	Either "true" (checked), "false" (not checked) or "" (empty, same as false)
device/&nomob	No Mobility	true	Either "true" (checked), "false" (not checked) or "" (empty, same as false)
device/&trusted	Reverse Proxy	true	Either "true" (checked), "false" (not checked) or "" (empty, same as false)

XML

With the XML format, a more complete information of the users can be provided. When importing no validation of the data takes place.