Modifying the ObjectManager properties file
The ObjectManager.properties file contains properties that control or limit the scope of the data that is exported by ObjectManager.
Depending on your requirements, modify the values of the properties. You can edit the ObjectManager.properties file in any text editor.
For information about the properties, see Settings in the ObjectManager.properties file.
The ObjectManager.properties file is located in the /bin directory where ObjectManager is installed.
If you're using the ObjectManager client, the location of the file is openpages-tools-client/bin/ObjectManager.properties
On application servers, the path is <OP_HOME>/bin/ObjectManager.properties
Settings in the ObjectManager.properties file
The logger property
- object.manager.logger.settings
-
Defines the location of the logging properties file relative to the bin directory. Do not change this setting.
object.manager.logger.settings=./log4j2.properties
The configuration.manager.migrate.configuration.objects
The configuration.manager.migrate.configuration.objects
property
overwrites the following configuration.manager.dump.*
properties
and is the equivalent of setting these properties to true
:
-
configuration.manager.dump.bundle.types
-
configuration.manager.dump.file.upload.content.types
-
configuration.manager.dump.jsp.based.content.types
-
configuration.manager.dump.admin.objectprofile.views
-
configuration.manager.dump.form.based.content.types
-
configuration.manager.dump.object.profiles
-
configuration.manager.dump.application.string.key.categorie
s -
configuration.manager.dump.application.string.keys
-
configuration.manager.dump.application.strings
-
configuration.manager.dump.object.strings
-
configuration.manager.dump.error.strings
-
configuration.manager.dump.query.definitions
-
configuration.manager.dump.field.dependency
-
configuration.manager.dump.field.dependency.picklist
-
configuration.manager.dump.recursive.hierarchy
-
configuration.manager.dump.recursive.hierarchy.strings
-
configuration.manager.dump.content.type.relationship.sets
-
configuration.manager.dump.actor.object.profile.associations
-
configuration.manager.dump.locales
-
configuration.manager.dump.role.templates
-
configuration.manager.dump.role.administrators
-
configuration.manager.dump.role.assignments
-
configuration.manager.dump.subsystem.exclusion.fields
-
configuration.manager.dump.registry
-
configuration.manager.dump.process.definitions
-
configuration.manager.dump.tbrules
-
configuration.manager.dump.tbcalculations
Additionally, the configuration.manager.migrate.configuration.objects
property
exports the following data:
- Any object folders referenced by:
-
jsp.based.content.types
-
form.based.content.types
-
- Query definition (filter) strings
- Reporting schema column definitions (which are used to keep framework labels consistent when you have duplicate field names).
The configuration.manager.dump.* export properties
The following list describes the behavior of the various export
configuration.manager.dump.*
properties when a property is enabled (the value is
set to true
).
- configuration.manager.dump.modules
- Exports a list of the modules (solutions) that are installed. It also controls the list of entries on the About OpenPages and Build Information pages.
- configuration.manager.dump.file.types
- Exports a list of valid file attachment types (such as
docx
,pdf
,jpg
). - configuration.manager.dump.bundle.types
- Exports all field groups in the system, along with all of their fields.
- configuration.manager.dump.file.upload.content.types
- Exports all file upload object types, such as SOXDocument. It will also export any folders (nonFormBasedResources) that are referenced by these object types.
- configuration.manager.dump.jsp.based.content.types
- Exports all other object types, such as SOXBusEntity, Mandate, and Policy. It will also export any folders (nonFormBasedResources) that are referenced by these object types.
- configuration.manager.dump.content.type.relationship.sets
- Exports a list of which objects types can be associated to what other object types.
- configuration.manager.dump.app.permissions
- Exports a list of application permissions that can be granted to groups or role templates.
- configuration.manager.dump.actors
- Exports all users, groups, and security domain groups.
- configuration.manager.dump.actor.group.memberships
- Exports all group memberships, such as: which users belong to what groups, which users belong to what security domains, and which security domains belong to what other security domains.
- configuration.manager.dump.actor.object.profile.associations
- Exports users and groups and their assigned profiles.
- configuration.manager.dump.admin.objectprofile.views
- Exports object profiles. This property should be used with the
configuration.manager.dump.object.profiles
setting. - configuration.manager.dump.object.profiles
- Exports object profiles. This property should be used with the
configuration.manager.dump.admin.objectprofile.views
setting. - configuration.manager.dump.non.form.based.resources
- Exports all folders and object instances in the system. You can use the setting
configuration.manager.dump.resources.root.folder
to narrow the scope of objects that are exported. You will probably want to use this setting with the settingconfiguration.manager.dump.resource.sets
.As an alternative, you can use the
configuration.manager.dump.associated.resources
property. - configuration.manager.dump.form.based.content.types
- Exports form-based object type definitions if these were used. By default (out of the box), the software does not use form-based object type definitions.
- configuration.manager.dump.form.based.resources
- Exports instances of form-based object types if these were used. This property is similar to the
configuration.manager.dump.non.form.based.content.types
property.The
configuration.manager.dump.form.based.resources
property is generally not needed because of what is stated in theconfiguration.manager.dump.form.based.content.types
property. - configuration.manager.dump.channels
- Exports all reports that appear on the Reporting menu in the IBM OpenPages application, such as: all JSP reports and
any Cognos® reports that have been published
to the OpenPages application. It does not export any report definitions from
Cognos. If you want to export
JSP
report definitions, you will also want to set theconfiguration.manager.dump.non.form.based.resources
property totrue
, and theconfiguration.manager.dump.resources.root.folder
property to /Reports. - configuration.manager.dump.resource.sets
- Exports object instance relationships. For example, if you had an entity called
Entity ABC
that had a child process calledProcess A
, you would set the following properties totrue
:-
configuration.manager.dump.non.form.based.resources property
to get the definitions ofEntity ABC
andProcess A
-
configuration.manager.dump.resource.sets
property to get the entry that saysProcess A
is a child ofEntity ABC
.
As an alternative, you can use the
configuration.manager.dump.associated.resources
property. -
- configuration.manager.dump.associated.resources
- Exports objects and their relationships – you can use it instead of
configuration.manager.dump.non.form.based.resources
andconfiguration.manager.dump.resource.sets
. - configuration.manager.dump.rule.sets
- Exports all object reset rule sets.
- configuration.manager.dump.rule.set.execute.sessions
- Exports the history of object reset executions.
- configuration.manager.dump.registry
- Exports all settings, except those that are encrypted.
To filter the scope of the export, you can use the following settings:
- configuration.manager.migrate.configuration.exclude.registry.entry.[number]
- Excludes entries listed in this setting from export.
- configuration.manager.dump.registry.root.entry.[number]
- Sets the scope of settings to be exported.
You can create multiple entries with this property by incrementing the [number] part of the name.
- configuration.manager.dump.recursive.hierarchy
- Exports recursive object levels.
- configuration.manager.dump.locales
- Exports supported locales (languages). No translations are included.
- configuration.manager.dump.application.string.key.categories
- Exports the application text folders.
- configuration.manager.dump.application.string.keys
- Exports application text keys – the list of entries on the Application Text page – without translations.
- configuration.manager.dump.application.strings
- Exports translations for application text.
- configuration.manager.dump.recursive.hierarchy.strings
- Exports translations for recursive object levels.
- configuration.manager.dump.error.strings
- Exports translations for error messages.
- configuration.manager.dump.object.strings
- Exports translations for: object type names, field names, field guidance, section names, and enumerated values.
- configuration.manager.dump.jobdetails
- Exports jobs from the Scheduler. It does not export workflows or Java™ classes that are used by the jobs.
- configuration.manager.dump.currency.exchange.rates
- Exports exchange rates.
- configuration.manager.dump.currencies
- Exports the list of valid currencies (enabled and disabled).
- configuration.manager.dump.query.definitions
- Exports public filters.
- configuration.manager.dump.user.preferences
- Exports Alert Notification settings for each user.
- configuration.manager.dump.role.templates
- Exports role templates.
- configuration.manager.dump.role.administrators
- Exports which users are assigned as administrators for what security domains.
- configuration.manager.dump.role.assignments
- Exports which users are assigned which role templates for what security domains.
- configuration.manager.dump.field.dependency
- Exports field dependencies.
- configuration.manager.dump.field.dependency.picklist
- Exports dependent picklists.
- configuration.manager.dump.subsystem.exclusion.fields
- Exports fields that are excluded from the reporting subsystem.
- configuration.manager.dump.record.level.security.rulesets
- Exports rule sets from record level security.
- configuration.manager.dump.process.definitions
- Exports GRC workflow definitions.
- configuration.manager.dump.dashboard.views
- Exports dashboards.
- configuration.manager.dump.responsive.views
- Exports views.
- configuration.manager.dump.tbrules
- Exports rules from the Rules Engine.
-
configuration.manager.dump.tbcalculations
- Exports calculations from GRC Calculations.
-
configuration.manager.dump.solutions
- Exports solution visualizations.
-
configuration.manager.dump.themes
- Exports themes.
-
configuration.manager.dump.tags
- Exports tags.
- configuration.manager.dump.include.system.application.strings
- Includes system strings, such as strings that are embedded in workflows and views, in the
export.Note: These strings cannot be migrated from one system to another.
- configuration.manager.dump.strings.locale.filter=<locale_code>
- Sets the localee to export, where <locale_code> is a single locale code.
For example, to export strings for the Croatian locale, type
hr_HR
. - configuration.manager.dump.strings.days.filter=<number_of_days>
- Sets the age of strings to export, where <number_of_days> is the number of days since the strings were added to the system.
The configuration.manager.force.update.* properties
- configuration.manager.force.update.object.strings
- Overwrites existing object strings when set to
true
prior to a load. - configuration.manager.force.update.application.strings
- Overwrites existing application strings when set to
true
prior to a load.
The invalid characters property
- configuration.manager.property.name.illegal.characters=!@#$%^&*()<>+=[]\/{}|?
- Defines characters that cannot be used in field names.
The disable triggers properties
- configuration.manager.migrate.configuration.disable.all.triggers=/OpenPages/Applications/GRCM/Disable Triggers
- Points to the registry setting that indicates whether triggers are disabled or not. Do not
change it. It works with the
configuration.manager.disable.triggers
setting. - configuration.manager.disable.triggers
- Disables triggers when importing or exporting data in order to not trigger excess processing as objects are created, modified, or associated. If set to true, triggers are disabled at the start of the import or export and re-enabled at the end. Default is false.
The resource load property
- configuration.manager.load.resource.ignore.undefined.property.value
- Controls behavior when loading objects. For more information, see Controlling data load behavior.
Legacy properties
- configuration.manager.dump.date.dimension.type
- Exports date dimension types.
- configuration.manager.dump.object.type.dimension
- Exports object type dimensions.
- configuration.manager.dump.date.dimension.type.associations
- Exports date dimension type associations (what date dimension types are enabled for what fields).
- configuration.manager.dump.date.dimension.type.strings
- Exports translations for date dimension types.
- configuration.manager.dump.object.type.dimension.strings
- Exports translations for object type dimensions.