Idoc script beginner guide

Idoc Script Syntax
 Idoc Script Tags
Idoc Script commands begin with <$ and end with $> delimiters. For example:
<$dDocTitle$>
<$if UseGuiWinLook and isTrue(UseGuiWinLook)$>
Idoc Script Comments
You can use standard HTML comments or Idoc Script comments in Idoc Script code. An Idoc Script comment
begins with [[% and closes with %]] delimiters. For example:

[[%My Comment%]]
----------------------------------------------------------------------------------------------------
Variables
A variable enables you to define and substitute variable values.
 A value can be assigned to a variable using the structure:
 <$variable=value$>
For example, <$i=0$> assigns the value of 0 to the variable i.
 Variable values can also be defined in an environment resource (CFG) file using the following
name/value pair format:
variable=value
Idoc Script supports multiple clauses separated by commas in one script block.
For example, you can use <$a=1,b=2$> rather than two separate statements: <$a=1$> and <$b=2$>.
Referencing a Variable in a Conditional
The following structure can be used to evaluate the existence of a variable:
<$if variable_name$>
If the variable is defined, this conditional is evaluated as TRUE. If the variable is not defined or it is defined as an
empty (null) string, it is evaluated as FALSE.
--------------------------------------------------------------------------------------------------------
Functions
Idoc Script has many built-in global functions. Functions perform actions, including string comparison and
manipulation routines, date formatting, and ResultSet manipulation. Some functions also return results, such as
the results of calculations or comparisons.
Information is passed to functions by enclosing the information in parentheses after the name of the function.
Pieces of information that are passed to a function are called parameters. Some functions do not take

parameters; some functions take one parameter; some take several. There are also functions for which the
number of parameters depends on how the function is being used.
Personalization functions refer to user properties that are defined in personalization files, also called user topic
files. Each user's User Profile settings, personal links in the left navigation bar, and workflow in queue information
are all defined in user topic files, which are HDA files located in
the WC_CONTENT_ORACLE_HOME/data/users/profiles/us/username/ directories.
The following global functions reference user topic files:
 "utGetValue"
 "utLoad"
 "utLoadResultSet"
For example, the Portal Design link in a user's left navigation bar is generated from the following code in
the pne_nav_userprofile_links include (located in
the WC_CONTENT_ORACLE_HOME/shared/config/resources/std_page.htm resource file). If
the portalDesignLink property in
the WC_CONTENT_ORACLE_HOME/data/users/profiles/us/username/pne_portal.hda file is TRUE, the link is
displayed:
<$if utGetValue("pne_portal", "portalDesignLink") == 1$>
<$hasUserProfileLinks=1$>
<tr>
<td colspan=2 nowrap align="left">
<a class=pneLink
href="<$HttpCgiPath$>?IdcService=GET_PORTAL_PAGE&Action=GetTemplatePage&Page=PNE_PO
RTAL_DESIGN_PAGE">
<$lc("wwPortalDesign")$></a>
<td>
</tr>
<$endif$>
---------------------------------------------------------------------------------------------------------------
Conditionals
A conditional enables you to use if and else clauses to include or exclude code from an assembled page.
 Use the following Idoc Script keywords to evaluate conditions:
o <$if condition$>
o <$else$>
o <$elseif condition$>
o <$endif$>
 Conditional clauses use this general structure:
 <$if conditionA$>
 
 <$elseif conditionB$>
 
 <$else$>
 
 <$endif$>

 A condition expression can be any Idoc Script function or variable.
For more information, see Section 2.3.2.5, "Referencing a Variable in a Conditional."
 Boolean Operators can be used to combine conditional clauses. For example, you can use
the and operator as follows:
 <$if UseBellevueLook and isTrue(UseBellevueLook)$>
 If the condition expression is the name of a ResultSet available for inclusion in the HTML page, the
