HCL Commerce Developer

Enabling Workspaces in the HCL Commerce development environment

The development environment is not meant to be an authoring environment. Support is provided in the environment for customization purposes only. For example, to test changes to the content management functionality. The ability to propagate changes is not available. If you want to change the content management workspaces, you cannot publish the changes out to another database.

Before you begin

Before you enable workspaces in the HCL Commerce development environment, ensure that:
  1. Change history is enabled in your development environment. Complete the following steps to enable it:
    1. Go to the WCDE_installdir/workspace/WC/xml/config/wc-server.xml.
    2. Open wc-server.xml and find <WorkspaceChangeHistoryEnabled enable="false"/>.
    3. Edit the settings to the following values: <WorkspaceChangeHistoryEnabled enable="true"/>.
    4. Save and close the file.
    5. Restart the server.
  2. Be sure you have a staging database loaded. For more information see, Loading the HCL Commerce Developer database schema.

Procedure

  1. Exit the development environment.
  2. Issue the following command: 
    WCDE_installdir/bin/enableContentManagement.bat number_of_workspaces addWorkspace
    Where:
    number_of_workspaces
    Use the number_of_workspaces parameter if you are enabling workspaces in the HCL Commerce development environment for the first time.

    Enter the maximum number of workspaces you want on the authoring environment. Ensure that the number of workspaces that are allocated is sufficient to handle the number of concurrent workspace activities that might occur.

    The maximum number of workspaces is the maximum number of simultaneous activities that require data isolation. Multiple stores that are managed by the same organization can share a workspace. For instance, to work on two future events simultaneously and provide regular updates and a data-isolated area in which to complete emergency fixes, you need four workspaces per organization.

    The maximum number of workspaces specifies the number of database schemas that are allocated for workspaces. The number of allocated database schemas remains fixed. If a Workspace Manager creates more workspaces than the number of workspace database schemas available, task groups in workspaces without an available database schema cannot be activated until another workspace is completed or canceled.

    For more information, see Workspaces data model.

    addWorkspace
    Use the addWorkspace parameter if workspaces is already enabled in the HCL Commerce development environment.
    Specify the number of additional workspaces to create.
    If you encounter errors when you run the utility, review the enableContentManagement.log file for more detailed troubleshooting information. This file can be located within the following directory:
    • WCDE_installdir\logs\
  3. Enable the HCL Commerce search index.
    Run the setupSearchIndex utility with the following workspace-specific parameters specified:
    • dbauser
    • dbauserpwd
    • createAll
    For more information, see Setting up the search index.
  4. Start the test server.
  5. Add the JVM argument, WorkspaceTaskListEnabled, which is required for workspaces to function.
    1. Open the Administration console, and go to Application Server > server > Process definition > Java Virtual Machine. server is the name of your server, and the default value is server1.
    2. In the Generic JVM argument field of the Configuration tab, add the following string. 
      -DWorkspaceTaskListEnabled=true
      Note: Subsequently setting -DWorkspaceTaskListEnabled=false does not disable the workspace. It inhibits the workspace from being shown in the Management Center. Since workspaces are implemented as schemas in the database, in order to actually remove a workspace you must remove the workspace schema from the database. Any content in the workspace that you want to keep must be "promoted" to the base schema (where Approved Content resides) before you remove the schema from the database.
    3. Save your changes to the master configuration.
    4. Restart the test server.
  6. Optional: Enable email notification in workspaces.