diff --git a/lam/docs/manual-sources/chapter-modules.xml b/lam/docs/manual-sources/chapter-modules.xml index e03e61617..1f3ca6e0c 100644 --- a/lam/docs/manual-sources/chapter-modules.xml +++ b/lam/docs/manual-sources/chapter-modules.xml @@ -6366,13 +6366,15 @@ OK (10 msec) In "Module settings" you can specify multiple scripts for each - action type (e.g. modify) and account type (e.g. user). The scripts need - to be located on the filesystem of your webserver and will be executed in - its user environment. E.g. if you webserver runs as user www-data with the - group www-data then the custom scripts will be run under this user with - his rights. The output of the scripts will be shown in LAM. + action type (e.g. preModify) and account type (e.g. user). The scripts + need to be located on the filesystem of your webserver and will be + executed in its user environment. E.g. if you webserver runs as user + www-data with the group www-data then the custom scripts will be run under + this user with his rights. The output of the scripts will be shown in + LAM. - You can specify the scripts on the LAM configuration pages. + You can specify the scripts on the LAM configuration pages. Please + note that the syntax changed with version 9.2 (see below). @@ -6390,15 +6392,21 @@ OK (10 msec) Syntax: Please enter one script per line. Each line has the following - format: <account type> <action> <script> + format: <action> <script> + + E.g.: preModify /usr/bin/myCustomScript -u $uid$ + + Syntax (pre 9.2): + + Please enter one script per line. Each line has the following + format: <account type> + <action> <script> E.g.: user preModify /usr/bin/myCustomScript -u $uid$ - Account types: - - You can setup scripts for all available account types (e.g. user, - group, host, ...). Please see the help on the configuration page about - your current active account types. + Account types: You can setup scripts for all available account types + (e.g. user, group, host, ...). Please see the help on the configuration + page about your current active account types. Actions: @@ -6615,14 +6623,10 @@ OK (10 msec) Example: - user preModify /opt/myapp/preModify.sh -u $uid$ -group postDelete /opt/myapp/postDelete.sh -g $gid$ + preModify /opt/myapp/preModify.sh -u $uid$ LAM_GROUP: Mail actions -user manual LAMLABEL="Clean" /bin/myscripts/cleanMailbox -u $uid$ -user manual LAMLABEL="Extend" /bin/myscripts/extendMailbox -u $uid$ -LAM_GROUP: Sync actions -user manual /bin/myscripts/syncWithCRM -u $uid$ -user manual LAMLABEL="Some app" /bin/myscripts/syncWithSomeApp -u $uid$ +manual LAMLABEL="Clean" /bin/myscripts/cleanMailbox -u $uid$ +manual LAMLABEL="Extend" /bin/myscripts/extendMailbox -u $uid$ @@ -6683,10 +6687,10 @@ user manual LAMLABEL="Some app" /bin/myscripts/syncWithSomeApp -u $uid$ LAM_SELECTION_TENANT: Tenant=foo;bar LAM_TEXT_COMMENT: Comment=no comment LAM_TEXT_AMOUNT: Amount -user manual LAMLABEL="Clean" /bin/myscripts/cleanMailbox -u $uid$ -e $LAM_SELECTION_ENV$ -user manual LAMLABEL="Extend" /bin/myscripts/extendMailbox -u $uid$ -e $LAM_SELECTION_TENANT$ -user manual /bin/myscripts/syncWithCRM -u $uid$ -c $LAM_TEXT_COMMENT$ -user manual LAMLABEL="Some app" /bin/myscripts/syncWithSomeApp -u $uid$ -a $LAM_TEXT_AMOUNT$ +manual LAMLABEL="Clean" /bin/myscripts/cleanMailbox -u $uid$ -e $LAM_SELECTION_ENV$ +manual LAMLABEL="Extend" /bin/myscripts/extendMailbox -u $uid$ -e $LAM_SELECTION_TENANT$ +manual /bin/myscripts/syncWithCRM -u $uid$ -c $LAM_TEXT_COMMENT$ +manual LAMLABEL="Some app" /bin/myscripts/syncWithSomeApp -u $uid$ -a $LAM_TEXT_AMOUNT$ diff --git a/lam/docs/manual-sources/images/customScripts.png b/lam/docs/manual-sources/images/customScripts.png index f97a06409..8eefbb4a8 100644 Binary files a/lam/docs/manual-sources/images/customScripts.png and b/lam/docs/manual-sources/images/customScripts.png differ