Configuring OSGi

Access the Configuration tab of the Web Console by either:

• Opening the web console from the link on the Tool > Operations menu. After logging into the console, you can use the drop-down menu of:

  OSGi >

• The direct URL; for example:

  http://localhost:4502/system/console/configMgr

A list is shown.

Select the bundle that you want to configure by either:

• clicking the Edit icon for that bundle
• clicking the Name of the bundle

A dialog box opens. Here you can edit as required. For example, set the Log Level to INFO:

NOTE

Updates are saved in the repository as configuration files. To locate these files afterwards to include in a content package for use on another instance, for example, make a note of the persistent identity ( PID).

Click Save.

Your changes are immediately applied to the relevant OSGi configuration of the running system, no restart is required.

NOTE

You can now locate the related configuration files. For example, to include in a content package for use on another instance.

Create the configuration file by making an initial change in the web console.

Open CRXDE Lite.

In the Tools menu, select Query … .

To search for the PID of the configuration that you have updated, submit a query of Type SQL.

For example, Apache Felix OSGi Management Console has the persistent identity (PID) of:

org.apache.felix.webconsole.internal.servlet.OsgiManager

So the SQL query could be:

select * from nt:base where jcr:path like '/apps/%' and contains(*, 'org.apache.felix.webconsole.internal.servlet.OsgiManager')

The configuration file node is shown.

For the above example:

/apps/system/config/org.apache.felix.webconsole.internal.servlet.OsgiManager.config

CAUTION

You can open this file to view your changes, but to avoid typing errors it is recommended to make actual changes with the console.

You can now build a content package, containing this node, and use as required on your other instances.

The Persistent Identity (PID) of the service.

Reference the Configurations field in the Web console. The name is shown in brackets after the bundle name (or in the Configuration Information towards the bottom of the page).

For example, create a node com.day.cq.wcm.core.impl.VersionManagerImpl. to configure AEM WCM Version Manager.

Is a specific run mode required? Create the folder:

• config - for all run modes
• config.author - for the author environment
• config.publish - for the publish environment
• config.<run-mode> - as appropriate

Is a Configuration or Factory Configuration necessary?

The individual parameters to be configured, including any existing parameter definitions that must be recreated.

Reference the individual parameter field in the Web console. The name is shown in brackets for each parameter.

For example, create a property
versionmanager.createVersionOnActivation to configure Create Version on Activation.

Does a configuration exist in /libs? To list all configurations in your instance, use the Query tool in CRXDE Lite to submit the following SQL query:

select * from sling:OsgiConfig

If so, this configuration can be copied to /apps/<yourProject>/, then customized in the new location.

Use CRXDE Lite to navigate to:

/apps/<yourProject>

If not existing, create the config folder ( sling:Folder):

• config - applicable to all run modes
• config.<run-mode> - specific to a particular run mode

Under this folder, create a node:

• Type: sling:OsgiConfig

• Name: the persistent identity (PID);

  for example, for AEM WCM Version Manager use com.day.cq.wcm.core.impl.VersionManagerImpl

NOTE

When making a Factory Configuration append -<identifier> to the name.

As in: org.apache.sling.commons.log.LogManager.factory.config-<identifier>

Where <identifier> is replaced by free text that you (must) enter to identify the instance (you cannot omit this information); for example:

org.apache.sling.commons.log.LogManager.factory.config-MINE

For each parameter that you want to configure, create a property on this node:

• Name: the parameter name as shown in the Web console; the name is shown in brackets at the end of the field description. For example, for Create Version on Activation use versionmanager.createVersionOnActivation
• Type: as appropriate.
• Value: as required.

You must only create properties for the parameters that you want to configure, others still take the default values as set by AEM.

Save all changes.

Changes are applied when the node is updated by restarting the service (as with changes made in the Web console).