Dialog 'Input Configuration'

Symbol: _visu_icon_input_configuration

Function: The dialog is used to assign input actions to specific input events. It also includes specific settings for the selected input action.

Call: In the “Input configuration” property, click “Configure”.

Requirement: An element is selected in the editor.

Input action 'User Management'

“Dialogs and actions”	Configures which one of the possible user management dialogs or which action follows the input event Note: The dialog used at runtime is configured in the “Dialog Settings” tab of the Visualization Manager. See also “ Login dialog” “Change password dialog” “Change configuration dialog” Default: Dialogs from the `‎VisuUserManagement‎` library
“Login”	The login prompt opens. Default: `‎VisuUserManagement.VUM_Login‎` in “Login dialog”
“Logout”	The current user is logged out.
“Change User Password”	The dialog for changing the password opens. Default: `‎VisuUserManagement.VUM_ChangePassword‎` in “Change password dialog”
“Open User Configuration”	The dialog opens for changing the configuration. Default: `‎VisuUserManagement.VUM_UserManagement‎` in “Change configuration dialog”

See also

Input action 'Close Dialog'

“Dialog”

The visualization of type “Dialog” that will be closed.

_visu_icon_open_list : List box with all “Dialog” type visualizations available in the project.

Example:

Default dialogs of the ‎VisuDialogs‎ library, which is usually integrated in the project.

‎FileOpenSave‎
‎Keypad‎
‎Login‎
‎Numpad‎
‎NumpadExtended‎
‎TextinputWithLimits‎

Note: The setting in the object property (“Visualization” tab) of a visualization determines whether or not a visualization can be used as a dialog.

“Result”	Return value for closing the dialog. Note: If there are more input actions after closing, then they configured in the “Input configuration OnDialogClosed” property of the element.
“None”	: No return value
“OK”	: The set return value is returned. The return value refers to the button in the dialog. The value `‎OK‎` is returned for the OK button. The value `‎Cancel‎` is returned for the cancel button.
“Cancel”
“Abort”
“Retry”
“Ignore”
“Yes”
“No”

See also

⮫ “Dialog 'Properties' of Visualization Objects”

Input action 'Open Dialog'

“Dialog”

Visualization (type “Dialog”). The dialog opens.

_visu_icon_open_list : List box with all dialogs available in the project.

Note: The “VisuDialogs” library provides visualizations (type “Dialog”).

‎VisuDialogs.FileOpenSave‎
‎VisuDialogs.Login‎

Transfer parameters of the dialog
“Parameter”	Interface parameter as declared in the interface editor of the visualization Example: `‎filelistProvider‎`
“Type”	Data type of the parameter as declared in the interface editor of the visualization. Example: `‎VISU_FBFILELISTPROVIDER‎`
“Value”	Variable (data type corresponds to the data type of the parameter). The value of the variable is read when the dialog opens and passed to the parameter. Example: `‎PLC_PRG.fileListProvider // Instance of function block VisuDialogs.Visu_FbFileListProvider‎` : The input assistance offers all variables available in the entire project.

Here the return value of the dialog is activated for which the `‎Var_OUTPUT‎` variable and `‎VAR_IN_OUT‎` variable are written. The dialog closes afterwards.
“Update” “and” “parameter in case of result”	Note: The parameters are updated before the dialog is closed. Until then, the values are stored temporarily. They are stored as a copy, not as a reference.
“None”	: No return value
“OK”	: Defines the return value for which the transfer parameter is written
“Cancel”
“Abort”
“Retry”
“Ignore”
“Yes”
“No”

“Open dialog modal”

_cds_icon_option_activated : Only the dialog processes user inputs. The remaining visualizations are blocked to user input.

“Position to open”
“Centered”	The dialog opens in the center of the visualization.
“Position”	The dialog opens at the position defined by “X” and “Y”.
“X”	Position (in pixels) or variable (integer data type)
“Y”	Position (in pixels) or variable (integer data type)

See also

⮫ “Calling a dialog in a visualization”

Input action 'Change Language'

“Language”

Language to be switched

Example: ‎en‎

_visu_icon_open_input_assistant : The input assistance offers all languages available in the project.

Input action 'Change Shown Visualization'

