Utility scripts

The scripting library provides multiple script procedures to automate the application configurations. See the usage information for scripts that set notification options, save configuration changes, and display scripting library information.

Each utility script procedure is located in the app_server_root/scriptLibraries/utilities/V70 directory. Use the following script procedures to perform utility functions:

• convertToList

• debugNotice

• getExceptionText

• fail

• fileSearch

• getResourceBundle

• getScriptLibraryFiles

• getScriptLibraryList

• getScriptLibraryPath

• help

• infoNotice

• save

• setDebugNotices

• setFailOnErrorDefault

• sleepDelay

• warningNotice

• configureAutoSave

convertToList

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	Name of the variable containing the string to convert to a list.

Syntax

AdminUtilities.convertToList(variable)

Example usage

apps=AdminApp.list()
AdminUtilities.convertToList(apps)

debugNotice

This script sets the debug notice text.

Argument	Description
message	Message text for the debug notice.

Syntax

AdminUtilities.debugNotice(message)

Example usage

AdminUtilities.debugNotice("Server is started")

getExceptionText

This script displays the exception message for a specific exception type, exception value, or traceback information.

Argument	Description
type	Exception type of interest. The exception type represents the class object of the exception.
value	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	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 handling 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"
, "")

fail

This script sets the failure message.

Argument	Description
message	Message text for the failure notice.

Syntax

AdminUtilities.fail(message)

Example usage

AdminUtilities.fail("The script failed")

fileSearch

This script searches the file system based on a specific path or directory.

Argument	Description
path	File path to search for a specific file.
directory	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)

getResourceBundle

This script displays an instance for the resource bundle of interest.

Argument	Description
bundleName	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")

getScriptLibraryFiles

This script displays the file path and file names for each script library file.

Syntax

AdminUtilities.getScriptLibraryFiles()

Example usage

AdminUtilities.getScriptLibraryFiles()

getScriptLibraryList

This script displays each script name in the script library.

Syntax

AdminUtilities.getScriptLibraryList()

Example usage

AdminUtilities.getScriptLibraryList()

getScriptLibraryPath

This script displays the file path to get to the script library files on the file system.

Syntax

AdminUtilities.getScriptLibraryPath()

Example usage

AdminUtilities.getScriptLibraryPath()

help

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")

infoNotice

This script sets the text for the information notice of a command or script.

Argument	Description
message	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"))

save

This script saves the configuration changes to the system.

Syntax

AdminUtilities.save()

Example usage

AdminUtilities.save()

setDebugNotices

This script enables and disables debug notices.

Argument	Description
debug	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")

setFailOnErrorDefault

This script enables or disables the fail on error behavior.

Argument	Description
failOnError	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")

sleepDelay

This script sets the number of seconds that the system waits for completion during two operations.

argument description. Run the script to specify the delay

Argument	Description
delaySeconds	Number of seconds to wait for completion.

Syntax

AdminUtilities.sleepDelay(delaySeconds)

Example usage

AdminUtilities.sleepDelay("10")

warningNotice

This script sets the text to display as the warning message.

Argument	Description
message	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"))

configureAutoSave

This script enables and disables the automatic saving of configuration changes to the master configuration repository.

Argument	Description
autosave	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)

Related tasks

Use the script library to automate the application serving environment