Commands in IPL Files

Sorry for the nube question, but (quick background) I recently got out of an Interwoven Training Class and have build a couple of sites in our instance of TeamSite, always being able to utilize existing Workflows (we have an installation that has been going for a couple of years.)

The newest site requires something a bit different, which means it is time for me to brave the Workflow world. I have broken down many of our workflows (by the way, we don't use the Builder...the primary support before me were not happy with it for some reason or another) and belive I am getting a very basic understanding of how it works.

One question....in each of the crafted workflows, various files are listed under 'my @externalcmd', which seems to be some kind of include that defines how certain actions take place. These files are always located here : $iwhome/local/bin/

My problem is that each of these files, in the BIN folder, contain a reference like this :
$iw_home/OpenDeployNG/bin/iwodstart intranet_hr_qa

It seems clear to me that the key is the 'intranet_hr_qa' variable...which must be defined somewhere...I simply cannot discover where. If any of this makes sense, I simply am interested in finding out where the 'intranet_hr_qa' definition is stored.

Thanks for your time.

Jones

Find more posts tagged with

Comments

Migrateduser

This must be a custom variable. You'll probably need to attach the code for your workflow.

- Jason

jajtiii

Absolutely:

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

##########################################################################
#
# Name: DNet News Review and Publish
# To Integration Area Workarea (dnet_news_review_and_publish.wft)
# Date: 03.27.2003
# Developer: James Green (Dominion 2003)
#
#
#
##########################################################################

########## ENVIRONMENT VARIABLES #####################################

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

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

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");
my($iw_selected_files) = iw_get_filelist();

#&debug; # UNCOMMENT FOR DEBUG

######################### BEGIN BASE SUBs #############################

#=====================================================================
# 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 don't
# 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(
"/intranet/$bp/WORKAREA/$wa");

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

#=====================================================================
# 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");
}

#======================================================================
# 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, $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",
$addr));
}

#=====================================================================
# 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);
}

#=====================================================================
# 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);
}

sub wa_validator{
my($wa, $error) = @_;
if ($wa eq ""){
return(0) if (!$error);
return("Please Enter a Workarea Name");
}
my($branch) = __VALUE__('branch_path');
my($avpath, $mount);
(undef, undef, $avpath) = iw_cleanup_paths("$branch", "$wa");
chomp($mount = `iwgetmount`);
if (! -d "$mount$avpath"){
return(0) if (!$error);
return("Invalid path: '$mount$avpath'");
}
return(1);
}

sub timeout_validator{
my($val, $error) = @_;
if ($val !~ /^\d+$/){
return(0) if (!$error);
return("Please enter a number between zero and three");
}
if ($val < 0){
return(0) if (!$error);
return("Number of days must be greater than or equal to zero");
}
if ($val > 3){
return(0) if (!$error);
return("Number of days must be less than or equal to three");
}
return(1);
}

sub debug{
TAG_info(
iw_output_file => "<input type='text' value='/tmp/foo.xml'>",
iw_debug_mode =>
"<input type='radio' value='true'>True</input>" .
"<input type='radio' value='false'>False</input>",
);
}

########### WORKFLOW SPECIFIC VARIABLES ####################
my @externalcmd = (
"$iwhome/local/bin/wfHR_DeployToQA.ipl",
"$iwhome/local/bin/wfHR_QAReviewEMail.ipl",
"$iwhome/local/bin/wfHR_PublishAndDeploy.ipl"
);

my $integration_area_vpath = "/intranet/main/hr1.dominionnet/WORKAREA/integration";
my $delay_time_out = sprintf("+%04d00", __VALUE__('time_out') * 24);
$reject_path_task = "initiate_job";
$editorial_review_start_attrib = "t";
my $user_task_reject = "";
my $user_task = "";

TAG_info(
wf_name => [
html => "<input type='text' size='40' maxLength='200'>",
is_required => 'true',
label => "Enter a Name for the New Job:",
error_msg => 'Please enter a Name for the Job to be performed.',],
time_out => [
html => "<input type='text' size='2' value='3'>",
is_required => 'true',
label => "Timeout for Job expiration in days:",
valid_input => 'timeout_validator($_, 0)',
error_msg => q{'timeout_validator($_, 1)'},],
iw_desc => [
html => "<textarea rows='5' cols='40'></textarea>",
is_required => 'true',
label => "Enter a Description for the New Job:",
error_msg => 'Please enter a description of the Job to be performed.',],
);

## CHECK FOR Workarea and Branch Validity ##
if ($iw_skip_branch eq "FALSE") {
TAG_info(
branch_path => [
html => "<input type='text'></input>",
label => 'Select Branch',
],
work_area => [
html => "<input type='text'></input>",
label => 'Enter Workarea',
valid_input => 'wa_validator($_, 0)',
error_msg => q{'wa_validator($_, 1)'},
],
);
}

]]>

</template_script>
<workflow name = "__TAG__('wf_name');"
owner = "__TAG__('iw_user');"
creator = "__TAG__('iw_user');"
description = "__TAG__('iw_desc');">

__INSERT__($user_task);



<usertask lock = "t"
name = "initiate_job"
owner = "__TAG__(iw_user);"
start = "t"
readonly = "f"
description = "Begin Publish Process">
<areavpath v = "__INSERT__($iw_area_vpath);"/>
<successors>
<successorset description = "Begin QA Review">
<succ v = "version_files"/>
</successorset>
__INSERT__($user_task_reject);
</successors>
__INSERT__($iw_selected_files);
</usertask>