Table 704: “Zoom to visualization”
Visualization that is shown at the user input
“Assign”	Visualization that is selected from all available visualizations in the project or libraries. Example: `‎visMain‎`
“Assign expression”	Variable (`‎STRING‎`) that contains the name of the visualization Example: `‎PLC_PRG.strVisu‎` for the following application code: `‎strVisu: STRING := 'visMain';‎`
The order in which visualizations are displayed by user inputs is saved internally. The following options use this information.
“Previous shown visualization”	: Visualization that has already been shown before the current one Requirement: A visualization switch has already occurred.
“Next shown visualization”	: Visualization that is next in the call order after the current one. Requirement: A visualization switch has already occurred which was called by “Previous shown visualization”.

Input action 'Execute Command'

Commands are listed here with transfer parameters that the visualization processes when an input event occurs.

“Configure commands”

_visu_icon_open_list

“Execute program on the plc”
“Execute program on client”
“Print”
“Navigate to URL (WebVisu)”
“Create Recipe”
“Read Recipe”
“Write Recipe”
“Write Recipe in File”
“Load Recipe from File”
“Delete Recipe ”

Click _visu_icon_add to add the selected command to the lower command list.

	The command in “Configure commands” is added to the list.
	The command is removed. Requirement: A command is selected.
The order in the list defines the order of execution.
	The selected command is moved down one position in the list.
	The selected command is moved up one position in the list.

Table 705: Command “Execute program on the plc”
“Command”	“1st parameter”	“2nd parameter”
`‎ExecutePlcProgram‎`	`‎'C:\programs\notepad.exe'‎`	`‎'Notes_A.txt'‎`
EXE file that is executed on the controller The program is executed on the PLC and therefore it must not be interactive or have any user interfaces. It is possible, for example, for a program to copy a file.	Program name with directory as `‎STRING‎` in single straight quotation marks	Arguments of the program as `‎STRING‎` in single straight quotation marks Example: Name of the file that the program opens

Table 706: Command “Execute program on client”
“Command”	“1st parameter”	“2nd parameter”
`‎ExecuteClientProgram‎`	`‎'C:\programs\notepad.exe'‎`	`‎'Notes_A.txt'‎`
EXE file that is executed on the display variant. Exception: WebVisu. The program is executed within the context of the display variant. After this, the program may be interactive and have a user interface.	Program name with directory as `‎STRING‎` in single straight quotation marks	Arguments of the program as `‎STRING‎` in single straight quotation marks Example: Name of the file that the program opens

NOTICE

If the visualization is displayed as a CODESYS WebVisu, then no program (EXE file) can be started.

Table 707: Command “Navigate to URL (WebVisu) ”
“Command”	“1st parameter”	“2nd parameter”
`‎NavigateURL‎`	`‎'http://en.wikipedia.org'‎` `‎PLC_PRG.stURL‎`	`‎'replace'‎`
The visualization navigates to the web page of the URL. Requirement: The visualization is executed as a CODESYS WebVisu.	URL As a literal in single straight quotation marks As a variable (`‎STRING‎`)	If a parameter is not specified, then the web page is displayed in a new window or a new tab. If `‎'replace'‎` is specified, then the CODESYS WebVisu is replaced by the web page.

Table 708: Command “Read Recipe”
“Command”	“1st parameter”	“2nd parameter”
`‎ReadRecipe‎`	`‎'RecipeDefinitionForModules'‎`	`‎'RecipeModuleA'‎`
	Name of the recipe definition As a literal As a variable (STRING)	Name of the recipe As a literal As a variable (STRING)
At visualization runtime, the controller reads the actual values from the variables of the recipe definition and writes them to the specified recipe. The values are saved implicitly (to a file on the controller) and shown in the recipe definition in the Recipe Manager of CODESYS. In other words, the recipe that is managed in CODESYS is updated with values from the controller.

Table 709: Command “Write Recipe”
“Command”	“1st parameter”	“2nd parameter”
`‎WriteRecipe‎`	`‎PLC_PRG.stRecipeDef‎`	`‎PLC_PRG.stRecipe‎`
	Name of the affected recipe definition As a literal As a variable (STRING)	Name of the recipe (from the recipe definition) As a literal As a variable (STRING)
At visualization runtime, the values of the recipe are written to the variables on the controller as they are in the Recipe Manager.

Table 710: Command “Save Recipe in File”
“Command”	“1st parameter”	“2nd parameter”
`‎SaveRecipeAs‎`	`‎PLC_PRG.stRecipeDef‎`	`‎PLC_PRG.stRecipe‎`
	Name of the affected recipe definition As a literal As a variable (STRING)	Name of the affected recipe that is updated and saved to a file As a literal As a variable (STRING) Optional parameter: If you do not specify a transfer parameter here, then the values from the recipe variables are saved only the file that is specified later. The implicit recipe files are not updated.
