LightArmy Ebooks: What kind of contents the help file is ?

There are five files to render help: contents, index, keywords, name and overview.
You will access the contents using context id like this: context_id=<root help>.ManifestProcessMaint.Queen.email_autoresponse. Here are as that examples:

contents:


<p><font face="Verdana" size="2">
<p>
<img src="help::this.figures.help-s.png"/>
<h3>Email Autoresponder Manifest Process Maintenance Page</h3>
</p>
<p>
 <a id="Purpose"><b>Purpose</b></a><br>
 Maintain an email autoresponder manifest process.
 <br><br> 
The Email Autoresponse takes an incoming email message 
from a mailbox, and sends the response using the 
recogniser patern to determine the response to 'replyto'
/or sender.
<br><br>
As with all Lightant queenProcess, you are required to  
have a unique 'process.name' value. The 'process.type' 
value corresponds to the processor source to load from 
the processes directory. If this configuration file is 
designed to load the code in processes/foo/bar.php, the 
entry for 'process.type' should be foo_bar.
</p>
<p>
 <a id="Operations"><b>Operations</b></a><br>
 <ol type="I">
 <li>Create<br>
 <br>
 <br>
  <ol>
   <li>Screenshots<br>
   <br>
   <img src="help::this.figures.hlp_en_queenmanifestmaint_new__email_autoresponse.png"/>
   </li>
   <br>
   <li>Fields<br>
   <br>
   <ol type="a">
    <li>Write manifest as explain in <b>Manifest Contents</b> below.<br>
    </li>
    <br>
   </ol>
   </li>
  </ol>
 </li>
 <li>Update<br>
 <br>
 <br>
  <ol>
   <li>Screenshots<br>
   <br>
   <img src="help::this.figures.hlp_en_queenmanifestmaint_update__email_autoresponse.png"/>
   </li>
   <br>
   <li>Fields<br>
   <br>
   <ol type="a">
    <li>Write manifest as explain in <b>Manifest Contents</b> below.<br>
    </li>
    <br>
   </ol>
   </li>
  </ol>
 </li>
 <li>Delete<br>
 <br>
 <br>
  <ol>
   <li>Screenshots<br>
   <br>
   <img src="help::this.figures.hlp_en_queenmanifestmaint_update__email_autoresponse.png"/>
   </li>
   <br>
   <li>Fields<br>
   <br>
   <ol type="a">
   </ol>
   </li>
  </ol>
 </li>
 <li>Cancel<br>
 <br>
 <br>
  <ol>
   <li>Screenshots<br>
   <br>
   <img src="help::this.figures.hlp_en_queenmanifestmaint_update__email_autoresponse.png"/>
   </li>
   <br>
   <li>Fields<br>
   <br>
   <ol type="a">
   </ol>
   </li>
  </ol>
 </li>
 </ol>
