Archive

Posts Tagged ‘Templating’

Creation of Data Content Records (DCRs)

May 26, 2010 Comments off

We will be using the Interwoven Teamsite WebDesk Pro Templating features for creation of DCRs and generation of output pages.

A DCR is created when a user inputs data into a DCT. A DCR is essentially an XML document containing data entered by the user. The DCR have tag <record> as the root tag containing a number of <item> tags.

The data is present inside tag <value> which is nested inside tag <item>.

Let us look at how to create a DCR using a Interwoven TeamSite Templating interface

Step 1: Launch Interwoven TeamSite templating and browse to your workarea.


In the snapshot above, the workarea is Development_wa inside Developmet_branch. So as a first step we just browse to our Workarea ‘Development_wa’. This will list all the directories/files present inside Development_wa on the right side(as can be seen  in the snapshot).

Step 2: Select ‘New Data Record’ from the first menu bar from left.


Step 3 : Select the category and data type for which you need to capture data. The following screen comes up which asks you to select a category and data type. One needs to just browse to the category directory and one will find all the data types listed for that directory. On selection of a data type the data capture form gets displayed to the user.



Step 4 : Input some data into the data capture form.



Step 5: Save the DCR by clicking the Save option. By default the DCR will get saved in data directory of the selected data type.


Generating an Output Page from a Presentation Template in my Next Post.

Creation of Data Capture Templates(DCT)

May 25, 2010 Comments off

There is a DCT for each data type and should be present inside the directory of the data type. A DCT is an XML configuration file named datacapture.cfg.

This DCT contains the definition of data type itself i.e. the information the data type will contain. For example the sports_news data type can consist of a Paragraph containing text(News item) and an associated image(News image).

The DCT contains the tags corresponding to these data for data type sports_news. When a Data Content record is to be generated, the Data Capture Subsystem of TeamSite Templating interprets the tags in DCT and presents a form to the content contributor which can be filled up to capture data.

All the DCT use the following DTD which is specific to TeamSite Templating

/iw-home/local/config/datacapture5.0/dtd

The DTD has all the data elements which can used top create the DCT.

We will build a DCT step by step for data type sports_news assuming that each sports news needs the following information:

1. Heading

2. Description – Can be present as multiple paragraphs, but at least one Paragraph long

3. Image

DCT

—data-capture-requirements ,tag encloses the entire DCT. Attribute ‘type’ is mandatory here. This can have values as ‘content’, ‘metadata’ or  ‘workflow’. For Templating datacapture files we use ‘content’.This tag is MANDATORY.

—ruleset, tag encloses all the items in the DCT. The value of attribute ‘name’ forms the caption of data capture form displayed. This tag is MANDATORY.

—description, tag is OPTIONAL. It holds the description about the DCT which gets displayed at the top of the data capture form.

—container, tag represents a set of subelements.

—The <item> element is used to assign a user defined name to an element type.

—The information contained in <label> is displayed as the field name in data capture form.

—Instances of <text> are used to display single line text boxes. <text> can have following attributes –

1. required

2. maxlength

3. size

4. validation-regex – This is used to restrict the format of input text i.e. It is used to validate the input text. Regular Expressions are used to

validate an input. E.g. A valid three digit number can be validated as:-

o    validation-regex=”[1-9][0-9][0-9]”

Tag <browser> is used to enable a file browser so that content contributor can easily select an image. Following is a description of the attributes:

1. required – value is ‘t’ if mandatory

2. ceiling-dir –  It sets a limit for the directories to be browsed. A user can browse the directories above this directory only

3. initial-dir – This is the initial directory

4. extns – Images with extensions specified here will only be available for selection

A <replicant> represents a repeatable section in a DCT. It can contain a list of one <item> tags. But vice-versa does not hold true. Tag <replicant>

can have following parameters:

1. min – Used to specify the mininmum number of instances of the replicant list.

2. Max – Used to specify the maximum number of instances of the replicant list.

3. Default – Used to specify the default number of instances of the replicant list.

4. Hide-name – This will determine whether the label gets displayed for the sub-items.

In addition to the tags mentioned in the DCT above there are other tags also which can be used. Some of the commonly use are listed below-

1. <textarea>

2. <radio>

3. <checkbox>

4. <select> – This will contain a list of <option> tags nested inside it.

5. <hidden>This contains a value invisible to the user.

6. <readonly> – This will display the item as readonly.

7. <allowed> – This is used to enable or disable an item depending on the user’s role.

This will contain one or more <cred> tags nested inside it. Here is an illustration-

This above set of tags will present <text> only to the user with role as Administrator.

We can also form complex access statements by using <and>, <or> and <not> tags. E.g. If we want to restrict access to Author or Editor roles then

we cab specify the following –

Creation of DCRs in my Next Post.

Categories: INTERWOVEN Tags: ,

Interwoven TeamSite Templating

May 24, 2010 Comments off

Interwoven TeamSite Templating provides an easy configurable way to capture, edit & store the data input by content contributors and define the look and feel of the captured data. The data capture process is separate and independent of the data presentation process, hence allowing unlimited usage of the captured data. The independent nature of the presentation process allows one to define different appearances for the same data depending on where and how the data is being used.

In TeamSite Templating the data is captured using a Data Capture Template(DCT). The data captured using a DCT is saved in an XML format in a file called as a Data ContentRecord(DCR). The DCR’s act as a source of data for Presentation Templates. A Presentation Template can use multiple DCR’s to generate a page(this page can be a JSP, ASP, XML, etc. as per the configuration defined).

Getting started – Configuring templating.cfg

Before creation of a DCT and Presentation templates associated with the data type we define some configurations in templating.cfg.

templating.cfg is the main TeamSite Templating configuration file. It is present at the following location:
/iw-home/local/config

The file is in an XML format and has information related to the following:
1. Data Categories and Types available for Templating
2. File extension of the files generated using a template
3. Mapping between presentation template and a data type
4. Mapping between files generated using presentation templates and the branch on which the files can be generated
5. Users or roles permitted to create or edit a DCR for a data type

Following is a sample of file templating.cfg containing a single category News which has only a single data type sports_news.

A template, Sports_Page_Template.tpl is defined under data type sports_news which will generate a file with extension .html .

Points to be noted:

The data storage hierarchy will be as follows:

1. There should be a directory named ‘templatedata’ inside your workarea.
2. Category ‘News’ will have a directory named ‘News’ representing the category inside directory ‘templatedata’ defined inside a branch.
3. Data type ‘sports_news’ will have a directory named ‘sports_news’ representing the data type inside directory ‘News’.
4. Inside directory ‘sports_news’ there will be two directories present namely:-
5. data – This will store the Data Content Records
6. presentation – This will store the templates for the data type

The following are important pointers related to tags used in templating.cfg

1. Tag contains only one tag
2. The definition of template is present inside tag . At least one tag should be present inside tag.
3. Attribute ‘extension’ is used to specify the extension of files generated using the template defined inside tag
4. Tag is used to define the location of presentation template file.
5. Tag is used to specify the output location of generated files

%d bloggers like this: