Difference between revisions of "FAQ:Licensing"

Latest revision as of 14:17, 14 August 2024

UBIK License

UBIK mobile clients require Licenses. These Licenses are managed by a Service called UBIK Archon Service.

How to configure/setup UBIK Archon Service

See Configure UBIK Archon Service

How to connect USAM with UBIK Archon Service

See [1] for details.

Where do I get a license file

You can ask for a new license file by contacting the UBIK License Team or UBIK Sales Team.

What (technical) information does the License Team need to create a new license

Next to the organization information (like number of licenses) you need to provide two information:

UBIK Archon Service Url
Service Key

Where do I get the UBIK Archon Service Url

The UBIK License Team might contact you and ask for the Url where your UBIK Archon Service is installed. Of course you can provide this information in advance too.

The Service Url is the url where the UBIK Archon Service is installed. Either you know this url (e.g. because you installed the service yourself) or you can extract this information from the USAM AppSettings.config. See [2] for details.

Where do I get the UBIK Archon Service Key

The UBIK License Team might contact you and ask for the unique Archon Service Key. Of course you can provide this information in advance too.

If you receive an Email asking about the key the only thing you need to do is to copy the link provided in the mail. Paste the link in your browser and load the page. The displayed text is the unique UBIK Archon Service Key. Copy this key and send it back to the UBIK License team. The key will look something like this: 51F2083F69309324A7FFB4A40E724FBCB55F71773F40319F104469E7B1A077A7

Alternative you can open the UBIK Archon Service Web UI (see [3]). In the Administrative section you can find an endpoint "api/admin/key". Please expand its section, press "Try it out" and press "Execute" then. You can find the UBIK Archon Service Key in the Response body. Copy this key and send it back to the UBIK License team.

How to install a license file

You will receive the license via Email. This email contains two files:

License.curl file
License.lic file

There are two possibilities how to install your license.

The first possibility is to save the License.curl file on your local disk and rename the file to License.curl.cmd If you execute this file now (e.g. by double-clicking on it) your license gets installed at the UBIK Archon Service.

Alternative you can open the UBIK Archon Service Web UI (see [4]). In the Administrative section you can find an endpoint "api/admin/licenses". Please expand the section and press "Try it out". Now the Request body - field gets editable. You need to copy the content of the License.lic file into this field now. For this you can open the file in a text editor and copy its content. The last thing you need to do is to press "Execute".

UBIK.Studio License

Where is the license file stored?

C:\Users\{Your Name}\AppData\LocalUBIKLicense.xml

Where is the license server located?

The current URL of the license server is https://licensevalidator.augmensys.com

You need to make sure that this address can be reached from the machine where UBIK is to be installed!

Can I transfer the licensing file to a new computer?

No. It contains information about your hard- and software and will therefore not work on any other computer than the one it was originally activated

Can I modify the information in the licensing file?

No. If you modify something in the file it will become invalid

What if license activation fails with HTTP status 417: Expectation Failed.?

If the activation of UBIK^® fails with an error The request failed with HTTP status 417: Expectation Failed. make sure that the system.net section in your local UBIK.Studio.config.xml contains a servicePointManager entry similar as

<system.net>
<settings>
<servicePointManager expect100Continue="false" />
</settings>
</system.net>

What if license activation fails with HTTP status 407: Proxy Authentication Required.?

If the activation of UBIK^® fails with an error The request failed with HTTP status 07: Proxy Authentication Required. make sure that the system.net section in your local UBIK.Studio.config.xml contains a "defaultProxy" entry similar as

<system.net>
<defaultProxy useDefaultCredentials="true" />
</system.net>

What license models are available?

The UBIK^® license model consists of Server-, TAG- and CLIENT-licenses. There are two fundamental licensing models – the TAG-driven and the CLIENT-driven model. It is not possible to mix the two models.

CLIENT driven license model

CLIENT-driven licensing means that CLIENT -license packages have to be put on top of the mandatory server licenses, according to the number of clients (i.e. Tablets, Smartphones, Notebooks, access via web applications …) using UBIK^®. The amount of Server Licenses is depending on the CLIENTs to be served, where one Server License can handle a maximum of 30 CLIENTs. It is furthermore recommended to use one dedicated server (physical or virtual) per 10000 TAGs; hence, the number of required server licenses increases. There are 3 different editions (Basic, Advanced and Professional) available with different functionality content. The functionality content of editions is shown at the Augmensys Homepage. The minimum setup per installation consists of one UBIK^® server license and at least one CLIENT-license package.