</p>
<p>
 <a id="ManifestContents"><b>Manifest Contents</b></a><br>
 <ol>
  <li>Structure<br>
   <fieldset style="border: 1px dotted ;" >
 <PRE>
 &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
 &lt;configuration id=&quot;email_autoresponse&quot;&gt;
  &lt;section name=&quot;core&quot;&gt;
   &lt;!-- Process Configuration--&gt;
   &lt;config name=&quot;process&quot;&gt;
    &lt;config name=&quot;type&quot;&gt;email_autoresponse&lt;/config&gt;
    &lt;config name=&quot;name&quot;&gt;&lt;/config&gt;
    &lt;config name=&quot;description&quot;&gt;&lt;/config&gt;
    &lt;config name=&quot;start&quot;&gt;&lt;/config&gt;
    &lt;config name=&quot;end&quot;&gt;&lt;/config&gt;
   &lt;/config&gt;
   
   &lt;!--Mail Connection--&gt;
   &lt;config name=&quot;connections&quot;&gt;
    &lt;config name=&quot;mail&quot;&gt;
     &lt;config name=&quot;type&quot;&gt;Mail&lt;/config&gt;
     &lt;config name=&quot;host&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;user&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;password&quot;&gt;&lt;/config&gt;
     
     &lt;config name=&quot;service&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;authuser&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;crypto&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;anonymous&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;debug&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;secure&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;norsh&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;notls&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;readonly&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;validate-cert&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;novalidate-cert&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;options&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;n_retries&quot;&gt;&lt;/config&gt;
     
     &lt;config name=&quot;port&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;mailboxes&quot;&gt;
      &lt;config name=&quot;source&quot;&gt;&lt;/config&gt;
      &lt;config name=&quot;handled&quot;&gt;&lt;/config&gt;
      &lt;config name=&quot;unhandled&quot;&gt;&lt;/config&gt;
     &lt;/config&gt;
    &lt;/config&gt;
   &lt;/config&gt;
   
   &lt;config name=&quot;testcode&quot;&gt;&lt;/config&gt;
   
   &lt;!--Recognizer--&gt;
   &lt;config name=&quot;recognizer&quot;&gt;
    &lt;config name=&quot;minLetters&quot;&gt;&lt;/config&gt;
    &lt;config name=&quot;maxLetters&quot;&gt;&lt;/config&gt;
    &lt;config name=&quot;brain&quot;&gt;
     #THE BRAIN CONFIGURATION#
    &lt;/config&gt;
   &lt;/config&gt;
   
   &lt;!--Responder--&gt;
   &lt;config name=&quot;responder&quot;&gt;
    &lt;config name=&quot;default&quot;&gt;&lt;/config&gt;
    &lt;config name=&quot;directory&quot;&gt;&lt;/config&gt;
    &lt;config name=&quot;names&quot;&gt;
     &lt;config name=&quot;{RESPONDER NAME}&quot;&gt;
      &lt;config name=&quot;type&quot;&gt;&lt;&gt;
      #THE RESPONDER CONFIGURATION#
     &lt;/config&gt;
     &lt;config name=&quot;{RESPONDER NAME}&quot;&gt;
      &lt;config name=&quot;type&quot;&gt;&lt;&gt;
      #THE RESPONDER CONFIGURATION#
     &lt;/config&gt;
    &lt;/config&gt;
   &lt;/config&gt;
   
   &lt;!--Control--&gt;
   &lt;config name=&quot;control&quot;&gt;
    &lt;config name=&quot;sleepingduration&quot;&gt;&lt;/config&gt;
    &lt;config name=&quot;errorsthreshold&quot;&gt;&lt;/config&gt;
   &lt;/config&gt;
   
   &lt;!--Response--&gt;
   &lt;config name=&quot;response&quot;&gt;
    &lt;config name=&quot;to&quot;&gt;&lt;/config&gt;
    &lt;config name=&quot;from&quot;&gt;&lt;/config&gt;
    &lt;config name=&quot;replyto&quot;&gt;&lt;/config&gt;
    &lt;config name=&quot;rpath&quot;&gt;&lt;/config&gt;
    &lt;config name=&quot;cc&quot;&gt;&lt;/config&gt;
    &lt;config name=&quot;bcc&quot;&gt;&lt;/config&gt;
    &lt;config name=&quot;subject&quot;&gt;&lt;/config&gt;
   &lt;/config&gt;
   
  &lt;/section&gt;
 &lt;/configuration&gt;
 </PRE>
   </fieldset>
  </li>
  <li>Parameters<br>
  <ol type="a">
   <li>id<br>
   The identity of manifest.
   </li>
   <li>core.process.type<br>
   The process type of manifest. Type is email_autoresponse.
   </li>
   <li>core.process.name<br>
   The name given to this manifest.
   </li>
   <li>core.process.description<br>
   The additional information to manifest.
   </li>
   <li>core.process.start<br>
   The first date (time) the process will be executed.
   </li>
   <li>core.process.end<br>
   The last date (time) the process will be executed.
   </li>
   <li>core.connections.mail.type<br>
   The type of connection. The value should be and always: MAIL.
   </li>
   <li>core.connections.mail.host<br>
   The mail server host name or IP address.
   </li>
   <li>core.connections.mail.user<br>
   The account/ user of mail server.
   </li>
   <li>core.connections.mail.password<br>
   The password of account/user of mail server.
   </li>
   <li>core.connections.mail.service<br>
   The type of service of this mail connection.
   </li>
   <li>core.connections.mail.authuser<br>
   The remote authentication user.
   </li>
   <li>core.connections.mail.crypto<br>
   The crypto type of connection:ssl,tls,null.
   </li>
   <li>core.connections.mail.anonymous<br>
   For anonymous connection mode.
   </li>
   <li>core.connections.mail.debug<br>
   Activate debuging.
   </li>
   <li>core.connections.mail.secure<br>
   Do not transmit a plaintext password.
   </li>
   <li>core.connections.mail.norsh<br>
   Do not use rsh or ssh to establish a preauthenticated.
   </li>
   <li>core.connections.mail.notls<br>
   Do not do start-tls.
   </li>
   <li>core.connections.mail.readonly<br>
   Request read-only mailbox open.
   </li>
   <li>core.connections.mail.validate-cert<br>
   Validate certificates from tls/ssl server.
   </li>
   <li>core.connections.mail.novalidate-cert<br>
   Do not validate certificates from tls/ssl server.
   </li>
   <li>core.connections.mail.options<br>
   Options of connection.
   </li>
   <li>core.connections.mail.n_retries<br>
   Number of maximum connect attempts.
   </li>
   <li>core.connections.mail.port<br>
   Port to your mail server.
   </li>
   <li>core.connections.mail.mailboxes.source<br>
   Mailbox name.
   </li>
   <li>core.connections.mail.mailboxes.handled<br>
   Mailbox name for handled email.
   </li>
   <li>core.connections.mail.mailboxes.unhandled<br>
   Mailbox name for unhandled email.
   </li>
   <li>core.testcode<br>
   The test code of email contents.
   </li>
   <li>core.recognizer.minLetters<br>
   The anagram minimum length.
   </li>
   <li>core.recognizer.maxLetters<br>
   The anagram maximum length.
   </li>
   <li>core.recognizer.brain<br>
   The brain configuration.
   </li>
   <li>core.responder.default<br>
   The default response.
   </li>
   <li>core.responder.directory<br>
   The directory location of responder.
   </li>
   <li>core.responder.names<br>
   The responder configuration.
   </li>
   <li>core.control.sleepingduration<br>
   The sleeping time on subsequence errors.
   </li>
   <li>core.control.errorsthreshold<br>
   The errors threshold for sleeping stage.
   </li>
   <li>core.response.to<br>
   The destination of email.
   </li>
   <li>core.response.from<br>
   The source of email.
   </li>
   <li>core.response.replyto<br>
   The destination of reply.
   </li>
   <li>core.response.rpath<br>
   The return path on error.
   </li>
   <li>core.response.cc<br>
   The cc of email.
   </li>
   <li>core.response.bcc<br>
   The bcc of email.
   </li>
   <li>core.response.subject<br>
   The subject of email.
   </li>
  </ol>
  </li>
  <li>Example<br>
   <fieldset style="border: 1px dotted ;" >
 <PRE>
 &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
 &lt;configuration id=&quot;email_autoresponse&quot;&gt;
  &lt;section name=&quot;core&quot;&gt;
   &lt;!-- Process Configuration--&gt;
   &lt;config name=&quot;process&quot;&gt;
    &lt;config name=&quot;type&quot;&gt;email_autoresponse&lt;/config&gt;
    &lt;config name=&quot;name&quot;&gt;CIISONLINE_COM_AUTORESPONSE&lt;/config&gt;
    &lt;config name=&quot;start&quot;&gt;&lt;/config&gt;
    &lt;config name=&quot;end&quot;&gt;&lt;/config&gt;
   &lt;/config&gt;
   
   &lt;!--Mail Connection--&gt;
   &lt;config name=&quot;connections&quot;&gt;
    &lt;config name=&quot;mail&quot;&gt;
     &lt;config name=&quot;type&quot;&gt;Mail&lt;/config&gt;
     &lt;config name=&quot;host&quot;&gt;imap.gmail.com&lt;/config&gt;
     &lt;config name=&quot;user&quot;&gt;ciisonline.com&lt;/config&gt;
     &lt;config name=&quot;password&quot;&gt;&lt;/config&gt;
     &lt;config name=&quot;crypto&quot;&gt;ssl&lt;/config&gt;
     &lt;config name=&quot;port&quot;&gt;993&lt;/config&gt;
     &lt;config name=&quot;service&quot;&gt;imap&lt;/config&gt;
     
     &lt;config name=&quot;mailboxes&quot;&gt;
      &lt;config name=&quot;source&quot;&gt;inbox&lt;/config&gt;
      &lt;config name=&quot;handled&quot;&gt;handled&lt;/config&gt;
      &lt;config name=&quot;unhandled&quot;&gt;unhandled&lt;/config&gt;
     &lt;/config&gt;
    &lt;/config&gt;
   &lt;/config&gt;
   
   &lt;!--Recognizer--&gt;
   &lt;config name=&quot;recognizer&quot;&gt;
    &lt;config name=&quot;minLetters&quot;&gt;5&lt;/config&gt;
    &lt;config name=&quot;maxLetters&quot;&gt;7&lt;/config&gt;
    &lt;config name=&quot;brain&quot;&gt;
     &lt;config name=&quot;type&quot;&gt;TextBrain&lt;/config&gt;
     &lt;config name=&quot;fact&quot;&gt;Application/Email/Recognizers/responder.fact&lt;/config&gt;
     &lt;config name=&quot;knowledge&quot;&gt;Application/Email/Recognizers/responder.knowledge&lt;/config&gt;
    &lt;/config&gt;
   &lt;/config&gt;
   
   &lt;!--Responder--&gt;
   &lt;config name=&quot;responder&quot;&gt;
    &lt;config name=&quot;default&quot;&gt;Default&lt;/config&gt;
    &lt;config name=&quot;directory&quot;&gt;Application/Email/Responder/&lt;/config&gt;
    &lt;config name=&quot;names&quot;&gt;
     &lt;config name=&quot;Default&quot;&gt;
      &lt;!--#THE RESPONDER CONFIGURATION#--&gt;
      &lt;config name=&quot;type&quot;&gt;Application_Email_Responder_Body&lt;/config&gt;
      &lt;config name=&quot;use_template&quot;&gt;1&lt;/config&gt;
      &lt;config name=&quot;mail&quot;&gt;
       &lt;config name=&quot;from&quot;&gt;ciisonline.net@gmail.com&lt;/config&gt;
       &lt;config name=&quot;fromname&quot;&gt;CIISONLINE NET&lt;/config&gt;
       &lt;config name=&quot;replyto&quot;&gt;ciisonline.net@gmail.com&lt;/config&gt;
       &lt;config name=&quot;replytoname&quot;&gt;CIISONLINE NET&lt;/config&gt;
       &lt;config name=&quot;rpath&quot;&gt;ciisonline.net@gmail.com&lt;/config&gt;
       &lt;config name=&quot;body&quot; xml:space=&quot;preserve&quot;&gt;
 Hello {toname},

 Thanks You
 {fromname}
       &lt;/config&gt;
      &lt;/config&gt;
     &lt;/config&gt;
     &lt;config name=&quot;OrderForm&quot;&gt;
      &lt;!--#THE RESPONDER CONFIGURATION#--&gt;
      &lt;config name=&quot;type&quot;&gt;Application_Email_Responder_Body&lt;/config&gt;
      &lt;config name=&quot;use_template&quot;&gt;1&lt;/config&gt;
      &lt;config name=&quot;mail&quot;&gt;
       &lt;config name=&quot;from&quot;&gt;ciisonline.net@gmail.com&lt;/config&gt;
       &lt;config name=&quot;fromname&quot;&gt;CIISONLINE NET&lt;/config&gt;
       &lt;config name=&quot;replyto&quot;&gt;ciisonline.net@gmail.com&lt;/config&gt;
       &lt;config name=&quot;replytoname&quot;&gt;CIISONLINE NET&lt;/config&gt;
       &lt;config name=&quot;rpath&quot;&gt;ciisonline.net@gmail.com&lt;/config&gt;
       &lt;config name=&quot;body&quot;&gt;OrderForm&lt;/config&gt;
       &lt;config name=&quot;bodyfile&quot;&gt;&lt;/config&gt;
       &lt;config name=&quot;altbody&quot;&gt;&lt;/config&gt;
       &lt;config name=&quot;altbodyfile&quot;&gt;&lt;/config&gt;
      &lt;/config&gt;
     &lt;/config&gt;
     &lt;config name=&quot;ProductInfo&quot;&gt;
      &lt;!--#THE RESPONDER CONFIGURATION#--&gt;
      &lt;config name=&quot;type&quot;&gt;Application_Email_Responder_Mime&lt;/config&gt;
      &lt;config name=&quot;use_template&quot;&gt;1&lt;/config&gt;
      &lt;config name=&quot;mail&quot;&gt;
       &lt;config name=&quot;from&quot;&gt;ciisonline.net@gmail.com&lt;/config&gt;
       &lt;config name=&quot;fromname&quot;&gt;CIISONLINE NET&lt;/config&gt;
       &lt;config name=&quot;replyto&quot;&gt;ciisonline.net@gmail.com&lt;/config&gt;
       &lt;config name=&quot;replytoname&quot;&gt;CIISONLINE NET&lt;/config&gt;
       &lt;config name=&quot;rpath&quot;&gt;ciisonline.net@gmail.com&lt;/config&gt;
       &lt;!--&lt;config name=&quot;mime&quot;&gt;&lt;/config&gt;--&gt;
       &lt;config name=&quot;mimefile&quot;&gt;Application/Email/Mimes/html.eml&lt;/config&gt;
      &lt;/config&gt;
     &lt;/config&gt;
     &lt;config name=&quot;ProductCatalog&quot;&gt;
      &lt;!--#THE RESPONDER CONFIGURATION#--&gt;
      &lt;config name=&quot;type&quot;&gt;Application_Email_Responder_Mime&lt;/config&gt;
      &lt;config name=&quot;use_template&quot;&gt;1&lt;/config&gt;
      &lt;config name=&quot;mail&quot;&gt;
       &lt;config name=&quot;from&quot;&gt;ciisonline.net@gmail.com&lt;/config&gt;
       &lt;config name=&quot;fromname&quot;&gt;CIISONLINE NET&lt;/config&gt;
       &lt;config name=&quot;replyto&quot;&gt;ciisonline.net@gmail.com&lt;/config&gt;
       &lt;config name=&quot;replytoname&quot;&gt;CIISONLINE NET&lt;/config&gt;
       &lt;config name=&quot;rpath&quot;&gt;ciisonline.net@gmail.com&lt;/config&gt;
       &lt;!--&lt;config name=&quot;mime&quot;&gt;&lt;/config&gt;--&gt;
       &lt;config name=&quot;mimefile&quot;&gt;Application/Email/Mimes/message.eml&lt;/config&gt;
      &lt;/config&gt;
     &lt;/config&gt;
    &lt;/config&gt;
   &lt;/config&gt;
   
   &lt;!--Control--&gt;
   &lt;config name=&quot;control&quot;&gt;
    &lt;config name=&quot;sleepingduration&quot;&gt;1000&lt;/config&gt;
    &lt;config name=&quot;errorsthreshold&quot;&gt;10&lt;/config&gt;
   &lt;/config&gt;
   
   &lt;!--Response--&gt;
  &lt;/section&gt;
 &lt;/configuration&gt;
 </PRE>
   </fieldset>
  </li>
 </ol>
