nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

External task to generate a page

tsrookie

Gidday all,

I wonder if anyone has an example of a simple external task that generates a page from a dct.

This is part of my first workflow.

Any help appreciated
Thanks
Colin

Find more posts tagged with

Comments

tsrookie

Im trying here, I am editting sample_external_task.ipl

I want to generate a page from the workflow, I believe an external task is the best thing to do this.

In sample_external_task.ipl there is a subroutine called do_work()

I am editting this, am I on the right track

any help appreciated.
If anyone has an example of an external task that generates a page I'd appreciate a copy if possible.

Thanks Colin

sub do_work
{
my ($job, $task) = @_;

my $cmd = 'iwgen -t templatedata/navigation/primaryMenu/presentation/primarymenu.tpl -r templatedata/navigation/primaryMenu/data/primarymenu includes/ssi/primarymenu';

open ( CMD, "$cmd |" ) or die "Cannot fork $cmd: $!\n";
close ( CMD );

# Get the number of the current iteration from a task variable (default 0).
my $iteration = $task->GetVariable('ITERATION') || 0;

# Get the maximum number of allowed iterations (default 1).
my $max_iterations = $task->GetVariable('MAX_ITERATIONS') || 1;

# Increment the count and update the task variable.
$iteration++;
$task->SetVariable('ITERATION', $iteration);

# 0 => Finish Job
# 1 => Retry Later
my $transition = (($iteration < $max_iterations) ? 1 : 0);
my $comment = "Ran $basename";

# To provide user feedback, let's change the description on the user task.
my ($found, $userTask) = $job->GetTaskByName('Wait for next test');
if ($found) {
$userTask->SetDescription("Iteration $iteration of $max_iterations");
}

return ($transition, $comment);
}

Adam Stoller

I'm not crazy about the way the command is being invoked - and I'm not sure what the rest of that subroutine is doing - but my guess is you'd have to look at the documentation for the sample scripts (which I'm not looking at right now) to understand the context in which that script was written.

I think you'd be better served to look at the workflow tutorial supplement (available on the DevNet site) and write your own script from scratch using that as a basis. Unless you really don't understand what you're trying to do or how to do it - in which case I think you either need to learn more about it or hire someone who already knows more about it.

The actual command you defined doesn't look entirely correct because you're using area-relative paths and I'm not sure you can assume the current working directory context - therefore you'd probably need to make sure you have the value of the current workarea ($task->GetArea()) and preface each of the paths with that value.

Additionally, you're hard-wiring in the information abount not-only the PT, but the DCR and the output file - which means that regardless of what file or files may be associated with the workflow that contains this external task (or even if no files are associated with the current workflow) - you will be generating the includes/ssi/primarymenu file (did you really mean for the output file not to have an extension?). Instead the externaltask script should probably base the name of the DCR on the file(s) associated with the task, the name of the output file based on the name (and path?) of the DCR and the name of the PT based on .... something... (there are many ways to do this - it all depends on the actual requirements and the way the entire structure of the implmentation has been designed).

I think you need to go back to the *design* stage and come up with a clear, detailed, design specification for what you want to do and the context in which it is supposed to happen - before trying to just blindly implement something.

--fish
Senior Consultant, Quotient Inc.
http://www.quotient-inc.com

tsrookie

Hi Fish,

Problem is their is no one else to write the workflow, we all have to start somewhere.

This external task was intended for a specific purpose, generating our primary navaigation, thats why I hardcoded the paths, what I really need from someone is an example of an external task that generates a page, I find the documentation insufficient for someone of my level.

Colin

gzevin

so why your company doesn't hire, even on contract basis someone who could kick start the implementation? and then you could continue?

do not consider this as my offer to travel to Queensland

Greg Zevin, Ph.D. Comp. Sc.
Independent Interwoven Consultant/Architect
Sydney, AU

tsrookie

Ok I have written this and it runs from the command line now I have to modify it and call it from a workflow.

I want it to be run when the author saves a primarymenu dcr what is the best way to do this?

#!/web/Interwoven/TeamSite/iw-perl/bin/iwperl

use strict;
use POSIX qw(getpid strftime);
use TeamSite::Config;
use File::Basename;
use egov::iwea;

# Debug module
use egov: Smiley Very Happy

ebugLog;
my $DEBUG = 1;

# Get iw_home and iw_mount
my $iw_home = TeamSite::Config::iwgethome();
my $iw_mount = TeamSite::Config::iwgetmount();

# Who am I.
my $scriptName = &basename($0);
$scriptName =~ s/\.[^\.]+$//i;

# Conststants of CLTs used in script
my $IWREGEN = $iw_home . "/bin/iwregen";
my $IWGEN = $iw_home . "/bin/iwgen";

# State variables in script.
my $errorComment = 'ERROR: task error detected in $scriptName.'; # Default error comment.
my $taskComment = 'SUCCESS: '; # Default task transition comment.

# What is my PID
my $pid = getpid();
chomp $pid;

my $debug = new egov: Smiley Very Happy

ebugLog ($DEBUG, "/tmp/$scriptName".".log");

# Error check debug object.
if (! defined $debug) {
exit(1);
}

$debug->printlog("Begin session $pid $scriptName");

$debug->printlog("BEGIN $pid: script body.");

my $branch = 'det';
my $subBranch = 'development';

my $waPath = "$branch/$subBranch/WORKAREA/internet";