conditional clause returns true if the ResultSet has at least one row. This ensures that a template page
presents information for a ResultSet only if there are rows in the ResultSet.
 A conditional clause that does not trigger special computation is evaluated using
the XXXXXXXXXXXX_cannot_cross-reference to a marker on a para in
a bable_XXXXXXXXXXXXXX prefix. The result is true if the value is not null and is either a nonempty
string or a nonzero integer.
For an example of conditional code, see Section 2.3.4.1, "Conditional Example."
2.3.4.1 Conditional Example
In this example, a table cell <td> is defined depending on the value of the variable xDepartment:
<$if xDepartment$>
<td><$xDepartment$></td>
<$else$>
<td>Department is not defined.</td>
<$endif$>
<$xDepartment=""$>
 If the value of xDepartment is defined, then the table cell contains the value of xDepartment.
 If the value of xDepartment is not defined or is an empty (null) string, a message is written as the
content of the table cell.
 The last line of code clears the xDepartment variable by resetting it to an empty string.
Looping
Loop structures allow you to execute the same code a variable number of times. Looping can be accomplished in
two ways with Idoc Script:
ResultSet Looping
ResultSet looping repeats a set of code for each row in a ResultSet that is returned from a query. The name of
the ResultSet to be looped is specified as a variable using the following syntax:
<$loop ResultSet_name$>
code
<$endloop$>
 The code between the <$loop$> and <$endloop$> tags is repeated once for each row in the
ResultSet.
 When inside a ResultSet loop, you can retrieve values from the ResultSet using the getValue function.
Substitution of values depends on which row is currently being accessed in the loop.
 When inside a ResultSet loop, that ResultSet becomes active and has priority over other ResultSets
when evaluating variables and conditional statements.
 You cannot use the <$loop$> tag to loop over a variable that points to a ResultSet. Instead you must
loop over the ResultSet manually using the rsFirst and rsNext functions.

For example, you cannot use the following code to loop over a ResultSet:
<$name="SearchResults"$>
<$loop name$>

<$endloop$>
Instead, you must use the following code:
<$name="SearchResults"$>
<$rsFirst(name)$>
<$loopwhile getValue(name, "#isRowPresent")$>

<$rsNext(name)$>
<$endloop$>
ResultSet Looping Example
In this example, a search results table is created by looping over the SearchResults ResultSet, which was
generated by the GET_SEARCH_RESULTS service.
<$QueryText="dDocType <matches> 'ADACCT'"$>
<$executeService("GET_SEARCH_RESULTS")$>
<table>
<tr>
<td>Title</td><td>Author</td>
</tr>
<$loop SearchResults$>
<tr>
<td><a href="<$SearchResults.URL$>"><$SearchResults.dDocTitle$></a></td>
<td><$SearchResults.dDocAuthor$></td>
</tr>
<$endloop$>
</table>
While Looping
While looping enables you to create a conditional loop. The syntax for a while loop is:
<$loopwhile condition$>
code
<$endloop$>
 If the result of the condition expression is true, the code between
the <$loopwhile$> and <$endloop$> tags is executed.
 After all of the code in the loop has been executed, control returns to the top of the loop, where
the condition expression is evaluated again.
o If the result is true, the code is executed again.
o If the code if the result is false, the loop is exited.
While Looping Example
In this example, a variable named abc is increased by 2 during each pass through the loop. On the sixth pass
(when abc equals 10), the condition expression is no longer true, so the loop is exited.
<$abc=0$>
<$loopwhile abc<10$>
<$abc=(abc+2)$>
<$endloop$>
Ending a Loop
There are two Idoc Script tags that will terminate a ResultSet loop or while loop:

 <$endloop$> returns control to the beginning of the loop for the next pass. All loops must be closed
with an <$endloop$> tag.
 <$break$> causes the innermost loop to be exited. Control resumes with the first statement following
