Actions

When you create advanced scripts or startup/shutdown scripts, you can choose and edit the actions as desired. You have access to the full potential of the NetMan Desktop Manager system and can create powerful scripts. You can also choose from the complete range of actions when you edit installation scripts. This chapter provides detailed descriptions of all actions and their use. It offers you a reference to inform yourself about an action, its use and return values. It also shows you work examples that illustrate the use of the actions. The Actions are listed alphabetically in the following:

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

You can also look up Actions by category in the following list of actions by category:

	App start
Category: User
Description: This action starts a specified Windows app.
Configuration: Under Windows app select the Windows app. Additional settings: Parameter. The program will be launched with the parameters entered here. Internet filter. Applies the specified filter to the program. Content definition. Defines applicable restrictions for Internet content. Log data. The program launch is recorded in a log file with the record ID specified here. Allow multiple instances on one workstation. Permits more than one instance of the program in a single session. Hold subsequent action(s) until this program is closed. No further actions in the script are executed until the app specified in this Windows App action has been closed.
Return values: Return: 1 - Windows app launched successfully; 0 = error Error code: 0 or error code
Example: -

	Cancel
Category: Control
Description: You can use the Cancel action to stop the processing of a script.
Configuration: If the return value from a preceding action indicates that the subsequent actions should not be executed, an inserted Cancel action can stop script processing. Position the Cancel action at that point in the script at which you wish processing to stop. You can define a message if desired; for example, giving the reason for the cancellation. The message is displayed when the Cancel action is called. If no message is configured, the script is cancelled with no further output. Show message. Defines how the cancellation message is displayed: •in a dialog. The cancellation message is displayed in the form of a dialog. •in the event log. The message is shown in the event log. •as a dialog and in the event log. Shows the message in both forms. Message. The message to be displayed. Click the 'selection' button to define a message in any of the available languages. Close automatically after. Sets the interval after which the message dialog box closes automatically.
Return values: Return: Always 1 Error code: Always 0, as there is no error case for this Action.
Example: -

	Change Collection
Category: User
Description: The action loads an alternative collection in the specified position.
Configuration: This action lets you define whether it automatically loads a particular collection or displays a selection to choose from, as well as the position in which the specified collection is integrated: Task. Depending on the selection, either a pre-determined collection is mounted, a list of collections shown, or the current collection dismounted. Collection. The collection to be mounted. Change icons. The collection is added to the Start menu, the desktop or mounted where the Change Collection action executes.
Return values: Return: 1 = The Collection was loaded; 0 = error while loading Error code: 0 or error code
Example: The Change Collection action, combined with the appropriate permissions, gives the administrator a handy tool for testing collections without getting "stuck" in a collection with no privileges.

	Close a program
Category: Controls
Description: The action terminates programs that are launched from a NetMan Desktop Manager script. Child processes are not considered.
Configuration: In the Script ID field, select the ID of the desired script. Edit. Opens a selected script for editing in the Script Editor.
Return values: Return: 1 - Program terminated; 0 = error Error code: 0 or error code
Example: This action allows the central termination of a program on all clients if the program was launched from a NetMan Desktop Manager script.

	Conditional Label
Category: Control
Description: The Conditional Label action lets you define a condition that must be met before script processing can continue.
Configuration: In the Condition field, specify a variable, a condition (is or is not) and a value that the variable must have or may not have. In the Description field, enter a meaningful description of the condition.
Return values: Return: Always 1 Error code: Always 0
Example: -

	Confirmation
Category: Dialogs
Description: The Confirm action can present a simple query or piece of information to the user, who responds by clicking Yes/No (OK/Cancel).
Configuration: Enter a text for the dialog box in the Message field. Next to Controls (return values) you can define the controls available to the user. Stay open for (n) seconds. The dialog remains open for n seconds. If you enter 0 here, the dialog remains open until the user makes a selection. Close automatically after (n) seconds. The dialog closes automatically after n seconds. If you enter 0 here, the dialog remains open until the user makes a selection.
Return values: If you define two buttons, the return values are 1 and 0, where 0 is the negative response (Cancel). If you use three buttons, 1 is the positive response, (OK), 2 the neutral response (Retry or No) and 0 is the negative (Cancel). 1 = button 1 2 = button 2 0 = Cancel
Example: The ReturnValue variable is the return value from this action. There are a number of actions that could be useful follow-ups to a Cancel or No response from the user, such as a message or a Cancel action, or other subsequent processing that differs from what would follow a positive response.

	Connect Drive
Category: Drives
Description: This action lets you allocate a drive letter to a drive share.
Configuration: The list shows the drive letter allocations to be carried out. Click on the New button at the top of the list to add a drive. The fields in this dialog define the column headers for the drive list as follows: Drive. Designation for the share to be mounted. Share. Path of the share to which the drive designation will be assigned. Users. User account under which the share will be mounted. Password. The password for the designated user.
Return values: Return: 1 = Drives(s) connected; 0 = error connecting drive(s) Error code: 0 or error code
Example: Assign a drive letter to a share to create an application drive.

	Connect Printer
Category: User
Description: This action connects one or more network printers.
Configuration: To disconnect a printer, click on the Add button above the printer list and select the desired printer. Select the printer in the dialog box. The default printer option connects the printer as the default printer. The printer is added to the list of printers to be connected. All printers on this list are connected when the action is executed. Only one printer can be made the default printer. If the default printer option is activated for more than one printer, the last printer connected will be designated as default printer.
Return values: Return: 1 = Printer(s) connected; 0 = error connecting printers Error code: 0 or error code
Example: -

	Copy Files
