Forms

Select the appropriate subsystem.

Type a title for this form.

Type a description for this form.

Select the information type to use for documents created using this form.

For a task form this is the information type that will be used for the temporary iKnowBase document used for temporary storage.

Select this check box if you want to update the information type of the document when the document is modified. Otherwise, the information type is only set for new documents.

This feature enables you to change information type for an existing information object.

Select this check box, if you don�t want to save the form identification together with the document. Default behavior is to write the form identification to the document upon each save.

Not applicable for task form.

Select the appropriate content format.

• Text enables the user to add text-based content using a text area or an HTML editor directly in the form.
• File enables the user to add file-base content, e.g. upload a file.
• Link enables the user to add an address of a resource on the internet or private intranet (URL).
• Optional enables the user to select the content format at run time.

Note: File and Link are not supported for task form.

Select this check box to specify the use of a cleaning routine which deactivates all attempts on cross site scripting (XSS). Primarily for forms to be used in an open solution such as response forms.

XSS is used by hackers to enter an executable JavaScript code that executes after a period of time.

Select the appropriate form generator for generating the form at run time.

• Rule-based – The form is generated based on the properties of the form component. Only applicable for content forms.
• HTML-based – The form is generated based on the html templates that are specified on the HTML tabs of the form component.
• Template – The form is generated based on the FreeMarker template that is specified on the Template tab of the form component. Only applicable for task forms.

Select this check box to override the edit permissions for the parent document. This will enable the end user to create a sub document for a parent document he doesn�t have edit permissions for.

If not selected, the security model in iKnowBase validates the new sub-document to ensure that you have edit permissions for the parent document (the document that becomes the master document).

Not applicable for task form.

Select the appropriate access control list. To access and use the form, the user must be a member of this access control list, and must also have the permission to publish content. If you do not specify an access control list, everyone can access the form.

For task forms this applies to the document used for temporary storage of values.

Select the appropriate language for the form.

If you do not select a language, it is automatically set according to: a) the user language, b) the browser language, c) the domain language in the given order.

Select this check box to edit the documents that have no forms associated with them. iKnowBase searches for forms with the same document type or format, and selects the first form with this property set.

Select styleset to use for this form.

For all form generators the header- and footer text apply.

The following tags apply just for the rule-based generator:

• Table tags
• Table tags for status line
• Html tags for the text on the status line

Select this check box to make the labels of the attributes visible in the form. If you do not select this check box, only the input field appears.

Select the check box to retrieve the labels from the attribute definitions.

Displays the default width of the <td>-cell for the labels. You can use this value when you create a new form or insert new attributes. If you change this value, none of the existing attributes for the form are affected.

Type the standard font classes for the labels. You can use this value when you create a new form or insert new attributes. If you change this value, none of the existing attributes for the form are affected.

Type the standard font classes for the value field. You can use this value when you create a new form or insert new attributes. If you change this value, none of the existing attributes for the form are affected.

Type the CSS class that is used in the mandatory fields in the form.

Select an iKnowBase target or an Oracle Portal page. This is used as the location for displaying a form, when the form is opened as a separate page or as a popup page.

Note: iKnowBase target is preferred over Oracle Portal page, the latter is kept for compatibility reasons.

Not applicable for task form.

Enter the width of the popup window used when the form is opened as a popup page.

Enter the height of the popup window used when the form is opened as a popup page.

Select the iKnowBase target that will be opened when a document has been inserted from this form.

For task form this target is used after temporary storage.

You can also override the default behavior if you want a JSON object as a return value when you save the document. This is ideal for forms opened with EXT where you programatically keep the control of the windows. To do this, you need to add a hidden input control to the HTML insert form (p_return_type = JSON)

Select the iKnowBase target that will be opened when a document has been updated from this form.

You can also override the default behavior if you want a JSON object as a return value when you save the document. This is ideal for forms opened with EXT where you programatically keep the control of the windows. To do this, you need to add a hidden input control to the HTML update form (p_return_type = JSON)

For task form this target is used after completion of a task.

For advanced use only, you can create a specific PL/SQL procedure to generate the iKnowBase form. Select the appropriate Database function if you want to override the default.

Note: The default database function for generating a form is ikb_ce_custom_editor_portlet.run_show. You can copy this as a starting point for you own custom show function, and then customize it. You must register you new procedure as a Database function.

Not applicable for task form.

For advanced use only, you can create a specific PL/SQL procedure to handle saves through this form. Select the appropriate Database function if you want to override the default.

Note: The default database function for save through Form is ikb_ce_custom_editor_portlet.save_document. It handles the save and navigation after the save. You can copy this as a starting point for you own custom save function, and then customize it. You must register you new procedure as a Database function.

Not applicable for task form.

Enter the URL for a custom JavaScript file, which will be included in the form by the iKnowBase forms engine.

The URL will be passed on to clients without conversion, and must be accessible from any web client.

Type the name of the JavaScript function that you want to use for the additional validating functions. Use the complete URL or relative path that is known to the application server such as /resource/file.js.

Default validating function validates required fields and input-format for date fields.

