Your data analysis solution

Manage your XLSTAT License using the command line

2017-09-01

Your XLSTAT License can be managed using the command line. The tool allowing you to do so is called xlc. It is available for PC and Mac and is located in the XLSTAT installation directory. It allows to perform operations such as activating, deactivating or printing your license information.

Introduction

Using the command line tool

Depending on your system:

PC

In order to open a command line prompt, press the Windows + R keys of your keyboard and type in cmd. Press Enter. A terminal window should appear.

Mac

Please open the Terminal application, usually located under Utilities in your Applications directory. The terminal should then appear.

 

Type xlc help in the terminal and press enter. A help message starting like this should be printed:

C:\>xlc help
-------------------------------------------------------------------------------
Usage: xlc operation [options...]
-------------------------------------------------------------------------------
Available operations and their options:
[...]

Process according to your case:

  • If this is what you see, you are ready to use the command line tool.

  • If instead of the help message you encounter an error, the XLSTAT installation directory is not included in your PATH variable. In order to use the XLSTAT command line tool, you need to navigate to the directory using the cd command:

    PC

    cd "C:/Program Files (x86)/Addinsoft/XLSTAT"

    Mac

    cd /Applications/XLSTAT.app/Contents/Library
     

    You may need to adapt the path above with your own installation path.

    Once again, type in the xlc help command. You should be able to see the help information. You are now able to use the command line tool.

 

Running with elevated permissions

A few operations require to be run with elevated permissions, started as an administrator. If so, it would be specified in the help section of that command, or in the corresponding guide in this tutorial.

Here is what you have to do in order to launch commands as an administrator:

PC

Open your start menu then type cmd in the search bar. Once the cmd icon appears in the menu, right-click on it then click Start as an administrator. Validate the popup and you should now have a terminal with elevated permissions. Refer to the previous section Using the command line tool to find out how to use the license tool.

Mac

Open a terminal as described in the Using the command line tool section. Prepend commands that need to be started as an administrator with sudo ./, like this:

sudo ./xlc <operation> <options...>

You should be prompted to enter your password. Once validated, the command will be run with elevated permissions.

 

Troubleshooting, accessing the command line help

It could be possible that some changes made to the tool might not be documented in this tutorial. If you happen to meet some unexpected behaviour from your commands, please refer, in the first place, to the help information of the operation you are using on the XLC tool itself. It is the most up-to-date information available concerning the XLSTAT Command line tool.

In order to consult that help, type in this command in your command prompt:

xlc help

If this does not help you solve your problem, please contact us with details about what you are trying to achieve, how you proceeded and what is happening.

 

Basic operations

Printing information about your license

The tool can be used in order to print details about your license status. This is done using the following command:

xlc status

Here is an example of what should be printed in your terminal:

C:\>xlc status
XLSTAT license details
----------------------
 Installation_Type: XLSTAT standalone
    License_Status: Registered
        Expiration: 2017-11-07
           User_ID: XLSTATID-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        Alias_Name: My-Alias-Name
   XLSTAT_Solution: FORECAST
    XLSTAT_Options: 3DPLOT

For more details on the status operation, please refer to the help on the tool itself by running this command:

xlc help status

 

Activating a license

Both online and manual activations can be made using the XLC tool. Here is a process for both methods:

Online activation

The online activation is the classic way to activate XLSTAT. It is done automatically.

  1. Type in this command by replacing placeholders with your own values:

    xlc activate -k YOUR_LICENSE_KEY

    You can also manually specify an alias name for this activation using the -a option. The command would be the following:

    xlc activate -k YOUR_LICENSE_KEY -a "YOUR ALIAS"

    Make sure to enter your alias name between double quotes if it contains any space, just like in the example.

  2. A message should then inform you of the result of the operation.

Manual activation