Category: Files
Description: The Copy Files action can be used to copy one or more files. There are a number of options you can define in this Action as well.
Configuration: In the Files list, enter the files to be copied by this Action. You can also set the following options for the 'copy’ operation (Copy mode): •Normal. Normal. You can select from the copy options for normal copying. •Advanced. Advanced copy mode. Copying can be made dependent on file attributes. Depending on the copy mode, choose from the following additional copy options (Settings): Normal mode: Copy items. Copies files in normal copy mode according to the following scheme: •always - replace existing files. All files will be copied. Existing files of the same name in the target directory will be replaced. •always - add new files - no overwrite old. Files are copied to the target only if no file of the same name is found there. Existing files are not replaced. •only if no folder with this name is found. The 'copy' operation is not carried out unless no folder of the same name is found at the designated target. Copy each item separately. A new 'delete' process is started for each folder. Advanced mode: Included items. Specifies which files are copied: •All items included. All files will be copied. •Only files with at least one selected attribute.. Copies only files that have one or more of the selected attributes: •None. No file attribute set. •Archive •Hidden •Read only •System Ignore errors. Ignores errors and continues the ‘copy’ operation in any case. Log file. Writes a log file about copy operations under the specified path. Reserved disc space. Free disk space reserved for the log file. OS progress dialog. Defines whether and how the operating system's progress indicator is displayed: •Enabled. The progress indicator is displayed. •Enabled; 'Cancel' button disabled. The progress indicator is displayed but the Cancel button is inactive. •Not shown. The progress indicator is not displayed. Move files. The files are moved instead of copied. Ask before overwriting files. A prompt for confirmation opens before any files are deleted. Copy each file separately. A new 'copy' process is started for each file. Execute with system privileges. The 'System' account is used to execute the 'copy' process.
Return values: Return: Number of copied files Error code: 0 or error code
Example: -

	Copy Folder
Category: File
Description: You can use this action to copy a folder and, if desired, its contents.
Configuration: Click the New button just above the list. Source is the folder to be copied. Destination is the path into which the folder will be copied. You can also set the following options for the 'copy’ operation (Copy mode): •Normal. Normal. You can select from the copy options for normal copying. •Advanced. Advanced copy mode. Copying can be made dependent on file attributes. •Update. Updating the folder content. Only files that have changed are copied. The update mode has the same settings as the advanced copy mode. •Collate. Creates a copy of the source directory in the target directory. Files that do not exist in the source directory are deleted in the target directory. The collation mode has the same settings as the advanced copy mode. Depending on the copy mode, choose from the following additional copy options (Settings): Normal mode: Copy items. Copies files in normal copy mode according to the following scheme: •always - replace existing files. All files will be copied. Existing files of the same name in the target directory will be replaced. •always - add new files - no overwrite old. Files are copied to the target only if no file of the same name is found there. Existing files are not replaced. •only if no folder with this name is found. The 'copy' operation is not carried out unless no folder of the same name is found at the designated target. Copy each item separately. A new 'delete' process is started for each folder. Advanced mode: Included items. Specifies which files are copied: •All items included. All files will be copied. •Only files with at least one selected attribute.. Copies only files that have one or more of the selected attributes: •None. No file attribute set. •Archive •Hidden •Read only •System Ignore errors. Ignores errors and continues the ‘copy’ operation in any case. Log file. Writes a log file about copy operations under the specified path. Reserved disc space. Free disk space reserved for the log file. Progress dialog. Defines whether and how the operating system's progress indicator is displayed: •Enabled. The progress indicator is displayed. •Enabled; 'Cancel' button disabled. The progress indicator is displayed but the Cancel button is inactive. •Not shown. The progress indicator is not displayed. Move folder. The source folder is removed during the copy operation. Copy recursively. All folders are copied recursively, i.e. the folder is copied with all subfolders. Ask before operations on existing entries (overwrite, delete). A prompt for confirmation opens before data is overwritten. Execute with system privileges. The 'System' account is used to execute the 'delete' operation.
Return values: Return: Number of copied files Error code: 0 or error code
Example: -

	Create Folder
Category: File
Description: You can use this action to create a new folder anywhere in the system.
Configuration: To create a folder, click on the New button above the list. All folders on this list are created when the action is executed. Activate the Execute with system privileges option to create the folder using the ‘System’ account. Keep in mind that a folder can be created only if the account used has the necessary privileges. This is particularly important in the network environment. You can use this action in combination with a Network Logon action to create the folder using an account that has the required privileges.
Return values: Return: Number of folders created Error code: 0 or error code
Example: -

	Create a Reparse Point
Category: Drives
Description: This Action creates a new link entry in NTFS file systems. The link can be deleted using a Remove Reparse Point action. This action requires the NTFS file system. Do not use this action unless you are familiar with reparse points. Incorrect use can lead to loss of data. Some basic information on reparse points is available in the Microsoft knowledge base. Folder. Folder linked by the reparse point. Reparse point. The reparse point. Server. Server with the NetMan Desktop Manager Reparse Point Service – usually the NetMan server.
Configuration: Folder. Local target folder, linked by the reparse point. Reparse point. Folder representing a reparse point. Server. Folder and target folder server. The NetMan Reparse Service must be installed on that server.
Return values: Return: 1 = All reparse points created; 0 = error creating reparse point Error code: 0 or error code
Example: -

	Delete files
Category: Files
Description: The Delete Files action can be used to delete one or more files. There are also a number of options you can configure in this action.
Configuration: In the Delete files field, you can define the files to be deleted. OS progress dialog. Defines whether and how the operating system's progress indicator is displayed: •Enabled. The progress indicator is displayed. •Enabled; 'Cancel' button disabled. The progress indicator is displayed but the Cancel button is inactive. •Not shown. The progress indicator is not displayed. Ask before deleting files. A prompt for confirmation opens before any files are deleted. Delete each file separately. A new 'delete' process is started for each file. Execute with system privileges. The 'System' account is used to execute the 'delete' process.
Return values: Return: Number of files deleted Error code: 0 or error code
Example: -

	Delete Folder
