Configuration - Defining rules
Rulesets are defined in the administration area of 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 does not match, it cannot be applied or executed. An error message appears.
Information: Each ruleset has a 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.
- 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.xml
files must exist in the installation files. - The import data set including the rules for ELO Automation Services will be imported as a folder into the Administration area of 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, e.g. in:
<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: Once you have saved it, the new ruleset is stored in the Rules folder of the repository. 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. The steps to be executed are described in the Rule box (blue). It contains information about what to do with each object found. 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, invalidRulesetBasic ruleset settings
Name: The name of the ruleset 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, maximumAdvanced search
From filing date ... to: You can narrow down the search here by selecting a specific filing date or a filing period.
Search, filing dateFrom date ... to: You can narrow down the search here by selecting a specific date or period.
Search, dateTarget forms for rules selection
Add target form: This is where you can select the keywording form for the target folder that moved documents are filed to.
Keywording form, target formInterval control
In the Interval control area, you define how often you want 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.
EndIncludes
Add Include library: In the Add Include library field, you can add any script libraries that you need to the ELOas rule.
Rules
This rule will be applied to entries found in the repository. This is where you define settings such as where documents are moved to.
Add (green plus icon): 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.
ConditionIn this menu, you can select a script, e.g. to move files to the file system. Scripts are filed to the administration area of ELO Automation Services in the repository.
JavaScriptPlease note: The configuration in your repository can differ from the illustrations shown here.
Filing path: Specify where you want to file the document 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 the basic settings for error handling in the Global Error Rule area. 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: This option enables you to define individual index fields that you can assign a specific character string on filing.
Index