At visualization runtime, the “Save Recipe as” dialog opens and prompts the user for a file name and a storage location on the controller. The file name must not be `‎<recipe>.<recipe definition>‎`. The file extension is `‎.txtrecipe‎`. The user can then save the file that includes the actual values from the recipe variables. If a transfer parameter is not specified in the 2nd parameter, then the file is saved without changing an implicit recipe file. If a transfer parameter is given in the 2nd parameter, then the implicit recipe file is also updated. Note: If the “Save recipe changes to recipe files automatically” option is selected in the “Recipe Manager - General” tab, then the recipe definition in CODESYS and the implicit recipe files are kept the same automatically. Note: Implicit (automatically generated) recipe files exist on the controller with names in the following syntax: `‎<recipe>.<recipe definition>.txtrecipe‎`. These are typically used in the application as a buffer when reading and writing recipe variables.

Table 711: Command “Load Recipe from File”
“Command”	“1st parameter”	“2nd parameter”
`‎LoadRecipeFrom‎`	`‎PLC_PRG.stRecipeDef‎`	`‎PLC_PRG.stRecipe‎`
	Name of the affected recipe definition As a literal As a variable (STRING)	Name of the affected recipe As a literal As a variable (STRING)
At visualization runtime, the “Load Recipe” dialog opens. It provides the visualization user with a file list that is located in the file system of the controller and filters by the extension `‎txtrecipe‎`. The selected file is downloaded. Then the recipes from the file are written to the implicit files and read to the given recipe in the recipe definition of the Recipe Manager. Requirement: The file was created with the `‎SaveRecipeAs‎` command.

Table 712: Command “Create Recipe”
“Command”	“1st parameter”	“2nd parameter”
`‎CreateRecipe‎`	`‎PLC_PRG.stRecipeDef‎`	`‎PLC_PRG.stRecipe_New‎`
	Name of the affected recipe definition As a literal As a variable (STRING)	Name of the new recipe As a literal As a variable (STRING)
At visualization runtime, a new recipe is created in the given recipe definition.

Table 713: Command “Delete Recipe”
“Command”	“1st parameter”	“2nd parameter”
`‎DeleteRecipe‎`	`‎PLC_PRG.stRecipeDef‎`	`‎PLC_PRG.stRecipe‎`
	Name of the affected recipe definition As a literal As a variable (STRING)	Name of the recipe As a literal As a variable (STRING)
At visualization runtime, the specified recipe is deleted from the recipe definition.

Table 714: Command “Print”
“Command”	“1st parameter”	“2nd parameter”
`‎Print‎`	Optional: File name for the visualization screen to be printed (example: 'Start screen')	A second parameter cannot be specified for the `‎Print‎` command.
The default “Printer” dialog opens while the visualization is running. In the dialog, you select a printer and configure additional print settings. When you confirm the dialog, the currently displayed visualization screen is printed. Note: The command can be executed in the TargetVisu only.

See also

Input action 'Switch Frame Visualization'

When the input event occurs, the display switches to another visualization within one frame.

“Frame selection type”
“Switch local visualization”	The “Frame Selection” group is visible.
“Switch to any visualization”	The “Frame and visualization selection” group is visible.

Requirement: “Switch local visualization” is selected.
“Frame selection”	List of all frames that contain the active visualization. The referenced visualizations are listed below each frame, as determined in the “References” property of the respective frame. Example:
“Assign selection”	The selection in the “Frame selection” input field is accepted. Then it appears in the “Selected frame” and “Selected visualization” settings. Requirement: A visualization is selected in the “Frame selection” input field.
“Selected Frame”	Name of the frame to be switched to Example: `‎MainArea‎` Hint: Use the “Assign selection” command for changing the setting here.
“Selected Visu”	Name of the switched visualization. Example: `‎visMainArea‎` Hint: Use the “Assign selection” command for changing the setting here.

Requirement: The “Switch to any visualization” option is selected.
“Frame and visualization selection”	Contains the frame to be switched to
“Assign”	Frame to be switched to (with complete path). The index determines the visualization. Example: `‎visMain.frameA.visB.frameB‎` The path is specified in the following syntax: `‎<visualization name>.<frame name> { <visualization name>.<frame name> }‎` Caution: Visualizations can be nested at any depth by means of frame elements. In order to use the “Switch to any visualization” frame selection type without any problems, a frame must not contain more than 21 referenced visualizations.
“Assign expression”	Variable (`‎STRING‎`). Contains the path of the frame to be switched to Example: `‎strFrane: STRING := 'visMain.frameA.visB.frameB';‎`
“Index to select”	Index that determines which of the referenced visualizations is displayed As an integer As a variable (integer data type) Example :`‎PLC_PRG.iIndex‎` Note: The referenced visualizations of a frame are indexed automatically according to their order.

