Workbench Link File

You can use a Workbench link file (wlk) to start Workbench. A Workbench link file consists of a series of instructions that include which Workbench project to open as well as DiveLine connection information. If a Workbench instance is already running and a new Workbench attempts to start via a wlk file, the original instance retains focus, and any Workbench links are opened by it.

NOTE: When you use a wlk file to start Workbench, Workbench does not show the Start Page.

There are two file formats available for Workbench link files: The OFile syntax, which is similar to Integrator scripts or DivePlans (rather than the traditional DI link files), and the SDL syntax that is similar to Spectre scripts.

The OFile Workbench link file syntax has the following components:

  • Top-level object—Consists of a single, top-level object called 'MAIN'.
  • Server—Can be one of the following:
  • Server:Port combination
  • URL to a DivePort server
  • Label name of a server as defined in Connection Manager

  • Workbench attempts to find an existing connection that matches. If it does not find one, it uses a temporary connection (which is not saved when all is done).

  • Username (optional)—If specified, overrides any username in the connection. If no username is specified, the user is prompted for one.
  • Password (optional)—If specified, overrides any password in the connection. If no password is specified, the user is prompted for one.
  • NOTE: DI  recommend not storing passwords in wlk files because they are not encrypted. However, a one-time password in a generated wlk file is acceptable (and expected).
  • OpenFiles—Specifies a list of Project URLs to open. The syntax is:
  • OpenFiles = {
  <project_url>,
  <project_url> 
}

    Use one of the following formats for project URLs:

    project://<project_name>/path/to/file.ext
    project://<project_name>/path/to/file.ext?Editor=Text Editor

For example:

version "1";
charset 1208;
object 'MAIN' "Main" {
  Server="myserver:2130",
  Username="admin",
  Password="asdhklasnuy8boi",
  OpenFiles = {
    "project://races/programs/buildall.prd?Editor=Text Editor"
  }
};

This example connects to myserver:2130, opens the project races, and opens the Production script /programs/buildall.prd in that project. The script opens in a text editor (instead of the default editor). The Editor instruction is optional, and without it the script opens with the default editor, such as Production GUI editor in this instance.

The SDL Workbench link file syntax has the following components:

  • Top-level object—Consists of a single, top-level object called workbench-link.

  • Server—Can be one of the following:
  • Server:Port combination
  • URL to a DivePort server
  • Label name of a server as defined in Connection Manager

  • Workbench attempts to find an existing connection that matches. If it does not find one, it uses a temporary connection (which is not saved when all is done).

  • Login (optional)—If specified, overrides login information with the following:

    • Username (optional)—If specified, overrides any username in the connection. If no username is specified, the user is prompted for one.

    • Password (optional)—If specified, overrides any password in the connection. If no password is specified, the user is prompted for one.

      NOTE: DI  recommends not storing passwords in wlk files because they are not encrypted. However, a one-time password in a generated wlk file is acceptable (and expected).

  • File—Specifies which file to open when the Workbench link file runs.

    • Project—Specifies which Workbench project the file is located in.

    • Path—Specifies the path and file to open. For example:

      If the file path of a Workbench file is /Sample_Project/path/to/file.build, the path is /path/to/file.build.

  • Parameters (optional)—Allow you to specify which line or character you want to have open in the Workbench file. There are four parameters available:

    • Line—Specify the numeric line in the file to display.

    • Char—Specify the character on the previously specified line in the file to display.

    • ShowLineNumbers—Specify whether to display line numbers.

    • Editor—Specify if the Workbench file opens in the text editor. Text Editor is the only valid value for this parameter.

For example:

workbench-link {
  server "Demos:7000"
  login username="admin" password="admin"
  file project="SpectreDemo" path="/programs/example.build" {
    parameter "line" "100" 
    parameter "char" "6" 
    parameter "ShowLineNumbers" "false"
    parameter "Editor" "Text Editor"

  }
}

This example connects to Demos:7000, opens the project SpectreDemo, and opens the Spectre script /programs/example.build in that project. The script opens in a text editor (instead of the default editor).

See also: Launching DI Applications.