Top of COR

Index

Table of Contents

Feedback

CORW0400 - Substitution Tags

• Overview
• Page Navigation
• Field Details
• Related Pages

Overview

A Substitution Tag can be defined as a static or dynamic image, or a link to the database using an SQL query. Substitution Tags are used within Communication Types to insert data or an image into a static template. This data is not actually inserted at the time of defining the Communication Type, but rather it is evaluated at runtime when the Communication Type is used to produce a Communication Item.

Communication tags can work at a number of levels and how values are derived in this process is described on the Substitution Tag Hierarchy page.

Substitution Tags defined here will be available for selection in pages such as CORW0500 and CORW0600. For more information, see the 'Related Pages' section, below.

Return to Top

Page Navigation

Navigating between Substitution Tag screens

A list of Substitution Tag records is displayed when CORW0400 is first accessed. For a description of how to organise a list such as this, see the Working with Callista Lists Help page.

Create a New Substitution Tag

Use the New Substitution Tag page to create a new Substitution Tag. It is accessed via the New icon on the Substitution Tags page.

Edit a Substitution Tag

To edit a Substitution Tag, click on the required Substitution Tag name in the table on the Substitution Tags page. The Substitution Tag's details are then displayed on a new page.

Return to Top

Field Details

This section contains:

• Generic Fields
• Types of Substitution Tags
• Other Fields
• Parent Substitution Tags
• Child Substitution Tags

Generic Fields

The fields in this table are required for all types of Substitution Tags.

Types of Substitution Tags

Select the Radio button for the required Tag Type. This may be Image, Dynamic Image or Database Query.
The fields displayed are different for each type of tag.

To Create an Image Substitution Tag

• Use the Browse button to browse for the image file that you want for this tag.
  

To Create a Dynamic Image Substitution Tag

• If the Substitution Tag is part of a hierarchy, select the Parent Substitution Tag.
• Record the Source Table.
• Record the Source Column.
• Record the Key Columns, separated by commas if more than one.
• Record the Key Values. Dynamic values can be derived according to the context of the correspondence item by inserting context variables for the communication type context (see below). A colon must inserted ahead of the context variable name. Separate by commas if more than one.

Note that if the number of key columns values is different to the number of key values, then the folloiwng message is generated: 'Invalid key columns or paired values'.

The Source Table, Source Column, Key Columns and Key Values are used to compose an SQL query as follows:

Select <Source Column> from <Source Table>
Where  <Key Column> = <Key Value>

For example:
Select PERSON_IMAGE from PERSON_IMAGE
where PERSON_ID = :p_person_id

Where there are more than one Key Column and Key Value values, the SQL query will be:

Select <Source Column)> from <Source Table>
Where  <Key Column 1> = <Key Value 1>
and <Key Column 2> = <Key Value 2>
and ...

To test that the Source Details are valid, click on the Verify Image Source button.

If an image is found then the Valid lamp is displayed. If not then an Invalid Source Table, Invalid Source Column or Invalid key columns lamp will display, depending upon the problem identified.

To Create a Database Query Substitution Tag

• Use the drop-down list to record the Parent Substitution Tag.
• Enter Context Parameter Name for use by child tags of this tag. The context for use by child tags is actually just a name that will be given to the parameter that child tags can use in their query in order to stay in context of the parent tag.
• Select the Multi value delimiter value. This determines how multiple values will be separated, for example, if multiple units will be listed, by selecting 'Newline' for this field then each Unit will be listed on a new line.
  Other options are Space, Tab , Hyphen, Comma, Semi Colon, Other.
• Record the SQL statement that will query the database and return values.
• Click on the Test SQL button to validate the syntax of the SQL statement. A 'Valid' lamp is displayed if the statement contains the correct SQL syntax.

Other Fields

Parent Substitution Tags

Substitution Tags can be related to each other in Parent-Child relationships.

[Image as of August 2011]
This is the Parent Substitution Tag field in CORW0400. Use the poplist to select the parent tag.

Select a Parent Substitution Tag to make the current Substitution Tag becomes a child of that Substitution Tag.
The Parent Substitution Tag can viewed as the context record by clicking on the link adjacent to Parent Substitution Tag field.
A tag and its parent must have the same context for use.

Child Substitution Tags

[Image as of August 2011]
The Child Substitution Tag section in CORW0400 displays a list of child tags. This list can be edited on this page.

Click on the Add button and use the 'Search and Select Child Substitution Tag' pop-up window to select Substitution Tags to be included as child tags of the current record.
The Child Substitution Tag can be viewed as the context record by clicking on the name of the child Substitution Tag.
A tag and its child must have the same context for use.

Communication tags can work at a number of levels and how values are derived in this process is described on the Substitution Tag Hierarchy page.

Return to Top

Related Pages

Substitution Tags in the Communication Process

For more information about the Communication process see Understanding Communication.

Return to Top

Last modified on 31 May, 2012 2:44 PM

History Information