Manual activation allows you to activate XLSTAT on a computer that has no access to the internet. However, it requires another computer that is connected in order to communicate with the XLSTAT activation website.

  1. On the offline computer, type in this command:

    xlc activate -o -k YOUR_LICENSE_KEY -a "YOUR ALIAS"

    The -o option specifies that an offline activation code should be generated. This code will be displayed in your terminal.

    Note: If you are activating a Campus or classroom license, you have to add into that command the -c option.

  2. Copy that code to the computer that is connected to internet, open an internet browser, browse to https://activation.xlstat.com, then paste the code in the Certificate field. Click on Generate the unlock file.

  3. An activation file should automatically be downloaded. Transfer this file back to the computer running XLSTAT. Using the XLC tool, import the activation file using this command:

    xlc import -f PATH_TO_ACTIVATION_FILE

    PATH_TO_ACTIVATION_FILE being the location of the activation file, for example: "C:\Users\My User\Desktop\XLSTAT_Activation.bin".

    Don't forget to enclose the path in between quotes (") if it contains any space.

  4. A message should then inform you of the result of the operation.

 

For more details on the activate and import operations, please refer to the help on the tool itself by running these commands:

xlc help activate
xlc help import

 

Deactivating a license

Both online and manual deactivations can be made using the XLC tool. Here is a process for both methods:

Online deactivation

The online deactivation is the classic way to deactivate XLSTAT. It is done automatically.

  1. Type in this command:

    xlc deactivate
  2. A message should then inform you of the result of the operation.

Manual deactivation

Manual deactivation allows you to activate XLSTAT on a computer that has no access to the internet. However, you need another computer that is connected in order to communicate with the XLSTAT activation website.

  1. On the offline computer, type in:

    xlc deactivate -o

    The -o option specifies that an offline deactivation code should be generated. This code will be displayed in your terminal.

  2. Copy that code to the computer that is connected to internet, open an internet browser, browse to http://activation.xlstat.com/en/Deactivation/, then paste the code in the Certificate field. Click on Deactivate.

  3. A message on the website will inform you of the result of the operation.

 

For more details on the deactivate operation, please refer to the help on the tool itself by running this command:

xlc help deactivate

Command summary

Here is a summary of the available operations and their options.

Please note that the help provided in the command line tool's help operation is the most up-to-date and should be trusted over the information provided in this summary.

Operation Options and details
xlc status [-s Status_Selector]
  • -s (--select)
    If given, returns a single detail designated by its name. E.g.:

    C:\>xlc status -s XLSTAT_Solution
    FORECAST
xlc activate [-o [-c]] -k Activation_Key [-a ComputerAlias] [-d]
  • -k (--key)
    License key to activate XLSTAT with.

  • -a (--alias)
    Alias name for this activation. Will be ignored if activating for more than one user (-g option).

  • -o (--offline)
    Generates an offline activation code to be used on our activation website. Not compatible with -g option.

  • -c (--computer)
    During the offline activation, allows to activate on the whole computer instead of on a single user session. This is only possible while activating a Campus license. This option is ignored if -o is not provided.

  • -d (--defer)
    Allows to defer the activation of the license on this computer for it to be done automatically with the provided license key. It happens once an user start their XLSTAT for the first time. Running this command requires administrator privileges. This option is not compatible with the offline activation (-o option).

xlc import -f Activation_File_Path

Corresponds to the final step of the manual activation.

  • -f (--file)
    Location of the offline activation file to be imported in order to activate XLSTAT with.

xlc deactivate [-o] [-a]
  • -o (--offline)
    Allows to specify that an offline deactivation code should be generated. To be used on our deactivation website.

  • -a (--all)
    Allows to deactivate the license of all users on the computer who activated XLSTAT. The usage of this option requires administrator privileges. The list of activated licenses on this computer can be retrieved using the list operation.

xlc list

Operation that allows to list all user sessions where XLSTAT is activated on the current computer. The usage of this command requires administrator privileges.

xlc settings {set|get} [Value_Name] [Value]

Operation that allows to edit the XLSTAT settings. Type in the get sub-command without any futher argument to have a list of available settings.

xlc borrow [-d Day_Duration]

This operation is only available for the Network edition of XLSTAT. Allows to borrow a license from the server for the given duration.

  • -d (--duration)
    Duration in days the borrowing should be made for (from 1 up to 365 days).

xlc return

This operation is only available for the Network edition of XLSTAT. Allows to return a previously borrowed license to the server.

No option.

xlc help [Operation]

Displays the tool's help document.

No option.

1c26995d494fb3061dd0ae8571ffc0a4@xlstat.desk-mail.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/portal/articles/autocomplete
9202