Table 2-1 Application Definition Command Quick Reference
|
Command |
Description |
|---|---|
|
Use the this symbol to define a line of text as a comment field. Comment fields are used to leave notes. For more information, see # |
|
|
Use quotation marks to group together text or variables containing spaces. Quotation marks are used with commands like Type, MessageBox, and If -Text. For more information, see " " |
|
|
Use the dollar sign to define the use of a SecureLogin variable stored in the directory for later use by that user. |
|
|
Use the question mark to define the use of a runtime variable. The values of these variables are not stored in the directory. They are reset each time SecureLogin is started. For more information, see ? |
|
|
Use the percentage sign to define the use of a directory attribute. The attributes that are available vary depending on the directory in use, and the setup of the directory. For more information, see % |
|
|
Use the backslash with the Type and Send Key commands to specify the use of a special function. |
|
|
Use this symbol in the same way as the backslash symbol, except its use is limited to HLLAPI enabled emulators. For more information, see @ |
|
|
Use the hyphen as a switch within several commands, such as If and Type. For more information, see - |
|
|
It is typically used before the application Username and Password are retrieved and entered into the login box. For more information, Section 6.2.1, AAVerify |
|
|
Adds one number to another. The numbers can be hard-coded into the application definition, or they can be variables. The result can be the output of another variable, or one of the original numbers. For more information, see Section 6.2.2, Add |
|
|
Use the Attribute specifier in conjunction with the Tag/EndTag command to specify which HTML attributes and attribute values must exist for that particular HTML tag. For more information, see Section 6.2.3, Attribute |
|
|
Use the AuditEvent to audit the following events from an application definition:
For more information, see Section 6.2.4, AuditEvent |
|
|
Use to display a splash screen across the whole Terminal Emulator window. This is used to mask any flashing produced by SecureLogin scraping the screen for text. A Delay command at the start of the application definition ensures that the emulator window is in place before the splash screen is displayed. For more information, see Section 6.2.5, BeginSplashScreen/EndSplashScreen |
|
|
Use BooleanInput within a site block to set the state of a Boolean field (either a check box or radio button). For more information, see Section 6.2.6, BooleanInput |
|
|
Use Break within the Repeat/EndRepeat commands to break out of a repeat loop. For more information, see Section 6.2.7, Break |
|
|
Use the Call command to call and run a subroutine. When a subroutine is called, the application definition begins executing from the first line of the subroutine. For more information, see Section 6.2.8, Call |
|
|
Use the ChangePassword command to change a single variable and is used in scenarios where password expiry is an issue. Set the <Variable> to the new password. For more information, see Section 6.2.9, ChangePassword |
|
|
When a window is created, it is based on a template known as a window class. The Class command checks to see if the class of the newly created window matches its <Window-Class> argument. For more information, see Section 6.2.10, Class |
|
|
Use to reset the last chosen platform, causing subsequent calls to ReLoadPlat to do nothing. For more information, see Section 6.2.11, ClearPlat |
|
|
Use within a Site block to clear the ‘matched’ status for a given site. For more information, see Section 6.2.12, ClearSite |
|
|
When used with windows applications, the Click command sends a click instruction to the specified <#Ctrl-ID>. For more information, see Section 6.2.13, Click |
|
|
Use to convert a numeric time value, for example, ?CurrTime(system), into a legible format and store it in <String Time>. For more information, see Section 6.2.16, ConvertTime |
|
|
Use the Ctrl command to determine if a window contains the control expressed in the <#Ctrl-ID> argument. The control ID number is a constant that is established at the time a program is compiled. For more information, see Section 6.2.17, Ctrl |
|
|
Use the DebugPrint command to display the text specified in the <Data> variable on a Debug console.The command can take any number of text arguments, including variables, (for example, DebugPrint "The user " $Username " has just been logged onto the system"). For more information, see Section 6.2.18, DebugPrint |
|
|
Use the Decrement command to subtract from a specified variable. For example, you can use Decrement to count the number of passes a particular application definition has made. For more information, see Section 6.2.19, Decrement |
|
|
Use the Delay command to delay the execution of the application definition for the time specified in the <Time Period> argument. For more information, see Section 6.2.20, Delay |
|
|
Use the Dialog/EndDialog command to identify the beginning and end of a dialog specification block respectively. You can use these commands to construct a dialog specification block, which consists of a series of dialog specification statements (for example Ctrl and Title). For more information, see Section 6.2.21, Dialog/EndDialog |
|
|
Use the DisplayVariables command to display a dialog box that lists the user's stored variables (for example, $Username and $Password) for the current application. For more information, see Section 6.2.22, DisplayVariables |
|
|
Use to divide one number by another. The numbers can be hard coded into the application definition, or they can be variables. The result can be output to another variable, or to one of the original numbers. For more information, see Section 6.2.23, Divide |
|
|
Use the DumpPage command to provide information about the current Web page. Use for debugging Web page application definitions. For more information, see Section 6.2.24, DumpPage |
|
|
Use the EndScript command to immediately terminate execution of the application definition. For more information, see Section 6.2.25, EndScript |
|
|
Application definitions generally execute at the point when an application window is created. This corresponds to the WM_CREATE message received from an application window at startup. By adding the Event Specifier to a dialog block, you can override this behavior whereby application definition executes only when the specified message is generated. If an Event Specifier is not givem, it is treated as the same as Event WM_CREATE. For more information, see Section 6.2.26, Event/Event Specifiers |
|
|
Use within a Site Block to focus on an input field based on the Boolean value of "focus". For more information, see Section 6.2.27, FocusInput |
|
|
Used to generate a one time password (OTP) as an authentication method in lieu of a traditional fixed and static password. For more information, see Section 6.2.28, GenerateOTP |
|
|
Use the GetCheckBoxState command to return the current state of the specified checkbooks. For more information, see Section 6.2.29, GetCheckBoxState |
|
|
Use the GetCommandLine command to capture the full command line of the program that is loaded, and save it to the specified variable. For more information, see Section 6.2.30, GetCommandLine |
|
|
Use the GetEnv command to read the value of an environment variable and save it in the specified <variable>. For more information, see Section 6.2.31, GetEnv |
|
|
Use GetHandle to capture the unique handle of the window on which the Windows application definition script is activated. For more information, see Section 6.2.32, GetHandle |
|
|
Use the GetIni command to read data from the INI file. For more information, see Section 6.2.33, GetIni |
|
|
Use the GetMD5 command to generate an MD5 hash value of the current process the script is running for. GetMD5 works only with the Win32 scripts. For more information, see Section 6.2.34, GetMD5 |
|
|
Use the GetReg command to read data from the registry and save it in the specified <variable>. For more information, see Section 6.2.35, GetReg |
|
|
Use the GetDirectoryStatus command to find out whether SecureLogin can connect to the directory or not. For more information, see Section 6.2.36, GetDirectoryStatus |
|
|
Use the GetSessionName command to find the current HLLAPI session name that is used to connect and return it to the specified variable. For more information, see Section 6.2.37, GetSessionName |
|
|
Use the GetText command to get all of the text from the screen and save it to the specified variable. It is used in a large Web application definition that might contain several If -Text statements. For more information, see Section 6.2.38, GetText |
|
|
Use the GetURL command to capture the URL of the site that is loaded and save it to the specified variable. For more information, see Section 6.2.39, GetURL |
|
|
Use the GoToURL command to make the browser navigate to the specified <URL>. By default the command opens the new Web page in the main window, rather than the frame that started the application definition. For more information, see Section 6.2.40, GoToURL |
|
|
Use the If command to establish a block to execute if the expression supplied is true. The Else command works inside an If block. The Else command is executed if the operator in the If block is false. Use the EndIf command to terminate the If block. For more information, see Section 6.2.42, If/Else/EndIf |
|
|
Use the Include command to share commonly used application definition commands by multiple applications. The application definition identified by <Platform-Name> is included at execution time into the calling application definition. The application definition included with the Include command must consists of commands supported by the calling application. For more information, see Section 6.2.43, Include |
|
|
Use the Increment command to add to a specified variable. For example, you can use increment to count the number of passes a particular application definition has made. For more information, see Section 6.2.44, Increment |
|
|
Use to terminate an application. For more information, see Section 6.2.45, KillApp |
|
|
Use the Local command to declare that a runtime variable will only exist for the lifetime of the application definition. Local runtime variables are used in the same way as normal runtime variables and are still written as ?Variable. For more information, see Section 6.2.46, Local |
|
|
Use MatchDomain inside a site block to filter a site based on its domain. If the domain does not match, the site block fails to match. For more information, see Section 6.2.47, MatchDomain |
|
|
Use MatchField to filter a form based on the presence of a particular field. If the field fails to match and it is not specified as optional, then the parent form fails to match. For more information, see Section 6.2.49, MatchField |
|
|
Use MatchForm to filter a site based on the presence of a particular field. If the field fails to match and it is not specified as optional, then the site fails to match. For more information, see Section 6.2.50, MatchForm. |
|
|
Use the MatchOption command to filter a field based on the presence of a particular option. For more information, see Section 6.2.51, MatchOption. |
|
|
Use MatchReferer inside a Site/EndSite block to match or filter a site based on a referrer. For more information, see Section 6.2.52, MatchReferer. |
|
|
Use the MatchRegex command to test whether a regular expression matches against the specified string or not. You can also use it inside a Site–EndSite or Dialog–EndDialog block for example. For more informations, see Section 6.2.53, MatchRegex. |
|
|
Used inside a site block, MatchTitle is used to filter a site based on its title. If the site title does not match, the site block fails to match. For more information, see Section 6.2.54, MatchTitle. |
|
|
Use MatchURL inside a site block to match or filter an HTML page within a site based on its URL. The URL can be a complex Web address or a secure website. For more information, see Section 6.2.55, MatchURL. |
|
|
Use the MessageBox command to display a dialog box that contains the text specified in the <Data> variable. The application definition is suspended until the user reacts to this message. The MessageBox can take any number of text arguments, including variables, (for example MessageBox "The user " $Username " has just been logged onto the system"). For more information, see Section 6.2.56, MessageBox. |
|
|
Use to multiply one number by another. You can hard-code the numbers into the application definition, or you can use variables. The results can be output to another variable, or to one of the original numbers. For more information, see Section 6.2.57, Multiply. |
|
|
Use the OnException command to detect when certain conditions are met. Currently, this is when Cancel is clicked on either of two dialog boxes. When the condition is met, a subroutine is run. Use the ClearException command to reset the exceptions value. For more information, see Section 6.2.58, OnException/ClearException. |
|
|
Use the EndParent command to terminate a Parent block and set the subject of the application definition back to the original window. You can nest the Parent command, thereby allowing the Parent block to act on the parent of the parent. For more information, see Section 6.2.59, Parent/EndParent. |
|
|
Use the PickList command to allow users with multiple accounts for a particular system to choose the account to which they will log in. For more information, see Section 6.2.60, PickListAdd. |
|
|
Use the PickListDisplay command to display the pick list entries built by previous calls to PickListAdd. The PickListDisplay command returns the result in a <?Variable> sent to the command. For more information, see Section 6.2.61, PickListDisplay. |
|
|
Use the PositionCharacter command in a password policy application definition to enforce that a certain character in the password is a numeral, uppercase, lowercase, or a punctuation character. For more information, see Section 6.2.62, PositionCharacter. |
|
|
Used within a site block to simulate a keyboard enter event. For more information, see Section 6.2.63, PressInput. |
|
|
Use the ReadText command to run in both Windows and Terminal Launcher application definitions. Although the usage and arguments for the use of ReadText with Windows and Terminal Launcher are different, the results of each command are the same. For more information, see Section 6.2.65, ReadText. |
|
|
Use the RegSplit command to split a string by using a regular expression. <Output-String1> and <Output-String2> contain the first and second subexpressions. For more information, see Section 6.2.66, RegSplit. |
|
|
Use to set the current platform to the last one chosen by the application definition, or if a platform is not chosen, leaves the platform unset. For more information, see Section 6.2.67, ReLoadPlat. |
|
|
Use the Repeat command to establish an application definition block similar to the If command. The repeat block is terminated by an EndRepeat command. Alternatively, you can use the Break or EndScript commands to break out of the loop. For more information, see Section 6.2.68, Repeat/EndRepeat. |
|
|
Use the RestrictVariable command to monitor a <Variable> and enforce a specified <Password-Policy> on the <Variable>. Any variable specified must match the policy or it is not saved. For more information, see Section 6.2.69, RestrictVariable. |
|
|
Use the Run command to launch the program specified in <Command> with the specified optional [<Arg1> [<Arg2>] …] arguments. For more information, see Section 6.2.70, Run. |
|
|
Use the Select command to select entries from a combo box or list box control. For more information, see Section 6.2.72, Select. |
|
|
Use the SelectListBoxItem command to select entries from a list box. For more information, see Section 6.2.73, SelectListBoxItem. |
|
|
Use the SelectOption command to select or deselect options within a list box or combo dialog box. For more information, see Section 6.2.74, SelectOption. |
|
|
Use the SendEvent command to broadcast events. For more information, see Section 6.2.75, SendEvent |
|
|
Use the SendKey command to work only with Generic and Advanced Generic emulators. You can use the SendKey command in the same manner as the Type command. Generally, the Type command is the preferred command to use. The Type command places the text into the clipboard, and then pastes it into the emulator screen. The SendKey command enters the text directly into the emulator screen. For more information, see Section 6.2.76, SendKey. |
|
|
Use the Set command to copy the value of <Data> into <Variable>. The <Data> can be any text, or another variable, whereas the <Variable> must be either a ?Variable or $Variable. For more information, see Section 6.2.77, Set. |
|
|
Use the SetCheckBox command to select or clear a check box. For more information, see Section 6.2.78, SetCheckBox. |
|
|
Use the SetCursor command to set the cursor to a specified <ScreenPosition> or <X Co-ordinate> <Y Co-ordinate>. For more information, see Section 6.2.79, SetCursor. |
|
|
Use the SetFocus command to set the keyboard focus to a specified <#Ctrl-ID>. For more information, see Section 6.2.80, SetFocus. |
|
|
SetPlat sets the platform or application from which variables are read and saved. By default, variables are stored directly against the platform or application on which you have SecureLogin enabled. For example, if you enable Groupwise.exe, the Groupwise credentials are stored against the Groupwise.exe platform. SetPlat sets the platform or application from which variables are read and saved. For more information, see Section 6.2.81, SetPlat. |
|
|
Use the SetPrompt command to customize the text in the Enter SecureLogin Variables dialog boxes. These dialog boxes are used to prompt the user for new variables. You can also use the DisplayVariables command to customize the prompt text in the dialog box (for previously stored variables). For more information, see Section 6.2.82, SetPrompt. |
|
|
Site/Endsite are Web commands added to allow for finer control of site matching. More detailed information within a loaded website can now be matched upon an used to execute blocks of scripting commands. Begins and ends an application definition, in place of Dialog/EndDialog. For more information, see Section 6.2.83, Site/Endsite. |
|
|
Use the StrCat command to append a second data string to the first data string. For example, StrCat ?Result "SecureRemote " "$Username". For more information, see Section 6.2.85, StrCat. |
|
|
Use the StrLength command to count the number of characters in a variable and output that value to the destination variable. For more information, see Section 6.2.86, StrLength. |
|
|
Use the StrLower command to modify a variable so that all the characters are lowercase. For more information, see Section 6.2.87, StrLower. |
|
|
Use the StrUpper command to modify a variable so that all the characters are uppercase. For more information, see Section 6.2.90, StrUpper. |
|
|
Use the Sub/EndSub commands around a block of lines within an application definition to denote a subroutine. For more information, see Section 6.2.91, Sub/EndSub, |
|
|
Use the Submit command only in Web application definitions, and only with Internet Explorer, to allow for enhanced control of how and when a form is submitted. The Submit command performs a Submit on the form in which the first password field is found. The Submit command is ignored if used with Netscape. For more information, see Section 6.2.92, Submit. |
|
|
Use the Substr command to search for a sub string from a text based on the index and the length which are provided as parameters. For more information, see Section 6.2.93, Substr. |
|
|
Use the Subtract command to subtract one value from another. This is useful if you are implementing periodic password change functionality for an application. You can use the subtract command (in conjunction with the Divide function and the Slina DLL) to determine the number of days that have elapsed since the last password change. Other numeric commands include Add, Divide, and Multiply. For more information, see Section 6.2.95, Subtract. |
|
|
Use the Tag/EndTag commands to find HTML tags. For more information, see Section 6.2.96, Tag/EndTag. |
|
|
Use within a site block to input text into a special field. For more information, see Section 6.2.97, TextInput. |
|
|
Use the Title command to retrieve the title of a window and compare it against the string specified in the <Window-Title> argument. For this block of the application definition to run, the retrieved window title and the <Window-Title> argument must match the text supplied to the Title command in the dialog block. For more information, see Section 6.2.98, Title. |
|
|
Use the Type command to enter data, such as usernames and passwords, into applications. There are reserved character sequences that are used to type special characters, for example TAB and ENTER. If it is not possible to determine Control IDs in a Windows application, and the Type command is not working, use the SendKey command instead. For more information, see Section 6.2.99, Type. |
|
|
Use the WaitForFocus command to suspend the running of the application definition until the <#Ctrl-ID> has received keyboard focus, or the <Repeat-Loops> expire. The <Repeat-Loops> is an optional value that defines the number of loop cycles to run. The <Repeat-Loops> value defaults to 3000 loops if nothing is set. After focus is received, the application definition continues. For more information, see Section 6.2.100, WaitForFocus. |
|
|
Use the WaitForText command so the Terminal Launcher waits for the specified <text> to display before continuing. For example, the user waits for a username field to display before attempting to type a username. For more information, see Section 6.2.101, WaitForText. |