Category: File
Description: You can use this action to delete a folder and its contents.
Configuration: Click on the New button at the top of the list and enter the folder to be deleted. You can also set the following options for the 'delete' operation: OS progress dialog. Defines whether and how the operating system's progress indicator is displayed: •Enabled. The progress indicator is displayed. •Enabled; 'Cancel' button disabled. The progress indicator is displayed but the Cancel button is inactive. •Not shown. The progress indicator is not displayed. Ask before deleting folders. A prompt for confirmation opens before folders are deleted. Delete each folder separately. A new 'delete' process is started for each folder. Execute with system privileges. The 'System' account is used to execute the 'delete' operation.
Return values: Return: Number of folders deleted Error code: 0 or error code
Example: -

	Directory Selection
Category: Dialogs
Description: This action presents the folders in a specified directory for user selection.
Configuration: In the Message define a message to the user. Under Path select the directory of which you wish to show the contents. Other settings: Use the full path for the selected directory. This action returns not only the name of the directory specified under "Path," but also the full pathname. Permit navigation within directories. If you select this option, the dialog will open showing the designated directory, but the user will be able to navigate freely among all directories. Show hidden folders. If you select this option, hidden folders will be shown in the dialog. Close automatically after. The folder selection dialog will close automatically after the interval defined here has elapsed.
Return values: Return: Selected folder, or nothing Error code: Always 0
Example: Use this action in combination with, for example, a File List action to offer the user your choice of files in a user-selected directory.

	Disconnect Drive
Category: Drives
Description: This action lets you undo the assignment of a drive designation to a network share.
Configuration: In the Drive(s) to disconnect field, enter the drive designation(s) to be dismounted. Activate the Restore previous drive status option to return the drive to the most recent previous status. If you activate the 'restore' option, the stored state of the drive(s) will be deleted.
Return values: Return: 1 - Designated share(s) successfully dismounted or restored to previous status; 0 = error Error code: 0 or error code
Example: -

	Disconnect Printer
Category: User
Description: This action disconnects one or more connected network printers.
Configuration: In the selection field, select whether you want to disconnect a specific or all printers: •Disconnect selected printers. Disconnects all printers that you specify in the list below. •Disconnect all connected printers. Disconnects all connected network printers. To disconnect a printer, click on the Add button above the printer list and select the desired printer. Select the printer in the dialog box. The selected printer is added to the list of printers to be disconnected. All printers on this list are disconnected when the action is executed.
Return values: Return: 1 = Printer(s) disconnected; 0 = error Error code: 0 or error code
Example: -

	Drive Selection
Category: Dialogs
Description: This action offers the user a choice of drive designations, shown with the drive names. The user selects a drive and confirms by clicking OK.
Configuration: The text you enter in the Message field will be displayed in the title bar of the dialog box. In the Selectable drive types list, tick the boxes next to the types of drives to be included in the list.
Return values: Return: Selected drive, or nothing Error code: 0; 1 = Cancel
Example: -

	Eject an Image
Category: Drives
Description: This action removes an image file from a specific drive or ejects all images.
Configuration: Next to Eject VCD(s) from you specify whether all drives are ejected in general or only one specific drive. Under Drive(s) to eject enter one or more drives that will be ejected. The drives are defined by the drive letter (with colon). Multiple drives are separated by semicolon and a subsequent space.
Return values: Return: 1 - All images ejected or drives’ state restored, 0 - Error Error code: 0 or error code
Example: -

	Environment
Category: Values
Description: This action lets you store a value in a NetMan environment variable. Modifications made by an Environment action affect only the NetMan environment on the workstation on which the action is executed. In contrast to the return value variables, which apply only while the NetMan Script is executing, NetMan environment variables are valid throughout the NetMan session.
Configuration: In the Variable field, enter the name of the variable. Value is the value to be stored in the variable. To delete the value in a variable, leave the Value field blank. Existing values listed under Environment will be overwritten.
Return values: Return: 1 = Value stored in environment variable; 0 = error Error code: 0, error or 1
Example: -

	Exit Windows
Category: User
Description: You can use this action to close the user's Windows session in a manner you define.
Configuration: Under Method, you can define whether the computer is shut down or restarted, or the user is logged off.
Return values: Return: 1 - Action successful; 0 = error Error code: 0 or error code
Example: This can be very useful, for example, if a script installs certain components prior to running an application, and the installation requires that Windows be restarted.

	File Dialog
Category: Dialogs
Description: You could also use the File Dialog action opens the standard Windows "File Open" dialog. The user can select only one file. Enter the path to the desired folder in the Directoryfield.
Configuration: In the Filter list, you can specify the files that will be available to choose from, using the usual wildcards (*, /, ?); for example: The user will be able to see all files, whether stored locally or on the network, subject only to restrictions imposed by user access permissions. If all you need to offer is a choice from among a specific selection of files, you might prefer to use a File List action, which does not show directory contents. Using variables can make your path names system-independent. When you use the selection dialog to enter the path, NetMan replaces the values it recognizes with the corresponding variables. Unlike other actions, your input in the Message field defines the title bar text for the dialog, as opposed to a message to the user.
Return values: Return: File name (in quotation marks) or nothing Error code: Always 0, as there is no error case for this action File names are returned in quotation marks. If the return value is for use with an application that requires a value without quotation marks, place an Environment action prior to this action that sets the NMActFileParamWithQuote variable to 0. Afterwards, use another Environment action to reset this value to '1', or delete the variable.
Example: -

	File List