my $vPath = "$iw_mount/default/main/$waPath/includes/ssi/primarymenu.ssi";
my $templateVPath = "$iw_mount/default/main/$waPath/templatedata/navigation/primaryMenu/presentation/primarymenu.tpl";
my $recordVPath = "$iw_mount/default/main/$waPath/templatedata/navigation/primaryMenu/data/primarymenu";

############################################################################
# Start script body
############################################################################

my $comment = "";

# has the file been generated before

if( -f $vPath ){

# it exists use iwregen
$debug->printlog("$pid. Regenerating primarymenu.ssi");

my $cmd = "$IWREGEN \"$vPath\"";

my $cmdResult = `$cmd 2>&1`;
if( $cmdResult =~ /^\s*$/ ) {
$cmdResult = "Successful file regeneration.";
$comment = "REGEN COMMAND: $cmd\nREGEN RESULT: $cmdResult";
$debug->printlog("REGEN $pid: Regen $vPath\n$comment");
} else {
$errorComment = "ERROR: Template renegeneration failed:\n";
$errorComment .= " Cmd: $cmd\n Result: $cmdResult\n";
$debug->printlog("$errorComment");
# &abort(1, "$errorComment");
}

}
else{

# it doesn't exist use iwgen
$debug->printlog("$pid. generating primarymenu.ssi");

if( -f $recordVPath ){

#dcr exists
$debug->printlog("$pid. primary menu dcr exists");

my $cmd = "$IWGEN -t \"$templateVPath\" -r \"$recordVPath\" \"includes/ssi/primarymenu.ssi\"";

my $cmdResult = `$cmd 2>&1`;
if( $cmdResult =~ /^\s*$/ ) {
$cmdResult = "Successful file generation.";
$comment = "GEN COMMAND: $cmd\nGEN RESULT: $cmdResult";
$debug->printlog("GEN $pid: gen $vPath\n$comment");
} else {
$errorComment = "ERROR: dcr generation failed:\n";
$errorComment .= " Cmd: $cmd\n Result: $cmdResult\n";
$debug->printlog("$errorComment");
# &abort(1, "$errorComment");
}

}
else{

#dcr doesn't exist
$debug->printlog("$pid. primary menu dcr has not been created! ");

}

}

Adam Stoller

I suggest you read the workflow tutorial supplement - available on DevNet - to learn more about how to write externaltask and/or cgitask scripts - because you're missing the entire section of code that ties the script into the workflow process.

--fish
Senior Consultant, Quotient Inc.
http://www.quotient-inc.com

tsrookie

Thanks fish,

Yes I realise Im missing the code that ties it in to the workflow, thats the problem I haven't written a workflow before. I did read somewhere that when developing an external task it was important to write something that ran from the command line first. Now for the next step.

I have downloaded the workflow supplement tutorial by the way.

The script above is written to generate our primary navigation ssi file. I think this is the best way to go about doing this because I want to control how it is named and where it is generated to so I know where to find it. I also control how the dcr is named using formapi.

I think the logical time to fire off this workflow is either when they save or click finish on the dcr. Any comments

It maybe easier to implement though if I fire it when they submit the dcr then the user (admin) is offered a choice of which workflow to use and they must select the right one?

Any help appreciated thank you
Colin

Adam Stoller

Personally, I prefer to develop all templated content within the framework of a workflow rather than launching a workflow after having created the DCR; but you can do it either way (note: workflows can fire on the Close of the DCR not on Save - unless you plan to use FormAPI CallServer() code to asynchronously run a workflow process every time you save the DCR - which I would not recommend).

Basically you need to define and design your entire content creation process - before you try to start implementing things - otherwise you'll just end up trying to hold things together with duct-tape after the fact. It might end up working, but it won't be a very solid or maintainable result.

Since you've downloaded the workflow tutorial supplement - you should be able to figure out how to modify your script to work within a workflow context - but it sounds to me like you still don't know what your workflow is supposed to do and/or when it's supposed to do it. But that's for you to figure out.

--fish
Senior Consultant, Quotient Inc.
http://www.quotient-inc.com

tsrookie

Hi Fish,

Thank you,

just to clarify you said personally I prefer to develop all templated content within the framework of a workflow does this mean then that when an author logs in to Teamsite rather than open a specific dcr they fire up a workflow choose that they may want to create the primary navigation for example then the workflow opens the primarymenu dct etc..

Colin

Adam Stoller

yes

--fish
Senior Consultant, Quotient Inc.
http://www.quotient-inc.com

Ottawa_IWOV

Hi Fish-

I never considered managed templated content within the framework of a workflow. Might you be able to add a little more color to this, and how you achieved it? Are you simple using the "New Form" inside a workflow, then worrying about page generation with an external task?

I look forward to your thoughts on this one.

Lucas Cochrane
lucas.cochrane@baucanada.com

Adam Stoller

I've given snippets of information about how I'd do this in numerous posts in these forums.
I'm not planning to do a free tutorial on this here in the forums.
If you can't figure it out for yourself, you can hope someone else will post a lengthy (and hopefully accurate) explanation; or you can hire someone who understands it to work with you in developing such a solution for your environment.

Rule #1 - Design - in depth - before attempting to implement anything.

--fish
Senior Consultant, Quotient Inc.
http://www.quotient-inc.com

tsrookie

Fish I agree with your idea above but will take it one bite at at time and continue with just a simple workflow to generate our primarymenu when the author submits a dcr.

Here is my workflow script.

It is not running the external task script though

