Content Management Guide

CHAPTER 13

Setting Up the Required Infrastructure

This chapter describes the order of tasks required for setting up the required parts of the infrastructure, along with associated procedures. It has these sections:

NOTE: Before creating documents for your exteNd Director application, you must define the content infrastructure, as described in Subsystem infrastructure.

Flow of operations

Here is a workflow that illustrates the recommended order of operations for setting up the required parts of the Content Management (CM) subsystem infrastructure:

orderOfOps1ReqInfrastructure

Generally, the task of building this infrastructure is assigned to a system administrator or content administrator who has READ, WRITE, and LIST permissions. For more information about managing security, see Managing Content Security.

Creating folders

The folder is a key part of the CM subsystem. Every document must reside in one (and only one) folder, although a single folder can store one or more documents as well as other folders.

Procedure To create a folder:

Enter Content mode by clicking the Content button in the toolbar.
Select the Folder View tab.

Your existing folders appear in the content tree view.
Select the folder that will house your folder by clicking the name.

The name appears highlighted.
Click the New Folder icon, located in the bottom-left panel of the CMS Administration Console.

An Untitled folder appears in the content tree view.

You may have to expand the parent folder in the content tree view to make the new folder visible in that view.
Click Untitled to open the Property Inspector for the new folder.
Fill in the Name and Description text boxes in the Property Inspector, then click Save.

The other General fields are filled in automatically by the CMS Administration Console. You cannot edit them.
Select the Security tab in the Property Inspector and set security for the folder, as described in Managing Content Security.
Click Save to preserve your settings.
Select the folder in the content tree view.

Your new folder should appear in the content tree view as well as in the content list along with the description, author, and date created.

Here is an example showing information about a PSAT folder:

newFolderContentList

Creating document types

A document type is the basic definition of a document. Every document is associated with a document type in the CMS Administration Console.

The document type is a template that specifies layout styles, fields of information, and document management options—such as whether or not the CMS Administration Console automatically checks in a document after it is edited.

Procedure To create a document type:

Enter Templates mode by clicking the Templates button in the toolbar.

A panel appears listing any document types that have been defined.
Click the Add button that appears under the Document Types list.

The Create A New Document Type window appears:

Specify the basic options, including:

Option	Effect
Auto-Checkin	If selected, CMS Administration Console checks in documents automatically after they are edited. If not selected, CMS Administration Console does not check in documents automatically after they are edited
Auto-Publish	If selected, CMS Administration Console publishes the latest version of the content of a document automatically after that document is edited. If not selected, CMS Administration Console does not publish documents automatically after they are edited
Default Content	If you select: HTML: CMS Administration Console will always enter content as HTML for documents of this type. Binary: CMS Administration Console will always upload content from an external source for documents of this type. Choice: You want to decide at content creation time whether to enter content as HTML or upload content from an external source.

Option

Effect

Auto-Checkin

If selected, CMS Administration Console checks in documents automatically after they are edited.

If not selected, CMS Administration Console does not check in documents automatically after they are edited

Auto-Publish

If selected, CMS Administration Console publishes the latest version of the content of a document automatically after that document is edited.

If not selected, CMS Administration Console does not publish documents automatically after they are edited

Default Content

If you select:

HTML: CMS Administration Console will always enter content as HTML for documents of this type.

Binary: CMS Administration Console will always upload content from an external source for documents of this type.

Choice: You want to decide at content creation time whether to enter content as HTML or upload content from an external source.

Click Extended Options to specify additional document type behavior.

The Create A New Document Type window expands:

Specify extended options, including:

Option	Effect
Default Folder	When the CMS Administration Console creates documents of this type, this folder is specified as the parent folder. You can change the folder when creating the new document.
Force Folder	If selected, the folder specified under Default Folder cannot be changed when creating a new document of this type.
Default Categories	When the CMS Administration Console creates documents of this type, this category is specified as the parent category. You can change the category when creating the new document.
Force Categories	If selected, the category specified under Default Category cannot be changed when creating a new document of this type.
Clean Up Data	If selected, when you remove a field from a document type (but leave it available for later use), the CMS Administration Console deletes the field from legacy documents of that type. If not selected, when you remove a field from a document type (but leave it available for later use), the CMS Administration Console preserves the field in legacy documents of that type but does not allow you to edit the field.
User Data	You can use the text box to store additional metadata about the document type (such as notes, procedural instructions, and so on).

Click the Create New Document Type button.

Your new document type is added to the list.

Creating fields and adding them to a document type

About fields

Fields are application-specific metadata that you define as part of a document type.

You can create custom fields using the CMS Administration Console or programmatically using the CM API.

NOTE: You must be a member of the SearchAdmin group to create fields. For more information about users and groups, see the chapter on using the Directory section of the DAC in the User Management Guide.

You assign each field a control type. The control type you select should reflect the way you'd like the content developer to enter information in the document type template. Each control type requires its own set of parameters, which you can specify in the Property Inspector. When fields are created, they are added to a pool of available fields that are shared by multiple document types.

