documentation for adding and editing workflows

This commit is contained in:
Colin Kuskie 2006-07-01 02:59:07 +00:00
parent 1d9151e68b
commit bc3054c56d
3 changed files with 112 additions and 4 deletions

View file

@ -27,6 +27,75 @@ our $HELP = {
],
},
'add a new workflow' => {
title => 'add a new workflow',
body => 'add a new workflow body',
fields => [
{
title => 'object type',
description => 'object type help',
namespace => 'Workflow',
},
],
related => [
{
tag => 'manage workflows',
namespace => 'Workflow'
},
{
tag => 'edit workflow',
namespace => 'Workflow'
},
],
},
'edit workflow' => {
title => 'edit workflow',
body => 'edit workflow body',
fields => [
{
title => 'object type',
description => 'object type help2',
namespace => 'Workflow',
},
{
title => 'title',
description => 'title help',
namespace => 'Workflow',
},
{
title => 'description',
description => 'description help',
namespace => 'Workflow',
},
{
title => 'is enabled',
description => 'is enabled help',
namespace => 'Workflow',
},
{
title => 'is singleton',
description => 'is singleton help',
namespace => 'Workflow',
},
{
title => 'is serial',
description => 'is serial help',
namespace => 'Workflow',
},
],
related => [
{
tag => 'manage workflows',
namespace => 'Workflow'
},
{
tag => 'add a new workflow',
namespace => 'Workflow'
},
],
},
};
1; ##All perl modules must return true

View file

@ -66,7 +66,8 @@ sub www_addWorkflow {
$f->submit;
my $ac = WebGUI::AdminConsole->new($session,"workflow");
$ac->addSubmenuItem($session->url->page("op=manageWorkflows"), $i18n->get("manage workflows"));
return $ac->render($f->print);
$ac->setHelp('add a new workflow', 'Workflow');
return $ac->render($f->print, 'add a new workflow');
}
#-------------------------------------------------------------------
@ -176,7 +177,8 @@ sub www_editWorkflow {
);
$f->readOnly(
label=>$i18n->get("object type"),
value=>$workflow->get("type")
value=>$workflow->get("type"),
hoverHelp=>$workflow->get("object type help2"),
);
$f->text(
name=>"title",
@ -226,7 +228,8 @@ sub www_editWorkflow {
my $ac = WebGUI::AdminConsole->new($session,"workflow");
$ac->addSubmenuItem($session->url->page("op=addWorkflow"), $i18n->get("add a new workflow"));
$ac->addSubmenuItem($session->url->page("op=manageWorkflows"), $i18n->get("manage workflows"));
return $ac->render($f->print.$addmenu.$steps);
$ac->setHelp('edit workflow','Workflow');
return $ac->render($f->print.$addmenu.$steps, 'edit workflow');
}

View file

@ -27,7 +27,13 @@ our $I18N = {
'object type help' => {
message => q|What type of objects do you want this workflow to be able to handle?|,
context => q|the hover help for the object type field|,
context => q|the hover help for the object type field in the add workflow screen|,
lastUpdated => 0,
},
'object type help2' => {
message => q|The type of workflow that you selected to add.|,
context => q|the hover help for the object type field in the edit workflow screen|,
lastUpdated => 0,
},
@ -127,6 +133,11 @@ our $I18N = {
lastUpdated => 0,
},
'edit workflow' => {
message => q|Edit workflow|,
lastUpdated => 0,
},
'manage workflow help body' => {
message => q|
<p>This is the master screen for managing workflows. All configured workflows are shown in a table by the title of the workflow, along with icons to edit or delete the workflow and the workflow's status, enabled or disabled. Links are provided to add new workflows and to show which, if any, workflows are presently running.</p>
@ -143,6 +154,31 @@ our $I18N = {
lastUpdated => 1151719633,
},
'add a new workflow body' => {
message => q|
<p>Adding a workflow is a two-step process:</p>
<div>
<ol>
<li>Select the type of workflow to add in this screen.</li>
<li>Edit the workflow and add activities to it in the screen that follows.</li>
</ol>
</div>
<p>Workflow types, and the kinds of activities that can be added to each, are configured in your WebGUI.conf file.</p>
|,
lastUpdated => 1151719633,
},
'edit workflow body' => {
message => q|
<p>Now that you have selected which type of workflow you want to add, you will edit the workflow
and add activities to it.</p>
<p>Below the fields in two columns are the set of activities that are available to be added, and activities, if any, that have already been added to the worflow.</p>
<p>To add a new activity to the workflow, click on its name. This will take you to the screen to configure that activity for this workflow.</p>
<p>Activities that have already been added and configured are displayed by name in the order they will be executed by Spectre. Icons next to the name of the activity allow it to be reordered, edited, deleted from this workflow.</p>
|,
lastUpdated => 1151721687,
},
'topicName' => {
message => q|Workflow|,
context => q|The title of the workflow interface.|,