<?xml version="1.0" standalone="no" ?>
<!DOCTYPE workflow SYSTEM "iwwf.dtd">
<template_script><![CDATA[

#----------------------------------------------------------------------------
# Copyright 2004 .
# All rights reserved.
#
# Name : prnav.wft
#
# Authors : Colin Johnstone <colin.johnstone@det.qld.gov.au>
#
# Date : Monday, 25 October 2004
#
# Synopsis : Workflow to handle generation and submit of primarynav.ssi.
#
# Edit History :
#
# Init No. Date Description
# ==== === ========== ===========
#
# CJ [0] 18/03/2003 initial requirements
#
#---------------------------------------------------------------------------- -->

# CHANGE ####################################
my $sysAdminGroup = "tsadmin";
my $sysAdminUser = "tsadmin";

use TeamSite::Config;
(my $iwhome = TeamSite::Config::iwgethome()) =~ tr|\\|/|;
my $sOwner = __VALUE__('iw_user');

#######################################################
# DEBUG
#######################################################
my $DEBUG = 1;
my $debug_output = "/tmp/prnav_wft.log";
if ($DEBUG == 1)
{
TAG_info(
iw_debug_mode => [html => "<font>Yes <input type='radio' checked value ='true'> " . "No <input type='radio' value='false'></font>", label => "</strong>" . "Debug mode?</font><strong>", is_required => "true" ]
);
}

debug("iw-home: $iwhome<br />");

#=====================================================================
#
# DEBUG ROUTINE
#
#=====================================================================
sub debug {
my ($str) = @_;

if ($DEBUG == 1) {
open DB , ">>$debug_output";
print DB "$str\n";
close DB;
}
}

#=====================================================================
# Name: iw_cleanup_paths
# Args: bp - branch path
# wa - workarea name
# Usage: ($b, $w, $a) = iw_cleanup_paths($bp, $wa);
# Purpose: Function used to clean up leading and trailing blanks
# from branch path and work area path, then derive
# $areavpath.
# Returns: Cleaned branch path, workarea, and generated areavpath
#=====================================================================
sub iw_cleanup_paths {
my ($bp, $wa) = @_;

# clean up leading and trailing slashes so we dont
# end up hassling the user over including/excluding them
$bp =~ s|^\s*/*([^/].*\S)/\s*$|$1|;
$wa =~ s|^\s*/*([^/].*\S)/\s*$|$1|;
#=# (Note - this code may need to change when we start supporting
#=# multiple archives [Arnold])
$bp = "main/$bp" if ($bpath !~ /^main/);

$areavpath = TeamSite::CGI_lite::escape_html_data(
"/default/$bp/WORKAREA/$wa");

return ($bp, $wa, $areavpath);

}

#=====================================================================
# get_config
#
# Retrieve specified values from a given section within the TeamSite
# iw.cfg file.
#
# $section - the relevant section of the iw.cfg file to examine.
# $entry - the name of the entry within that section to find.
# $default - an optional default value to use if not found.
#
# If the requested entry in the specified section exists, the value
# of that entry is returned (trailing newline removed).
#
# Otherwise, the default value will be returned. If no default
# value was specified, 'undef' will be returned.
#=====================================================================
sub get_config {
my ($section, $entry, $default) = @_;
my $value = `$iwhome/bin/iwconfig $section $entry`;
$value =~ s/\n$//;
return($default) if (!defined($value));
$value =~ s/^\s*(\S.*\S)\s*$/$1/;
return ($value eq '') ? $default : $value;
}

#=====================================================================
# Name: iw_set_area
# Args: btag - TAG_info variable name for branch path.
# watag - TAG_info variable name for workarea.
# Usage: ($a, $b, $w, $s) = set_area("$btag", "$watag");
# Purpose: If the built-in variables for branch and workarea have
# not been set, pull the information from the workflow
# instantiation form (using the btag and watag info).
# Use the branch and workarea information to generate
# a valid areavpath (using a library routine)
# Returns: Returns the generated areavpath, the branch path, the
# workarea name, and a boolean indicating whether or not
# the branch and workarea need to be prompted for during
# instantiation (this relies on the fact that this code
# is run multiple times during the instantion process).
#=====================================================================
sub iw_set_area{
my($btag, $watag) = @_;
my($avpath, $bpath, $wapath, $skip);
my($iwbpath, $iwwapath) = (__VALUE__("iw_branch"),
__VALUE__("iw_workarea"));
if ((length($iwbpath)) > 0 && (length($iwwapath)) > 0){
$bpath = $iwbpath;
($wapath = $iwwapath) =~ s|^\s*/.* Smiley Indifferent

|;
$wapath =~ s|/\s*$||;
return("$wapath", "$iwbpath", "$wapath", "TRUE");
}
($bpath, $wapath, $avpath) = iw_cleanup_paths(__VALUE__("$btag"),
__VALUE__("$watag"));
return("$avpath", "$bpath", "$wapath", "FALSE");
}

my($iw_area_vpath, $iw_branch_path, $iw_work_area, $iw_skip_branch) =
iw_set_area("branch_path", "work_area");

debug("Area vpath: $iw_area_vpath");
debug("Area branch path: $iw_branch_path");
debug("Area work area: $iw_work_area");
debug("Area skip branch: $iw_skip_branch");

#======================================================================
# Name: iw_get_mail_cmd
# Args: type - either "iwsend_mail" or "iwsend_servlet_mail"
# addr - 'To:' email address
# Usage: __INSERT__(iw_get_mail_cmd("$type", "$addr"));
# Purpose: This function generates the command statement called
# by the external email notification task.
# Returns: Returns the generated XML string.
# Note: Defaults to iwsend_servlet_mail.ipl unless $type is
# explicitly set to iwsend_mail
#=# (this will hopefully change with the next version of iwsend_mail)
#=# (when that happens, either drop type, or make it a second
#=# [optional] argument, that if set - assumes the program lives in
#=# iw-home/local/bin ?)
#=====================================================================
sub iw_get_mail_cmd {
# NT lacks the ability to bind a script executor with a
# script on a 'shebang' line (eg: #!/blah/blah/iwperl)
# Instead it uses the assoc/ftype mechanism which employs
# the use of environment variables that are not always
# available (cf: IIS's metabasse, which replicates the
# extention-based association scheme on its own). Therefore,
# we need to spoon-feed iwperl the script like this for now:

my($type, $taskName, $addr) = @_;
return(sprintf("<command v='%s$iwhome/bin/%s %s'/>",
($^O eq "MSWin32") ? "$iwhome/iw-perl/bin/iwperl " : "",
($type eq "iwsend_mail") ?
"$type.ipl" : "iwsend_servlet_mail.ipl",
($taskName eq "" ) ? $addr: "$taskName $addr"));
}

#############################################################
#
# Subroutine to get the Visual Annotate solutions email
# command.
# Input: $program (iw-home relative path to email script)
# @parameters (parameters)
# Output: <command v="{email command}" />
#
#############################################################
sub iw_get_va_mail_cmd {

my ($program, @parameters) = @_;
my $parameter;
foreach (@parameters) {
$parameter .= " -t " . "\"$_\"" ;
}
$parameter =~ s/\s$//;

my $cmd;

if ($^O eq "MSWin32") {
$cmd = '"' . __VALUE__('iw_home','html') .
"/iw-perl/bin/iwperl\" " .
'"' . __VALUE__('iw_home','html') .
"/local/config/wft/solutions/$program\"" .
"$parameter";
} else {
$cmd = __VALUE__('iw_home','html') .
"/local/config/wft/solutions/$program" .
"$parameter"
}

$cmd = "<command v='$cmd'/>";
return $cmd;
}

#=====================================================================
# Name: iw_getrole
# Args: role - basename of a TeamSite role (*.uid) file, or
# similarly constructed customized file in the
# same directory.
# Usage: $html = iw_getrole("master");
# Purpose: Generate an HTML formatted drop-down menu of all
# entries in named file for use within a TAG_info()
# section.
# Returns: Returns the generated drop down list on success, or
# a text field with an error message if it was unable
# to open the file.
#=====================================================================
sub iw_getrole{
my($role) = @_;
$role .= ".uid" if ($role !~ /\.uid$/);
my($html) = "";

if (!open(IN, "<$iwhome/conf/roles/$role")){
$html = "<input type='text' value='--Error opening $role--'>";
}
else {
$html = "<select size='1'>\n<option>\n";
foreach (sort(<IN>)){
s/^\s*//gs; s/\s*$//gs;
$html .= "<option>$_\n";
}
close(IN);
$html .= "</select>\n";
}
return($html);
}

#=# (changed reference to renamed subroutine)
my($iw_admin_html) = iw_getrole("admin");
my($iw_masters_html) = iw_getrole("master");
my($iw_authors_html) = iw_getrole("author");
my($iw_editors_html) = iw_getrole("editor");

#=====================================================================
# file list for start task
#=====================================================================
my($iw_selected_files) = iw_get_filelist();

debug("<br />-----------------<br />$iw_selected_files<br />-----------------<br />");

#=====================================================================
# Name: iw_get_filelist
# Args: None.
# Usage: $xml = iw_get_filelist();
# Purpose: Generate an XML formatted list of all the files that
# were pre-selected when the workflow was initiated.
# Returns: Returns the XML formatted list if files were selected.
# Returns an empty string if no files were selected.
# Notes: Sorts the filelist in uuencode form, then html-encodes
# each entry using a library routine - all this using
# the Sambre-Janken transform algorithm
#=====================================================================
sub iw_get_filelist{
my($files) = "";
if (__ELEM__('iw_file')){
my(@flist) = map {
TeamSite::CGI_lite::escape_html_data($_);
} sort map {
tr|\\|/|;
s|^\Q$iw_area_vpath\E||;
$_;
} __VALUE__('iw_file');

$files = "<files>\n";
for (my $i = 0; $i < @flist; ++$i) {
$files .= "\t<file path='$flist[$i]' comment='task file'/>\n";
}
$files .= "</files>\n";
}
return($files);
}

############################################################
#
# Subroutine to obtain the owner and group of a file
# Input: <filename>
# Return: (waOwner, waGroup)
#
############################################################
sub getFileOwnerGroup {
my ($file) = (shift);
return (undef,undef) if (!defined $file);
$area =~ s/[\\\/]+/\//g;
my $cmd = "$iwhome/bin/iwattrib "; $cmd =~ s/[\\\/]+/\//g;
my $owner = __VALUE__('iw_areaowner');
my $group = `$cmd \"$file\" group`; chomp $group;
return ($owner, $group);
}

my ($waOwner, $waGroup) = &getFileOwnerGroup($iw_area_vpath); #__VALUE__('iw_workarea'));
$waGroup =~ s/^[^\\\/]+[\\\/]//;

debug("WA Owner $waOwner<br />");
debug("WA Group $waGroup<br />");

#############################################################
#
# Subroutine to get the correct path to a certain command.
# Input: teamsite relative path to the command
# eg. custom/detir/bin/do_nothing.ipl
# Output: full path of command
#
#############################################################
sub iw_get_cmd {

my($cmd) = @_;
return(sprintf("<command v='%s%s'/>",
($^O eq "MSWin32") ? "$iwhome/iw-perl/bin/iwperl " : "",
"$iwhome/$cmd"
));

}

#############################################################
#
# START USER/GROUP SUBROUTINES DEPENDENT ON AUTHORISATION
# AND AUTHNETICATION MODELS (LDAP/SOLARIS/LOCAL)
#
#############################################################
my $authType = "SOLARIS"; # options: SOLARIS|LDAP

#------------------------------------------------------------------------------
# Subroutine: GetOSGroupMembers
#
# Synopsis: returns a list of users derived from a domain groups (for SOLARIS)
#
# input: $groupname -- groupname to indicate a domain group
#
# output: $grpmembers -- a HTML string
#
#-------------------------------------------------------------------------------
sub GetOSGroupMembers {

if ($authType !~ /SOLARIS/) {
return undef;
}

my ($groupname) = @_;
my (@grpmembers)= ();
my $grpmembers = "";

#
# grab a list of members in the spceified domain groups
#
setgrent();
while (($name,$passwd,$gid,$members) = getgrent()) {

if ($name eq "$groupname") {
@grpmembers = split(/ /,$members);
foreach $ele(@grpmembers) {
chomp($ele);
$grpmembers = $grpmembers.",".$ele;
}
}
}
endgrent();
if ($grpmembers =~ /^,(.*)$/) {
$grpmembers = $1;
}

return $grpmembers;
}

# determine approval groups
my $gm_grp = $waGroup . "gm"; # gm approval group
$iw_area_vpath =~ /.*\/default\/main\/(dir|det)\/.*/;
my $web_grp = $1 . "itapp"; # I.T. Approvers
my $bus_grp = $waGroup . "ba"; # web approval group

# get users from groups
my $GM_APPROVERS = GetOSGroupMembers($gm_grp);
my $WEB_APPROVERS = GetOSGroupMembers($web_grp);
my $BUS_APPROVERS = GetOSGroupMembers($bus_grp);
my $ADMIN_USERS = GetOSGroupMembers($sysAdminGroup);

#############################################################
# END USER/GROUP SUBROUTINES
#############################################################

#############################################################
#
# Subroutine to determine if any of the file are
# non-templated.
# Templated types include DCRs.
# Input: none
# Output: 1 if all files are templated types
# 0 if any of the files are not templated
#
#############################################################
sub isTemplated {
use egov::iwea; # changed from iwsite::iwea

my(@flist) = map {
TeamSite::CGI_lite::escape_html_data($_);
} sort map {
tr|\\|/|;
s|^\Q$iw_area_vpath\E||;
$_;
} __VALUE__('iw_file');

# search for non-templated file. Assume templated initially
# and then change if non-templated file found
my $templated = 1;
foreach my $file (@flist) {

$file = $iw_area_vpath . $file;

my ($eaHash, $resultCode) = &eaRead($file);
if (! defined $eaHash) { return 0; }
if (! defined ${$eaHash}{"TeamSite/Templating/DCR/Type"}) {
$templated = 0;
}

if ((! defined ${$eaHash}{"TeamSite/Templating/Encoding"}) &&
(! defined ${$eaHash}{"TeamSite/Templating/PrimaryDCR"}) &&
(! defined ${$eaHash}{"TeamSite/Templating/PrimaryDocumentType"}) &&
(! defined ${$eaHash}{"TeamSite/Templating/PrimaryPT"}))
{
if ($templated == 0) {
return 0;
}
} else {
$templated = 1;
}

}

return ($templated);
}
# templated variable
my $iw_templated = &isTemplated();

#############################################################
#
# Subroutine to return the list of presentation files
# for a category/type in the current branch
# Input: (cat, type)
# Output: List of Files
#
#############################################################
sub getPTFileList {
debug("getPTFileList: CALLED");
my @fileList;
my ($category, $type) = @_;
debug("category=$category");
debug("type=$type");

my $ptdir = $iw_area_vpath . "/templatedata/$category/$type/presentation";
debug("ptdir=$ptdir");

# read ptdir
if (! opendir DFH, $ptdir) {
return undef;
}

my @dirContents = grep { ! /^\.+/ } readdir(DFH);

# add each non-directory file to the filelist
foreach $dirEntry (@dirContents) {
if (! -d $dirEntry) { push @fileList, $dirEntry; }
}
debug("getPTFileList: FINISHED");
return @fileList;

}

#############################################################
#
# Utility subroutine to determine if a passed parameter
# is not undefined or not empty
# Input: "string to check"
# Output: 1 if not empty and defined
# 0 otherwise
#
#############################################################
sub checkNotEmpty {
debug("checkNotEmpty: CALLED");
my ($param) = @_;

if ((! defined $param) || ($param =~ /^\s*$/)) {
debug("checkNotEmpty: FINISHED");
return 0;
} else {
debug("checkNotEmpty: FINISHED");
return 1;
}
}

##############################################################################
#
# Subroutine to determine the OpenDeploy deployment configuration to use
# as part of the workflow deploy script. This value should then be set
# as a workflow variable to be used by the deployment scripts
# Input: none
# Ouput: deployment profile name
#
##############################################################################
sub getDeploymentProfile {

my $br = $iw_area_vpath;
$br =~ s/(.*)main\/.*?\/(.*)\/(STAGING|WORKAREA|EDITION)\/.*/$2/;
$br =~ s/(.*)\/(.*)/$2/;

# get deployment for the current branch
my $deplProf = get_config('opendeploy', $br);

# check for validity. Use default if not found.
if (! defined $deplProf) {
$deplProf = get_config('opendeploy', 'default');
}

return ($deplProf);

}

##############################################################################

# default timeout value
my $iw_timeout = "72";

TAG_info(

iw_desc => [ html => "<textarea rows='5' cols='40'></textarea>",
label => "Job Description",
error_msg => "Please enter a short description",
is_required => 'true',
],
);

]]>

