Jython script library: BLA configuration scripts using wsadmin.sh

Business-level application configuration scripts

The scripting library provides script procedures to automate the application server configurations. Use the scripts in this topic to create, query, and manage a business-level applications. We can run each script individually or combine procedures to create custom automation scripts.

The AdminBLA script procedures are located in the app_server_root/scriptLibraries/application/V70 directory.

Use the following script procedures to administer a business-level applications:

addCompUnit
createEmptyBLA
deleteAsset
deleteBLA
deleteCompUnit
editAsset
editCompUnit
exportAsset
importAsset
startBLA
stopBLA

Use the following script procedures to query a business-level application configurations:

help
listAssets
listBLAs
listCompUnits
viewBLA
viewAsset
viewCompUnit

The commands, viewBLA, viewAsset, and viewCompUnit only display output to the console and do not return data to the calling Jython script. These commands are not intended to be used as part of a script to store the output of the command to a string variable. By using these commands in a Jython script to store the output to a string variable, the string variable will only contain the value "Operation Successful!".
When invoked, as intended, with the Jython wsadmin interface, these commands properly display output to the console.

addCompUnit

This script adds assets, shared libraries, or additional business-level applications as composition units to the empty business-level application. A composition unit represents an asset in a business-level application. A configuration unit enables the asset contents to interact with other assets in the application. It also enables the product run time to load and run asset contents.

To run the script, specify the business-level application name and the composition unit source arguments, as defined in the following table:

Argument Description
blaName Name of the business-level application to which the system adds the composition unit.
compUnitID Name of the composition unit to add to the business-level application of interest.
deployableUnit Optional. The name of the deployable unit for the asset. A deployable unit is the smallest portion of an asset that can be individually chosen for deployment
compUnitName Optional. The name for the composition unit to add.
compUnitDescription Optionally specifies a description for the new composition unit.
startingWeight Optional. The starting weight of the composition unit.
target Optional. The target to which the composition unit is mapped.
activationPlan Optional. The activation plan for the composition unit.

Syntax
AdminBLA.addCompUnit(blaName, compUnitID, deployableUnit, compUnitName,
 compUnitDescription, startingWeight, target, activationPlan)
Example usage
AdminBLA.addCompUnit("bla1", "asset1.zip", "default", "myCompositionUnit", "cu description", "1", 
"server1", "specname=actplan1")
createEmptyBLA

Create a New business-level application in the environment. Create an empty business-level application and then add assets, shared libraries, or business-level applications as composition units to the empty business-level application.

To run the script, specify the business-level application name argument, as defined in the following table:

Argument Description
blaName Name to assign to the new business-level application.
description Optionally specifies a description for the business-level application.

Syntax
AdminBLA.createEmptyBLA(blaName, description)
Example usage
AdminBLA.createEmptyBLA("myBLA", "bla to control transactions")
deleteAsset

This script removes a registered asset from the configuration.

To run the script, specify the asset ID argument, as defined in the following table:

Argument Description
assetID Name of the asset to delete.

Syntax
AdminBLA.deleteAsset(assetID)
Example usage
AdminBLA.deleteAsset("asset.zip")
deleteBLA

This script removes a business-level application from the configuration.

To run the script, specify the business-level application name argument, as defined in the following table:

Argument Description
blaName Name of the business-level application to delete.

Syntax
AdminBLA.deleteBLA(blaName)
Example usage
AdminBLA.deleteBLA("myBLA")
deleteCompUnit

This script removes a composition unit from a specific business-level application configuration.

To run the script, specify the business-level application name and composition unit arguments, as defined in the following table:

Argument Description
blaName Name of the business-level application of interest.
compUnitID The identifier of the composition unit to delete.

Syntax
AdminBLA.deleteCompUnit(blaName, compUnitID)
Example usage
AdminBLA.deleteCompUnit("myBLA", "asset.zip")
editAsset

This script edits the metadata of a specific registered asset.

To run the script, specify the arguments defined in the following table:

Argument Description
assetID Name of the asset to edit.
assetDescription Optional. The new description of the asset of interest.
assetDestinationURL Optional. The new destination URL for the asset of interest.
assetTypeAspects Optional. The new type aspects for the asset of interest.
assetRelationships Optional. The new asset relationship configurations.
filePermission Optional. The new file permission configuration for the asset of interest.
validateAsset Optionally specifies whether the command validates the asset.

Syntax
AdminBLA.editAsset(assetID, assetDescription, assetDestinationURL, 
assetTypeAspects, assetRelationships, filePermission, validateAsset)
Example usage
AdminBLA.editAsset("asset1.zip", "asset for testing", "c:/installedAssets/asset1.zip", 
"WebSphere:spec=sharedlib", "", ".*\.dll=755#.*\.so=755#.*\.a=755#.*\.sl=755", "true")
editCompUnit

This script edits a specific composition unit within a business-level application.

To run the script, specify the business-level application name and composition unit ID arguments, as defined in the following table:

Argument Description
blaName Name of the business-level application to which the composition unit is associated.
compUnitID Name of the composition unit to edit.
compUnitDescription Optionally specifies a new description for the composition unit.
startingWeight Optionally specifies a new starting weight for the composition unit.
target Optionally specifies a new target to which the composition unit is mapped.
activationPlan Optionally specifies a new activation plan for the composition unit.

Syntax
AdminBLA.editCompUnit(blaName, compUnitID, compUnitDescription, 
startingWeight, target, activationPlan)
Example usage
AdminBLA.editCompUnit("bla1", "asset1.zip","cu description", "1", 
"server1", "specname=actplan1")
exportAsset

This script exports a registered asset to a file on the system.

To run the script, specify the asset ID and file name arguments, as defined in the following table:

Argument Description
assetID The identifier of the asset to export.
fileName Fully qualified file path to which the system exports the asset.

Syntax
AdminBLA.exportAsset(assetID, fileName)
Example usage

(Windows)
AdminBLA.exportAsset("asset.zip", "c:\temp\a.zip")
(AIX) (Linux) (Solaris) (HPUX) (iSeries) (ZOS)
AdminBLA.exportAsset("asset.zip", "/temp/a.zip")
importAsset

This script imports and registers an asset to a management domain in the configuration.

To run the script, specify the assetID, displayDescription, and deployableUnit arguments, as defined in the following table:

Argument Description
assetID Asset to import.
displayDescription Optionally specifies whether the script displays the description of the asset.
dispDeployableUnit Optionally specifies whether the script displays the deployable units for the asset to import.

Syntax
AdminBLA.importAsset(assetID, displayDescription, dispDeployableUnit)
Example usage
AdminBLA.importAsset("asset.zip", "true", "true")
startBLA

This script starts the business-level application process in the configuration.

To run the script, specify business-level application name argument, as defined in the following table:

Argument Description
blaName Name of the business-level application to start.

Syntax
AdminBLA.startBLA(blaName)
Example usage
AdminBLA.startBLA("myBLA")
stopBLA

This script stops the business-level application process in the configuration.

To run the script, specify the business-level application name argument, as defined in the following table:

Argument Description
blaName Name of the business-level application to stop.

Syntax
AdminBLA.stopBLA(blaName)
Example usage
AdminBLA.stopBLA("myBLA")
help

This script displays the script procedures that the AdminBLA script library supports. To display detailed help for a specific script, specify the name of the script of interest, as defined in the following table:

Argument Description
script Name of the script of interest.

Syntax
AdminBLA.help(script)
Example usage
AdminBLA.help("createEmptyBLA")
listAssets

This script displays the registered assets in the configuration.

To run the script, we can choose to specify the asset ID, display description, and display deployable units arguments, as defined in the following table:

Argument Description
assetID Optional. The group ID for which to display authorization groups.
displayDescription Optionally specifies whether the command displays a description for each asset. Specify true to display descriptions.
displayDeployUnits Optionally specifies whether the command displays the deployable units associated with the assets. Specify true to display the deployable units.

Syntax
AdminBLA.listAssets(assetID, displayDescription, displayDeployUnits)
Example usage
AdminBLA.listAssets("asset.zip", "true", "true")
listBLAs

This script displays each or specific business-level applications in the configuration.