the end of the loop.
Workflow Admin
In the Workflow Admin tool, you can use Idoc Script to define the following:
 step events
 jump messages
 extra exit conditions
 tokens
 custom effects for jumps
For example, the following step entry script sends documents in the Secure security group to the next step in
the workflow:
<$if dSecurityGroup like "Secure"$>
<$wfSet("wfJumpName", "New")$>
<$wfSet("wfJumpTargetStep", wfCurrentStep(1))$>
<$wfSet("wfJumpEntryNotifyOff", "0")$>
<$endif$>
--------------------------------------------------------------------------------------------------------------------------------------
#active <$#active.variable$> Retrieves the value of the specified variable from the DataBinder,
searching in the following default order:
1. Active ResultSets
2. Local data
3. All other ResultSets
4. Environment
Does not send an error report to the debug output if the variable is not
found.
#local <$#local.variable$> Retrieves the value of the specified variable from the local data. Does not
send an error report to the debug output if the variable is not found.
#env <$#env.variable$> Retrieves the value of the specified variable from the environment
settings. Does not send an error report to the debug output if the variable
is not found.
exec <$exec expression$> Executes an expression and suppresses the output (does not display the
expression on the page).
In earlier versions of Idoc Script, the exec keyword was required to
suppress the value of any variable from appearing in the output file. In
the current version, the exec keyword is needed only to suppress
an expression from appearing in the output file.
include <$include ResourceName$> Includes the code from the specified resource. For more information,
see Section 2.3.1, "Includes."
super <$include
super.<include>$>
Starts with the existing version of the include code. For more information,
see Section 2.3.1.2, "Super Tag."

- exec Keyword
The exec keyword executes an Idoc Script expression and suppresses the output (does not display the
expression on the page). It is primarily used to set variables without writing anything to the page.
In earlier versions of Idoc Script, the exec keyword was required to suppress the value of any variable from
appearing in the output file. In the current version, the exec keyword is needed only to suppress an expression
from appearing in the output.
For example, the first line below is equivalent to the last two lines:
<$varA="stringA", varB ="stringB"$>
<$exec varA="stringA"$>
<$exec varB="stringB"$>
eval Function
The eval function evaluates an expression as if it were actual Idoc Script.
In the following example, a variable named one is assigned the string Company Name, and a variable
named two is assigned a string that includes variable one.
<$one="Company Name"$>
<$two="Welcome to <$one$>"$>
<$one$><br>
<$two$><br>
<$eval(two)$>
In the page output, variable one presents the string Company Name, variable two presents the string Welcome
to <$one$>, and the function eval(two) presents the string Welcome to Company Name.
Note that the string to be evaluated must have the Idoc Script delimiters <$ $> around it, otherwise it will not be
evaluated as Idoc Script.
Also note that too much content generated dynamically in this manner can slow down page display. If
the eval function is used frequently on a page, it may be more efficient to put the code in an include and use
the inc Function in conjunction with the eval function.
Metadata Field Naming
Each metadata field has an internal field name, which is used in code. In addition, many fields have descriptive
captions which are shown on web pages.
 All internal metadata field names begin with either a d or an x:
o Predefined field names begin with a d. For example, dDocAuthor.
o Custom field names begin with an x. For example, xDepartment.
Workflow Functions
 wfSet
Sets a key with a particular value in the companion file.
Parameters
Takes two parameters:

 The first parameter is the key.
 The second parameter is the value.
Example
Sets the key wfJumpName to MyJump:
<$wfSet("wfJumpName", "MyJump")$>
--------------------------------------------------------------------------------------------------------------------------------------
 WfStart
Sends the revision to the first step in the current workflow. Note that this variable begins with an
uppercase W.
Example
Sets the target step for a jump to restart the workflow:
<$wfSet("wfJumpTargetStep",WfStart)$>
--------------------------------------------------------------------------------------------------------------------------------------
 wfCurrentSet
Sets the local state value of a key in the companion file.
Parameters
 The first parameter is the key.
 The second parameter is the value.