</template_script>

<workflow name = "Build Primarymenu" owner = "__TAG__(iw_areaowner);" creator = "__TAG__(iw_user);" description = "Simple workflow to generate primary menu">
<endtask name = "end" />
<externaltask lock = "f" name = "Generate" owner = "__TAG__(iw_areaowner);" retry = "t" start = "t">
<areavpath v = "__INSERT__($iw_area_vpath);"/>
<successors>
<successorset description = "success">
<succ v="end"/>
</successorset>
</successors>
<command v = "/web/Interwoven/TeamSite/custom/bin/prnav_gen.ipl"/>
</externaltask>
</workflow>

Edited by tsrookie on 10/26/04 08:27 PM (server time).

tsrookie

Fish,

In your supplemental tutorial you suggest running it from the command line in the same way the workflow egine would

e.g

iwperl scriptname-with-path 123 124 areavpath

When I do this my script runs successfully,

but when called from the workflow it doesn't

Any suggestions?

I imagine their is some relationship between owner of the workflow, owner and creator of the task and the owner of the folder to which the external task script is generating the output.

Regards
Colin

When I run debug this is the workflow xml
<?xml version="1.0" standalone="no" ?>
<!DOCTYPE workflow SYSTEM "iwwf.dtd">

<workflow name = "Build Primarymenu" owner = "johnstcx" creator = "johnstcx" description = "Simple workflow to generate primary menu">
<endtask name = "end" />
<externaltask lock = "f" name = "Generate" owner = "johnstcx" retry = "t" start = "t">
<areavpath v = "/default/main/det/development/WORKAREA/internet"/>
<successors>
<successorset description = "Success">
<succ v="end"/>
</successorset>
</successors>
<command v = "/web/Interwoven/TeamSite/iw-perl/bin/iwperl /web/Interwoven/TeamSite/local/config/wft/egov/prnav_exttasks/prnav_gen.ipl"/>
</externaltask>
</workflow>

