Download & Distribute NCSs

You are here
Download & Distribute manually

Work orders and reservations can be downloaded using a parameter-driven API URL, which is detailed below.

https://yoururl.mcs.com/myspeed/dstl

This API URL can be passed parameters to download both standard work orders and reservations.

Work orders

https://yoururl.mcs.com/myspeed/dstl?a=swo_name&u=result_id

The parameters accepted for work orders are below.

Key Value & Description
a Specify the exact name of the work order. For example, if the work order is named "voiptests", enter "voiptests" here.
u Optional. Defines the session ID to be used. If omitted, the session ID will be automatically generated from the hardware it runs on, typically the computer name.
t Optional. Defines either a desired operating system or a custom satellite file. When not used the default satellite download will be Windows. For MacOS use t=mac and for Linux use t=lin. When targeting a custom satellite use the assigned number, like t=7. For help with custom satellite files and what that means see the section below.

Reservations

https://yoururl.mcs.com/myspeed/dstl?a=swo_name&k=ACDF5C2D

The parameters accepted for work orders are below.

Key Value & Description
a Specify the exact name of the work order. For example, if the work order is named "voiptests", enter "voiptests" here.
k Specify the exact reservation key.
u Optional. Defines the session ID to be used. If omitted, the session ID will be automatically generated from the hardware it runs on, typically the computer name.
t Optional. Defines either a desired operating system or a custom satellite file. When not used the default satellite download will be Windows. For MacOS use t=mac and for Linux use t=lin. When targeting a custom satellite use the assigned number, like t=7. For help with custom satellite files and what that means see the section below.

The work order name must match the one defined in the reservation; otherwise, an error will occur. Similarly, an error will occur if the reservation key does not exist. The reservation key is returned when a reservation is created successfully.

Custom satellite specification

This feature is intended for MCS deployments that require support for multiple satellite binaries.

By default, MCS includes a single satellite binary for each supported operating system (Windows, macOS, and Linux). In cases where additional satellites are required, such as custom branding, specialized functionality, or market-specific deployments, Visualware can generate custom satellite binaries upon request. The custom satellite specification provides a structured method for registering and selecting these additional binaries.

Server-level access is required to configure and enable this feature.

Within the MCS root directory, locate the configuration file named local.ini. This file is used to define references to custom satellite binaries.

Each custom satellite must be declared using the following syntax:

CustomSatelliteX=customsatellite.exe

The placeholder X must be replaced with a numeric value greater than six (6). Each key must be unique, as duplicate key names are not supported.

The referenced satellite binary must be placed in the /MCS Root/www/ directory and referenced by its exact filename, including the file extension. For example:

CustomSatellite7=customsatellite.exe

Once defined, the custom satellite can be selected by supplying the optional t parameter using the same numeric value defined in the configuration file. For example:

t=7