</p>
<p>
 <a id="RelatedPages"><b>Related Pages</b></a><br>
 <ol>
  <li><a href="help::this.ManifestProcessesList">Manifest Processes List Page</a><br>
  Display list of Queen manifest processes.
  </li>
 </ol>
</p>
<p>
 <a id="RelatedTopics"><b>Related Topics</b></a><br>
 <ol>
  <li><a href="help::LIGHTARMY-UserGuide.Concepts.General.Manifest">Manifest (Concept)</a></li>
  <li><a href="help::LIGHTARMY-UserGuide.Concepts.General.ServiceBus">Service Bus (Concept)</a></li>
  <li><a href="help::LIGHTARMY-UserGuide.Concepts.General.Capability">Capability (Concept)</a></li>
  <li><a href="help::LIGHTARMY-UserGuide.Concepts.General.AutomationPlatform">Automation Platform (Concept)</a></li>
  <li><a href="help::LIGHTARMY-UserGuide.Concepts.General.ProcessPlatform">Process Platform (Concept)</a></li>
  <li><a href="help::LIGHTARMY-UserGuide.Concepts.Application.Queen">Queen (Concept)</a></li>
  <li><a href="help::LIGHTARMY-UserGuide.Concepts.Application.Nest">Nest (Concept)</a></li>
 </ol>
