Running a CL script

<< Click to Display Table of Contents >>

Navigation:  User Guide >

Running a CL script

CL licence

There are two levels of CL licence available.

Extended licence users have the ability to run a CL script using [CL] [Run CL script].

Full CL licence users will be able to use the full CL menu with [CL] [Open CL script window] to run scripts. This is a replacement for the separate CL program, see CL Window.

Both types of users can open scripts using the Open existing project dialog.

If you run a CL script with Companion, any CSV tables produced will be converted to a formatted Excel (.xlsx) with a table of contents provided you follow the following advice:

The main script file (with the control stage) should use the extension .stpx

Use RCP CSV2I. This will add info lines to the CSV output to help the formatting

Do not use RCP OLDNAMES

Do not use RCP O=

If the run fails or a CSV tables file was not produced, Companion will show the log file from the run.

If the run is successful Companion will open the created Excel file.

The programs used by Companion to view files will be the default ones for the file extension, usually:

For .txt files Notepad

For .xlsx files Excel

Spreadsheet options

Extended licence users

When the CL run is finished and CSV tables were produced you will be presented with the Spreadsheet options window.  You can change the settings now before pressing OK.

You can set the defaults using the Companion menu:

[Analysis] [Default spreadsheet options] [Set global defaults] for every project/script.

[Analysis] [Default spreadsheet options] [Set local defaults] for this folder only (the one containing the opened project/script).

If there is a local default set this will be used in place of the global defaults.

Full CL licence users

Full CL licence users can use the [Spreadsheet] menu from the CL script window:

[Spreadsheet] [Global settings] for every project/script.

[Spreadsheet] [Local settings] for this folder only (the one containing the opened project/script).

[Spreadsheet] [This script only settings] for this script only (the opened script).

If there is a local default set this will be used in place of the global defaults.

If there is a [This script only] set this will be used in place of the global and local defaults.

Format options

You will only be shown the Format options window if you have not added the letter I (info) to the CSV2 RCP. This will add the relevant formats to the output.