The scripting library provides multiple script procedures to automate your application configurations. This topic provides usage information for scripts that set notification options, save configuration changes, and display scripting library information.
This script converts a string to a list. For example, the AdminApp.list() command returns a string of application names. Use the convertToList script to change the output to a list format, such as ['DefaultApplication', 'a1', 'a2', 'ivtApp', 'query'].
Argument | Description |
---|---|
variable | Specifies the name of the variable that contains the string to convert to a list. |
Syntax
AdminUtilities.convertToList(variable)
Example usage
apps=AdminApp.list() AdminUtilities.convertToList(apps)
This script sets the debug notice text.
Argument | Description |
---|---|
message | Specifies the message text for the debug notice. |
Syntax
AdminUtilities.debugNotice(message)
Example usage
AdminUtilities.debugNotice("Server is started")
This script displays the exception message for a specific exception type, exception value, or traceback information.
Argument | Description |
---|---|
type | Specifies the exception type of interest. The exception type represents the class object of the exception. |
value | Specifies the exception value of interest. The value represents the instance object that is the argument of the exception or the second argument of the raise statement. |
traceback | Specifies the traceback information of interest. The traceback object contains special attributes, including the line number where the error occurred. Do not assign traceback to a local variable in the function that handles the exception, as this assignment creates a circular reference. |
Syntax
AdminUtilities.getExceptionText(type, value, traceback)
Example usage
AdminUtilities.getExceptionText("com.ibm.ws.scripting.ScriptingException ", "com.ibm.ws.scripting.ScriptingException: AdminControl service not available" , "")
This script sets the failure message.
Argument | Description |
---|---|
message | Specifies the message text for the failure notice. |
Syntax
AdminUtilities.fail(message)
Example usage
AdminUtilities.fail("The script failed")
This script searches the file system based on a specific path or directory.
Argument | Description |
---|---|
path | Specifies the file path to search for a specific file. |
directory | Specifies the directory to search for a specific file. |
Syntax
AdminUtilities.fileSearch(path, directory)
Example usage
Paths = [] Directory = java.io.File("c:\\WebSphere\\AppServer\\scriptLibraries") AdminUtilities.fileSearch(directory, paths)
Paths = [] Directory = java.io.File("//WebSphere//AppServer//scriptLibraries") AdminUtilities.fileSearch(directory, paths)
This script displays an instance for the resource bundle of interest.
Argument | Description |
---|---|
bundleName | Specifies the name of the bundle of interest. For example, to get a message object from the ScriptingLibraryMessage resource bundle, specify com.ibm.ws.scripting.resources.scriptLibraryMessage. |
Syntax
AdminUtilities.getResourceBundle(bundleName)
Example usage
AdminUtilities.getResourceBundle("com.ibm.ws.scripting.resources.scriptLibraryMessage")
This script displays the file path and file names for each script library file.
Syntax
AdminUtilities.getScriptLibraryFiles()
Example usage
AdminUtilities.getScriptLibraryFiles()
This script displays each script name in the script library.
Syntax
AdminUtilities.getScriptLibraryList()
Example usage
AdminUtilities.getScriptLibraryList()
This script displays the file path to get to the script library files on your file system.
Syntax
AdminUtilities.getScriptLibraryPath()
Example usage
AdminUtilities.getScriptLibraryPath()
This script displays help information for the AdminUtilities script library, including general library information, script names, and script descriptions.
Argument | Description |
---|---|
scriptName | Optionally specifies the name of the AdminUtilities script of interest. |
Syntax
AdminUtilities.help(scriptName)
Example usage
AdminUtilities.help("sleepDelay")
This script sets the text for the information notice of a command or script.
Argument | Description |
---|---|
message | Specifies the message text or a message ID such as "Application is installed" or resourceBundle.getString("WASX7115I"). |
Syntax
AdminUtilities.infoNotice(message)
Example usage
AdminUtilities.infoNotice(resourceBundle.getString("WASX7115I"))
This script saves the configuration changes to your system.
Syntax
AdminUtilities.save()
Example usage
AdminUtilities.save()
This script enables and disables debug notices.
Argument | Description |
---|---|
debug | Specifies whether to enable or disable debug notices. Specify true to enable debug notices, or false to disable debug notices. |
Syntax
AdminUtilities.setDebugNotices(debug)
Example usage
AdminUtilities.setDebugNotices("true")
This script enables or disables the fail on error behavior.
Argument | Description |
---|---|
failOnError | Specifies whether to enable or disable the fail on error behavior. Specify true to enable the fail on error behavior, or false to disable the behavior. |
Syntax
AdminUtilities.setFailOnErrorDefault(failOnError)
Example usage
AdminUtilities.setFailOnErrorDefault("false")
This script sets the number of seconds that the system waits for completion during two operations.
Argument | Description |
---|---|
delaySeconds | Specifies the number of seconds to wait for completion. |
Syntax
AdminUtilities.sleepDelay(delaySeconds)
Example usage
AdminUtilities.sleepDelay("10")
This script sets the text to display as the warning message.
Argument | Description |
---|---|
message | Specifies the non-translated text for the warning notice or a message ID such as resourceBundle.getString("WASX7411W"). |
Syntax
AdminUtilities.warningNotice(message)
Example usage
AdminUtilities.warningNotice(resourceBundle.getString("WASX7411W"))
This script enables and disables the automatic saving of configuration changes to the master configuration repository.
Argument | Description |
---|---|
autosave | Specifies whether to save configuration changes to the master configuration repository automatically. The default value is true. |
Syntax
AdminUtilities.configureAutoSave(autosave)
Example usage
AdminUtilities.configureAutoSave(false)