Difference between revisions of "Configure UBIK Archon Service"
| Line 8: | Line 8: | ||
* Make sure all files are accessible | * Make sure all files are accessible | ||
| − | = | + | = Installation UBIK Archon = |
* Download the UBIK Archon Webservice from the release portal. | * 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) | * 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 == |
* Add a new website under the "Sites" folder in 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. | ** "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]] | ||
| − | = Firewall settings = | + | |
| + | = Configuration UBIK Archon = | ||
| + | |||
| + | == Firewall settings == | ||
Firewall and Router settings must adapted so the Archon service can be accessible from outside of the IIS Server | 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 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. | * 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 | Usam must be configured by adding the necessary value to the UBIK Service Archon Url key in the AppSettings.config file | ||
| − | * ''' Example | + | * ''' Example: |
| + | <source lang = "xml"> | ||
| + | <appSettings> | ||
| + | <add key="ArchonUrl" value="https://hostname:port/api"/> | ||
| + | </appSettings> | ||
| + | </source> | ||
| + | |||
| + | == Connecting UBIK Archon with the USAM == | ||
| + | The UBIK Archon service has to be connected to the USAM service, '''this must be done only once for each Database''', and can be achieved using a Get Method call and providing two parameters "register" and "secret(password)". | ||
| + | * ''' Example using Postman Get:''' | ||
| + | <source lang = "xml"> | ||
| + | https://hostname:port/"PathToUsam"/USAM.svc/register/secret | ||
| + | </source> | ||
| − | ==See also | + | == Archon 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, like | ||
| + | * ''' Example using Postman Get:''' | ||
| + | https://hostname:port/"PathToUsam"/USAM.svc/session-details/2024.06-11/2024.06-11 | ||
| + | <source lang = "xml"> | ||
| + | [ | ||
| + | { | ||
| + | "AverageSessionDuration": 2, | ||
| + | "Concurrent": 2, | ||
| + | "Day": "/Date(1718056800000+0200)/", | ||
| + | "Logins": 4, | ||
| + | "Sessions": 6 | ||
| + | } | ||
| + | ] | ||
| + | </source> | ||
| + | =See also= | ||
<!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED --> | <!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED --> | ||
* [[HowTo:Configure_Microsoft_IIS_for_UBIK]] | * [[HowTo:Configure_Microsoft_IIS_for_UBIK]] | ||
* [[HowTo:Install_Microsoft_IIS]] | * [[HowTo:Install_Microsoft_IIS]] | ||
Revision as of 13:23, 3 July 2024
The UBIK Archon Service is a web service for administering UBIK License information. 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.
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:
<appSettings>
<add key="ArchonUrl" value="https://hostname:port/api"/>
</appSettings>
<add key="ArchonUrl" value="https://hostname:port/api"/>
</appSettings>
Connecting UBIK Archon with the USAM
The UBIK Archon service has to be connected to the USAM service, this must be done only once for each Database, and can be achieved using a Get Method call and providing two parameters "register" and "secret(password)".
- Example using Postman Get:
https://hostname:port/"PathToUsam"/USAM.svc/register/secret
Archon 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, like
- Example using Postman Get:
https://hostname:port/"PathToUsam"/USAM.svc/session-details/2024.06-11/2024.06-11
[
{
"AverageSessionDuration": 2,
"Concurrent": 2,
"Day": "/Date(1718056800000+0200)/",
"Logins": 4,
"Sessions": 6
}
]
{
"AverageSessionDuration": 2,
"Concurrent": 2,
"Day": "/Date(1718056800000+0200)/",
"Logins": 4,
"Sessions": 6
}
]