Edited by tsrookie on 10/27/04 00:02 AM (server time).

Adam Stoller

Who are you logged in as when you use the shell? If you're not logged in as "johnstcx" you're wasting your time - since that's the user who is supposedly the owner of the externaltask.

Is the externaltask currently an active task in the workflow? If not - you're again wasting time - since the externaltask script needs to run in the context of the externaltask it was defined for (this is the reason for commenting out the callback when you're doing the debugging - so that the task stays active and you can run the script multiple times within that same context).

What do you see if you run:
iwperl -w -c /web/Interwoven/TeamSite/local/config/wft/egov/prnav_exttasks/prnav_gen.ipl

--fish
Senior Consultant, Quotient Inc.
http://www.quotient-inc.com

tsrookie

Hi fish,

It says syntax ok when I use -w -c switches.

I login to Teamsite as myself johnstcx as a master

When I run the workflow in Teamsite my debug log says it cannot create the file which suggests a permisons issue, I think.

Colin

Adam Stoller

can you post the externaltask script as it currently exists?

--fish
Senior Consultant, Quotient Inc.
http://www.quotient-inc.com

tsrookie

Hi Fish,

Thank you

here it is.

#!/web/Interwoven/TeamSite/iw-perl/bin/iwperl

use strict;
use POSIX qw(getpid strftime);
use TeamSite::Config;
use TeamSite::WFtask;
use TeamSite::WFworkflow;
use File::Basename;
use egov::iwea;

