Modifying the addColony.xml file

The addColony.xml file lets you add colonies to a sharded deployment.

About this task

You can define database information for colonies by creating an addColony.xml file that you can pass with the manageColony command. This file contains colony and database information that is required when you add a colony.


  1. Create the addColony.xml file with a text editor. The file must contain the entries described in Modifying the addColony.xml file. An example of an addColony.xml file is provided after the table.
  2. After you edit the file, make a note of its name and location, so that you can pass it with the manageColony command.
    Table 1. Parameters for the addColony.xml file
    Parameter Definition
    <colony_name> The name of the colony you want to create or modify. This can be up to 40 characters in length.
    <primary_key_prefix> A two-digit prefix for the colony. The recommendation is to use numbers from 10 - 99 (except 19 and 20). If you need to use additional characters, you can use uppercase letters. You can use characters between A0 and ZZ, where the first character must be an uppercase letter and the second character can be either an uppercase letter or a number.
    <new_pool_id> The new connection pool pointing to the shard this colony is associated with.
    <jdbc_url> Specify the URL to connect to the database.
    • If using Db2, set to:

      jdbc:db2://<Database ServerHostname>:<Port Number>/<Database name>
    • If using Oracle, set to:

    <db_user> Specify the user name associated with the database.
    <db_password> Specify the password associated with the database.
    <dbvendor> Specify the database vendor name.

    Valid values: Db2 and Oracle

    <db_driver_class> Specify the class name of your database driver, as follows.
    • If the <dbvendor> is Db2, set to:
    • If the <dbvendor> is Oracle, set to:

    <db_schema> Specify the shard name associated with the database if it is different from the <db_user> name you entered. This parameter is case sensitive and you must specify it in UPPERCASE.