Category: Dialogs
Description: The File List action presents the user with a list of files to choose from; the user can select one or more files.
Configuration: Enter a text for the dialog box in the Message field. Under Filter(s) you can define the files that the user will be able to choose from, and next to No. of files selectable, the maximum number of files that the user can select. Return format. Defines how the name of the selected file is returned. Close automatically after (n) seconds. Shuts down the File List action after n seconds. Show hidden files. The file list also shows hidden files. Columns shown. Define what file attributes are shown (date modified, file size, etc.).
Return values: Return: 1 = the selected file; 0 = cancel Error code: Always 0 File names are returned in quotation marks. If the return value is for use with an application that requires a value without quotation marks, place an Environment action prior to this action that sets the NMActFileParamWithQuote variable to 0. Afterwards, use another Environment action to reset this value to '1', or delete the variable. In order to create workstation-independent queries, we recommend using (NetMan) variables rather than specific path names. The action has several default return variables. By default, the return value of the action is stored in the NetMan variable $nmrc$. Because this action allows multiple selection, the NetMan variables $nmrc$1 to $nmrc$N are also available, which contain the separate return values in the selected format. If you use a user-defined return variable, the return variable for the individual return values changes to <your return variable>N. The action also has the predefined return variable $rccount$ that contains the number of objects currently selected.
Example: The ReturnValue variable is the return value from this action. One or two files may be selected. Subsequent action(s) can utilize both the ReturnValue variable, which contains names of the two selected files name separated by a comma, and the ReturnValue1 and ReturnValue2 variables, each of which contains one of the selected file names. Additionally, the NetMan variable $rccount$ contains the number of selected objects.

	Filter Configuration
Category: User
Description: This action can be used for session-independent configuration of various filter settings.
Configuration: This action lets you configure settings for the Internet filter, the local drive filter and the client drive filter. Settings overwrite the global defaults: Internet filter. Lets you configure settings that differ from the global defaults: •No change. The global default Internet filter settings are applied. •Disabled. The Internet filter is deactivated. •Enabled (Internet and content filter). Internet filter and content filter are activated. The filter settings of the Internet filter file selected under Filter File and the content filter definition selected under Content Definition are applied. •Enabled (Content filter only). The content filter is activated. The filter settings of the content filter file selected in the Filter file field are applied. •Enabled (Internet filter only). The Internet filter is activated. The settings defined in the file named in the Filter file field are applied. Filter file. If the Internet filter is active, the settings defined in this filter file are applied. Content definition. If the content filter is active, the settings defined in this filter file are applied. Local drive filter. Lets you configure local drive filter settings that differ from the global defaults: •No change. The global default local drive filter settings are applied. •Disabled. The local drive filter is deactivated. •Enabled. The local drive filter is activated. This configuration.... Defines how settings are handled in relation to the global defaults: •is superseded by global settings. Settings for the local drive filter are restored to the global defaults. •overwrites the global settings. The settings defined in the file named in the Filter file field overwrite the global defaults. Filter file. When the local drive filter is active, the settings defined in this filter file are applied. Client drive filter. Lets you configure settings that differ from the global defaults: •No change. The global default client drive filter settings are applied. •Disabled. The client drive filter is deactivated. •Enabled. The client drive filter is activated. This configuration.... Defines how settings are handled in relation to the global defaults: •is applied together with global settings. The settings for the client drive filter complement the global defaults. •overwrites the global settings. The settings defined in the file named in the Filter file field overwrite the global defaults. •is superseded by global settings. Settings for the client drive filter are restored to the global defaults. •blocks all client drives. All client drives are blocked, regardless of the global defaults. Filter file. If the client drive filter is active, the settings defined in this filter file are applied.
Return values: Return: 1 = values set; 0 = error Error code: 0 or error code
Example: -

	Go To
Category: Control
Description: Use this action to skip one or more actions in the cript. This action must be used in conjunction with the Marker action. Together with the Loop action it is the the only action that has two section entries.
Configuration: There are no configurable options for this action. It is solely intended for use in skipping over a part of the script. Position the Go To action so that it immediately precedes the first of the actions you wish to skip, and the Marker subsequent to the last action you wish to skip.
Return values: Return: 1 = Jumped to Marker; 0 = did not jump to Marker Error code: Always 0
Example: Work with user privileges in defining whether a certain part of the script is skipped or not.

	Information file
Category: Dialogs
Description: The action displays to the user a dialog with information stored in a text file.
Configuration: The text you enter in the Message field is shown in the title bar of the dialog box. In the File field, select the file containing the message you wish to display in the dialog. In the Buttons list, you can define the button controls for the dialog box.
Return values: Return: 1 = OK; 0 = Cancel Error code: Always 0, as there is no error case for this action.
Example: This action is commonly used to inform users of changes on their particular workstation that will be made as a result of subsequent actions in the script. You can configure the controls, for example, to let the user determine whether the changes will be carried out or not.

	Insert an Image
Category: Drives
Description: This action inserts images such as ISO or VCD into certain drives.
Configuration: Click the New button just above the list. Under Drive select the drive where the image will be inserted. Under Virtual CD, select the image. The Browse button opens the directory that is defined as the default directory for image files in the NetMan Settings program. Under Password enter the password if the image is password protected.
Return values: Return: 1 = All images inserted; 0 = Error on inserting Error code: 0 or error code
Example: -

	List Selection
Category: Dialogs
Description: This action lets you query a number of parameters in a dialog that contains a selection list.
Configuration: Enter a text for the dialog box in the Message field. Use this message to inform the user of the purpose of their selection. In the list, define which elements will be available to choose from. In the Label column, you can define the options that the user will be able to choose from, and under Value, the value to be returned as a result of choosing that option.
Return values: Return: Selected value, or nothing Error code: Always 0, as there is no error case
Example: The action's return value is used as follows: The user selects the option labeled "H+H web page". The return value assigned to this option is the URL "http://www.hh-software.com". As a result, the subsequent Program action opens a browser with the return value (URL) as argument.

	Loop
