Ant target: RegisterInstance

RegisterInstance generates the master instance configuration XML file and registers the instance into the Configuration Manager tool. RegisterInstance can be used to regenerate the master instance configuration XML file based on the property values in the Ant properties file.

Important: This Ant target is to be used only as a part of WebSphere Commerce instance creation.
Note: Any customizations made in Configuration Manager or manually to the instance.xml file will be lost if you run this target.
The master instance configuration file is contained in these files:
  • LinuxAIXWindowsWC_installdir/instances/instance_name/xml/instance_name.xml
  • For IBM i OS operating systemWC_userdir/instances/instance_name/xml/instance_name.xml
The instance property values are contained in these files:
  • LinuxAIXWindowsWC_installdir/instances/instance_name/properties/
  • For IBM i OS operating systemWC_userdir/instances/instance_name/properties/

Called by



The file must exist for this Ant target to work. For information about generating the properties file, see Ant targets.

Required parameters

The name of the WebSphere Commerce instance with which you are working (for example, demo).
The WebSphere Commerce site administrator's password.
The WebSphere Commerce site merchant key.
LinuxAIXWindowsThe database administrator's password.
The WebSphere Commerce database user's password.


  • LinuxAIXWC_installdir/bin/ -DinstanceName=instance_name -DsiteAdminPassword=siteAdminPassword -DmerchantKey=merchantKey -DdbaPassword=dbaPassword -DdbUserPassword=dbUserPassword RegisterInstance
  • For IBM i OS operating systemWC_installdir/bin/ -DinstanceName=instance_name -DsiteAdminPassword=siteAdminPassword -DmerchantKey=merchantKey -DdbUserPassword=dbUserPassword RegisterInstance
  • WindowsWC_installdir/bin/config_ant.bat -DinstanceName=instance_name -DsiteAdminPassword=siteAdminPassword -DmerchantKey=merchantKey -DdbaPassword=dbaPassword -DdbUserPassword=dbUserPassword RegisterInstance


  1. If an error occurs, review the following log files:
    • LinuxAIXWindows
      • WC_installdir/instances/instance_name/logs/createInstanceANT.log
      • WC_installdir/instances/instance_name/logs/createInstanceANT.err.log
    • For IBM i OS operating system
      • WC_userdir/instances/instance_name/logs/createInstanceANT.log
      • WC_userdir/instances/instance_name/logs/createInstanceANT.err.log
  2. Resolve the problem.
  3. Run the RegisterInstance target again.