Difference between revisions of "Configure UBIK Archon Service"
m (→Parameters since Version 5.0) |
(→Session Details) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 12: | Line 12: | ||
* Deploy the UBIK Archon Webservice to the designated web app folder on the IIS Server (web app folder needs to be created if necessary) | * Deploy the UBIK Archon Webservice to the designated web app folder on the IIS Server (web app folder needs to be created if necessary) | ||
** IIS Manager setting check: see [[Configure_EventNotification_Endpoint_and_Enterprise_Service_for_CUI#IIS_Manager|IIS Manager]] | ** IIS Manager setting check: see [[Configure_EventNotification_Endpoint_and_Enterprise_Service_for_CUI#IIS_Manager|IIS Manager]] | ||
| − | |||
== IIS Manager == | == IIS Manager == | ||
| Line 18: | Line 17: | ||
** "Site Name", "Application pool", "Physical path", "Binding", "Host Name", "Port" and "SSL Certificate" should be adapted accordingly. | ** "Site Name", "Application pool", "Physical path", "Binding", "Host Name", "Port" and "SSL Certificate" should be adapted accordingly. | ||
* ''' Example settings'''. <br/> [[Image:IIS1.PNG|300px]] | * ''' Example settings'''. <br/> [[Image:IIS1.PNG|300px]] | ||
| − | |||
| − | |||
{{Hint| When setting up the IIS Application Pool responsible for the Archon Service the Load User Profile setting must be set to "true". This way Archon can create the necessary files under the specified User in the File System}} | {{Hint| When setting up the IIS Application Pool responsible for the Archon Service the Load User Profile setting must be set to "true". This way Archon can create the necessary files under the specified User in the File System}} | ||
| − | + | = Setting up UBIK Archon = | |
| − | + | ||
| − | + | ||
| − | = | + | |
== Firewall settings == | == Firewall settings == | ||
| Line 40: | Line 34: | ||
https://hostname:port/PathToArchon/api/admin/_put_your_secret_here | https://hostname:port/PathToArchon/api/admin/_put_your_secret_here | ||
</source> | </source> | ||
| − | |||
| − | |||
| − | |||
== USAM == | == USAM == | ||
| Line 51: | Line 42: | ||
</appSettings> | </appSettings> | ||
</source> | </source> | ||
| − | |||
| − | |||
| − | |||
== Connecting UBIK Archon with USAM == | == Connecting UBIK Archon with USAM == | ||
The UBIK Archon service has to be connected to the USAM service. ''This must be done only once for each Database.'' This can be achieved using a URL schema, the user has to provide hostname:port/path to Usam service/ the method "register" and a couple of parameters. The list of parameters differ in newer Ubik Versions. | The UBIK Archon service has to be connected to the USAM service. ''This must be done only once for each Database.'' This can be achieved using a URL schema, the user has to provide hostname:port/path to Usam service/ the method "register" and a couple of parameters. The list of parameters differ in newer Ubik Versions. | ||
| − | ===Parameters until Version 4.9=== | + | === Parameters until Version 4.9 === |
* Parameter "secret": The "secret" is the password selected by the Archon Administrator. | * Parameter "secret": The "secret" is the password selected by the Archon Administrator. | ||
| + | |||
| + | '''Example:''' | ||
The following example URL registers the UBIK Archon service on the USAM and the USAM on the Archon service: | The following example URL registers the UBIK Archon service on the USAM and the USAM on the Archon service: | ||
| Line 66: | Line 56: | ||
</source> | </source> | ||
| − | + | === Parameters since Version 5.0 === | |
| − | + | ||
| − | + | ||
| − | ===Parameters since Version 5.0=== | + | |
* Parameter USAM-Name: human readable name of the USAM service. We recomend to use the name of the Usecase (e.g. "Productive System"). | * Parameter USAM-Name: human readable name of the USAM service. We recomend to use the name of the Usecase (e.g. "Productive System"). | ||
* Parameter License - Mode: The license mode defines how a license is evaluated by the Archon for the given USAM : | * Parameter License - Mode: The license mode defines how a license is evaluated by the Archon for the given USAM : | ||
| Line 84: | Line 71: | ||
* Parameter "secret" (the "secret" is the password selected by the Archon Administrator). | * Parameter "secret" (the "secret" is the password selected by the Archon Administrator). | ||
| + | |||
| + | '''Example:''' | ||
The following example URL registers the UBIK Archon service on the USAM and the USAM on the Archon service: | The following example URL registers the UBIK Archon service on the USAM and the USAM on the Archon service: | ||
| Line 93: | Line 82: | ||
{{Hint|A registration key is saved encrypted in the UBIK Database (as setting).}} | {{Hint|A registration key is saved encrypted in the UBIK Database (as setting).}} | ||
| + | === Disconnecting an USAM from the Archon === | ||
There is also the possibility to unconnect the USAM service from the Archon Service. | There is also the possibility to unconnect the USAM service from the Archon Service. | ||
| Line 99: | Line 89: | ||
</source> | </source> | ||
| − | + | = Using UBIK Archon = | |
| − | + | ||
| − | + | ||
| − | + | ||
== Archon == | == Archon == | ||
=== Archon Web UI === | === Archon Web UI === | ||
| Line 110: | Line 97: | ||
https://hostname:port/swagger/index.html | https://hostname:port/swagger/index.html | ||
</source> | </source> | ||
| − | |||
=== How to fetch unique Archon Id === | === How to fetch unique Archon Id === | ||
| Line 119: | Line 105: | ||
== USAM == | == USAM == | ||
=== Session Details === | === Session Details === | ||
| − | The UBIK Archon service can provide detailed Session Information. | + | The UBIK Archon service can provide detailed Session Information. Session details can be called using a web service method and will provide additional information about the currently active sessions: |
| − | + | * How many users were logged in, | |
| − | * | + | * on which day, |
| − | + | * with how many sessions, | |
| + | * how many users were online simultaneously, | ||
| + | * and average session duration. | ||
| + | |||
| + | '''Example:''' | ||
<source lang = "XML"> | <source lang = "XML"> | ||
| Line 137: | Line 127: | ||
</source> | </source> | ||
| − | + | [[Category:Installing|Configure UBIK Archon Service]] | |
| − | + | [[Category:Login management|Configure UBIK Archon Service]] | |
=See also= | =See also= | ||
Latest revision as of 13:14, 5 February 2026
The UBIK.Archon WebService is the central information hub that is responsible for managing the set of available licenses for one subscription This page describes how to setup the system.
Contents
Overview
- Make sure the USAM is installed on the IIS Server.
- Install the UBIK Archon Webservice on the IIS Server.
- If it is missing on the IIS Machine Install net.7.0.
- Make sure all files are accessible
Installation UBIK Archon
- Download the UBIK Archon Webservice from the release portal.
- Deploy the UBIK Archon Webservice to the designated web app folder on the IIS Server (web app folder needs to be created if necessary)
- IIS Manager setting check: see IIS Manager
IIS Manager
- Add a new website under the "Sites" folder in IIS Manager.
- "Site Name", "Application pool", "Physical path", "Binding", "Host Name", "Port" and "SSL Certificate" should be adapted accordingly.
- Example settings.
 | When setting up the IIS Application Pool responsible for the Archon Service the Load User Profile setting must be set to "true". This way Archon can create the necessary files under the specified User in the File System |
Setting up UBIK Archon
Firewall settings
Firewall and Router settings must adapted so the Archon service can be accessible from outside of the IIS Server
- A New Inbound rule must be created in the IIS Server "Firewall Settings", using the same "Port" as the one specified in the website "Binding" settings.
- A new Port forwarding rule must also be added in the Router "Firewall Settings" using the same "Port" as the one specified in the website "Binding" settings.
Secret
The secret must be defined once for an Archon Service. Even if the secret can be defined implicit by the very first time an USAM registers at the Archon we recommend to define the secret in advance using the following URL:
https://hostname:port/PathToArchon/api/admin/_put_your_secret_here
USAM
The UBIK Archon URL must be configured in the USAM's AppSettings.config file, e.g.:
<appSettings>
<add key="UBIK.Service.ArchonUrl" value="https://hostname:port/api"/>
</appSettings>
<add key="UBIK.Service.ArchonUrl" value="https://hostname:port/api"/>
</appSettings>
Connecting UBIK Archon with USAM
The UBIK Archon service has to be connected to the USAM service. This must be done only once for each Database. This can be achieved using a URL schema, the user has to provide hostname:port/path to Usam service/ the method "register" and a couple of parameters. The list of parameters differ in newer Ubik Versions.
Parameters until Version 4.9
- Parameter "secret": The "secret" is the password selected by the Archon Administrator.
Example:
The following example URL registers the UBIK Archon service on the USAM and the USAM on the Archon service:
https://hostname:port/PathToUsam/USAM.svc/register/_put_secret_here_
Parameters since Version 5.0
- Parameter USAM-Name: human readable name of the USAM service. We recomend to use the name of the Usecase (e.g. "Productive System").
- Parameter License - Mode: The license mode defines how a license is evaluated by the Archon for the given USAM :
| Value | Mode | Description |
|---|---|---|
| 0 | Standard | Archon compares Login Name and Device - ID. |
| 1 | Login | Archon compares Login Name only. The Device ID will be ignored. |
| 2 | Device | Archon compares Device ID only. The Login Name will be ignored. |
- Parameter "secret" (the "secret" is the password selected by the Archon Administrator).
Example:
The following example URL registers the UBIK Archon service on the USAM and the USAM on the Archon service:
https://hostname:port/PathToUsam/USAM.svc/register/_put_usam-name_here_/_put_license-mode_here_/_put_secret_here_
| One USAM can only be registered once. If you want to register it again or use a different Archon Service you need to unregister it first. |
| A registration key is saved encrypted in the UBIK Database (as setting). |
Disconnecting an USAM from the Archon
There is also the possibility to unconnect the USAM service from the Archon Service.
https://hostname:port/PathToUsam/USAM.svc/unregister
Using UBIK Archon
Archon
Archon Web UI
Using swagger a test Web UI can be accessed.
- Example:
https://hostname:port/swagger/index.html
How to fetch unique Archon Id
- Example using Postman Get:
https://hostname:port/api/admin/key
USAM
Session Details
The UBIK Archon service can provide detailed Session Information. Session details can be called using a web service method and will provide additional information about the currently active sessions:
- How many users were logged in,
- on which day,
- with how many sessions,
- how many users were online simultaneously,
- and average session duration.
Example:
https://hostname:port/PathToUsam/USAM.svc/session-details/2024.06-11/2024.06-11
[
{
"AverageSessionDuration": 2,
"Concurrent": 7,
"Day": "/Date(1718056800000+0200)/",
"Logins": 25,
"Sessions": 48
}
]
[
{
"AverageSessionDuration": 2,
"Concurrent": 7,
"Day": "/Date(1718056800000+0200)/",
"Logins": 25,
"Sessions": 48
}
]
