Run the authoring environment update scripts on the WebSphere Commerce Server

Before beginning

When running the config_ant scripts make sure that you have met the following conditions:

• Ensure that the WebSphere Commerce Server is not running, as this tool is updating the workspace schema structure.

• The createInstance.properties file contains a complete list of properties. If you need to change any of the property values, we can do this by modifying the createInstance.properties file:

  • (Linux)

    utilities_root/instances/instance_name/properties/createInstance.properties 
    

• Run the config_ant tool by opening a command-line shell in the Utility server Docker container container. For information on entering and leaving containers, see Running utilities from the Utility server Docker container.

Procedure

• Recalibrating a single table:

  If you have changed a table in the base schema, run the following script to recalibrate the table:

  • (Linux)

    utilities_root/bin/config_ant.sh -buildfile
    utilities_root/components/Workspaces/xml/updateWorkspacesSchemaTable.xml
    -DinstanceName=instance_name
    -DdbaPassword=administrative_password
    -DtableName=tableName
    -DtableResourceType=tableResourceType(optional)
    -DresourceXMLLocation=location_of_resource_XML_Files(optional)
    -DgenerateSQLStatementsOnly=true|false(optional)
    -DgenerateSQLStatementsOutputFile=outputFileDirectory(optional)
    -DdebugMode=trueOptional: CM_updateWorkspacesTable

  This Ant script takes a single table from the base schema and updates the table in the workspaces. See Ant task: CM_updateWorkspacesTable for usage and parameter information.

  Note: This text is wrapped for display purposes. Enter the command on one line.

• Recalibrating the entire schema:

  If you have made many changes in the base schema and want the workspaces schema to reflect those changes, run the following script to recalibrate the entire schema:

  • (Linux)

    utilities_root/bin/config_ant.sh
    -buildfile utilities_root/components/Workspaces/xml/updateWorkspacesSchema.xml
    -DinstanceName=instance_name
    -DdbaPassword=administrative_password
    -DresourceXMLLocation=location_of_resource_XML_Files
    -DgenerateSQLStatementsOnly=true|false(optional)
    -DgenerateSQLStatementsOutputFile=outputFileDirectory(optional)
    -DdebugMode=trueOptional: CM_updateWorkspacesSchema 

  This Ant script scans through the base schema and adjusts the workspaces schema accordingly. See Ant task: CM_updateWorkspacesSchema for usage and parameter information.

  Note: This text is wrapped for display purposes. Enter the command on one line.

• Ant target: CM_updateWorkspacesTable
  Use the update workspaces table script when we make schema changes to a table and need to update your workspaces schema to include the changes.

• 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.

• Troubleshooting: Update Workspace failing to update the workspace because of missing column for primary key
  When running the update workspace table ANT task when the primary key changed on the table to account for a new column, the tool will fail. The tool will attempt to create the primary key on the workspace tables before creating the new column.

Related concepts
Authoring environment schema update tool

Related tasks
Enable Workspaces
Creating an authoring environment
Synchronizing an authoring environment with a production environment
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
Ant target: CM_updateWorkspacesSchema
Troubleshooting: Update Workspace failing to update the workspace because of missing column for primary key