To run the script, we can choose to specify the business-level application name and the display description arguments, as defined in the following table:

Argument Description
blaName Optional. The name of a business-level application of interest.
displayDescription Optionally specifies whether the command displays a description for each business-level application. Specify true to display descriptions.

Syntax
AdminBLA.listBLAs(blaName, displayDescription)
Example usage
AdminBLA.listBLAs("", "true")
listCompUnits

This script displays composition units within a business-level application.

To run the script, specify the business-level application name argument, as defined in the following table:

Argument Description
blaName Name of the authorization group of interest.
displayDescription Optionally specifies whether the command displays a description for each composition unit. Specify true to display descriptions.

Syntax
AdminBLA.listCompUnits(blaName, displayDescription)
Example usage
AdminBLA.listCompUnits("myBLA", "true")
viewBLA

This script displays the name and description of the business-level application of interest.

To run the script, specify the configuration ID argument of the business-level application of interest as defined in the following table:

Argument Description
blaID Configuration ID of the business-level application of interest.

Syntax
AdminBLA.viewBLA(blaID)
Example usage
AdminBLA.viewBLA("bla01.zip")
viewAsset

This script displays the configuration attributes for a specific registered asset.

To run the script, specify the asset ID argument, as defined in the following table:

Argument Description
assetID Name of the asset of interest.

Syntax
AdminBLA.viewAsset(assetID)
Example usage
AdminBLA.viewAsset("asset.zip")
viewCompUnit

This script displays the configuration attributes for a specific composition unit within a business-level application.

To run the script, specify the business-level application and composition unit ID arguments, as defined in the following table:

Argument Description
blaName Name of the business-level application of interest.
compUnitID The identifier for the composition unit of interest.

Syntax
AdminBLA.viewCompUnit(blaName, compUnitID)
Example usage
AdminBLA.viewCompUnit("myBLA", "asset.zip")
Related:

Business-level applications
Assets
Composition units
Use the script library to automate the application serving environment
Update business-level applications

Argument	Description
blaName	Name of the business-level application to which the system adds the composition unit.
compUnitID	Name of the composition unit to add to the business-level application of interest.
deployableUnit	Optional. The name of the deployable unit for the asset. A deployable unit is the smallest portion of an asset that can be individually chosen for deployment
compUnitName	Optional. The name for the composition unit to add.
compUnitDescription	Optionally specifies a description for the new composition unit.
startingWeight	Optional. The starting weight of the composition unit.
target	Optional. The target to which the composition unit is mapped.
activationPlan	Optional. The activation plan for the composition unit.

Argument	Description
blaName	Name to assign to the new business-level application.
description	Optionally specifies a description for the business-level application.

Argument	Description
blaName	Name of the business-level application of interest.
compUnitID	The identifier of the composition unit to delete.

Argument	Description
assetID	Name of the asset to edit.
assetDescription	Optional. The new description of the asset of interest.
assetDestinationURL	Optional. The new destination URL for the asset of interest.
assetTypeAspects	Optional. The new type aspects for the asset of interest.
assetRelationships	Optional. The new asset relationship configurations.
filePermission	Optional. The new file permission configuration for the asset of interest.
validateAsset	Optionally specifies whether the command validates the asset.

Argument	Description
assetID	The identifier of the asset to export.
fileName	Fully qualified file path to which the system exports the asset.

Argument	Description
assetID	Asset to import.
displayDescription	Optionally specifies whether the script displays the description of the asset.
dispDeployableUnit	Optionally specifies whether the script displays the deployable units for the asset to import.

Argument	Description
assetID	Optional. The group ID for which to display authorization groups.
displayDescription	Optionally specifies whether the command displays a description for each asset. Specify true to display descriptions.
displayDeployUnits	Optionally specifies whether the command displays the deployable units associated with the assets. Specify true to display the deployable units.

Argument	Description
blaName	Optional. The name of a business-level application of interest.
displayDescription	Optionally specifies whether the command displays a description for each business-level application. Specify true to display descriptions.

Argument	Description
blaName	Name of the authorization group of interest.
displayDescription	Optionally specifies whether the command displays a description for each composition unit. Specify true to display descriptions.