From 23c17851eafe5cdacd9ff08dd16ad3e7d087f905 Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Sun, 2 Jul 2006 04:32:46 +0000 Subject: [PATCH] Big batch o' Activity docs. --- ...kflow_Activity_ProcessRecurringPayments.pm | 27 +++++++++++++ ...orkflow_Activity_PurgeOldAssetRevisions.pm | 28 ++++++++++++++ .../Help/Workflow_Activity_PurgeOldTrash.pm | 28 ++++++++++++++ ...w_Activity_RequestApprovalForVersionTag.pm | 38 +++++++++++++++++++ .../Workflow_Activity_RollbackVersionTag.pm | 23 +++++++++++ .../Workflow_Activity_RunCommandAsUser.pm | 28 ++++++++++++++ ...orkflow_Activity_SendQueuedMailMessages.pm | 23 +++++++++++ ...kflow_Activity_ProcessRecurringPayments.pm | 18 +++++++++ ...orkflow_Activity_PurgeOldAssetRevisions.pm | 19 ++++++++++ .../Workflow_Activity_PurgeOldTrash.pm | 19 ++++++++++ ...w_Activity_RequestApprovalForVersionTag.pm | 20 ++++++++++ .../Workflow_Activity_RollbackVersionTag.pm | 18 +++++++++ .../Workflow_Activity_RunCommandAsUser.pm | 5 +++ ...orkflow_Activity_SendQueuedMailMessages.pm | 5 +++ 14 files changed, 299 insertions(+) create mode 100644 lib/WebGUI/Help/Workflow_Activity_ProcessRecurringPayments.pm create mode 100644 lib/WebGUI/Help/Workflow_Activity_PurgeOldAssetRevisions.pm create mode 100644 lib/WebGUI/Help/Workflow_Activity_PurgeOldTrash.pm create mode 100644 lib/WebGUI/Help/Workflow_Activity_RequestApprovalForVersionTag.pm create mode 100644 lib/WebGUI/Help/Workflow_Activity_RollbackVersionTag.pm create mode 100644 lib/WebGUI/Help/Workflow_Activity_RunCommandAsUser.pm create mode 100644 lib/WebGUI/Help/Workflow_Activity_SendQueuedMailMessages.pm create mode 100644 lib/WebGUI/i18n/English/Workflow_Activity_ProcessRecurringPayments.pm create mode 100644 lib/WebGUI/i18n/English/Workflow_Activity_PurgeOldAssetRevisions.pm create mode 100644 lib/WebGUI/i18n/English/Workflow_Activity_PurgeOldTrash.pm create mode 100644 lib/WebGUI/i18n/English/Workflow_Activity_RequestApprovalForVersionTag.pm create mode 100644 lib/WebGUI/i18n/English/Workflow_Activity_RollbackVersionTag.pm diff --git a/lib/WebGUI/Help/Workflow_Activity_ProcessRecurringPayments.pm b/lib/WebGUI/Help/Workflow_Activity_ProcessRecurringPayments.pm new file mode 100644 index 000000000..040f06828 --- /dev/null +++ b/lib/WebGUI/Help/Workflow_Activity_ProcessRecurringPayments.pm @@ -0,0 +1,27 @@ +package WebGUI::Help::Workflow_Activity_ProcessRecurringPayments; + +our $HELP = { + 'process recurring payments' => { + title => 'topicName', + body => 'process recurring payments body', + isa => [ + { + namespace => "Workflow_Activity", + tag => "add/edit workflow activity" + }, + ], + fields => [ + ], + variables => [ + ], + related => [ + { + tag => 'settings', + namespace => 'WebGUI' + } + ], + }, + +}; + +1; ##All perl modules must return true diff --git a/lib/WebGUI/Help/Workflow_Activity_PurgeOldAssetRevisions.pm b/lib/WebGUI/Help/Workflow_Activity_PurgeOldAssetRevisions.pm new file mode 100644 index 000000000..cf6d32f95 --- /dev/null +++ b/lib/WebGUI/Help/Workflow_Activity_PurgeOldAssetRevisions.pm @@ -0,0 +1,28 @@ +package WebGUI::Help::Workflow_Activity_PurgeOldAssetRevisions; + +our $HELP = { + 'purge old asset revisions' => { + title => 'topicName', + body => 'purge old asset revisions body', + isa => [ + { + namespace => "Workflow_Activity", + tag => "add/edit workflow activity" + }, + ], + fields => [ + { + title => 'purge revision after', + description => 'purge revision after help', + namespace => 'Asset', + }, + ], + variables => [ + ], + related => [ + ], + }, + +}; + +1; ##All perl modules must return true diff --git a/lib/WebGUI/Help/Workflow_Activity_PurgeOldTrash.pm b/lib/WebGUI/Help/Workflow_Activity_PurgeOldTrash.pm new file mode 100644 index 000000000..5b2775714 --- /dev/null +++ b/lib/WebGUI/Help/Workflow_Activity_PurgeOldTrash.pm @@ -0,0 +1,28 @@ +package WebGUI::Help::Workflow_Activity_PurgeOldTrash; + +our $HELP = { + 'purge old trash' => { + title => 'topicName', + body => 'purge old trash body', + isa => [ + { + namespace => "Workflow_Activity", + tag => "add/edit workflow activity" + }, + ], + fields => [ + { + title => 'purge trash after', + description => 'purge trash after help', + namespace => 'Asset', + }, + ], + variables => [ + ], + related => [ + ], + }, + +}; + +1; ##All perl modules must return true diff --git a/lib/WebGUI/Help/Workflow_Activity_RequestApprovalForVersionTag.pm b/lib/WebGUI/Help/Workflow_Activity_RequestApprovalForVersionTag.pm new file mode 100644 index 000000000..0203137b6 --- /dev/null +++ b/lib/WebGUI/Help/Workflow_Activity_RequestApprovalForVersionTag.pm @@ -0,0 +1,38 @@ +package WebGUI::Help::Workflow_Activity_RequestApprovalForVersionTag; + +our $HELP = { + 'request approval for version tag' => { + title => 'topicName', + body => 'request approval for version tag body', + isa => [ + { + namespace => "Workflow_Activity", + tag => "add/edit workflow activity" + }, + ], + fields => [ + { + title => 'group to approve', + description => 'group to approve help', + namespace => 'VersionTag', + }, + { + title => 'approval message', + description => 'approval message help', + namespace => 'VersionTag', + }, + { + title => 'do on deny', + description => 'do on deny help', + namespace => 'VersionTag', + }, + ], + variables => [ + ], + related => [ + ], + }, + +}; + +1; ##All perl modules must return true diff --git a/lib/WebGUI/Help/Workflow_Activity_RollbackVersionTag.pm b/lib/WebGUI/Help/Workflow_Activity_RollbackVersionTag.pm new file mode 100644 index 000000000..58865ccaa --- /dev/null +++ b/lib/WebGUI/Help/Workflow_Activity_RollbackVersionTag.pm @@ -0,0 +1,23 @@ +package WebGUI::Help::Workflow_Activity_RollbackVersionTag; + +our $HELP = { + 'rollback version tag' => { + title => 'topicName', + body => 'rollback version tag body', + isa => [ + { + namespace => "Workflow_Activity", + tag => "add/edit workflow activity" + }, + ], + fields => [ + ], + variables => [ + ], + related => [ + ], + }, + +}; + +1; ##All perl modules must return true diff --git a/lib/WebGUI/Help/Workflow_Activity_RunCommandAsUser.pm b/lib/WebGUI/Help/Workflow_Activity_RunCommandAsUser.pm new file mode 100644 index 000000000..62b213422 --- /dev/null +++ b/lib/WebGUI/Help/Workflow_Activity_RunCommandAsUser.pm @@ -0,0 +1,28 @@ +package WebGUI::Help::Workflow_Activity_RunCommandAsUser; + +our $HELP = { + 'run command as user' => { + title => 'topicName', + body => 'run command as user body', + isa => [ + { + namespace => "Workflow_Activity", + tag => "add/edit workflow activity" + }, + ], + fields => [ + { + title => 'command', + description => 'command help', + namespace => 'Workflow_Activity_RunCommandAsUser', + }, + ], + variables => [ + ], + related => [ + ], + }, + +}; + +1; ##All perl modules must return true diff --git a/lib/WebGUI/Help/Workflow_Activity_SendQueuedMailMessages.pm b/lib/WebGUI/Help/Workflow_Activity_SendQueuedMailMessages.pm new file mode 100644 index 000000000..480e07fa1 --- /dev/null +++ b/lib/WebGUI/Help/Workflow_Activity_SendQueuedMailMessages.pm @@ -0,0 +1,23 @@ +package WebGUI::Help::Workflow_Activity_SendQueuedMailMessages; + +our $HELP = { + 'get cs post' => { + title => 'topicName', + body => 'send queued mail messages body', + isa => [ + { + namespace => "Workflow_Activity", + tag => "add/edit workflow activity" + }, + ], + fields => [ + ], + variables => [ + ], + related => [ + ], + }, + +}; + +1; ##All perl modules must return true diff --git a/lib/WebGUI/i18n/English/Workflow_Activity_ProcessRecurringPayments.pm b/lib/WebGUI/i18n/English/Workflow_Activity_ProcessRecurringPayments.pm new file mode 100644 index 000000000..5c275e2d9 --- /dev/null +++ b/lib/WebGUI/i18n/English/Workflow_Activity_ProcessRecurringPayments.pm @@ -0,0 +1,18 @@ +package WebGUI::i18n::English::Workflow_Activity_ProcessRecurringPayments; + +our $I18N = { + + 'topicName' => { + message => q|Process Recurring Payments|, + context => q|The name of this workflow activity.|, + lastUpdated => 0, + }, + + 'process recurring payments body' => { + message => q|