The function does not take any parameters and returns either TRUE (Validating OK, continue) or FALSE (Validating not OK, terminate).

Example:

function test() 
{
   if (checksomething) {
      alert(writeanerror);
      return false;
   }
   else {
      return true;
   }
}

Defines the attributes included in the form. Select new attributes by clicking the link Attributes. You can reorder the attributes by drag/drop functionality.
If you want to remove an attribute, click the delete-icon and the press Save.

The <Text/image> attribute is used to display text or pictures among attributes. You can specify this in the later tabs.

The <Display/add other attributes> attribute enables the end user to view or add attributes other than the ones that you define in the form, at runtime. The attributes associated with the information type will be available for selection. When the form is executed, two things will happen:

• Attributes that are defined on the actual information object (not the information object type, but the object itself) will be displayed.
• The form will display a drop down list for all attributes that are referred on the information object type, but not included in the form.

This mechanism makes it possible to allow custom attribute combinations on a document, without having to create forms for every possible combination of attributes.

The “Format” attribute is available if you select Optional format for the form. This attribute enables the end user to select the content format at runtime. Remember that you also need to select the content attributes (file, link or content) that you will let the user choose from.

The Folder attribute enables the end user to change the parent document.

List of all attributes in the form.

A logical name used by the Freemarker engine.

Not applicable for content form.

Select this check box to hide this field, when new documents are created.

Not applicable for task form.

Select this check box to hide this field, when existing documents are updated.

Not applicable for task form.

Select this check box to allow the user to enter values while creating documents. Does not apply if <Hide insert> is checked.

If unchecked, the field will display, but no be editable.

For the special attribute <Display/add other attributes>, check this box to allow the user to add new attributes.

Select this check box to allow the user to enter values while updating documents. (Does not apply if <Hide insert> is checked).

If unchecked, the field will display, but no be editable.

For the special attribute <Display/add other attributes>, check this box to allow the user to edit the attribute values that are not specified on the form.

Select this check box to specify if the attribute is mandatory (required) while creating a new document.

Select this check box to save this attribute in iKnowBase.

In some cases, an attribute is used only during forms processing, and may be processed by a custom save function. An example would be a checkbox indicating whether to send an e-mail: The custom save function will use the value, but it should not be saved on the document.

For a task form, checking this box will make iKnowBase store the value into the temporary iKnowBase document.

Used for dimension attributes only, select this check box to display the favorite values for dimension attributes in a list. The list displays the last ten values that the user used for an attribute.

Used for the ACL attribute only, select this check box to enable the user to create access control lists.

Displays the number of values a user can enter for this attribute. The value is retrieved from the attribute definitions, but can be overridden.

Checkbox indicating whether these attributes should be written back to the manual task entry in the BPEL process engine.

The field is written to the manual task only when the task is finalized by setting an outcome.

Not applicable for content form.

When selected, indicates where the task attribute should be written. Click the appropriate task attribute.

Note: If a user does not configure this property correctly, the user of the task dialog receives an error when the task dialog is used. The task attribute that must be used is self evident, with the exception of the following:

AS_PERSONCARD requires a numerical attribute, because it is the document ID of the Person card that is written.

For fields allowing multiple selection, you must select a BPEL text attribute, since multiple values are written to the task as a semicolon separated list.

Not applicable for content form.

Select the appropriate value with which the field is mapped with the task.

For example, for a text attribute, the field can be written only as text.

Not applicable for content form.

Select this check box to write the field to the iKnowBase document that initiated the BPEL process instance. The field is written to the iKnowBase document when the task is finalized by setting an outcome.

Not applicable for content form.

Select the appropriate write mode. The write mode describes how to write the field to the iKnowBase document that initiated the BPEL process instance, e.g. whether to replace existing attributes or add new ones.

Note: The Add mode is relevant only for the document attributes of the type: Dimension, Value list, or External attribute. The selections is not filtered in the user interface.

Not applicable for content form.

Displays the name of the attribute.

Type a label for the attribute.

This property will be used when you have selected the Show label property and deselected the Use the prompt from the attribute property on the Common attributes tab.

You may use HTML codes in this field.

Note: This property doesn�t have language support. You may use labels stored in the NLS tables to achieve this. The syntax is #ObjectId.StringId#, where ObjectId is the value in the IKB_NLS_STRING.OBJECT_ID column and StringId is the value in the IKB_NLS_STRING.STRING_ID column. The NLS tables may be overwritten in case of an upgrade.

Select this check box to add the attribute to a new line.

Type the HTML tags that display the labels. If the code does not have the correct syntax, there can be an error when the form is generated. By default, the field gets the values from Default font for labels and TD-length for labels property.

Using this format value:

align="left" valign="middle" width="20%" class="PortletText1" 

renders this HTML-code:

<td align="left" valign="middle" width="20%" class="PortletText1">MY PROMPT</td>

Type the HTML tags that display the value field. If the code does not have the correct syntax, there can be an error when the form is generated. By default, the field gets the values from Default font for labels and TD-length for labels property.

Using this format value:

align="left" align="TOP" width="80%" class="iKBFormInput" 

renders this HTML-code

