Skip to main content

Install Continuum Scripting Framework (CSF) on Windows

  • Updated

On this page:

Prerequisites

Before starting, confirm you have the following:

  • Node.js (version 18 or later)
  • Java JDK (version 20 or later)
  • An AMP package repository token
  • An AMP API token

Install Node.js

Node.js is required to run CSF scripts.

To install Node.js:

  1. Open a web browser and navigate to Node.js Downloads.
  2. Download the LTS version for Windows.
  3. Run the installer with administrator privileges. Use the default installation options.
  4. After the installation, verify the versions of Node.js and npm from the command prompt: 
    node --version
    npm --version

Install Java JDK

Java JDK provides the runtime environment required to run CSF. 

Download and install Java JDK

To configure Java JDK:

  1. Visit Oracle Java downloads.
  2. Select the Windows tab.
  3. Download the x64 compressed archive.
  4. Navigate to your home directory. For example:
    C:\Users\YourUsername\
  5. Create a new folder called Java.
  6. Extract the downloaded .zip file into the Java folder.
  7. Confirm the folder structure looks like this:
    C:\Users\YourUsername\Java\jdk-20.0.2

Set the JAVA_HOME environment variable

To set the variables:

  1. Open the control panel and search for env.
  2. Select Edit environment variables for your account.
  3. In the pop-up, Select New under user variables.
  4. Set the following:
    • Variable name: JAVA_HOME
    • Variable value: C:\Users\YourUsername\Java\jdk-20.0.2
  5. Select OK to save.
  6. Close and reopen the command prompt for changes to take effect.
  7. Verify the Java installation by running: 
    %JAVA_HOME%\bin\java -version

Configure .npmrc

The .npmrc file stores essential configurations to access the Continuum private repository.

To configure the .npmrc file:

  1. Navigate to your home directory, for example:
    C:\Users\YourUsername\.
  2. Create a new file named .npmrc or edit the existing one.
  3. Add the following lines to the file: 
    @continuum:registry=https://npm.levelaccess.net/continuum/
    //npm.levelaccess.net/continuum/:_authToken=[Package Repository Token]
  4. Replace [Package Repository Token] with your token from the AMP Toolbox.
  5. Save the file.

Download and verify the CSF installation

With .npmrc configured, you can install CSF globally on your local machine.

To instal CSF locally:

  1. Open Command Prompt and run: 
    npm config set strict-ssl false
    npm install -g @continuum/continuum-script-executor
    npm config set strict-ssl true
  2. Verify the installation by checking the CSF version: 
    continuum-script-executor -v
  3. The output should show version 2.6.0 or later.

Create a configuration file

To create a configuration file and define your testing environment:

  1. Create a working folder for CSF by running: 
    cd %userprofile%
    mkdir continuumwork\src\main\resources
  2. Copy the configuration template into the folder: 
    copy AppData\Roaming\npm\node_modules\@continuum\continuum-script-executor\src\main\resources\continuum.json %userprofile%\continuumwork\src\main\resources
  3. Open continuum.json in a text editor and update the following line: 
    "ampApiToken": null
  4. Replace it with your AMP API Token: 
    "ampApiToken": "your-token-here"
  5. Save the file.

Create and run a crawler script

CSF uses XML-based scripts to configure and execute tests.

Create a script

To create a script:

  1. Create a file called example.xml in the continuumwork folder.
  2. Copy the following template into the file: 
    <tests url="https://not.webaccessibility.com" browser="chrome" browserWidth="1366" browserHeight="768" headless="false" >
      <properties>
        <organizationId>12345</organizationId>
        <assetId>67890</assetId>
        <todaysDate>${TODAYS_DATE}</todaysDate>
      </properties>
      <test>
        <step name="Crawl Site">
          <crawl
            organizationId="${organizationId}"
            assetId="${assetId}"
            reportName="Site Report - ${todaysDate}">
          </crawl>
        </step>
      </test>
    </tests>
  3. Replace the following placeholders:
    1. organizationId: Replace with your AMP organization ID.
    2. assetId: Replace with your AMP asset ID.
    3. url: Replace https://not.webaccessibility.com with your desired site URL.

Run the script

Define the TODAYS_DATE variable by running:

set "TODAYS_DATE=%date:~7,2%/%date:~4,2%/%date:~10,4%"

Execute the script:

To execute the script:

  1. Run the following command: 
    continuum-script-executor example.xml
  2. Check the AMP organization and asset specified in the script for the generated report.

Optional: Add AMP Certificates to Java Store

In some cases, you may need to import AMP certificates for secure communication:

Download the AMP certificate

To download the certificate:

  1. Open AMP in Chrome.
  2. Go to Menu.
  3. From more tools, select Developer tools (ctrl+shift+i).
  4. Select Security and click View Certificate.
  5. Export the certificate and save it as _http://.levelaccess.net.crt.

Import the certificate

To import the certificate:

  1. Open command prompt.
  2. Navigate to the location of the .crt file: 
    cd %userprofile%\Desktop
  3. Import the certificate using the keytool: 
    %JAVA_HOME%\bin\keytool -import -trustcacerts -cacerts -storepass changeit -noprompt -alias ampcert -file _http://.levelaccess.net.crt
  4. Verify the import: 
    %JAVA_HOME%\bin\keytool -list -cacerts -alias ampcert

Related articles

Comments

0 comments

Article is closed for comments.