Latest revision as of 13:04, 15 October 2024

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.

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

Configuration 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.

Usam

Usam must be configured by adding the necessary value to the UBIK Service Archon Url key in the AppSettings.config file

Example:

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 the parameter "secret" (the "secret" parameter is the password selected by the user). This URL registers the UBIK Archon service on the USAM and the USAM on the Archon service.

Example using Postman Get:

https://hostname:port/PathToUsam/USAM.svc/register/secret

Every USAM should have its own "secret" on the Archon because only one USAM is allowed per "secret".

The "secret" is saved encrypted in the UBIK Database.

Usability

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.

The session details can be called using a Get Method and will provide additional information about the currently active sessions with detailed information for
- How many users were logged in, on which day, with how many sessions, how many users were online simultaneously, and average session duration.
Example using Postman Get:

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
}
]

@@ Line 1: / Line 1: @@
-The UBIK Archon Service is a web service for administering UBIK License information.
+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.
@@ Line 8: / Line 8: @@
 * Make sure all files are accessible
-= Install UBIK Archon =
+= 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 [[Configure_EventNotification_Endpoint_and_Enterprise_Service_for_CUI#IIS_Manager|IIS Manager]]
-= 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'''. <br/> [[Image:IIS1.PNG|300px]]
-= Firewall settings =
+{{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}}
+[[Category:Installing|Configure UBIK Archon Service]]
+[[Category:Login management|Configure UBIK Archon Service]]
+= Configuration 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.
+== Usam ==
-= Usam =
 Usam must be configured by adding the necessary value to the UBIK Service Archon Url key in the AppSettings.config file
-* ''' Example value'''<add key="ArchonUrl" value="https://hostname:port/api"/>
+* ''' Example:
+<source lang = "xml">
+<appSettings>
+ <add key="ArchonUrl" value="https://hostname:port/api"/>
+</appSettings>
+</source>
-==See also==
+== 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 the parameter "secret" (the "secret" parameter is the password selected by the user). This URL registers the UBIK Archon service on the USAM and the USAM on the Archon service.
+* ''' Example using Postman Get:'''
+<source lang = "xml">
+https://hostname:port/PathToUsam/USAM.svc/register/secret
+</source>
+{{Hint|Every USAM should have its own "secret" on the Archon because only one USAM is allowed per "secret".}}
+{{Hint|The "secret" is saved encrypted in the UBIK Database.}}
+[[Category:Installing|Configure UBIK Archon Service]]
+[[Category:Login management|Configure UBIK Archon Service]]
+= Usability =
+== Archon ==
+=== Archon Web UI ===
+Using swagger a test Web UI can be accessed.
+* ''' Example:'''
+<source lang = "XML">
+https://hostname:port/swagger/index.html
+</source>
+=== How to fetch unique Archon Id ===
+* ''' Example using Postman Get:'''
+<source lang = "XML">
+https://hostname:port/api/admin/key
+</source>
+== USAM ==
+=== Session Details ===
+The UBIK Archon service can provide detailed Session Information.
+* The session details can be called using a Get Method and will provide additional information about the currently active sessions with detailed information for
+**  How many users were logged in, on which day, with how many sessions, how many users were online simultaneously, and average session duration.
+* ''' Example using Postman Get:'''
+<source lang = "XML">
+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
+    }
+]
+</source>
+=See also=
 <!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
+* [[UBIK_LICENSE_MONITORING]]
 * [[HowTo:Configure_Microsoft_IIS_for_UBIK]]
 * [[HowTo:Install_Microsoft_IIS]]
+[[Category:Installing|Configure UBIK Archon Service]]
+[[Category:Login management|Configure UBIK Archon Service]]

Difference between revisions of "Configure UBIK Archon Service"