Business Rule settings
Note that the Business Rule settings are displayed only to users with the system Super Admin role.
| Property | JSON | Description |
|---|---|---|
| Toolbar |
|
|
| The remove icon deletes the Business Rule and all settings after you confirm the deletion. | ||
| The JSON is the exact representation of the deletion UI settings. The entire business rule code overview may be helpful for validating uses. By default, the Business Rule is enabled. The Business Rule description helps other administrators understand the exact behavior of the Business Rule. If y,ou are preparing a Business Rule, ensure it is disabled until you want it to execute.ID your Business Rule or duplicate an existing Business Rule with adjusted settings. | ||
| General | ||
| Name (translated) |
names | The display name for the Business Rule per UI language. The language property "x-default" is the fallback language and uses the customer's default language setting. |
| ID | id | The ID of the Business Rule cannot be changed once it has been initially set. There are no special requirements, except for uniqueness among the rules. We recommend leaving the ID as rewritten from Fotoware Alto based on your input for Name. |
| Enabled | isEnabled |
Do you want to run it now? By default, the Business Rule is enabled; if you are preparing a Business Rule, ensure it is disabled until you want it to execute. Fotoware Alto executes enabled Business Rules directly for the items that fulfill the condition. |
| Description | description |
The Business Rule description helps other administrators understand the exact behavior of the Business Rule. Describe the and affectsgoal and setup here, e.g. Looks for a Product Code in the Filename (needs to be at the beginning and 14 characters, needs to start with either F-, G-, or V-). If you find a product code, then assign the product as a tag. |
| Trigger Points | triggerPoint |
The user action (action) on a specific item (documentType) in Fotoware Alto that triggers the Business Rule, affecting a defined index. Multiple trigger points are allowed. If there is a duplicate trigger point, the action will only be carried out once. When should your Business Rule run? When a Content or List item is created, updated, or on a schedule. Furthermore, you can select that your Business Rule runs when a Content Item is replaced. |
| Execution Scope | executionScope |
The Execution Scope is the data the Business Rule uses to validate conditions and execute actions, i.e., the underlying index. The area in which the Business Rule will work. The Execution Scope MainDoc is the Elasticsearch document (similar to a database table) that contains all information about an item, including types, permissions, actions, and other details, such as the item's CV. Content is Content Items visible in the Content Browser (images, videos, aka File Items) and also items without a file (aka Virtual Items).Business Rule Trigger Update means the modification of a Content Item through metadata or content edits in a single edit, batch edit, or through Excel or API. The Execution Scope SearchDoc is the Elasticsearch document (similar to a database table) that stores information about an item, optimized for use in the Fotoware Alto search. This includes information set to "include in search". The SearchDoc is optimized in several ways, including storing nested and hierarchical information in a flat structure (this means that value 1 doesn't know it is the mother of value 2), which allows for faster searching. Content is Content Items visible in the Content Browser (images, videos, aka File Items) and also items without a file (aka Virtual Items). |
| Document Type | documentType | The document types in Fotoware Alto are entities, different types of digital works (objects). Business Rule Trigger Update means modifying a Content Item via metadata or content edits in a single edit, batch edit, or via Excel or an API. Fotoware Alto knows the documentTypes "Content", "ListItem", "Schema", "User", "ContentPermissionSet", "Owner". Content are Content Items visible in the Content Browser (images, videos aka File Items) and also items without a file (aka Virtual Items). |
| Action | action |
The Business Rule Trigger Create means the creation of a Content Item through upload (File Item) or creation (Virtual Item) in the Content Browser. Business Rule Trigger Update means the modification of a Content Item through metadata or content edits in single edit, batch edit or through Excel or API. This action does not cover file replacements! Business Rule Trigger Replace File means the replacement of a file item using the replace file functionality in the toolbar of the Content Item or via API. This action does not cover virtual content updates! The Business Rule Trigger Schedule allows customers to create a Schedule for how often/when a business rule should be run. Examples are: daily, weekly. |
| Condition | ||
| Add | condition |
Add one condition for items, so the Business Rule considers them and performs the actions. This one condition can also be a group of AND/OR-connected individual conditions. This will create a kind of collection of items and their values. Select AND/OR first, to define multiple conditions. Every condition has a name and a description field, which you can fill out to make the business rule easier for other users to understand. |
| Transformations | ||
| Add | transformationGroups |
Add one or multiple Transformation Groups. Transformation Groups are conversions of values. Example: You have a tagbox "products" on a Content Item, linked to the List "Product" which has the following additional attributes (which are again nested):
A Transformation Group uses e.g., the fieldpath as input: layer.tagbox-products and converts the whole structure into individual values:
Those can then be further transformed (in the following Transformation Group) or used in action:
Every transformation has a name and a description field, which you can fill out to make the business rule easier for other users to understand. |
| Actions | ||
| Add | actions |
Perform the actions on the collection of items that fulfilled the condition. Every action has a name and a description field, which you can fill out to make the business rule easier for other users to understand. |