Category: Drives
Description: This action creates a loop containing one or more other actions in the script and execute them repeatedly. You can have the loop repeated either a defined number of times, or until a specified condition is met. An End Loop action always belongs to the Loop action. This pair and the Go To/Marker pair are the only actions that have two components.
Configuration: Next to Loop you can specify the desired number of repetitions. Next to Condition you can specify a variable that must contain (or not contain) a certain value to end the loop. If you configure both of these options, the loop ends when the first one is fulfilled.
Return values: Return: 1 - Run the loop; 0 - do not run the loop Error code: Always 0
Example: -

	Network Login
Category: User
Description: This action permits users to log on to a network server.
Configuration: The following options define the network logon: Server. Server that the user will be logged in on. Users. User name for the login. Password. Password for the login. Login dialog. Defines whether the login dialog is displayed. Close automatically after. Define the period after which the login dialog automatically closes.
Return values: Return: 0 = Login failed; 1 = login successful Error code: 0 or error code
Example: -

	Parameters
Category: Dialogs
Description: Use this action to pass parameters or arguments to subsequent actions. You can define specific values to be passed and/or use values defined in whole or part by the user.
Configuration: In the Message field, enter a message to the user. In the list, you can configure the parameter input prompt: Label. Label for the input field. Definition. This is shown in the column labeled Parameter. Defining user input: A space for user input is defined using square brackets ('[]'). You can further define parameter input and values to be passed as follows: •Limit the number of characters in user input: Enter a number of hyphen ('-') characters equal to the number of characters permitted for input. •Hidden values to be passed: The user only edits part of the parameter. You can add hidden values before or after the user-input space by placing the desired value, in square brackets, between "<hidden>" markers. •No user input prompt: If you enter '[]<characterstring>' (i.e., 'open' and 'close' square brackets with no space between them, followed by a character string), the parameter (said character string) is passed on directly without prompting the user for input. This option lets you define, for example, two parameter actions configured with 'execute' permissions that determine which of the two actions returns a value. Variable. Return value variable in which the parameter will be stored. Hide user input by showing only asterisks (***). The display shows an asterisk for each character the user enters. The PW column shows Yes if user input is hidden, and No if the input is not hidden.
Return values: Return: 0 = User canceled input; otherwise 1 Error code: Always 0, as there is no error case for this action
Example: Only 10 characters are to be entered by the user in the Parameter action. The string "NetMan" is also saved as an invisible parameter. To do this, we enter the following in the Definition field: [----------]<hidden>[NetMan]<hidden>.

	Password
Category: Dialogs
Description: This actions prompts input of a particular password. If the required password is not entered, execution of the script is halted.
Configuration: In the Message field, enter a message to the user. In the Password field, enter the required password. This is hidden during input (only asterisks are shown). Click on Show to display the password. Close automatically after. The password-input dialog will close automatically after the interval defined here has elapsed.
Return values: Return: 0 = error, 1 = password prompt successful Error code: Always 0, as there is no error case for this action
Example: There are a number of events you could program as a response to incorrect password input, such as a message to the user, a prompt for renewed password input ("Retry"), a Cancel action, or a Go To action to jump to another portion of the script before processing continues, for example. You can assign login-dependent 'execute' permissions to a Password action and deny permission for administrator accounts, with the result that administrators do not have to enter a password.

	Printer Configuration
Category: User
Description: This action configures various settings for the NetMan Desktop Manager PDF printer.
Configuration: In the Preview field, you can activate or deactivate a print preview. In the Bandwidth field, select the bandwidth available to the printer for the print job. You can either confirm one of the predefined values or enter a custom value.
Return values: Return: 0 = error; 1 = values set Error code: 0 or error code
Example: -

	Printer Security
Category: User
Description: Grants or denies user access to a printer.
Configuration: In the Change security field, enter the type of setting to be configured. This is implemented by an entry in the printer's access control (AC) list. If you select the third option, the entry is removed from the AC list. In the Printer operator field, enter the name of a user that has 'write' permission in the printer's AC list. In the Password field, enter that user's password. In the Printer list, enter the printer for which the setting is to be configured. This field contains either the printer's share name or a list of printers separated by the vertical bar character (ASCII 124). If no printer name is entered, the PDF printer is configured.
Return values: Return: 0 = Printer security settings changed; 1 = Printer security settings not changed Error code: 0 or error code
Example: Access to a color printer can be granted in connection with a specified application. To do this, the default rights for the printer are modified so that not all users can print. Before the application is launched, the current user is granted access to the color printer. After closing the program, that user is removed from the list.

	Program
Category: Program
Description: This action launches a specified program.
Configuration: In the Program field, select the executable file for the program. Other settings: Add this path to Program Control. The program is entered in the NetMan Program Control list of permitted programs. Parameter. The program will be launched with the parameters entered here. Working directory. The directory in which the program will be executed. If you do not specify a working directory here, the program will run in the program directory. Execute in (window). Specify whether the program is executed in a maximized, minimized, hidden or normal window. Internet filter. Applies the specified filter to the program. File association. You can select a file name extension to associate with this program. Optional settings: Timeout after. This feature closes the program automatically after a defined period has elapsed without user activity. 'Hard close' the program. Closes the program immediately following the timeout period without executing any further operations. Log data. The program launch is recorded in a log file with the record ID specified here. License. Allocate a user license to the program. NetMan will prevent the launch of further program instances once the maximum number of licenses is in use. Verify MD5 hash. The NetMan Client checks the hash value when the program starts. The program will not launch unless the values match. Following a program update, click on the Refresh button to update the hash value; otherwise, the program will not start. Allow multiple instances on one workstation. Permits more than one instance of the program in a single session. Hold subsequent action(s) until this program is closed. No further Actions in the script are executed until the program specified in this program action has been closed. Run as Administrator (Windows Vista or later). The program runs with administrator privileges. Execute with system privileges. The program is launched by the OS 'System' account.
Return values: Return: 1 - Program launched successfully; 0 = error Error code: 0 or error code
Example: -

	Program Control