Requirement: The project contains visualizations that form a structure.

See also

⮫ “Dialog 'Frame Configuration'”

Input action 'Write Variable'

The configuration of the input action defines how a visualization user specifies a value and to which variable the value is written.

Check all inputs for there validity. Be sure that only values within the range can be added to a numeric field. Depending on the datatype of the input value, the limitations can be different.

“Input type” How the input is prompted.
“Default”:	An input field also opens, or if necessary a virtual keyboard (when the display variant does not have a physical keyboard). Note: The default option for text input at runtime is set in the Visualization Manager: “Dialog Settings” tab, “Settings for Default Text Input”.
“Text input”	An input field appears. You use the keyboard to specify a number or a text. Requirement: The display variant has a keyboard as input device.
“Text input with limits”	An input field appears. You use the keyboard to specify a number or a text. The field also shows the range of values for the input. When a limit is passed, the input value is displayed in red. Requirement: The display variant has a keyboard as input device.
“VisuDialogs.Keypad”	A virtual keyboard opens. You use it to specify a number or a text.
“VisuDialogs.Numpad”	A virtual keyboard opens. You use it to specify a number.
“VisuDialogs.NumpadExtended”	A virtual keyboard opens. You use it to specify a number. Hexadecimal and exponential notation are also permitted here.

“Choose variable to edit”
“Use text output variable”	: The input value is written to the text output variable of the element. This is the variable that is assigned in the “Text variable Text” property.
“Use another variable”	: Variable where the input value is written. Example: `‎PLC_PRG.iVariable‎`
“Initial display format”	Placeholder with format definition. It defines the output format for the variable value and the input limits. Example: `‎%2.3f‎` for displaying the value as a decimal fraction.

“Min”	Minimum value of the input limit. If a user specifies a lesser value, then it is not accepted. As a fixed value As a variable (data type corresponds to selected variable)
“Max”	Maximum value of the input limit. If a user specifies a greater value, then it is not accepted. As a fixed value As a variable (data type corresponds to selected variable)
“Dialog title”	Text displayed in the title bar of the dialog. Optional. As a fixed string Example: `‎Insert value‎` As a variable (`‎STRING‎`) Example: `‎PLC_PRG.stTitle : STRING := 'Insert value';‎`

“Password field”

_cds_icon_option_activated : Unseen text input. ‎***‎ is shown instead of the input text.

Table 715: “Position to open input dialog”
“Use global setting (from the Visualization Manager)”	: This option is applies only for use in a TargetVisu or WebVisu. The settings are used which are available in the “Dialog Settings” tab of the Visualization Manager.
“Centered”	: The dialog opens in the center of the visualization window.
“Position”	: The dialog opens in the visualization at the position defined here. “X”, “Y”: Variable or explicit number (in pixels) for the definition of the upper left corner of the dialog in the coordinate system of the visualization window. You can use the placeholders `‎ElementRectangle.ptTopLeft.iX‎` and `‎.iY ElementRectangle.ptBottomRight.iY‎`. It is replaced at runtime by the coordinates of the calling element.

See also

Input action 'Execute ST Code'

Input field

Editor for code as Structured Text

Input action 'Toggle Variable'

“Variable”

Variable (‎BOOL‎). It toggles between ‎TRUE‎ and ‎FALSE‎ for an input event.

Example: ‎PLC_PRG.bSwitch‎

Input action 'File Transfer'

With the “File Transfer” input action, a file can be transferred from an operating variant (target or web visualization) to the PLC as well as to and from the PLC. This works either by means of a file transfer (“Type”: “File”) or streaming (“Type”: “Streaming”).

The action has the effect that a file selection dialog is displayed in the visualization at runtime. There the visualization user can select a file which will be transferred either to or from the PLC: For a transfer from a PLC to the visualization, the “Save File” dialog opens. For the transfer from the visualization to the PLC, the “Open File” dialog opens.

“Transfer”

“Direction”

Direction of file transfer

“From PLC to Visualization”

The object specified in “File name” or “Streaming instance name” is transferred from the PLC to the visualization.

The “Save File” file selection dialog is displayed in the visualization at runtime.

“From Visualization to PLC”

The file specified by the visualization user is transferred to the PLC and saved in the file path specified in “File name” or “Streaming instance name”.

