Differences

This shows you the differences between two versions of the page.

--- en:software:tim:timer:signalbymailreply [2014/12/08 10:04]
felix.studnitz
+++ en:software:tim:timer:signalbymailreply [2021/07/01 09:52] (current)
@@ Line 1: / Line 1: @@
-FIXME **This page is not fully translated, yet. Please help completing the translation.**\\ //(remove this paragraph once the translation is finished)//
 ===== SignalByMailReply =====
 ==== Description ====
-This timer checks mail boxes for e-mails and forwards instances if there are any e-mails which have to be answered to generate further instances.
-The timer has to be used in combination with a [[en:software:tim:actionhandler:VariableDecisionHandler]] at a node if a decision has to be made after receiving a signal. The sender will be assigend as an actor to all tasks of the current node if the signal has been transmitted successfully.
-All incoming e-mails will be attached as a notice to a corresponding activity if they can be related to this activity. [[en:software:tim:timer:signalbymailreply#reasonregexp|RegExp]] will be used to select a number of successful e-mails as part of a variable (with the name given //Nodename//-answer_successful).
-\\ The corresponding process instance has to be referred to as <code>-----(${processInstanceId})-----</code> in the text of the e-mail.
-\\ The answer can either be written in the first line or optionally in the following form <code>-----[Reply: ]-----</code>.
-------
+This timer checks mail boxes for e-mails and forwards instances if there are any e-mails which have to be answered in order for further instances to be generated. The timer has to be used in combination with a [[:en:software:tim:actionhandler:variabledecisionhandler|VariableDecisionHandler]] at a node if a decision has to be made after receiving a signal. The sender will be assigned as an actor to all tasks of the current node once the signal has been transmitted successfully. Additionally, all incoming e-mails will be attached to activities as a note, so long as they are able to be correlated to a given activity. [[:en:software:tim:timer:signalbymailreply#reasonregexp|RegExp]] will be used to select a part of a successful e-mail, which will be brought into the process as a variable (with the name given //Nodename//-answer_successful).\\
+The corresponding process instance has to be referred to as
+<code>
+-----(${SYS.PROCESSINSTANCE_ID})-----
+</code>
+in the text of the e-mail.
+The answer can either be written in the first line or in the following form
+<code>
+-----[Reply: ]-----
+</code>
+.
-==== Web service name ====
-ProcessInstanceManager \\
-==== Web service method ====
-signalByMailReply \\
 ----
-==== Parameter ====
-email,password,port,host,limit,moveFolder,piIdRegExp,pDName,NodeNameRegExp,firstline,box,decisionRegExp,signalSuccessMail,processVariable,transitions
+==== Web service name ====
-\\ new version:
-\\ username,password,port,host,moveFolder,pDName,NodeNameRegExp,signalSuccessMail,processVariable,transitions,decisionRegExp
+<code>
+ProcessInstanceManager
+</code>
+==== Web service method ====
+<code>
+signalByMailReply
+</code>
+==== Parameter ====
+email, password, port, host, limit, moveFolder, piIdRegExp, pDName, NodeNameRegExp, firstline, box, decisionRegExp, signalSuccessMail, processVariable, transitions new version: username, password, port, host, moveFolder, pDName, NodeNameRegExp, signalSuccessMail, processVariable, transitions, decisionRegExp
 == 1. e-mail ==
-This entails the complete e-mail address which will be used to further generate e-mails.
+This entails the complete e-mail address which will be used to generate further e-mails.
 == 2. password ==
-This will show the password to access the desired e-mail account.
+This will show the password used to access the desired e-mail account.
 == 3. Port ==
-This provides information on the port corresponding to the e-mail address and the host. \\
-Frequently used ports are: \\
-//Pop// \\
-//Pop including encryption// \\
-//IMAP// \\
-//IMAP with encryption// \\
+This provides information on the port corresponding to the e-mail address and the host. Frequently used ports are: 110 //Pop// 995 //Pop including encryption// 143 //IMAP// 993 //IMAP with encryption//
 == 4. Host ==
-Host, e.g., pop3.gmail.com or imap.gmail.com (very often this will entail either pop or pop3 or IMAP. SMTP is by far less common!). An IMAP mail box will be necessary if moving all e-mails to other folders. The decision on what kind of protocol to use is depending on the mail box employed. If both common protocols are supported by the web sevice, then IMAP should be selected as preferred protocol.</note>
+Host, e.g., pop3.gmail.com or imap.gmail.com (very often this will entail either pop or pop3 or IMAP. SMTP is far less common!). An IMAP mail box will be necessary if moving all e-mails to other folders. The kind of protocol to use is dependent on the mail box being employed. If both common protocols are supported by the web service, then IMAP should be selected as preferred protocol.
+<note important>Important: If you want to move mails to other folders, an IMAP mailbox is required. Basically, the use of the protocol depends on the mailbox. If both protocols are supported, then IMAP is to be preferred.</note>
+<note important> It is highly recommended to use a separate mail box for each timer and process definition.</note>
 == 5. moveFolder ==
-This will not be a mandatory field if activated: This is the name of the folder to which successfully processed e-mails for signalling should be moved.
+This is not a mandatory field if activated. This is the name of the folder into which successfully processed e-mails for signalling should be moved.
 == 6. pDName ==
-Name belonging to the process definition.
+Name of the process definition.
 == 7. nodeNameRegExp ==
-NodeNameRegExp is a regular expression which provides clues on how to find the name of a node. The textual content of e-mails as well as corresponding subject headings will be scanned for this expression.
-\\ e.g., \+\+(.+)\+\+
+NodeNameRegExp is a regular expression which provides clues on how to find the name of a node. The textual content of e-mails as well as corresponding subject headings will be scanned for this expression. e.g., ++(.+)++ The element which has to be searched would be the nodeName included in brackets. For example:
-The element which has to be searched would be the nodeName included in brackets.
-For example: <code>++Wait++</code>
+<code>
+++Wait++
+</code>
 For further elaboration on this topic, please refer to the entry piIdRegExp.
 == 8. signalSuccessMail ==
-If the value is "true" then an e-mail will also be sent to the sender as a reply confirming the successful receipt of a signal.
-The reply can be configurated within the process by using variables. Please refer to the section provided [[en:software:tim:timer:signalbymailreply#variablen|below]] for further information on this topic.
+If the value is "true" then an e-mail will also be sent to the sender as a reply confirming the successful receipt of a signal. The reply can be configured within the process by using variables. Please refer to the section provided [[:en:software:tim:timer:signalbymailreply#variablen|below]] for further information on this topic.
 == 9. processVariable ==
-The value of a process variable will be set to the selected transition which then enables the [[en:software:tim:actionhandler:VariableDecisionHandler]] at the XOR-Gateway to make a decision.
+The value of a process variable will be set to the selected transition which then enables the [[:en:software:tim:actionhandler:variabledecisionhandler|VariableDecisionHandler]] at the XOR-Gateway to make a decision.
 == 10. leavingTransitions ==
-How will the correct pathway for the process be found if after the current activity several other activies might also follow?
-Transitions will be included in the timer as parameters by mapping which exact terms are meant to be detected by this transition. At least one transition has to work properly which in turn means that at least one of the correct terms has to be included in the text of an e-mail.
-For example:
-Approval:ok-O.K.-okay-yes-y-to-approve-approval-accepting-accept-adopting-all-right-alright-agreed-agreeing;rejected-rejecting:-not-okay-not-ok-not-O.K.-no-never-unacceptable
-The transitions according to this node are: approval and rejection
+How will the correct pathway for the process be found if multiple options exist after the current activity? Transitions will be included in the timer as parameters by mapping which exact terms are meant to be detected by this transition. At least one transition has to work properly, which in turn means that at least one of the correct terms has to be included in the text of an e-mail. For example: Approval:ok-O.K.-okay-yes-y-to-approve-approval-accepting-accept-adopting-all-right-alright-agreed-agreeing;rejected-rejecting:-not-okay-not-ok-not-O.K.-no-never-unacceptable
-To signal an approval a response to the e-mail might entail ok, okay, O.K. etc. Alternatively, to signal a rejection words would be used like "not okay", no, never etc.
+The transitions according to this node are: approval and rejection To signal an approval a response to the e-mail might entail ok, okay, O.K. etc. Alternatively, to signal a rejection words would be used like "not okay", no, never etc.
 == 11. reasonRegExp ==
-The decision contained in the e-mail which has signaled the process should be saved to be available at a later stage of the process. At this point it can be determined what terms should be used by searching the text of the e-mail. If the decision is meant to provide a result extending over several rows the RegExp has to use the ending '?s', for example (.*?)Replies:?s
-------
+The decision contained in the e-mail which signals that the process should be saved for access at a later stage of the process. At this point the terms should be used can be determined by searching the text of the e-mail. If the decision is meant to provide a result extending over several rows the RegExp has to use the ending '?s', for example (.*?)Replies:?s
+----
 === Variables ===
-The replies to invalid messages can be setup either by using a variable or the file loom.properties:
+The replies to invalid messages can be setup either by using a variable or the file loom.properties:\\
-\\ //no-tim-user-found-for-signal-by-mail-reply
+//no-tim-user-found-for-signal-by-mail-reply\\
-\\ user-not-actor-for-signal-by-mail-reply
+user-not-actor-for-signal-by-mail-reply\\
-\\ found-no-transition-for-signal-by-mail-reply
+found-no-transition-for-signal-by-mail-reply\\
-\\ found-no-node-for-signal-by-mail-reply
+found-no-node-for-signal-by-mail-reply\\
-\\ signal-done-for-signal-by-mail-reply
+signal-done-for-signal-by-mail-reply\\
-\\ found-no-processinstance-for-signal-by-mail-reply// Only the configuration using loom.properties would be possible in this case.
+found-no-process-instance-for-signal-by-mail-////reply//Only the configuration using loom.properties would be possible in this case.\\
-\\ The correct answer has to be configurated in the following way:
+The correct answer has to be configured in the following way:\\
-\\ //signal-successful-signal-by-mail-reply//
+//signal-successful-signal-by-mail-reply// \\
 \\
-\\
+The name of the folder which has to be accessed can also be configured by using loom.properties via //inbox-name-signal-by-mail-reply//.\\
-The name of the folder which has to be accessed can also be configurated by using loom.properties via //inbox-name-signal-by-mail-reply//.
+\\
-\\
-\\
 > Attention!
 >> Depending on the exact stage of the procedure the following variables can be implemented:
 >> //emailFrom//, This indicates the sender
->> //userNameLast//, This entry shows the surname of the T!M user
+>> //userNameLast//, This entry shows the surname of the TIM user
->> //userNameFirst//, This variable represents the given name of the current T!M user
+>> //userNameFirst//, This variable represents the given name of the current TIM user
->> //nodeName//, The name of the node which should be signalled is provided in this section
+>> //nodeName//, The name of the node that should be signaled is provided in this section
 >> //nodeEndDate//, This displays the date when this node was terminated. This variable is meant to be used only after termination of a node when trying to signal
 >> //nodeEndTime//, This indicates the point in time when this node was terminated. This variable is intended to be used only after termination of a node when trying to signal
->> //lastUserNameLast//, This shows the surname of the user who terminated the node. This is supposed to be used only when trying to signal afer termination of a node
+>> //lastUserNameLast//, This shows the surname of the user who terminated the node. This is supposed to be used only when trying to signal after termination of a node
->> //lastUserNameFirst//, This displays the given name of the user who terminated the node. Only after termination of a node is this meant to be used for signalling
+>> //lastUserNameFirst//, This displays the given name of the user who terminated the node. This is this meant to be used for signalling only after the termination of a node
-\\
+After sending the signal, the following variables are also available: //nodename//-lastActor //nodename//-signalDateTime (Format: "yyyy-MM-dd HH:mm:ss")
-After sending the signal the following variables are also available:
-//nodename//-lastActor
-//nodename//-signalDateTime (Format: "yyyy-MM-dd HH:mm:ss")
 ----
 ==== Procedure ====
-In a first step the mailbox specified by the timer will be opened to receive incoming e-mails.
+First, the mailbox specified by the timer will be opened to receive incoming e-mails. As a default setting the folder //Inbox// will be retrieved. This setting can be changed by configuring loom.properties with the parameter //inbox-name-signal-by-mail-reply//.\\
-As a default setting the folder //Inbox// will be retrieved. This setting can be changed by configurating loom.properties with the parameter //inbox-name-signal-by-mail-reply//.
+In the second step the first five e-mails to be found will be processed. This number of e-mails can be adapted by configuring loom.properties with the parameter //inbox-name-signal-by-mail-reply//. With each e-mail, a search will be conducted to find a text according to the form of —–(1234)—– at first in the textual content and then in the subject heading. This text represents the identification number (ID) of the TIM process instance.\\
-\\ In the second step the first five e-mails to be found will be processed. This number of e-mails can be adapted by configurating loom.properties with the parameter //inbox-name-signal-by-mail-reply//.
+The message will be ignored if neither an ID nor a corresponding process instance can be found within TIM.\\
-With each e-mail a search will be conducted to find a text according to the form of -----(1234)----- at first in the textual content and then in the subject heading. This text represents the identification number (ID) of the T!M process instance.
+In the next step a TIM user will be sought while sending an e-mail. The sender will receive an e-mail if no user can be identified.\\
-\\ The message will be ignored if neither an ID nor a corresponding process instance can be found within T!M.
+In the following stage the name of an activity will be searched for in the content as well as in the subject heading of the e-mail by using [[:en:software:tim:timer:signalbymailreply#nodenameregexp|NodeNameRegExp]]. In case a name is found, an examination will be conducted to check if this process instance is pertaining to the provided [[:en:software:tim:timer:signalbymailreply#pdname|process definition]]. If this is not the case, then this e-mail is not supposed to be assigned to this timer. This e-mail would then also be ignored and no e-mail would be sent as a reply.\\
-\\ In the next step a T!M user will be sought while sending an e-mail. The sender will receive an e-mail if no user can be identified.
+If this timer is the proper one pertaining to this particular e-mail, an examination will be started to ensure that the process is also focused on the correct activity. If this is the case the e-mail will be attached as a notice to an activity. In addition, the sender will receive a corresponding message.\\
-\\ In the following stage the name of an activity will be searched for in the content as well as in the subject heading of the e-mail by using [[en:software:tim:timer:signalbymailreply#nodenameregexp|NodeNameRegExp]]. In case a name is found an examination will be conducted to check if this process instance is pertaining to the provided [[en:software:tim:timer:signalbymailreply#pdName|process definition]]. If this is not the case then this e-mail is not supposed to be assigned to this timer. This e-mail would then also be ignored and no e-mail would be sent as a reply.
+Now the TIM user who sent the e-mail will be examined to ensure if he/she is responsible at least for one of the tasks related to the current activity. This user will then in turn be informed if this is not the case.\\
-\\ If this timer is the proper one pertaining to this particular e-mail an examination will be started to ensure that the process is also focused on the correct activity. If this is the case the e-mail will be attached as a notice to an activity. In addition, the sender will receive a corresponding message.
+Next, a check for follow-up activities takes place. If there is only one existing activity the user will be assigned the status of an actor who is responsible for all tasks. There are several possibilities to continue with the process and to check if the mail entails a corresponding [[:en:software:tim:timer:signalbymailreply#leavingtransition|decision]].\\
-\\ Now the T!M user who sent the e-mail will be examined to ensure if he is responsible at least for one of the tasks related to the current activity. This user will then in turn be informed if this is not the case.
+Afterwards, the user will receive the status of an actor assigned to the task. Process variables will then be generated and the process forwarded. An e-mail will also be sent if [[:en:software:tim:timer:signalbymailreply#signalsuccessmail| desired]].\\
-\\ At this later stage it will be checked if there are several follow-up activities. If there is only one existing activity the user will be assigned the status of an actor who is responsible for all tasks. There are several possibilities to continue with the process and to check if the mail entails a corresponding [[en:software:tim:timer:signalbymailreply#leavingTransition|decision]].
+All e-mails that had been answered will be moved to the folder errorMessages if this folder already exists. The initial e-mail which forwarded the whole process will be moved to the [[:software:tim:timer:signalbymailreply#movefolder|configurated]] folder.
-\\ Afterwards, the user will receive the status of an actor assigned to the task. Process variables will then be generated and the process forwarded.
-An e-mail will also be sent if this is [[en:software:tim:timer:signalbymailreply#signalsuccessmail| desired]].
-\\ All e-mails which had been answered will be moved to the folder errorMessages if this folder already exists. The initial e-mail which forwarded the whole process will be moved to the especially [[software:tim:timer:signalbymailreply#moveFolder|configurated]] folder.
-------
+----
 ==== Examples ====
-{{en:software:tim:timer:signalbymail.png?direct&200|}}
+{{  :software:tim:timer:timersignalbymailreply_en.png  }}Parameter:
-Parameter:
-<code>johnm1477@gmail.com,123456,993,imap.gmail.com,,SignalByMailReply mk4,\-+\{(Wait.*)\}\-+,true,decision,no:rejected-no-nok;jo:approved-ok-yes,(.*?)wrote ?s</code>
+<code>
-This process is provided as an example:
+johnm1477@gmail.com,123456,993,imap.gmail.com,,SignalByMailReply mk4,-+{(Wait.*)}-+,true,decision,no:rejected-no-nok;jo:approved-ok-yes,(.*?)wrote ?s
-{{en:software:tim:timer:signalbymail_process.png?400|}} \\
+</code>
+This process is provided as an example: {{  :en:software:tim:timer:signalbymail_process.png  }}
 The following is a simple example for the text of an e-mail:
 <code>
 Hello,
@@ Line 137: / Line 156: @@
 Please answer with "approved", "yes" or "ok" for the decision "Yes".
 Best regards,
-Your T!M-System
+Your TIM-System
+-----(${SYS.PROCESSINSTANCE_ID})-----{Wait4}-----
------(${processInstanceId})-----{Wait4}-----
 </code>
 ----
 ==== Dependencies ====
-\\ __T!M version__ : this is available for configuration starting with [[en:software:tim:changelog:tim362|version 3.6.2]]
+__TIM version__ : this is available for configuration starting with [[:en:software:tim:changelog:tim362|version 3.6.2]]

TIM Wiki / NEW TIM 6 Documentation

User Tools

Site Tools

Differences

Page Tools