Category: User
Description: This action activates the NetMan Desktop Manager Program Control.
Configuration: In the Program control is field, you can choose from the following options to activate or deactivate Program Control: •deactivated. The Program Control is deactivated for the session. •is enabled. The Program Control is activated for the session. •enabled; reset settings. The Program Control is activated for the session. All previous session settings are deleted. In the Folders allowed list, you can specify the folders permitted for use with this program. In the Files allowed list, you can specify the files permitted for use with this program. These list are not active unless the Program Control is enabled.
Return values: Return: 1 = values set; otherwise 0 Error code: 0 or error code
Example: The settings configured by the action overwrite the global defaults. This means the Program Control can be deactivated within a session, for the duration of the session. Conversely, you can enable Program Control for particular sessions, for example by defining access permissions accordingly. The enabled; reset settings setting lets you apply various configurations for Program Control within a single script.

	Read AD object properties
Category: Values
Description: The Read AD Object Properties action returns values from Active Directory objects.
Configuration: In the AD object field, specify the AD object of which you would like to read the properties. In the AD object property list, enter the object property or properties to be read.
Return values: Return: Number of properties set in the environment. Error code: 0 or error code
Example: -

	Read INI Entries
Category: Values
Description: Use this action to read entries in an INI file.
Configuration: Enter the following data to find an entry in a Windows INI file: INI file. Name of the INI file. Expand system environment variables in value. Select this option to have environment variables for the operating system and non-NetMan variables expanded. Do not use this option if you wish to write these variables with no changes. Execute with system privileges. The 'System' account is used to execute the action. Use the control buttons at the top of the list box to add entries to be read. Enter the following in the Edit an INI file entry dialog: Section. Section containing the desired entry. Entry. Entry from which the value is to be read. Variable. Name of the return value variable in which the result will be stored. You can use a single action to read any number of entries from the INI file and store each result in a separate variable.
Return values: Return: 1 = INI file entries were read; 0 = error Error code: 0, error or 1
Example: -

	Read Object Properties
Category: Values
Description: This action reads properties of a specified NetMan resource. Once a property has been read by this action, it can be set in the script environment using a Set Object Properties action. With this action, both single properties (e.g.: ‘user-name'), as well as entire property groups (e.g. 'user-*) can be set. Asterisks ('') as wildcards are permitted only at the end of the property name. This action reads properties into the environment one-to-one. For example, if the user has a property defined as 'user-name=Test' and you specify that the 'user-name' property is to be read, this exact expression will be in the environment once the action has been executed.
Configuration: In the Object type field, select the type of object to be read, e.g. 'User'. Under Object ID select the NetMan resource. In the Properties list, enter the property or properties to be read. Asterisks ('*') as wildcards are permitted only at the end of the property name. Expand system environment variables in value. Select this option to have environment variables for the operating system and non-NetMan variables expanded. Do not use this option if you wish to write these variables with no changes.
Return values: Return: Number of properties read in the environment. Error code: 0 or error code (1 = resource not found; 2 = general database error)
Example: -

	Read Registry Entry
Category: Values
Description: Use this action to read values from the Windows registry.
Configuration: Click the New button just above the list. Enter the desired registry key in the Key field or click the 'browse' button to locate and select it. In the Variable field, enter the value to be read. If you select a value using the browse function, the value is entered here automatically. Execute with system privileges. The 'System' account is used to execute the Action.
Return values: Return: 1 = Values were read; 0 = error Error code: 0 or error code
Example: -

	Remote Script
Category: Control
Description: This action lets you launch scripts remotely in one or more specified NetMan sessions. Which workstation runs the script is defined by specifying the corresponding NetMan Desktop Manager ressource.
Configuration: In the Script ID field, select the ID of the script you want to start remotely. At the top of the Destinations list, click on the Add destination button and select the desired type of resource, and then select the specific resource. If the list is blank, the script is executed for all sessions. The Variables defined list lets you pass variables from the NetMan environment to the scripts if desired.
Return values: Return: Always 1 Error code: Always 0
Example: -

	Remove a Reparse Point
Category: Drives
Description: This action deletes a new link entry (reparse point) in NTFS file systems. To create the link entry, use the action called Create Reparse Point. This action requires the NTFS file system. Do not use this action unless you are familiar with reparse points. Incorrect use can lead to loss of data. Some basic information on reparse points is available in the Microsoft knowledge base. Reparse point. The reparse point to be removed. Server. Server with the NetMan Desktop Manager Reparse Point Service – usually the NetMan server.
Configuration: Reparse point. Folder representing a reparse point. Server. Folder and target folder server. The NetMan Reparse Service must be installed on that server.
Return values: Return: 1 = All reparse points removed; 0 = error removing reparse point Error code: 0 or error code
Example: -

	Script
Category: Controls
Description: This action executes a specified NetMan Desktop Manager script identified by its script ID. Use this action to have one script start another script.
Configuration: In the Script ID field specify the script to be started. Hold subsequent actions until this script is closed. No further actions in the originating script are executed until the script it started has concluded. Optional settings: In the Variables defined list, you can make the values stored in certain NetMan environment variables available to the script launched.
Return values: Return: 1; 0 - Error Error code: 0; 1 - Error
Example: -

	Script Selection