# Debug module
use egov: Smiley Very Happy

ebugLog ($DEBUG, "/tmp/$scriptName".".log");

# Get parameters
my ($jobId, $taskId, $area) = (@ARGV[0..2]);

# Create wf and task objects
my($wf) = TeamSite::WFworkflow->new($jobId);
if (! defined $wf) {
$debug->printlog("ERROR: creating workflow job object.");
exit(1);
}

my($task) = TeamSite::WFtask->new($taskId);
if (! defined $task) {
$debug->printlog("ERROR: creating workflow task object.");
exit(1);
}

# State variables in script.
my $errorComment = 'ERROR: task error detected in $scriptName.'; # Default error comment.
my $taskComment = 'SUCCESS: '; # Default task transition comment.

# What is my PID
my $pid = getpid();
chomp $pid;

# Error check debug object.
if (! defined $debug) {
exit(1);
}

$debug->printlog("Begin session $pid $scriptName");

$debug->printlog("BEGIN $pid: script body.");

my $branch = 'det';
my $subBranch = 'development';

my $waPath = "$branch/$subBranch/WORKAREA/internet";

my $vPath = "includes/ssi/primarymenu.ssi";
my $templateVPath = "$iw_mount/default/main/$waPath/templatedata/navigation/primaryMenu/presentation/primarymenu.tpl";
my $recordVPath = "$iw_mount/default/main/$waPath/templatedata/navigation/primaryMenu/data/primarymenu";

