2.7.6.121001, 10 December 2018 11:38 AM : © 2018 - Mead & Company Ltd.

How to install ScriptX.Services for Windows PC

ScriptX.Services for Windows PC is available now. The system is being improved and enhanced regularly and the minimum version required is v2.7.1.

ScriptX.Services for Windows PC requires

  •  Microsoft Windows 7 or Windows 10 (1803) or later on an Intel x64 PC.
  •  .NET Framework 4.6.1 or later

Installation/configuration Overview

ScriptX.Services for Windows PC has two parts:

A single installer is available that will install both parts and a default configuration that is suitable for most use-cases.

The default configuration has these key aspects:

Using Google Chrome 70, Edge 42 or later?

Google Chrome 70 and Edge 42 and later on Windows 7/Windows 10 do not block communication between a secure internet site and an "insecure" server hosting on the local loopback address 127.0.0.1. Because of this a certificate enabling https: is not necessarily required.

Other/older browsers do block communication and so a certificate for localhost will be required when printing of content originating from a secure site.

The default configuration can be customised on a per-user basis.

Install and use of ScriptX.Services for Windows PC

Administrator rights are required to install ScriptX.Services for Windows PC.

  1. Download ScriptX.Services For Windows PC Installer package v2.7.6.0:

  2. Run the downloaded installer.

ScriptX.Services for Windows PC is now available to any browser at any time.

Customising the configuration if required

As installled:

To view the configration in use navigate to the  server dashboard (this link assumes the default port works).

Each of these aspects can be changed by defining configuration values in the appsettings.json file.

This file should be created in the user's local application data folder: C:\Users\[UserName]\AppData\Local\MeadCo\ScriptXServices

An empty appsettings.json file is simply this:

{
}

To configure the server, add sections as described below to between these top level braces {}, for example:

{
  "ServerHost": {
    "Endpoints": {
      "Http": {
        "Port": "45678"
      }
    }
  }
}

Standard Port Configuration

The server cannot work and will not start if the default configured port is already in use. If this occurs, then configure a new port number that is free.

To configure the port used, create an appsettings.json file similar to this:

  "ServerHost": {
    "Endpoints": {
      "Http": {
        "Port": "45678"
      }
    }
  }

The value given to "Port" can be any value that is free on your systems.

Support for https:

To support https a server certificate for localhost must be installed and recognised as valid by the browsers that are to be used. Such a certificate may already be installed, in which case it will be used.

If there is a port clash for https, then configure the port to be used by create an appsettings.json file similar to this:

  "ServerHost": {
    "Endpoints": {
      "Http": {
        "Port": "45678"
      },
      "Https": {
        "Port": "45679",
        "Certificate": {
          "Source": "localhost",
        }
      }
    }
  }

Enable logging assistance

Logging is available and configured in the same way as for all .NET Core applications with a section similar to this:

  "Logging": {
    "LogLevel": {
      "Default": "Debug",
      "System": "Information",
      "Microsoft": "Information"
    },
    "File": {
      "Name": "service.log"
    }
  }

ScriptX.Services for Windows PC enables logging to the Debug output stream. If you wish to log to a file, add a "File" section as shown above. The file will be created in the folder C:\Users\[UserName]\AppData\Local\MeadCo\ScriptXServices.

Test printing - Using ScriptX.Services for Windows PC to print

How to use our samples with ScriptX.Services for Windows PC

A walk through of taking some classic ScriptX factory code and making it work with ScriptX.Services