This workflow activity will process all recurring transactions (payments) in the Commerce system that are complete at the time the Activity is executed. When the Activity is through with all those payments, a email with the details of all transactions is sent to the user configured in the Settings to receive them.

|, + lastUpdated => 0, + }, + +}; + +1; diff --git a/lib/WebGUI/i18n/English/Workflow_Activity_PurgeOldAssetRevisions.pm b/lib/WebGUI/i18n/English/Workflow_Activity_PurgeOldAssetRevisions.pm new file mode 100644 index 000000000..07a6be421 --- /dev/null +++ b/lib/WebGUI/i18n/English/Workflow_Activity_PurgeOldAssetRevisions.pm @@ -0,0 +1,19 @@ +package WebGUI::i18n::English::Workflow_Activity_PurgeOldAssetRevisions; + +our $I18N = { + + 'topicName' => { + message => q|Purge Old Asset Revisions|, + context => q|The name of this workflow activity.|, + lastUpdated => 0, + }, + + 'purge old asset revisions body' => { + message => q|

This workflow activity will delete versions of assets that are older than the configured interval, unless the asset only has one approved version. This can be used to save diskspace and keep the size of your database down.

+

The default version of WebGUI ships with a weekly Workflow to delete Assets older than 1 year old. Disabling this Activity in the Workflow will keep versions forever.

|, + lastUpdated => 0, + }, + +}; + +1; diff --git a/lib/WebGUI/i18n/English/Workflow_Activity_PurgeOldTrash.pm b/lib/WebGUI/i18n/English/Workflow_Activity_PurgeOldTrash.pm new file mode 100644 index 000000000..0f270872a --- /dev/null +++ b/lib/WebGUI/i18n/English/Workflow_Activity_PurgeOldTrash.pm @@ -0,0 +1,19 @@ +package WebGUI::i18n::English::Workflow_Activity_PurgeOldTrash; + +our $I18N = { + + 'topicName' => { + message => q|Purge Old Trash|, + context => q|The name of this workflow activity.|, + lastUpdated => 0, + }, + + 'purge old trash body' => { + message => q|

This workflow activity will delete assets from the trash that are older than the configured interval, unless the asset only has one approved version.

+

The default version of WebGUI ships with a weekly Workflow to delete Trash older than 30 days old. Disabling this Activity in the Workflow will keep Assets in the Trash forever.

|, + lastUpdated => 0, + }, + +}; + +1; diff --git a/lib/WebGUI/i18n/English/Workflow_Activity_RequestApprovalForVersionTag.pm b/lib/WebGUI/i18n/English/Workflow_Activity_RequestApprovalForVersionTag.pm new file mode 100644 index 000000000..fbd68b94e --- /dev/null +++ b/lib/WebGUI/i18n/English/Workflow_Activity_RequestApprovalForVersionTag.pm @@ -0,0 +1,20 @@ +package WebGUI::i18n::English::Workflow_Activity_RequestApprovalForVersionTag; + +our $I18N = { + + 'topicName' => { + message => q|Request Approval For Version Tag|, + context => q|The name of this workflow activity.|, + lastUpdated => 0, + }, + + 'request approval for version tag body' => { + message => q|

This workflow activity is used by WebGUI's version control. It is used to require approval for a version tag to be committed.

+

When a user commits a version tag, an email is sent out to all members of a user selected group. The email contains all comments from the committer along with a URL to manage the committed version tag. The first user to respond to the email can either approve or deny the commit. If the user approves the version tag, it will be committed the next time this Activity is called. If the user denies the version tag, then a selectable Workflow will be called.

+

One of WebGUI's default Workflows includes this Activity to implement basic authorization for committing versions. In this Workflow, if the commit is denied, then the version tag is unlocked and the committer is notified that the commit was denied with comments as to why.

|, + lastUpdated => 0, + }, + +}; + +1; diff --git a/lib/WebGUI/i18n/English/Workflow_Activity_RollbackVersionTag.pm b/lib/WebGUI/i18n/English/Workflow_Activity_RollbackVersionTag.pm new file mode 100644 index 000000000..d9a81f632 --- /dev/null +++ b/lib/WebGUI/i18n/English/Workflow_Activity_RollbackVersionTag.pm @@ -0,0 +1,18 @@ +package WebGUI::i18n::English::Workflow_Activity_RollbackVersionTag; + +our $I18N = { + + 'topicName' => { + message => q|Rollback Version Tag|, + context => q|The name of this workflow activity.|, + lastUpdated => 0, + }, + + 'rollback version tag body' => { + message => q|

This workflow activity will purge all versions of assets contained in a version tag.

|, + lastUpdated => 0, + }, + +}; + +1; diff --git a/lib/WebGUI/i18n/English/Workflow_Activity_RunCommandAsUser.pm b/lib/WebGUI/i18n/English/Workflow_Activity_RunCommandAsUser.pm index e8fc06bf6..974825d3d 100644 --- a/lib/WebGUI/i18n/English/Workflow_Activity_RunCommandAsUser.pm +++ b/lib/WebGUI/i18n/English/Workflow_Activity_RunCommandAsUser.pm @@ -19,6 +19,11 @@ our $I18N = { lastUpdated => 0, }, + 'run command as user body' => { + message => q|

This workflow activity will switch the session's current user to that passed in to the Activity. Then it will process any macros found in the command and execute the command on the command line.

|, + lastUpdated => 0, + }, + }; 1; diff --git a/lib/WebGUI/i18n/English/Workflow_Activity_SendQueuedMailMessages.pm b/lib/WebGUI/i18n/English/Workflow_Activity_SendQueuedMailMessages.pm index 3b9935326..cc99d9d91 100644 --- a/lib/WebGUI/i18n/English/Workflow_Activity_SendQueuedMailMessages.pm +++ b/lib/WebGUI/i18n/English/Workflow_Activity_SendQueuedMailMessages.pm @@ -7,6 +7,11 @@ our $I18N = { lastUpdated => 0, }, + 'send queued mail messages body' => { + message => q|

This workflow activity will process queued emails. If an email fails to be sent, then it will be requeued to be sent later. Because this process could take a long time, based on the number of emails that have queued up, this activity will stop after one minute.

|, + lastUpdated => 0, + }, + }; 1;