TAG driven license model

TAG-driven licensing means that TAG-license packages have to be put on top of the mandatory server licenses, according to the number of administrated/published TAGs in UBIK^®. One TAG is defined as one individual object with distinctive properties, i.e. a piece of equipment like a motor, a pump, a valve, a temperature sensor, etc. The amount of Server Licenses is depending on the TAGs to be served, where one Server License can handle a maximum of 10000 TAGs. It is furthermore recommended to use one dedicated server (physical or virtual) per 30 Clients; hence, the number of required server licenses increases. There are 3 different editions (Basic, Advanced and Professional) available with different functionality content. The functionality content of editions is shown at the Augmensys Homepage. The minimum setup per installation consists of one UBIK^® server license and at least one TAG-license package.

@@ Line 6: / Line 6: @@
 === How to connect USAM with UBIK Archon Service ===
-See [https://wiki.augmensys.com/index.php?title=Configure_UBIK_Archon_Service#USAM_2:~:text=%3C/appSettings%3E-,Connecting%20UBIK%20Archon%20with%20USAM,-%5Bedit%5D] for details.
+See [https://wiki.augmensys.com/index.php?title=Configure_UBIK_Archon_Service#Connecting_UBIK_Archon_with_USAM] for details.
 === Where do I get a license file ===
 You can ask for a new license file by contacting the UBIK License Team or UBIK Sales Team.
@@ Line 19: / Line 17: @@
 * UBIK Archon Service Url
 * Service Key
 === Where do I get the UBIK Archon Service Url ===
 The UBIK License Team might contact you and ask for the Url where your UBIK Archon Service is installed. Of course you can provide this information in advance too.
-The Service Url is the url where the UBIK Archon Service is installed. Either you know this url (e.g. because you installed the service yourself) or you can extract this information from the USAM AppSettings.config. See [https://wiki.augmensys.com/index.php?title=Configure_UBIK_Archon_Service#:~:text=website%20%22Binding%22%20settings.-,Usam,-%5Bedit%5D] for details.
+The Service Url is the url where the UBIK Archon Service is installed. Either you know this url (e.g. because you installed the service yourself) or you can extract this information from the USAM AppSettings.config. See [https://wiki.augmensys.com/index.php?title=Configure_UBIK_Archon_Service#Connecting_UBIK_Archon_with_USAM] for details.
 === Where do I get the UBIK Archon Service Key ===
@@ Line 33: / Line 33: @@
 F2083F69309324A7FFB4A40E724FBCB55F71773F40319F104469E7B1A077A7
-Alternative you can open the UBIK Archon Service Web UI (see [https://wiki.augmensys.com/index.php?title=Configure_UBIK_Archon_Service#:~:text=%5Bedit%5D-,Archon%20Web%20UI,-%5Bedit%5D]). In the Administrative section you can find an endpoint "api/admin/key". Please expand its section, press "Try it out" and press "Execute" then. You can find the UBIK Archon Service Key in the Response body.
+Alternative you can open the UBIK Archon Service Web UI (see [https://wiki.augmensys.com/index.php?title=Configure_UBIK_Archon_Service#Archon_Web_UI]). In the Administrative section you can find an endpoint "api/admin/key". Please expand its section, press "Try it out" and press "Execute" then. You can find the UBIK Archon Service Key in the Response body.
 Copy this key and send it back to the UBIK License team.
 === How to install a license file  ===
@@ Line 46: / Line 47: @@
 If you execute this file now (e.g. by double-clicking on it) your license gets installed at the UBIK Archon Service.
-Alternative you can open the UBIK Archon Service Web UI (see [https://wiki.augmensys.com/index.php?title=Configure_UBIK_Archon_Service#:~:text=%5Bedit%5D-,Archon%20Web%20UI,-%5Bedit%5D]). In the Administrative section you can find an endpoint "api/admin/licenses". Please expand the section and press "Try it out". Now the Request body - field gets editable. You need to copy the content of the License.lic file into this field now. For this you can open the file in a text editor and copy its content.
+Alternative you can open the UBIK Archon Service Web UI (see [https://wiki.augmensys.com/index.php?title=Configure_UBIK_Archon_Service#Archon_Web_UI]). In the Administrative section you can find an endpoint "api/admin/licenses". Please expand the section and press "Try it out". Now the Request body - field gets editable. You need to copy the content of the License.lic file into this field now. For this you can open the file in a text editor and copy its content.
 The last thing you need to do is to press "Execute".