When you add a field to a document type, an equivalent blank field is added to documents of that type that you have already created in the CMS Administration Console.

Creating and manipulating fields

This section explains how to create fields, add existing fields to document types, and specify which fields to display in the Available Fields list.

Procedure To create a field:

Make sure you are a member of the SearchAdmin group.

For information, see the procedures described in the chapter on using the Directory section of the DAC in the User Management Guide.
Enter templates mode by clicking the Templates button in the toolbar.

A panel appears listing the document types that have been defined.
Click the document type for which you are going to create a field.

NOTE: If you want to create a new document type first, see Creating document types.

A Content Types panel appears displaying the currently defined fields in the document type and providing controls for creating new fields or adding existing fields:
Click Add in the Content Types panel.

An Untitled field appears in the Fields pane for the selected document type, and the Property Inspector opens allowing you to specify properties for the new field:
In the Fields pane, select the control type you want for your field. Choices include Textfield, Checkbox, Radio Button, and so on.

The Property Inspector refreshes to display options appropriate for the control type you select. These control types represent HTML control types, and the display options represent the attributes for those control types.
In the Property Inspector, enter an informative name for your field and fill in the other parameters.
Click Update.

The new field appears in the Fields pane for the selected document type and in the Available Fields pane for other document types to use.
Repeat these steps for as many fields as you want to create and add to the document type.
Click Save in the Fields pane to save the fields in the current document type.

Procedure To add an existing field to a document type:

Enter templates mode by clicking the Templates button in the toolbar.

A panel appears listing all document types that are currently defined.
Click the document type for which you want to add a field.

NOTE: If you want to create a new document type first, see Creating document types.

The Content Types panel appears displaying a pane of available fields:
Add fields to the document type using one of these methods:
- Double-click the field name in the Available Fields list.
  
  OR
- Select a field in the Available Fields list and click the Add Field button:
  
  OR
- Drag the field icon from the Available Fields list to the Fields list:

Procedure To change the Available Fields display:

Click the down arrow of the dropdown menu labeled Show Fields in Document Type, located under the Available Fields list. A menu appears allowing you to display the fields available for only a particular document type or for all document types:
Select a menu option.

The Available Fields list refreshes to reflect your choice.

Writing JavaScript for document types and fields

The CMS Administration Console enables you to specify JavaScript code for document types and fields. You can specify JavaScript that runs when:

A content page is loaded
An HTML form on a page is submitted
A field on a page gains or loses focus, or is clicked
The content of a field is changed

If you code JavaScript for a particular document type, you can access that code when defining JavaScript for individual fields in that document type. For example, if you define a function for the document type, you can call that function on a JavaScript event for a field, such as gaining focus or clicking.

CAUTION: The CMS Administration Console does not verify JavaScript code. You are responsible for verifying that JavaScript written for a document type or field is designed and coded correctly.

Procedure To specify JavaScript for a document type:

Enter templates mode by clicking the Templates button in the toolbar.

A panel appears listing all document types currently defined.
Click the document type for which you want to specify JavaScript code.

NOTE: If you want to create a new document type first, see Creating document types.
Click the Advanced tab.

The Advanced Properties window displays:
Under JavaScript Event, specify when you want the JavaScript to run during the life cycle of the document. Choices include:
- Before Page Is Loaded
- After Page Is Loaded
- Form Submitted
If you want the JavaScript code to be available to fields in the document type (for example, if you want to define functions that will be called by individual fields), specify Before Page Is Loaded.
Under JavaScript Code, insert the code.

For example, here is some JavaScript code containing two function definitions that is to run before the page is loaded:
Click Save to save the JavaScript specification in the current document type.

To code additional JavaScript for other events, repeat this procedure specifying the alternate event(s) in Step 4 and code in Step 5.

Procedure To specify JavaScript for a field:

Enter templates mode by clicking the Templates button in the toolbar.

A panel appears listing all document types that are currently defined.
Click the document type that contains the field for which you want to specify JavaScript code. A list of the fields defined for that type appears.

NOTE: If you want to create a new document type first, see Creating document types.
Double-click the field for which you want to specify JavaScript to access the field properties.
Under JavaScript Events, specify when you want the JavaScript to run. Depending on the kind of field (text field, check box, text area, and so on) selected, one or more of these events might be available:
- onBlur
- onFocus
- onClick
- onChange
You can specify different JavaScript code for different events.
In the text box next to the JavaScript Events selection box, type your JavaScript code.

If any functions for the document type that contains the field have been defined, you can click Available Functions to select from the list of predefined functions:

A template for the function is inserted into the text box. You can then edit the text box.

For information about defining JavaScript functions for a document type, see To specify JavaScript for a document type:above.
Click Update to save your field properties.

To code additional JavaScript for other field events, repeat this procedure specifying the alternate event(s) in Step 4 and code in Step 5.

CAUTION: If you create a field that references a function defined in a particular document type and then use that field in another document type, you must redefine the function in the second document type before that function can work.