Configuration - Defining rules
Rulesets are defined in the administration area of the ELO Automation Services.
ELOasELO Automation ServicesThe program executes rules at regular intervals to carry out defined tasks in the repository.
Rules are written in JavaScript and will be executed by the Indexserver at specified intervals.
Rule processing
1. The program first searches for objects in the repository that match the rule definition.
2. The rule is applied to all elements found in the repository.
Information: The setting for the documents to be searched is defined in the search fields.
3. If a rule is not applicable, it cannot be applied or executed. An error message appears.
Information: Each ruleset has a rule definition for error handling.
The defined rules are filed in the repository under Administration (Administration folder, Rules).
In brief
Verify the installation requirements before creating a new processing rule.
- The ELO Automation Services requires a filing path in the repository. Rules and configurations are stored here.
- The path <
¶Administration¶ELOas> is used by default for the configuration - as long as the settings were not modified. - ELO Automation Services also requires the child directories Rules, JavaScript and Translate.
- Both
config.xmlfiles must exist in the installation files. - The import data set including the rules for the ELO Automation Services will be imported into the repository to the Administration area. The folder is then available in the repository.
Configuration directory
If the configuration is stored in the predefined path, then no other path should be entered in the config.xml configuration file.
After installation, the config.xml file for the ELO Administration Console is available in the Tomcat Server configuration directory config, for example:
<installation folder>\config\as-<repository name>
Define new rule
A new ruleset is created in the left area of the program.
Rule, newRulesetSample ruleset
1. Enter the name for the new ruleset in the input field above the Add button (ELOas rule).
The ruleset is created.
Information: The newly created ruleset is stored in the Rules folder of the repository and will only be effective after saving. You can configure the rulesets in the Rules area.
Repository, rulesRule, global error ruleRuleGlobal error ruleInformation: A ruleset is made up of two rules sections. Steps to be executed are described in the second Rule box (blue). It contains information about what to do with each located object. In the Global Error Rule section (red), you can define what should happen when errors occur.
Please note: If a ruleset is invalid, it cannot be saved. The validity of a ruleset is verified when saving.
Ruleset, invalidRulesetRuleset settings
Name: The name of the processing rule that you entered when you created the rule is shown here. The name can be modified later.
NameSearch form: Select the search (keywording) form that will be used to find documents to be processed.
Search formIndex search: Select a group field to search across various index fields.
Index searchSearch term: Enter the character string you want to search for here. All documents in the repository which correspond to the defined rules will be selected in accordance with the rules and criteria defined in the wizard. The character string should be entered with quotation marks.
Search valueSearch max: Enter the maximum number of search results here.
Number of results, maximumSearch by filing date: You can narrow down the search here by selecting a specific filing date or a filing period.
Search, filing dateSearch by date: You can narrow down the search here by selecting a specific date or period.
Search, dateTarget forms: Here you can select the keywording form for the target folder, where moved documents should be filed.
Keywording form, target formInterval control: This is where you define how often to run ELO Automation Services.
Interval controlStart: This input box contains script code that will be executed before running the ruleset.
StartEnd: This box contains script code that will be executed after running the ruleset.
EndRuleset
This defined rule will be applied to entries found in the repository. Here you will define settings such as where documents are moved.
Add (green button): Add a new rule. The rules will be processed one after another.
Name: Enter a name for the rule.
NameCondition: The query rule is defined here to check the status of an index field, for example.
ConditionHere, a script can be opened with which you can move files to the file system, for example. Scripts will be filed in the repository in the Administration¶ELOas Base folder.
JavaScriptPlease note: The configuration in your repository can differ from what is displayed here.
Filing path: Determine the location that the document should be filed to. Use the button at the end of the input field to enter separator characters for paths in the ELO repository.
TargetTarget form: Select the keywording form for the document.
Keywording form, folderIndex fields: You can replace the content of index fields in the keywording of the target documents here.
Index field, replaceInformation: If you switch to the Script tab, you make all the rule settings using a script. If you do so, then you can no longer access the Rule tab.
Error handling
You can define error handling in general in the Global Error Rule section. This rule is executed when an error occurs in a general rule.
Global error ruleError ruleName: The name of the error handling routine is entered here.
NameCondition: A condition for an error rule is defined here.
ConditionFiling path: Set the filing path of the error report in the repository here.
TargetTarget form: Select the keywording form for the document with the error log.
Keywording form, error logError log, keywording formIndex fields: Here you can define individual index fields to be filled with a particular character string.
IndexSave: Click Save to store the settings for the current ruleset. Click Reset to delete existing entries in the current ruleset.
Ruleset