Category: Dialogs
Description: This action creates a selection dialog offering a choice of scripts for execution. The dialog closes automatically once the user has selected a script.
Configuration: Specify which scripts are on the list for the user to choose from. In the Message field, define a text describing the selection to be made. The scripts listed here will be presented for the user to choose from. The buttons at the top of the list let you edit the list as follows: Click on the New button to create either a new selection in the list or a new environment variable. Only those scripts can be presented for selection which have access rights that would allow them to be visible in the collection. Selection. This opens a dialog showing all the scripts that are available to choose from. Tick the box next to the script(s) you wish to add, and then confirm by clicking OK. Environment. You can specify an environment variable here. With this option, the script selection is filled in automatically. Prerequisite is that an environment variable that loads certain scripts has already been configured. Click on the Edit button to open a script in the Script Editor.
Return values: Return: Selected script, or nothing Error code: 0 or error code
Example: -

	Selection Dialog
Category: Dialogs
Description: The Selection Dialog action opens a dialog with buttons offering the user a number of options to choose from. A value is assigned to each button. The choice is made by clicking on the respective button, and each button writes a specific value in the return value variable. You can use the default return values or define your own. The Selection Dialog is best for offering just a few options. If you wish to offer a large number of options, we recommend using a different action: Selection List.
Configuration: Enter a text for the dialog box in the Message field. In the list, you can define new buttons (Label) and the associated return values (Value). The button controls above the list let you edit or delete existing buttons, and change their positions within the list.
Return values: Return: Value (contents of the Valuecolumn) or nothing Error code: Always 0
Example: -

	Session Configuration
Category: User
Description: This action configures certain aspects of the NetMan Client and its autostart program in the notification area, as well as file association and protocol association functions, in a remote desktop session.
Configuration: Client tray symbol. Shows or hides the NetMan Client autostart icon in the notification area (tray) of the Windows taskbar. NetMan Client shutdown. Enables or prevents shutdown of the NetMan Client. File association. Configures the File Association function: •No change. The global settings for file association apply. •Disabled. File association is deactivated. This setting overwrites the global setting. •Enabled. File association is active; this means if a file is associated with an application, the application opens when the user double-clicks on the file. The file is launched using a client drive. This setting overwrites the global setting. Protocol association. Configures the Protocol Association function: •No change. The global settings for protocol association apply. •Disabled. Protocol association is deactivated. This setting overwrites the global setting. •Enabled. Protocol association is active; this means if a file is associated with a protocol, the protocol is applied when the user double-clicks on the file. The file is launched using a client drive. This setting overwrites the global setting. Protocol definition. The protocol definition used by the Protocol Association function. Sound. Configures the sound behavior of the client: •No change. The global default audio settings are applied. •Disabled. Audio playback is disabled. This setting overwrites the global setting. •Enabled. Audio playback is enabled. This setting overwrites the global setting. Volume. Defines the volume in percent if audio playback has been enabled for the client. Start menu entries. Specifies where NetMan Desktop Manager published applications within the Start menu (until Windows 7)/on the start page (from Windows 8) are shown: •are shown in a separate folder. The applications are shown within the Start menu in a separate folder named after the collection. •are shown directly in 'All Programs'. The applications are shown in the start menu directly under 'All Programs'. •are shown in the NetMan start menu. The applications are shown in the NetMan start menu. The NetMan Start menu replaces the Start menu in Windows 7 (and earlier), in Windows 8 a Start menu is inserted in the taskbar. The NetMan Start menu shows only the NetMan applications and options you have specified. Windows 8 Apps. Defines whether Windows 8 apps are allowed: •<No change>. For Windows 8 apps, the global settings from the NetMan Settings program apply. •are NOT permitted. Launching and running Windows 8 apps is prevented by NetMan Desktop Manager. This setting overwrites the global setting. •are permitted. Windows 8 apps can be used regardless of the global settings. Windows ‘Modern UI’. Configures the appearance of Windows 8: •<No change>. For the appearance of Windows 8, the global settings from the NetMan Settings program apply. •is NOT permitted. Opening the Windows 8 Start page is prevented by NetMan Desktop Manager. This setting overwrites the global setting. •is permitted. The Windows 8 Start page can be opened regardless of the global settings.
Return values: Return: 1 = values set; 0 = error Error code: 0 or error code
Example: The File association or Protocol association options are especially designed for start script usage, but can be used in other scripts as well. File association, for example, is enabled in the startup configuration for a station profile that does not have an Office program installed on the local machine. When file association is enabled, Office documents are linked to NetMan scripts that launch corresponding Office programs on a session host.

	Set File Attributes
Category: Files
Description: The action Set file attributes sets selected file attributes for specified files.
Configuration: In the Files list you define the files whose attributes are set. The use of the "*" placeholder is permitted. Set file attributes. Sets one or more of the following file attributes for the specified files: •Archive •Hidden •Read only (write-protected) •System Set attributes recursively. The file attributes are assigned recursively. Ignore errors. Errors when setting the file attributes are ignored and processing is continued. Execute with system privileges. The 'System' account is used to execute the setting of file attributes.
Return values: Return: Always 1 Error code: 0 or error code
Example: -

	Set INI Entries
Category: Values
Description: Use this action to write values in an INI file.
Configuration: Enter the following data to find an entry in a Windows INI file: INI file. Name of the INI file. Expand system environment variables in value. Select this option to have environment variables for the operating system and non-NetMan variables expanded. Do not use this option if you wish to write these variables with no changes. Execute with system privileges. The 'System' account is used to execute the action. Use the control buttons at the top of the list box to add entries to be read. Enter the following in the Edit an INI file entry dialog: Section. Section in which the new value will be written. Entry. Entry to be written. Value. Value to be written.
Return values: Return: 1 = Values in the INI file were changed; 0 = error Error code:
Example: 0, error or 1

	Set Object Properties