<submittask name = "version_files"
owner = "teamsite"
start = "f"
unlock = "t"
override = "f"
skiplocked = "f"
description = "Version files."
savecomments = "t"
skipconflicts = "f">
<areavpath v = "__INSERT__($iw_area_vpath);"/>
<successorset description = "Deploy web docs to QA for review.">
<succ v = "deploy_to_qa"/>
</successorset>
</submittask>



<externaltask lock = "f"
name = "deploy_to_qa"
owner = "teamsite"
retry = "t"
start = "f"
description = "Deploy web docs to QA for review.">
<areavpath v = "__INSERT__($iw_area_vpath);"/>
<successors>
<successorset description = "QA Review List sent to task owner, cc: to Manager.">
<succ v = "qa_review_email"/>
</successorset>
</successors>
<command v = "__INSERT__($externalcmd[0]);"/>
</externaltask>



<externaltask lock = "f"
name = "qa_review_email"
owner = "__TAG__(iw_user);"
retry = "t"
start = "f"
description = "QA Review List sent to task owner, cc: to Manager.">
<areavpath v = "__INSERT__($iw_area_vpath);"/>
<successors>
<successorset description = "Final review of attached files.">
<succ v = "final_review"/>
</successorset>
</successors>
<command v = "__INSERT__($externalcmd[1]);"/>
</externaltask>



<usertask lock = "f"
name = "final_review"
owner = "__TAG__(iw_user);"
start = "f"
readonly = "t"
description = "Final review of attached files.">
<areavpath v = "__INSERT__($iw_area_vpath);"/>
<successors>
<successorset description = "Approve For Production">
<succ v = "update_integration_area"/>
</successorset>
<successorset description = "Reject - Send Back For Rework">
<succ v = "__INSERT__($reject_path_task);"/>
</successorset>
<successorset description = "Reject - Cancel Job">
<succ v = "end"/>
</successorset>
</successors>
</usertask>



<updatetask lock = "f"
name = "update_integration_area"
owner = "teamsite"
start = "f"
delete = "t"
description = "Update Integration"
overwritemod = "t">
<areavpath v = "__INSERT__($integration_area_vpath);"/>
<successorset description = "Submit To Staging">
<succ v = "submit_to_integration" />
</successorset>
<srcareavpath v = "__INSERT__($iw_area_vpath);"/>
</updatetask>



<submittask name = "submit_to_integration"
owner = "teamsite"
start = "f"
unlock = "t"
override = "f"
skiplocked = "f"
description = "Version Files"
savecomments = "t"
skipconflicts = "f">
<areavpath v = "__INSERT__($integration_area_vpath);"/>
<successorset description = "Publish and Deploy">
<succ v = "publish_and_deploy"/>
</successorset>
</submittask>



<externaltask lock = "f"
name = "publish_and_deploy"
owner = "root"
retry = "t"
start = "f"
description = "Publish next edition and deploy changes to production">
<areavpath v = "__INSERT__($integration_area_vpath);"/>
<successors>
<successorset description = "Go to Delay">
<succ v = "delay"/>
</successorset>
</successors>
<command v = "__INSERT__($externalcmd[2]);"/>
</externaltask>



<dummytask name = "delay"
owner = "teamsite"
start = "f">
<timeout v = "__INSERT__($delay_time_out);">
<succ v = "end"/>
</timeout>
</dummytask>




<endtask name = "end"
description = "End Job"/>

</workflow>

Migrateduser

Sorry, I misread your first post... The intranet_hr_qa isn't a variable. It's the name of a deployment configuration. There should be a configuration file in your <OD-HOME>/conf directory with that name.

Looks like the @externalcmd array is pointing to 3 different programs.
$externalcmd[0] == "$iwhome/local/bin/wfHR_DeployToQA.ipl"
$externalcmd[1] == "$iwhome/local/bin/wfHR_QAReviewEMail.ipl"
$externalcmd[2] == "$iwhome/local/bin/wfHR_PublishAndDeploy.ipl"

Hope that helps.

- Jason

Adam Stoller

One question....in each of the crafted workflows, various files are listed under 'my @externalcmd', which seems to be some kind of include that defines how certain actions take place. These files are always located here : $iwhome/local/bin/

My problem is that each of these files, in the BIN folder, contain a reference like this :
$iw_home/OpenDeployNG/bin/iwodstart intranet_hr_qa

It seems clear to me that the key is the 'intranet_hr_qa' variable...which must be defined somewhere...I simply cannot discover where. If any of this makes sense, I simply am interested in finding out where the 'intranet_hr_qa' definition is stored.

@externalcmd was a convention adopted in a number of workflows to list all the externaltask scripts up near the top and then reference them latter on via something like <command v='__INSERT__($externalcmd[0]);'/> - other people created separate variables like $mailcmd and $deploycmd to store this information, and other folks just coded everything into the insertion directive like <command v='__INSERT__($iwhome/local/bin/myscript.ipl);'/> - nothing special, just a stylistic approach.

The intranet_hr_qa is not a variable - it is the name of an OD deployment configuration file (which live in $iw_home/OpenDeployNG/conf/ and end with a ".xml" extension.

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

jajtiii

I truly appreciate your prompt reply on that one, Jason.

That is exactly what I was looking for.

jajtiii

also, thanks to ghoti!