Changes between Version 2 and Version 3 of Public/Docs/CAEConfigFile


Ignore:
Timestamp:
Dec 16, 2019, 3:24:24 PM (5 years ago)
Author:
Administrator
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • Public/Docs/CAEConfigFile

    v2 v3  
    11= CAE configuration file
    22Cinnamon Asynchronous Engine (CAE) is a flexible framework for asynchronous, server-based tasks. The functionality CAE should load and the exact behaviour are highly configurable. The configuration is maintained in a file {{{CinnamonAsynchronousEngine.config.xml}}} residing in CAE's program folder on the server.
     3
     4The following shows the content of a simple configuration file, referencing only Open Source plugins:
     5{{{
     6<config>
     7        <log enablefile="false" enableconsole="false">/opt/cae/log</log>
     8        <tasks>
     9                <task name="summary_writer" assembly="CinnamonAEResources" type="StandardTaskDefinitions.SummaryWriter">
     10      <custom_data>
     11        <!-- summary writer configuration-->
     12      </custom_data>
     13                </task>
     14                <task name="wf_task_dispatcher" assembly="WorkflowEngine" type="AETaskDefinitions.WFTaskDispatcher">
     15      <custom_data>
     16        <!-- summary writer configuration-->
     17      </custom_data>
     18                </task>
     19                <task name="wf_auto_task_runner" assembly="WorkflowEngine" type="AETaskDefinitions.WFAutoTaskRunner">
     20      <custom_data>
     21        <!-- summary writer configuration-->
     22      </custom_data>
     23                </task>
     24    <!-- other tasks -->
     25  </tasks>
     26
     27        <repository id="demo" name="demo">
     28                <username>cae</username>
     29    <server id="content" name="content">https:/my_server.cinnamon-hosting.de/cinnamon/cinnamon/legacy</server>
     30    <password>password</password>
     31    <thread_wait milliseconds="5000" />
     32
     33                <jobs active="false">
     34                        <tasks>
     35      </tasks>
     36                </jobs>
     37
     38                <objects active="true">
     39                        <query batch_size="100">
     40                                <BooleanQuery minimumNumberShouldMatch="1">
     41                                        <Clause occurs="should">
     42                                                <TermQuery fieldName="metadatachanged">true</TermQuery>
     43                                        </Clause>
     44                                        <Clause occurs="should">
     45                                                <TermQuery fieldName="contentchanged">true</TermQuery>
     46                                        </Clause>
     47                                </BooleanQuery>
     48                        </query>
     49                        <tasks>
     50                                <task name="summary_writer" />
     51        <task name="wf_task_dispatcher" />
     52                                <task name="wf_auto_task_runner" />
     53                        </tasks>
     54                </objects>
     55
     56                <folders active="false">
     57                        <query batch_size="100">
     58                                <TermQuery fieldName="metadatachanged">true</TermQuery>
     59                        </query>
     60                        <tasks>
     61                        </tasks>
     62                </folders>
     63        </repository>
     64</config>
     65}}}
     66
     67Inside the root element, there are three second-level elements:
     68* {{{log}}}, defining the logging behaviour.
     69* {{{tasks}}}, defining the task classes and their configurations (the configuration was replaced with a comment). The same class can be loaded multiple times with a different name.
     70* {{{repository}}}, defining the CAE login information and the task definitions to be applied.