Ant target: CM_updateWorkspacesSchema
Use the update workspaces schema script when you change your base schema and need to update your workspaces schema to include the changes.
Usage
utilities_root/bin/config_ant.sh -buildfile utilities_root/components/Workspaces/xml/updateWorkspacesSchema.xml -DinstanceName=instance_name -DresourceXMLLocation=location_of_resource_XML_Files -DdbaPassword=administrative_password -DgenerateSQLStatementsOnly=true|false(optional) -DgenerateSQLStatementsOutputFile=outputFileDirectory(optional) -DdebugMode=true(optional) CM_updateWorkspacesSchema -logfile location_of_log_file (optional)Notes:
- This text is wrapped for display purposes. Enter the command on one line.
(Developer) To run the update workspaces schema utility in a WebSphere Commerce Developer environment, see Running authoring environment update scripts.
Parameters
- instance_name
- The WebSphere Commerce instance name.
- resourceXMLLocation
- This parameter is the XML directory where the content-management/wc-resource-containers.xml and all the other resource manager XML files reside. This directory needs to contain only the resource manager XML file for this table if the table is content managed or operational. If there is no resource file for a table found in the content-management directory under the specified location, the utility assumes that there is no change to the resource type of the table, or the table is a non-managed type table if the table does not exist in the workspace. The utility looks for the directory named "content-management" under the specified location first. If the utility cannot find the content-management directory under the specified location, it tries to locate the content-management directory under the utility classpath. If the utility still cannot find any content-management directory, it throws an exception. In summary, the content-management directory must exist even if it is empty.
- dbaPassword
- The password for the database administrative user. This password is needed for schema creation and update.
- generateSQLStatementsOnly
- Optional. A flag that indicates whether the Ant task updates workspaces or only generates the SQL to use to update workspaces. We can set the following values for this parameter:
- true
- The utility only reports the SQL that for updating workspace pool.
- false
- The utility updates the workspace pool. This value is the default value.
- generateSQLStatementsOutputFile
- The output file to print the SQL statements to if generateSQLStatementsOnly is set to true. If not specified then the SQL is output to standard output stream.
- debugMode
- Optional. If true, trace and log information is enabled and prints to file: utilities_root/logs/Application.messages.log.
- logfile
- Optional. If provided, the Ant script creates or overwrites a log file at this location. If not specified, the logging information is displayed in the console.
Related concepts
Authoring environment schema update tool
Related tasks
Enable Workspaces
Creating an authoring environment
Synchronizing an authoring environment with a production environment
Running the authoring environment update scripts on the WebSphere Commerce Server
Updating the quick publish target
Updating the JDBC provider setting for the quick publish target
Enable retry for quick publish
Enable e-mail notification for workspaces
Enable shopping flow preview for workspaces
Changing workspaces locking policy
Related reference
Ant target: CM_updateWorkspacesTable
Troubleshooting: Update Workspace failing to update the workspace because of missing column for primary key