A newer version of this documentation is available.

View Latest

WLD

Workstation Lock Down

WLD default configuration
[WLD]
ActionBarBackgroundColor=#FFFFFF
ActionBarBorderColor=#000000
:ActionBarBorderWidth=2
:ActionBarResizeStep=0
:ActionBarResizeTime=0
ApplicationLogo=wld_app_logo_white.png
ApplicationLogoSize=384
BackgroundColor=#FFFFFF
BackgroundImage=
BackgroundPattern=
ButtonBackgroundColor=#FFFFFF
ButtonBackgroundColorHover=#E0E0E0
ButtonBorderColor=#000000
ButtonBorderColorHover=#000000
:ButtonBorderRadius=8
:ButtonBorderWidth=2
ButtonSize=96
DescriptionBackgroundColor=#FFFFFF
DescriptionBorderColor=#000000
:DescriptionBorderSize=1
:DescriptionPosition=20
DescriptionTextColor=#000000
DescriptionTextSize=22
InformationImage=wld_info.png;wld_info.png;wld_info.png;wld_info.png
InformationImageSize=0x01EF010D
InformationText=-;{string:1010};-;-
InformationTextColor=#000000
InformationTextSize=48
:PaddingSize=16
:ProgressColor=#000000
:ProgressCorners=1
:ProgressLength=0
ProgressLines=12
:ProgressOpacity=0.25
:ProgressRadius=24
:ProgressWidth=12
ScreenSaverColor=#000000
ScreenSaverImage=
:ScreenSaverLoadStep=0.05
:ScreenSaverLoadTime=20
ScreenSaverOpacity=0.9
ScreenSaverTimeout=60
ScrollSize=8
TokenModelList=

General parameter values

Color parameters

Colors can be defined by using their HTML color names, or the color’s hex value on the form #123456

Number parameters

Depending on parameter type, numbers can be integers or floats. For floats, a decimal point is used as decimal separator.

Size parameters

Size is given in pixels. The value is written as in the CSS file, that is, 10px or 0.25px

Image parameters

Supported image file formats:

  • .BMP

  • .GIF

  • .ICO

  • .JPG

  • .TIF

  • .PNG

  • .SVG

Image size should not be an issue, but try to not use bigger images than necessary.

Background

The parameters for background sets the webb page or application background. Background color, image, and pattern can be used, and any combination of them can be used. Such as color in the back, then a pattern, and on top an image.

[WLD]
BackgroundColor=#1040D0
BackgroundImage=
BackgroundPattern=

BackgroundColor

BackgroundColor is the background color of the page or application. If no value is given, black is selected.

BackgroundImage

BackgroundImage is the background image to use. The image is stretched so that it fits the screen. If no image value is given, no image is shown.

BackgroundPattern

BackgroundPattern is set by using an image that is repeated to fill the screen. If no value is given, no pattern is shown.

[WLD]
ApplicationLogo=wld_app_logo_white.png
ApplicationLogoSize=384

ApplicationLogo is the image that is shown at the bottom right of the screen. The image has no specific requirements on size. For more information about image file formats, see Image parameters

The image is stored as a resource in Net iD Client. See resource for more information.

If the image cannot be found, no image is shown.

ApplicationLogoSize

ApplicationLogoSize is the size of the ApplicationLogo image. The size is specified using the format 0xXXXXYYYY where XXXX is the width and YYYY is the height given in hexadecimal format. The image is stretched to the specified size.

If only the width is given, the height will be stretched proportionally. It is therefore recommended to use square images.

Example 1. Size specification example

The image size is 1024 × 640 pixels (width × height).

Convert the decimal number to a hexadecimal number.

Decimal number Hexadecimal number

Width

1024 pixels

0400

Height

640 pixels

0280

Thus, the ApplicationLogoSize value is 0x04000280.

ActionBar

ActionBar is the area where the buttons are located, see Buttons It is only visible if there are any buttons to show. It can be shown in an instant or gradually depending on the settings when buttons are available, see ActionBarResizeStep and ActionBarResizeTime. Now, it is always shown to the left on the screen and buttons are placed from the top to bottom.

[WLD]
ActionBarBackgroundColor=#FFFFFF
ActionBarBorderColor=#000000
:ActionBarBorderWidth=2
:ActionBarResizeStep=0
:ActionBarResizeTime=0
:PaddingSize=16

ActionBarBackgroundColor

ActionBarBackgroundColor is the background color of the ActionBar. The value none makes the background transparent.

ActionBarBorderColor

ActionBarBorderColor is the color of the border.

The value none makes the border transparent. But to make the border invisible it is recommended to instead set the border width to 0, see ActionBarBorderWidth.

ActionBarBorderWidth

ActionBarBorderWidth is the width of the border. Set this value to 0 to not show the border.

ActionBarResizeStep