############################################################################
# Start script body
############################################################################

my $comment = "";

# has the file been generated before

if( -f $vPath ){

# it exists use iwregen
$debug->printlog("$pid. Regenerating primarymenu.ssi");

my $cmd = qq[$IWREGEN "$vPath"];

my $cmdResult = `$cmd 2>&1`;
if( $cmdResult =~ /^\s*$/ ) {
$cmdResult = "Successful file regeneration.";
$comment = "REGEN COMMAND: $cmd\nREGEN RESULT: $cmdResult";
$debug->printlog("REGEN $pid: Regen $vPath\n$comment");
} else {
$errorComment = "ERROR: Template renegeneration failed:\n";
$errorComment .= " Cmd: $cmd\n Result: $cmdResult\n";
$debug->printlog("$errorComment");
&abort(1, "$errorComment");
}

}
else{

# it doesn't exist use iwgen
$debug->printlog("$pid. generating primarymenu.ssi");

if( -f $recordVPath ){

#dcr exists
$debug->printlog("$pid. primary menu dcr exists");

my $cmd = qq[$IWGEN -t "$templateVPath" -r "$recordVPath" "$vPath"];

my $cmdResult = `$cmd 2>&1`;
if( $cmdResult =~ /^\s*$/ ) {
$cmdResult = "Successful file generation.";
$comment = "GEN COMMAND: $cmd\nGEN RESULT: $cmdResult";
$debug->printlog("GEN $pid: gen $vPath\n$comment");
} else {
$errorComment = "ERROR: dcr generation failed:\n";
$errorComment .= " Cmd: $cmd\n Result: $cmdResult\n";
$debug->printlog("$errorComment");
&abort(1, "$errorComment");
}

}
else{

#dcr doesn't exist
$debug->printlog("$pid. primary menu dcr has not been created! ");
&abort(1, "$errorComment");
}

}

$task->CallBack( 0, "Success" );
exit(0);

# EXITS THE SCRIPT ON ERROR
sub abort {
my ($callback, $comment) = (shift,shift);

my $message = "";
if ($callback == 0) {
$message = $taskComment . " " . $comment ;
}
else {
$message = $comment;
}
$debug->printlog("$message");
print STDERR $message;
$task->CallBack($callback, "$message");
exit($callback);
}

Adam Stoller

See the notes in red
#!/web/Interwoven/TeamSite/iw-perl/bin/iwperl
use strict;
use POSIX qw(getpid strftime);
use TeamSite::Config;
use TeamSite::WFtask;
use TeamSite::WFworkflow;
use File::Basename;
use egov::iwea;

# Debug module
use egov: Smiley Very Happy

ebugLog;
my $DEBUG = 1;

# Get iw_home and iw_mount
my $iw_home = TeamSite::Config::iwgethome();
my $iw_mount = TeamSite::Config::iwgetmount();

# Who am I.
#=# my $scriptName = &basename($0);
#=# $scriptName =~ s/\.[^\.]+$//i;
#=# File::Basename is bad performance-wise, the regex is simpler and faster
(my $scriptName = $0) =~ s|^.*/([^/]+)\.[^/\.]+$|$1|;

# Conststants of CLTs used in script
my $IWREGEN = $iw_home . "/bin/iwregen";
my $IWGEN = $iw_home . "/bin/iwgen";

my $debug = new egov: Smiley Very Happy

ebugLog ($DEBUG, "/tmp/$scriptName".".log");

# Get parameters
my ($jobId, $taskId, $area) = (@ARGV[0..2]);

# Create wf and task objects
#=# my($wf) = TeamSite::WFworkflow->new($jobId);
#=#if (! defined $wf) {
#=# $debug->printlog("ERROR: creating workflow job object.");
#=# exit(1);
#=#}
#=# Don't bother creating the wf object if you don't need it.
my($task) = TeamSite::WFtask->new($taskId);
#=#if (! defined $task) {
#=# Use the IsValid() method
if (!$task->IsValid()){
$debug->printlog("ERROR: creating workflow task object.");
exit(1);
}

# State variables in script.
my $errorComment = 'ERROR: task error detected in $scriptName.'; # Default error comment.
my $taskComment = 'SUCCESS: '; # Default task transition comment.

# What is my PID
my $pid = getpid();
chomp $pid;

#=# This error check should have occurred when you
#=# first tried to create the debug object.
# Error check debug object.
if (! defined $debug) {
exit(1);
}

$debug->printlog("Begin session $pid $scriptName");

$debug->printlog("BEGIN $pid: script body.");

my $branch = 'det';
my $subBranch = 'development';

my $waPath = "$branch/$subBranch/WORKAREA/internet";

my $vPath = "includes/ssi/primarymenu.ssi";
my $templateVPath = "$iw_mount/default/main/$waPath/templatedata/navigation/primaryMenu/presentation/primarymenu.tpl";
my $recordVPath = "$iw_mount/default/main/$waPath/templatedata/navigation/primaryMenu/data/primarymenu";

############################################################################
# Start script body
############################################################################

my $comment = "";

