Product Activation Guide

Author: | Reading time: 3 minutes | Category: ScriptRunner

ScriptRunner is delivered to customers under the terms of a term based license. This involves a user license for three to five years and the associated maintenance over the same period.

This article has been translated automatically.

Licence Model

ScriptRunner licenses are structured modularly according to function modules. The function modules must be activated individually. The following function modules are delivered with the ScriptRunner:

  • ASR-Base: this function module controls the licensing in the trial period as well as the licensed users.
  • ASR maintenance: this function module controls the licensing of the update and upgrade capability of the installation.
  • ASR-SQLConnect: this function module controls the licensing of the SQL Connector for the external reporting/audit database.
  • ASR-WebSvcConnect: this function module controls the licensing of the Web Service interfaces.
  • ASR-MailConnect: this function module controls the licensing of the mail service interfaces (from 2016R2)

Evaluation Licence

After installation, the software runs for 30 days with an evaluation license for 5 users, a web service interface and the inbound email interface. The update capability is deactivated. At the end of the evaluation period, the automation interfaces must be enabled with a valid key. From version 2016 onwards, the Evaluation License no longer requires an online connection for registration.

The license status can be viewed in the main menu on the left under the settings and the selection of “ScriptRunner License Status”.

The license information can also be queried on the ScriptRunner Service Host using the PowerShell ScriptRunnerSettings module. To do this, open the PowerShell console or the PowerShell ISE as an administrator and call Get-ASRLicense.

Initialize and activate Base License once

The ScriptRunner license module has to be initialized once via the Base License. With the initialization the license is registered and provided with a copy protection. For initialization the ScriptRunner Host must be connected to the Internet. The easiest way to check this is to use a browser.

The operation is performed using the PowerShell ScriptRunnerSettings module. To do this, open the PowerShell console or PowerShell ISE as an administrator. Enter the following command:

Initialize-ASRLicense -Firstname Max -Lastname Mustermann -Email scriptrunner@appsphere.com -Company AppSphere -ActivationKey XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX -Company AppSphere

Mandatory parameters areEmail,Company andActivationKey.

SR Licence

The ScriptRunner service must then be restarted. Simply use the Restart-ASRService command.

Note: For deployment scenarios in a specially secured offline environment, see below.

Activate additional licences

After a successful initialization, further functions can be activated via license key or extension and maintenance keys can be imported. Keep your installation on the current license status with the respective activation keys.

The PowerShell ScriptRunnerSettings module is used to enable additional keys. To do this, open the PowerShell console or PowerShell ISE as an administrator. Enter the following command:

Update-ASRLicense -Key XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX

Repeat this procedure for all keys.

SR License

The ScriptRunner service must then be restarted. Simply use the commandRestart-ASRService.

Repeat this command with each key. With the command Get-ASRLicense, Get-ASR-Licensed User and via the Admin App under Settings you can check the license status of the installation.

SR License

When starting the ScriptRunner Admin App the current license status is displayed.

To simplify the activation of keys, the ScriptRunnerSettings module can also be integrated into ScriptRunner and a corresponding action can be configured with the CmdletUpdate-ASRLicense and executed interactively.

To include the PowerShell ScriptRunnerSettings module, open the PowerShell console or PowerShell ISE as the administrator. Enter the following command:

Add-ASRPSModules -Modules ScriptRunnerSettings

The ScriptRunner service must then be restarted. Simply use the commandRestart-ASRService.

Now start the Admin App and navigate in the main menu to “Scripts | Cmdlets” and open the submenu. There select ScriptRunner Settings and in the list that appears select the CmdletUpdate-ASRLicense. Click “New Action” in the action bar to create the action.

SR AdminApp

When configuring the action, pay attention to the “Direct Service Execution” setting as the target system and deactivate the Restart option.

SR Action Properties

SR Assign Parameter Value

You can now execute the action several times and enter a valid key.

SR

The license information must then be reloaded into the Host service. Either restart the ScriptRunner service or open the ScriptRunner License Settings and execute the refresh function.

SR License Stat

Specially secured offline environments

In specially secured offline environments without a connection to the Internet, an additional offline key is required that requires an offline ID of your ScriptRunner host. With this ID you can have übersupport@scriptrunner.com generate the necessary key BEFORE initializing the Base License.

To determine the offline ID, you can read the ID in the Admin App under License Settings or display it as an offline ID4 using the PowerShell module and the commandGet-ASRLicense.

After you have received the key, the Base License must be initialized with the Unlock Key option. For this you need the activation key for the module and the additional offline key also for the base license module.

All other license keys do not require any additional offline keys after offline initialization.

The operation is performed using the PowerShell ScriptRunnerSettings module. To do this, open the PowerShell console or ISE as administrator. Enter the following command:

Initialize-ASRLicense -Firstname Max -Lastname Mustermann -Email scriptrunner@appsphere.com -Company AppSphere -ActivationKey XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX -UnlockKey XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX

All other keys are imported via the commandUpdate-ASRLicense -Key XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX.

Important note: The keys must have been created with the offline ID of the ScriptRunner host!

Support in case of problems

If you should expect or have problems with the update, please use our support website or contact the ScriptRunner team via e-mail. We will be glad to help you.

These posts might also be interesting for you:

Secure Password Server, PowerShell
ScriptRunner 2019R1, Network, Multi-Team
ScriptRunner Version 2018R3