ActionBarResizeStep is used to control a gradual emergence. It sets how many pixels each step should be. The value 0 will show the ActionBar immediately.

Depending on the WebKit implementation, there is a computational problem in getting the actual load time bacause it depends on the time it takes to redraw the image. The actual value will most likely have to be decided through tests.

ActionBarResizeTime

ActionBarResizeTime is used to control a gradual emergence. It sets how many milliseconds there are between each step. The value 0 will show the ActionBar immediately.

Depending on the WebKit implementation, there is a computational problem in getting the actual load time bacause it depends on the time it takes to redraw the image. The actual value will most likely have to be decided through tests.

PaddingSize

PaddingSize is the distance bewteen the buttons and the distance between the buttons and the border of the ActionBar.

Buttons

Buttons are buttons with a built in actions. That is, press the button to make something happen. These actions are entirely linked to Net iD Client, so what you can do with Actions in Net iD Client, you can here do by pressing a button.

For more information on how to configure the buttons, see WLD Buttons.

[WLD]
ButtonBackgroundColor=#FFFFFF
ButtonBackgroundColorHover=#E0E0E0
ButtonBorderColor=#000000
ButtonBorderColorHover=#000000
:ButtonBorderRadius=8
:ButtonBorderWidth=2
ButtonSize=96
ScrollSize=8

ButtonBackgroundColor

ButtonBackgroundColor is the background color of the button.

ButtonBorderColor

ButtonBorderColor is the border color of the button.

ButtonBorderRadius

ButtonBorderRadius defines the radius of the button’s corners.

The value 0 gives right-angled corners, and the value 50 gives a corners with the shape of quarter circles.

ButtonBorderWidth

ButtonBorderWidth is the border width of the button. Set this value to 0 to not show the border.

ButtonSize

ButtonSize is the size of the button. The size does not include the border. This is important when using images on the buttons.

ButtonBackgroundColorHover

ButtonBackgroundColorHover sets the color on the button when you mouse over it.

ButtonBorderColorHover

ButtonBorderColorHover sets the color on the button border when you mouse over it.

ScrollSize

ScrollSize is the padding size between the buttons and the scroll bar. The scroll bar is visible when the number of buttons are too many for the current screen resolution.

Descriptions

Each button can have a description tooltip. The button description is specified under WLD Buttons. This function is optional.

[WLD]
DescriptionBackgroundColor=#FFFFFF
DescriptionBorderColor=#000000
:DescriptionBorderSize=1
:DescriptionPosition=20
DescriptionTextColor=#000000
DescriptionTextSize=22
:PaddingSize=16

DescriptionBackgroundColor

DescriptionBackgroundColor is the background color of the description tooltip.

DescriptionBorderColor

DescriptionBorderColor is the color of the border.

The value none makes the border transparent. But to make the border invisible it is recommended to instead set the border width to 0, see DescriptionBorderSize.

DescriptionBorderSize

DescriptionBorderSize is the border width of the of the description tooltip. Set this value to 0 to not show the border.

DescriptionPosition

DescriptionPosition is the position of the description tooltip relative to the mouse cursor. Enter the number of pixels below and to the right of the button that the upper left corner of the description will end up.

DescriptionTextColor

DescriptionTextColor is the color of the description text.

DescriptionTextSize

DescriptionTextSize is the size of the typeface for the description text.

PaddingSize

PaddingSize specifies the distance between text and borders. Make sure to divide the distance you want to use with two (2).

Information

You can show information as image or text or both based on the token status.

The token status can be:

progress

 

token-not-present

 

token-present

 

token-logged-on

 

The information contains of two parts, image and text. The image is always placed above the text and they are both centered. They are shown on the center of the screen.

[WLD]
InformationImage=wld_info.png;wld_info.png;wld_info.png;wld_info.png
InformationImageSize=0x01EF010D
InformationText=-;{string:1010};-;-
InformationTextColor=#000000
InformationTextSize=48

InformationImage

InformationImage is a list of the images to show for each token status. The values are separated by semi-colon. The image is stored as a resource in Net iD Client. See the resource command for more information.

If the image cannot be found, no image is shown.

InformationImageSize

InformationImageSize is the size of the InformationImage image. The size is specified using the format 0xXXXXYYYY where XXXX is the width and YYYY is the height given in hexadecimal format. The image is stretched to the specified size.

If only the width is given, the height will be stretched proportionally. It is therefore recommended to use square images.

Example 2. Size specification example

The image size is 1024 × 640 pixels (width × height).

Convert the decimal number to a hexadecimal number.

Decimal number Hexadecimal number

Width

1024 pixels

0400

Height

640 pixels

0280

Thus, the InformationImageSize value is 0x04000280.

InformationText

InformationImage is a list of the texts to show for each token status. The text can be given directly as a string or as a string ID. For more information about string IDs for different languages see Language. The values are separated by semi-colon.

