Business Rule Settings
Please note the Business Rule settings are only displayed to users that have the system Super Admins role.
Property | JSON | Description |
Toolbar | ||
 | The remove icon deletes the Business Rule and all settings after you confirm your desire to delete. | |
 | The JSON is the exact representation of the UI settings. The whole business rule code overview may be helpful for validation of your Business Rule or duplicating an existing Business Rule with adjusted settings. | |
General | ||
Name | names | The display name for the Business Rule per UI language. The language property "x-default" is the fallback language and used the default language setting of the customer. |
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 amongst rules. We recommend leaving the ID as rewritten from Picturepark based on your input for Name. |
Enabled | isEnabled | Do you want to run it now? On creation, the Business Rule is enabled by default, if you are preparing a Business Rule to ensure it is disabled until you want it to execute. Picturepark executes enabled Business Rules directly for the items that fulfill the condition. |
Description | description | The description of the Business Rule which helps other administrators to understand the exact behavior of the Business Rule. Describe goal and setup here e.g. Looks for a Product Code in the Filename (needs to be at the beginning and 14 char, 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 Picturepark 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 which the Business Rule will use for validating the conditions and executing the actions, which means the underlying index. The area which the Business Rule will work. The Execution Scope MainDoc, means the document (similar to a database table) in ElasticSearch that carries all information about an item e.g. types, permission, actions, like the CV of the item. The Execution Scope SearchDoc, means the document in ElasticSearch (similar to a database table) that carries information of an item which is optimized for the usage in the Picturepark search. This includes information set to "include in search". The SearchDoc is optimized in several ways, including saving nested and hierarchical information in a flat structure (this means that value 1 doesn't know that it is the mother of value 2, this allows for faster searching). |
Document Type | documentType | The document types in Picturepark are entities, different type of digital works (objects) you can have in Picturepark. Picturepark 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.
Every condition has a name and a description field which you can fill out to make the business rule easier to understand for other users. |
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 to understand for other users. |
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 to understand for other users. |