</p>
<p>
 <a id="Notes"><b>Notes</b></a><br>
 <ol>
 </ol>
</p>
</font></p>

index:


Email Autoresponder Manifest Process Maintenance
Email Autoresponder Manifest Process Maintenance Page

keywords:


Email Autoresponder Manifest Process Maintenance
Email Autoresponder Manifest Process Maintenance Page

name:


Email Autoresponder Manifest Process Maintenance Page

overview:



<p><font face="Verdana" size="2">
<p>
<h3>Email Autoresponder Manifest Process Maintenance Page</h3>
</p>
<p>
 <a id="Purpose"><b>Purpose</b></a><br>
 Maintain an email autoresponder manifest process.
 <br><br> 
The Email Autoresponse takes an incoming email message 
from a mailbox, and sends the response using the 
recogniser patern to determine the response to 'replyto'
/or sender.
<br><br>
As with all Lightant queenProcess, you are required to  
have a unique 'process.name' value. The 'process.type' 
value corresponds to the processor source to load from 
the processes directory. If this configuration file is 
designed to load the code in processes/foo/bar.php, the 
entry for 'process.type' should be foo_bar.
</p>

LightArmy Ebooks

What kind of contents the help file is ?

No comments:

Post a Comment

Followers

Awards

CIISONLINE

About Me

PHP LightArmy

Download

Blog Archive