The “Open File” file selection dialog is displayed in the visualization at runtime.

“Type”

Determines how the file is transferred

Transfer type “File”: By file transfer
Transfer type “Streaming”: By streaming

“Type”

“File”

The data transfer is done by file transfer.

“File name”

File path (type ‎STRING‎) which describes the file in the file system

Variable

Example: ‎strTransferFile: STRING;‎
Literal with relative path

Example: ‎'/Recipes/Recipe_1.txt'‎ saves the file in the directory ‎Recipes‎.
Literal with placeholder ‎$PLCLOGIC$‎

‎PlcLogic‎ is the default resolution for the directory placeholder ‎$PLCLOGIC$‎.

Example: ‎'$$PLCLOGIC$$/test.txt'‎ saves the file in the directory ‎PlcLogic‎.

Example: ‎'$$PLCLOGIC$$/MyData/test.txt'‎ saves the file in the directory ‎PlcLogic/MyData‎.
Literal with placeholder ‎$VISU$‎

‎visu‎ is the default resolution for the placeholder ‎$VISU$‎.

Example: ‎'$$VISU$$/test.txt'‎ save the file in the subdirectory ‎PlcLogic/visu‎. Alternatively, ‎'visu/test.txt'‎ can also be specified.
Literal with absolute path

Example: ‎ 'E:\temp\test.txt'‎

Note: These kinds of file paths are not always supported.

Note: If a user specifies the file path in the visualization by means of a “Text Field” element, the masking character ‎$‎ must not be included: ‎$VISU$/dummy.txt‎

Note: In the case that the file path is specified by the user, it should be checked by the application in order to prevent files from being read or overwritten accidentally.

“Type”

“Streaming”

The data transfer is done by streaming.

“Streaming instance name”

Instance path (type ‎IVisuStreamWriter‎ or ‎IVisuStreamReader‎) which describes the object in the file system of the controller

Type ‎IVisuStreamReader‎ for transfer direction “From PLC to Visualization”

Type ‎IVisuStreamWriter‎ for transfer direction “From Visualization to PLC”

“Control flags”

Note: The variable is evaluated only for transfer direction “From Visualization to PLC”.

Variable (type ‎DWORD‎)

Determines how the object (file or instance object) is handled on the file system of the PLC. Two flags are provided for this with which the variable can be set.

Flag 1: ‎VisuElems.VisuEnumFileTransferControlFlags.UseOriginalFileName‎
Flag 2: ‎VisuElems.VisuEnumFileTransferControlFlags.ConfirmFileOverwriteInPlc‎

Options

No flag set:

The user selects a file which is saved in the path specified in “File name” or “Streaming instance name”.
Flag 1 is set:

The path, which is specified by the user at visualization runtime, is applied and used as the path in the PLC file system.
Both flags are set:

The path is also checked. If an object already exists in the path specified on the client side, then a message prompt is displayed in the visualization. There the visualization user can confirm that the file will be overwritten.

Example: ‎dwControlFlag‎

Example

The transfer direction is “From Visualization to PLC” (write).

Example: A new recipe file ‎Recipes/Recipe_2021.txt‎ has been created in the visualization device. The visualization user selects this file and wants to save the file on the PLC under the same name. Because the control flags are set accordingly, a message window opens and the visualization user can confirm that the file will be overwritten.

PROGRAM PLC_PRG
VAR
	xVisuToggle : BOOL;
	dwControlFlag : DWORD:= VisuElems.VisuEnumFileTransferControlFlags.UseOriginalFileName + VisuElems.VisuEnumFileTransferControlFlags.ConfirmFileOverwriteInPlc;
	strFileName: STRING := '/Recipes/Recipe_new.txt';
END_VAR

Table 716: “Status Variables”
“Transfer active”	Boolean variable (optional) `‎TRUE‎`: The transfer is in progress.
“Transfer successful”	Boolean variable (optional) `‎TRUE‎`: The transfer has completed successfully.
“Error code”	`‎0‎`: No errors `‎1‎`: Unspecified error `‎2‎`: Cancellation of file dialog `‎3‎`: Other file transfer in progress `‎4‎`: Error during file transfer `‎5‎`: Cancellation by timeout `‎6‎`: File read error – The file is not available or cannot be read. `‎7‎`: No device support for file transfer Possible causes: CODESYS WebVisu: File transfer is not possible by default. Communication with a controller of a version < 3.5.11: Functionality not implemented. Communication with a controller of a version >= 3.5.11: File transfer not activated (device description). Note: In this case, contact the CODESYS support team.