Category: Values
Description: You can use this action to set one or more properties of a particular NetMan resource in the script environment that were previously read using a Read Object Properties action.
Configuration: In the Object type field, select the type of object to be read, e.g. 'User'. Under Object ID select the NetMan resource. In the Properties list, enter the property or properties to be set. Asterisks ('*') as wildcards are permitted only at the end of the property name. Expand system environment variables in value. Select this option to have environment variables for the operating system and non-NetMan variables expanded. Do not use this option if you wish to write these variables with no changes.
Return values: Return: 1 = values set; 0 = error Error code: 0 or error code (1 = resource not found; 2 = general database error)
Example: -

	Set Registry Entry
Category: Values
Description: Use this action to write values in the Windows registry.
Configuration: Click the New button just above the list. In the Key field, specify the entry you wish to set. The drop-down selector on the right lets you select the type of entry. In the Variable field, select the variable you wish to modify. The input field to the left of the Variable field is the Valuefield, in which you can enter a value for the variable. This setting is optional. The Delete this registry entry option lets you delete the selected registry key rather than modifying it. Expand system environment variables in value. Select this option to have environment variables for the operating system and non-NetMan variables expanded. Do not use this option if you wish to write these variables with no changes. Execute with system privileges. The 'System' account is used to execute the Action.
Return values: Return: 1 = Values have been changed; 0 = error Error code: 0 or error code
Example: -

	Start Message
Category: Dialogs
Description: This action shows a message until a program has started or other defined state is reached.
Configuration: In the Message field, enter a message to the user. Optional settings: The optional settings let you define conditions under which the start message dialog closes without requiring a program launch. Close automatically after (n) seconds. Closes the dialog automatically after the period specified here has elapsed. Show countdown in title bar. Select this option to have the number of seconds to go before the dialog closes shown in the dialog title bar. Condition. Defines a NetMan variable that has to have (or not have) a certain value before the dialog can be closed. In the Variable field, enter the NetMan variable, define the relationship and, in the Value field, specify the value.
Return values: Return: Always 1 Error code: Always 0
Example: This action can be used to inform the user, for example, that the program start will take a few minutes. In such cases, the message is usually set to close when program starts; no optional settings are defined. Optional settings are not configured. You could also use the Start Message action to generate a message that remains visible to the user for a defined period of time. In such a case, the optional setting Close automatically after (n) seconds would be configured. When a number is entered for that setting, the start message closes automatically when that period has elapsed. The optional setting Condition reads a specific variable from the NetMan environment. If it matches a certain value or does not match a certain value, the start message is closed. The variable may be a return value variable, with a value written by another action.

	Toolbox
Category: Dialogs
Description: This action creates a selection dialog offering a choice of scripts for execution. The dialog either closes automatically when the user selects a script or remains open to permit selection of additional scripts. In the latter case, the user must close the dialog.
Configuration: Specify which scripts are on the list for the user to choose from. In the Message field, define a text describing the selection to be made. The scripts listed here will be presented for the user to choose from. The buttons at the top of the list let you edit the list as follows: Click on the New button to create either a new selection in the list or a new environment variable. Only those scripts can be presented for selection which have access rights that would allow them to be visible in the collection. Selection. This opens a dialog showing all the scripts that are available to choose from. Tick the box next to the script(s) you wish to add, and then confirm by clicking OK. Environment. You can specify an environment variable here. With this option, the toolbox is filled in automatically. Prerequisite is that an environment variable that contains script IDs has already been configured. Click on the Edit button to open a script in the Script Editor. Optional settings: Show entries as. You can define whether the toolbox entries are shown as tiles or as icons. The toolbox: •returns the selected script ID. The toolbox passes the script ID and closes. •stays open and runs selected scripts. Selected scripts are started immediately. The toolbox remains open until the user closes it.
Return values: Return: Selected script, or nothing; if the toolbox merely passes the Script ID, 1 is returned Error code: 0 or error code; if the toolbox merely passes the Script ID, 0 is returned in case of error
Example: If the toolbox merely passes the script ID as a return value, you can utilize this, for example, in a subsequent program action. Of course, you can also utilize the ID in any other subsequent action of your choice. If the toolbox action runs the script directly, no program action is required.

	URL
Category: User
Description: This Action loads a specified URL.
Configuration: In the URL field, specify the desired URL. Under Internet filter, you can specify an Internet filter definition to be applied to the hyperlink, if desired. The following additional settings can be configured: Log data. The opening of the URL is recorded with the specified record ID in the NetMan log. Hold subsequent action(s) until this program is closed. You can define whether subsequent actions are executed directly after the URL action is started, or only after execution of the Hyperlink has concluded.
Return values: Return: 1 - Hyperlink called; 0 = error Error code: 0 or error code
Example:

	Wait
Category: Control
Description: This action holds processing of the Script for a specified period or until a specified condition is met.
Configuration: Under Seconds, you can define the period (in seconds) for which processing is halted. Alternatively, under Condition you can specify a variable and a value and a relationship between them to define a condition that must be met. When the condition is met, the waiting period is ended.
Return values: Return: Always 1 Error code: Always 0
Example: -

	Write Message
Category: Control
Description: This action adds a message to the NetMan event log.
Configuration: Enter the desired message in the Message field. This message will be written in the NetMan event log. In the Type field specify the type of the message written: Message, Warning, Error oder Script error.
Return values: Return: Always 1 Error code: Always 0
Example: -