Reference13r1:Concept Apps: Difference between revisions
No edit summary |
(→App) |
||
| Line 26: | Line 26: | ||
;Licenses: If the App uses Service Licenses, the number of licenses to beused by this service can be configured here. The PBX then tries to acquire licenses of the type Service(<name of the App .htm>)=<number> | ;Licenses: If the App uses Service Licenses, the number of licenses to beused by this service can be configured here. The PBX then tries to acquire licenses of the type Service(<name of the App .htm>)=<number> | ||
;Plain website: Indicates that this App service is a website, which does not make use of the authentication provided by the PBX. No App icon can be displayed for this kind of Apps. | |||
;Hidden: Apps marked as hidden are not displayed in the myApps client. This kind of Apps is used to provide APIs for other Apps and are loaded automatically when the API is used. | |||
;Websocket: If set, the App Object establishes a Websocket connection to the App Service. This way the App Service itself can make use of APIs provided by the PBX. | |||
Revision as of 12:51, 7 March 2019
The innovaphone PBX allows the integration of Apps into the innovaphone myApps client. An App consists of an App Service from which the App is loaded and executed in the innovaphone myApps client as a Web application inside an iframe. The App Service may be the PBX itself, an AppService running on an innovaphone App Platform, or any other webserver.
The PBX controls which user may use which App. This is the main mechanism for assigning rights to users.
So called App Objects are used in the PBX include Apps into the PBX. The main configuration items in an App Object are the link to an App Service and the password, which acts as a shared secret between the PBX and the App Service, so that the PBX can authenticate the user for the App Service.
There is the generic App Object, which can be used for any App without special integration into the PBX. Some services of the PBX use external App Services (e.g. Push). For these services, some special App Objects are available.
Applies To
- innovaphone PBX from version 13r1
Objects
App
The App object is the generic mechanism to include an App in innovaphone myApps. The following parameters are used with this object:
- Description, Long Name, Name
- Same meaning as for all objects
- Password
- This is the shared secret between the PBX and the App Service. It allows the PBX to authenticate users for the App Service. If an App Service provides a PBX Manager Plugin for configuration, this password is typically set by the Plugin as a random string. Manual configuration of ths password should only done, if there is no other way.
- URL
- The link to the App Service. This should be configured without filename extension. A postfix of .htm is added to the URL to load the App code as Web application. A postfix of .png is added to load the icon to be displayed in myApps. A size of 100px x 100px is recommended for the icon to have a nice display on 4K monitors.
- Licenses
- If the App uses Service Licenses, the number of licenses to beused by this service can be configured here. The PBX then tries to acquire licenses of the type Service(<name of the App .htm>)=<number>
- Plain website
- Indicates that this App service is a website, which does not make use of the authentication provided by the PBX. No App icon can be displayed for this kind of Apps.
- Hidden
- Apps marked as hidden are not displayed in the myApps client. This kind of Apps is used to provide APIs for other Apps and are loaded automatically when the API is used.
- Websocket
- If set, the App Object establishes a Websocket connection to the App Service. This way the App Service itself can make use of APIs provided by the PBX.