Example
Sets the key <step_name>@<workflow_name>.myKey to myValue:
<$wfCurrentSet("myKey", "myValue")$>
wfCurrentGet
Retrieves a local state value from the companion file.
Parameters
The only parameter is the key.
Output
Returns the local state value from the companion file.
Example

Returns the value of the local key <step_name>@<workflow_name>.myKey:
<$wfCurrentGet("myKey")$>
--------------------------------------------------------------------------------------------------------------------------------------
wfAddUser
Adds a user, alias, or workflow token to the list of reviewers for a workflow step. This function can only be used
inside a token.
Parameters
 The first parameter indicates the user name, alias, or token name.
 The second parameter indicates the type, either user or alias.
Example
Adds the user mjones as a reviewer:
<$wfAddUser("mjones", "user")$>
Adds the original author token and the hr alias as reviewers:
<$wfAddUser(dDocAuthor, "user")$>
<$wfAddUser("hr", "alias")$>
wfComputeStepUserList
Computes the list of users from the current step in the workflow.
Returns a comma-delimited list of users.
wfExit
Exits a workflow step. This function moves the revision to a particular step in a workflow according to the
function parameters and resets the parent list information. To completely exit a workflow,
use wfExit(100,100) or any parameters that ensure that the revision returns to the parent workflow and then
gets moved past the last step in that workflow.
Parameters
 The first parameter indicates the number of jumps to rewind.

 The second parameter indicates the target step relative to the step determined by the first parameter.
Example
Exits to the parent step in the workflow:
<$wfExit(0,0)$>
Returns to the previous jump step:
<$wfExit(1,0)$>
Returns to the previous jump step and moves to the next step in that workflow:
<$wfExit(1,1)$>
--------------------------------------------------------------------------------------------------------------------------------------
wfGet
Retrieves a state value from the companion file.
Parameters
The only parameter is the state key.
Output
Returns the state value from the companion file.
Example
Returns the current jump name:
<$wfGet("wfJumpName")$>
--------------------------------------------------------------------------------------------------------------------------------------
WfStart
Sends the revision to the first step in the current workflow. Note that this variable begins with an uppercase W.
Example
Sets the target step for a jump to restart the workflow:
<$wfSet("wfJumpTargetStep",WfStart)$>
--------------------------------------------------------------------------------------------------------------------------------------
wfUpdateMetaData
Defines a metadata value for the current content item revision in a workflow.

The wfUpdateMetaData function can be used only for updating custom metadata fields. You cannot use this
function to update standard, predefined fields
Type and Usage
 Section 3.8.1.1, "Workflow Functions"
 Section 4.33, "Workflow"
Example
Defines "This is my comment." as the value of the Comments field:
<$wfUpdateMetaData("xComments", "This is my comment.")$>
--------------------------------------------------------------------------------------------------------------------------------------
wfNotify
Sends an e-mail message to a specified user, alias, or workflow token.
The wfMailSubject and wfMessage variables can be set to customize the notification message.
Parameters
Takes two parameters and an optional third parameter:
 The first parameter specifies the user name, alias, or token to be notified.
 The second parameter indicates the type, either user, alias or token.
 The optional third parameter specifies the name of the e-mail template to use for constructing the
message. (See the IdcHomeDir/resources/core/templates/templates.hda file for template definitions.)
Example
Notifies the original author:
<$wfNotify(dDocAuthor, "user")$>
Notifies all users in the myAlias alias, using the IdcHomeDir/resources/core/templates/reject_mail.htm file as a
template:
<$wfNotify("myAlias", "alias", "WF_REJECT_MAIL")$>

Idoc script beginner guide

Recommended

More Related Content

What's hot (20)

Viewers also liked (11)

Similar to Idoc script beginner guide (20)

More from Vinay Kumar (20)

Recently uploaded (20)

Idoc script beginner guide