Introduction
The present guide is addressed to project developers to give them an overview about global IOM properties, which are settable in context of projects.
Glossary
| Wording | Description |
|---|---|
| CLI | Command Line Interface |
| IOM | The abbreviation for Intershop Order Management |
| JBoss | Synonym for WildFly (former name of the WildFly application server) |
| OMS | The abbreviation for Order Management System, the technical name of IOM |
| URL | Uniform Resource Locator |
| WildFly | The application server that IOM runs on |
References
Cluster Properties
These properties are defined in IOM standard project structure as part of the customization artifact. Cluster properties are WildFly system properties, which define the machine-independent global configuration of an IOM cluster. It is possible to define environment-specific cluster.properties.
etc/
├── base/
│ ├── cluster.properties
│ └── ...
└── env/
├── <env-name 1>/
│ └── cluster.properties
├── <env-name 2>/
│ └── cluster.properties
└── ...
Property | Description | Exemplary Value |
|---|---|---|
| is.oms.mail.external.from | The sender address for external e-mails (e.g., e-mails sent to the shop customers) | noreply@youraddress.com |
| is.oms.mail.internal.from | The sender address for internal e-mails (e.g., to report errors via e-mail) | noreply@youraddress.com |
| is.oms.mail.internal.to | The recipient for internal e-mails | operations@youraddress.com |
| is.oms.mail.internal.cc | The carbon copy for internal e-mails | |
| is.oms.mail.internal.bcc | The blind carbon copy for internal e-mails | |
| is.oms.mail.businessoperations.to | The recipient for business operations e-mails | businessoperations@youraddress .com |
| is.oms.validation.pattern.phone | Validation pattern for phone numbers. If not set, the default value will be used. | (^$)|(^[+]?[0-9. ()/-]{8,25}$) |
| is.oms.validation.pattern.email | Validation pattern for e-mail addresses. If not set, the default value will be used. Note The character '\' in the regular expression requires an escaping (\ => \\). Otherwise, the property would not be set correctly. | Desired expression ^[A-Za-z0-9._%+-]+@[A-Za-z0-9][A-Za-z0-9.-]*\.[A-Za-z]{2,9}$ requires the following escaped expression ^[A-Za-z0-9._%+-]+@[A-Za-z0-9][A-Za-z0-9.-]*\\.[A-Za-z]{2,9}$ |
| is.oms.validation.pattern.password | Validation pattern for passwords. If not set, the default value will be used. Note The character '\' in the regular expression requires an escaping (\ => \\). Otherwise, the property would not be set correctly. | Desired expression ^(?=[^\s]*[a-zA-Z])(?=[^\s]*[\d])[^\s]{8,}$ requires the following escaped expression ^(?=[^\\s]*[a-zA-Z])(?=[^\\s]*[\\d])[^\\s]{8,}$ |
| is.oms.validation.pattern.password.hint | The displayed note where you can explain the password rules for OMT users can be customized. If not set, the default value will be used. | The password must include a letter, a number and must contain at least 8 characters. |
Persisted Platform Wide Properties
Definition and Background
A few platform-wide configurations are set directly in the database, within the table PlatformConfigDO or PlatformConfigPropertyDO. These properties are also kept in a java cache that must be explicitly reset if one of those properties get modified.
The difference between PlatformConfigDO and PlatformConfigPropertyDO is a historic one and the properties currently kept in PlatformConfigDO might move to PlatformConfigPropertyDO in a future version.
PlatformConfigPropertyDO can be used to add project-specific customization properties.
References
- Concept - IOM Synchronization of Java-based Caches: "bakery-cache-config"
- Overview - IOM Database Documentation for
PlatformConfigDOandPlatformConfigPropertyDO
Properties
PlatformConfigPropertyDO
Expected properties:
| Key | Default Value | Validate | Description |
|---|---|---|---|
| archive_OrderMessageLog_min_age | 90 | ^[1-9]([0-9]+)? | Number of days after which the entries in table "OrderMessageLogDO" should be exported and the columns "request" and "response" set to 'archived' in order to reduce the table size. Min. accepted value: 10 |
| delete_OrderMessageLog_min_age | 180 | ^[1-9]([0-9]+)? | The number of days after which the entries in table "OrderMessageLogDO" will definitely be deleted in order to reduce the table size. Must be greater than archive_OrderMessageLog_min_age. |
| archive_ShopCustomerMail_min_age | 1826 | ^[1-9]([0-9]+)$ | Number of days after which the entries in table "ShopCustomerMailTransmissionDO" should be exported (Quartz job "ShopCustomerMailTransmissionArchive") and the column "message" set to ''deleted'' in order to reduce the table size. The default is 1826 for 5 years, however, the export will not take place if this property and ''archive_ShopCustomerMail_max_count'' are not set. Min. accepted value: 10 |
| archive_ShopCustomerMail_max_count | 10000 | ^[1-9]([0-9]+)$ | Maximum Number of entries in table "ShopCustomerMailTransmissionDO" to be exported per run of the Quartz job "ShopCustomerMailTransmissionArchive". The default is 10000, however, the export will not take place if this property and ''archive_ShopCustomerMail_min_age'' are not set. Min. accepted value: 10 |
| delete_ShopCustomerMail_min_age | 2190 | ^[1-9]([0-9]+)$ | The number of days after which the entries in table "ShopCustomerMailTransmissionDO" will definitely be deleted in order to reduce the table size. (Quartz job"ShopCustomerMailTransmissionArchive") The default is 2190 for 6 years, however, the deletion will not take place if this property is not set. |