If you do not want to show any text at all, leave the field empty. If you always are showing an image but only show text sometimes

InformationTextColor

InformationTextColor is the color of the text.

InformationTextSize

InformationTextSize is the size of the typeface for the text.

Progress

It is possible to use a progress animation. This animation uses the open source component spin.js. Some of the spin.js parameters can be specified in this configuration. Make sure to read the spin.js documentation to fully understand how they work.

[WLD]
:ProgressColor=#000000
:ProgressCorners=1
:ProgressLength=0
ProgressLines=12
:ProgressOpacity=0.25
:ProgressRadius=24
:ProgressWidth=12

Parameters are sent directly to the options object, which makes the progress animation.

//-----------------------------------------------------------------------------
// LoadOptions
//-----------------------------------------------------------------------------
function LoadOptions(settings) {
  return {
    lines: settings.ProgressLines, // The number of lines to draw
    length: settings.ProgressLength, // The length of each line
    width: settings.ProgressWidth, // The line thickness
    radius: settings.ProgressRadius, // The radius of the inner circle
    scale: 1, // Scales overall size of the spinner
    corners: settings.ProgressCorners, // Corner roundness (0..1)
    color: settings.ProgressColor, // #rgb or #rrggbb or array of colors
    opacity: settings.ProgressOpacity, // Opacity of the lines
    rotate: 0, // The rotation offset
    direction: 1, // 1: clockwise, -1: counterclockwise
    speed: 1, // Rounds per second
    trail: 50, // Afterglow percentage
    fps: 20, // Frames per second when using setTimeout() as a fallback for CSS
    zIndex: 999, // The z-index (defaults to 2000000000)
    className: 'xxx', // The CSS class to assign to the spinner
    top: '50%', // Top position relative to parent
    left: '50%', // Left position relative to parent
    shadow: false, // Whether to render a shadow
    hwaccel: false, // Whether to use hardware acceleration
    position: 'absolute', // Element positioning
  };
}
Example 3. No progress animation

To not show any progress, set the number of lines to zero (0).

[WLD]
ProgressLines=0
Example 4. Net iD Portal progress animation

To show a progress animation similar to Net iD Portal, use the follong values.

[WLD]
ProgressLength=12
ProgressRadius=12
ProgressWidth=6
Example 5. Windows 10/11 progress animation

To show a progress animation similar to Windows 10/11, use the follong values.

[WLD]
ProgressLength=0
ProgressRadius=24
ProgressWidth=12

ScreenSaver

The screensaver can be an animated gif image, for example an animated gif image. It all depends on what WebKit implementation you use.

It can also be any standard image. The image will be stretched to fill the entire background. It is possible to chose transparency as well as how to control the transition when the screensaver comes into view.

[WLD]
ScreenSaverColor=#000000
ScreenSaverImage=
:ScreenSaverLoadStep=0.05
:ScreenSaverLoadTime=20
ScreenSaverOpacity=0.9
ScreenSaverTimeout=60

ScreenSaverColor

ScreenSaverColor is the background color of the of the screensaver. If no color is specified, the color black is used.

ScreenSaverImage

ScreenSaverImage is the image that is shown. The image is stretched to fit the screen. If no image is specified, no image is shown.

ScreenSaverLoadStep

ScreenSaverLoadStep is used to control a gradual emergence. It sets how much to increase the transparency with each step. The value 0 will show the screensaver immediately.

Depending on the WebKit implementation, there is a computational problem in getting the actual load time bacause it depends on the time it takes to redraw the image. The actual value will most likely have to be decided through tests. Due to the complexity of animated gif images, they usually take longer time to be redrawn.

ScreenSaverLoadTime

ScreenSaverLoadTime is used to control a gradual emergence. It sets how many milliseconds there are between each step. The value 0 will show the screensaver immediately.

Depending on the WebKit implementation, there is a computational problem in getting the actual load time bacause it depends on the time it takes to redraw the image. The actual value will most likely have to be decided through tests. Due to the complexity of animated gif images, they usually take longer time to be redrawn.

ScreenSaverOpacity

ScreenSaverOpacity gives how transparent the background should be. The value 1.0 causes no transparenty, and smaller values will give more transparency.

ScreenSaverTimeout

ScreenSaverTimeout is the inactivity timeout threshold that controls when to activate the screensaver. To not use a screensaver, set the value to zero (0).

Tokens

TokenModelList

TokenModelList is a whitelist of token models, that is, a list that controls which tokens to use. The values are separated by semi-colon. If no value is given, all models are allowed to use.

Unless otherwise stated, soft tokens are always allowed. Also, they are always present which affects the presentation of ActionBar and Buttons since these are controlled by "a present" token. Always "present" makes sure that token-not-present never occurs.

[WLD]
TokenModelList=