Common folder objects

You can simplify the administration of several common databases, by defining a core set of folder objects (common folder objects).

Common folder objects across all the databases:
  • Have identical names
  • Are in the same categories
  • Have an identical definition
  • Are set to Public access (unless you are using iBase database replication in which case the original access setting on the folder object is preserved)
Any authorized user can define folder objects as common items.

There is otherwise no visible difference between an ordinary folder object and a common folder object. For this reason, you might want to use a naming convention for common folder objects or keep them in a specific category.

How common folder objects are updated

Common folder objects are updated by running the Schema Update command in iBase Designer. This command applies changes held in a database template to the schema of the database in which it is run.

When a folder object, such as a report definition or a charting scheme, is defined as a common folder object, it can be:
  • Added to databases that do not already contain it
  • Updated with the changes held in a database template
  • Removed from a database if it exists in the database but not in the template

Ordinary folder objects remain unchanged (but are renamed if they have the same name as a common folder object).

To update a compatible database with the current folder objects, create a template from the database containing the folder objects, and then apply that template to the other database. For more information, see Updating Database Schemas.

Defining a common folder object

To define an existing folder object as a common folder object:
  • From the Tools menu in iBase, select Common Folder Objects. The Common Folder Objects dialog is displayed. Click Help in the dialog for information on how to use the dialog.
  • Dependent on a set. Being data-dependent, sets cannot be saved in a template.
  • Dependent on a folder object that is not selected as a common folder object (or that is deleted).

A folder object cannot be defined as a common folder object if it is:

The settings that are made in the Common Folder Objects dialog are saved in the database. Redisplaying the dialog displays the common folder objects defined in the database.

Any template that is saved from the database, distinguishes between ordinary and common folder objects.

Effect of adding, modifying, and removing common folder objects

What happens when you define a new folder object as a common folder object in the source database on folder objects in the target database is summarized below:

Summary of new folder objects in the target database

In the source database, add a folder object and define it as a common folder object An identical common folder object is added to the target database. If any ordinary folder object with the same name exists, then the object is not overwritten but it is renamed by adding an underscore to the beginning of the name.
Note: The access permission is not copied, unless you are using iBase database replication.
In the source database, modify a common folder object The common folder object in the target database is updated to match the definition in the source database, including any updates to the name or category. If the common folder object was renamed in the source database, then any ordinary folder object in the target database with the same name is not overwritten. It is renamed by adding an underscore to the beginning of the name.
Note: The access permission is not copied, unless you are using iBase database replication.
In the source database, make a common folder object into an ordinary folder object The common folder object is deleted from the target database.
In the source database, delete a common folder object The common folder object is deleted from the target database.
Note: You are informed if any name changes are made during the update process. The renamed folder objects are identifiable as they appear at the top of any lists (because of the underscore prefix).