# has the file been generated before
#=# This next test is questionable, instead of $vPath
#=# you should probably be using $iw_mount/default/main/$waPath/$vPath
if( -f $vPath ){
# it exists use iwregen
$debug->printlog("$pid. Regenerating primarymenu.ssi");

#=# Again, $vPath by itself may not be good enough
#=# I'd suggest /default/main/$waPath/$vPath
my $cmd = qq[$IWREGEN "$vPath"];

my $cmdResult = `$cmd 2>&1`;
if( $cmdResult =~ /^\s*$/ ) {
$cmdResult = "Successful file regeneration.";
$comment = "REGEN COMMAND: $cmd\nREGEN RESULT: $cmdResult";
$debug->printlog("REGEN $pid: Regen $vPath\n$comment");
} else {
$errorComment = "ERROR: Template renegeneration failed:\n";
$errorComment .= " Cmd: $cmd\n Result: $cmdResult\n";
$debug->printlog("$errorComment");
&abort(1, "$errorComment");
}

}
else{

# it doesn't exist use iwgen
$debug->printlog("$pid. generating primarymenu.ssi");

if( -f $recordVPath ){

#dcr exists
$debug->printlog("$pid. primary menu dcr exists");
#=# Both $templateVPath and $recordVPath were defined
#=# with $iw_mount at the beginning, which means that they are
#=# file system paths, not vpaths - they should be vpaths;
#=# Additionally, $vPath is an area-relative path not a vpath, as stated
#=# before, it should be /default/main/...$vPath
#=# The fact that it isn't could account for a permission denied error.
my $cmd = qq[$IWGEN -t "$templateVPath" -r "$recordVPath" "$vPath"];

my $cmdResult = `$cmd 2>&1`;
if( $cmdResult =~ /^\s*$/ ) {
$cmdResult = "Successful file generation.";
$comment = "GEN COMMAND: $cmd\nGEN RESULT: $cmdResult";
$debug->printlog("GEN $pid: gen $vPath\n$comment");
} else {
$errorComment = "ERROR: dcr generation failed:\n";
$errorComment .= " Cmd: $cmd\n Result: $cmdResult\n";
$debug->printlog("$errorComment");
&abort(1, "$errorComment");
}

}
else{

#dcr doesn't exist
$debug->printlog("$pid. primary menu dcr has not been created! ");
&abort(1, "$errorComment");
}

}

$task->CallBack( 0, "Success" );
exit(0);

# EXITS THE SCRIPT ON ERROR
sub abort {
my ($callback, $comment) = (shift,shift);

my $message = "";
if ($callback == 0) {
$message = $taskComment . " " . $comment ;
}
else {
$message = $comment;
}
$debug->printlog("$message");
print STDERR $message;
$task->CallBack($callback, "$message");
exit($callback);
}

--fish
Senior Consultant, Quotient Inc.
http://www.quotient-inc.com

example1.jpg

tsrookie

Hi Fish,

Thank you , thank you, thank you it works High 5!

I didn't know what exactly a vpath was and assumed all system relative paths as you saw.

Regards
Colin

now to add some more tasks etc.

tsrookie

Ok Im stumped,

I tried to add a submit task with no success.

I assume the purpose of a submit task is ismply to move files to the staging area.

I guess I have to add the generated file to the task so the submit task knows what to submit but I can't figure out how to do that.

I have successfully added an email task as well but need to flesh out the email.

Any help appreciated.

Thank you
Colin

<?xml version="1.0" standalone="no" ?>
<!DOCTYPE workflow SYSTEM "iwwf.dtd">

<workflow name = "Build Primarymenu" owner = "johnstcx" creator = "johnstcx" description = "Simple workflow to generate primary menu">

<variables>
<variable key="workarea" value="/default/main/det/development/WORKAREA/internet"/>
</variables>

<externaltask lock = "f" name = "Generate" owner = "johnstcx" retry = "t" start = "t">
<areavpath v = "/default/main/det/development/WORKAREA/internet"/>
<successors>
<successorset description = "Success">
<succ v="EmailAuthor"/>
</successorset>
</successors>
<command v = "/web/Interwoven/TeamSite/iw-perl/bin/iwperl /web/Interwoven/TeamSite/local/config/wft/egov/prnav_exttasks/prnav_gen.ipl"/>
</externaltask>

<externaltask lock = "f" name = "EmailAuthor" owner = "johnstcx" retry = "f" start = "f" description = "Notify WCO of proposed changes via Email">
<areavpath v = "/default/main/det/development/WORKAREA/internet"/>
<successors>
<successorset description = "Submit files to Staging">
<succ v = "SubmitContent"/>
</successorset>
</successors>
<command v='/web/Interwoven/TeamSite/bin/iwsend_mail.ipl colin.johnstone@det.qld.gov.au'/>
<activation>
<or>
<pred v = "Generate"/>
</or>
</activation>
</externaltask>

<submittask name = "SubmitContent" owner = "johnstcx" description = "Submit files to staging" unlock = "t" skiplocked="f" override="t" start="f">
<areavpath v = "/default/main/det/development/WORKAREA/internet"/>
<successorset description = "Go to End">
<succ v = "end"/>
</successorset>
<activation>
<or>
<pred v = "EmailAuthor"/>
</or>
</activation>
</submittask>

<endtask name = "end" />

</workflow>

Adam Stoller

Adding files to an active workflow is pretty trivial - have you bothered to read the documentation? not just the manuals but the perldoc for the workflow specific modules? If not, I suggest you do. If so, I suggest you either re-read them, get some training, or hire someone who knows how to do this.

There's a limit of how much of your work I'm going to do for you for free.

--fish
Senior Consultant, Quotient Inc.
http://www.quotient-inc.com

tsrookie

Thanks again, Fish

submit task completed

sometimes I just need a push in the right direction.

iwaddtaskfile right !

Colin