<td align="left" align="TOP" width="80%" class="iKBFormInput"><input > </td>

Type the HTML tags that are used within input fields that are generated. For example, the size of a select box that can be specified with a font class or a style tag directly (style=“width:249px”)

Using this format value:

class="iKBEditorInput" 

renders this HTML-code

<input class="iKBFormInput" ...> ... </input>

Type the width or Height of the text field for CLOB attributes (ingress and body text).

The selected style decides the measuring unit that you must use.

• If you use the TinyMCE style, you must specify pixel values.
• If you use a text box, you must specify the rows and columns for a text area field.

Displays the name of the attribute.

Select the appropriate style.

This property specifies how the input field is generated. The available options depend on the attribute type.

• Text Attributes: Text box: By default, text attributes provide the input type = TEXT, while the text box creates a TEXTAREA box. The text area box has a limit of 4,000 characters. After you select the text box, you must define the height and width of the text box on the Format tab.
• Numerical Attributes: Will always generates <INPUT type="text" ...
• File: Will always generates <INPUT type="file" ...
• Ingress/Body text: Text box, or one of the defined TinyMCE Editor profiles:
• Status: Select, Radio.
• Acl: Select, Radio, Popup.
• Value lists: Select, radio, check, multi-select.
• Dimensions: Dimension navigator(default), picklist, select, radio, check, multi-select. By default, the user gets access to the dimension navigator. You can implement your own picklist using a target and a search source. Note: For selections other than <default> or picklist, you must enter a sub-set of values in the Values tab.
• Date Attributes: Date (dd.mm.yyyy), Date/time (dd.mm.yyyy hh24:mi:ss).
• Template: Select, Radio button.
• Folder: document archive(defaylt), picklist: By default, the user gets access to the document archive where he can choose the parent document for the document being created. You can implement your own pick list using a target and a search source. Note: The folder attribute is used only by creation of new documents through office integration.
• Related objects / images: Gives a selector box where you can select documents related to the document that is created. You can implement you own pick list using a target and a search source.

Select the target where your pick list is placed. This target is used when you select the pick list as a style (only for Dimensions, Folder, and Related objects or images).

Select the pick list that is used to select dimensions or documents. This search source is used where you have selected a pick list as a style (only for Dimensions, Folder and Related objects or images).

Note: For related objects or images, the picklist must return document IDs. For dimensions, the picklist must return dimensions.

Displays the name of the attribute.

Define a subset of values for an attribute to limit the values that a user can choose. You can define subsets for the following attribute types: value lists, dimension, status codes, access control lists and templates. Note: In order to be able to define a subset for a dimensional attribute, you must define a style other than dimension navigator or picklist for the dimensional attribute.

For dimensional attributes you can select a subset with the dimension navigator. For the other attribute types you can select a subset of values from the list box.

Default value

Type the default value for the attributes when a document is created.

For text fields, type a value in the field.

For dimension values, select the desired value. If the style is different from the dimension navigator, you must select a value from the subset. These values are available when the subset is created. If the dimension navigator is available, you can select the values from the dimension selector.

For lists, select the appropriate value in the drop down box.

You can also specify a function to retrieve a dynamic default value. You must always specify functions with the character # before the function name. The function can be either an SQL function such as TO_CHAR or a stored PL/SQL function. You can also send context-based parameters. Available variables are:

• :DOCUMENT_ID: If the document exists (edit-modus), the document ID is sent.
• :PARENT_ID: Identifier for the portlet instance.
• :REFERENCE_PATH: Identifier for the portlet instance.
• :STYLE_ID : Identifier for the form definition.

Examples:

To return today�s date:

#to_char(sysdate,�dd.mm.yyyy�)

To run the function �get_process_state", sending the current document�s parent_id as the parameter:

#get_process_state(:PARENT_ID)

Type the URL parameter to set the suggested value to the current field over the URL string. The value differs between parameters that are active when documents are created or updated. The URL parameters override any default values.

The URL is built upon the quick link where the parameter is given a value. It is available for selection on the Parameters tab on the Edit pane of a quick link.

Select this check box to insert the URL parameter when documents are created.

Select this check box to insert the URL parameter when documents are updated.

The Attachment attribute lets you attach subdocuments to the document being edited in the form.

At run time, users can upload multiple files as attachments to the current document. They will not use a separate form to edit the metadata for the attachments.

At design time, you need to select the form to use for later editing of the attachment. This form also defines the information type (document type) and possible attributes of the attachments.

You can also choose to display already existing attachments by checking �display existing attachments". All sub documents created with the form provided in �select form for attachments" will be displayed. If you want to remove the �delete"-link, simple create the form as a HTML-form, generate HTML code for update and remove the tag �DELETE_ATTACHMENT".

Type the HTML template code.
Note: Use the action buttons Create new template or Update to automatically create or update HTML template code. To modify the HTML in a full window, use the link (open full screen editor)

A list of available attributes and their IDs available for use in the HTML template code.

Type the FreeMarker template code.

Note: Use the action buttons Create new template or Update to automatically create or update FreeMarker template code.

A list of available attributes and their IDs available for use in the FreeMarker template code.