Form Definition

You can use the example code provided here to understand the form definition.

Forms are defined the same way as components are defined. Below is an example of a form with three input fields and one event handler trapping changes to one of the parameters. The form definition is divided into two sections; General and Advanced. The General section contains two parameters ("firstParameter" and "$GLOBAL.debug"), whereas the second section contains just one parameter ("secondParameter").

We have only defined a label for the two parameters; $GLOBAL.debug is an IBM Security Directory Integrator global parameter that enables detailed logging when checked.

<Folder name="Forms">
	<Form name="com.acme.CustomConnector">
		<TranslationFile>CustomConnector</TranslationFile>
		<parameter name="title">title_key</parameter>
		<parameter name="formevents">function firstParameter_changed() 
          { form.alert("First param modified"); }</parameter>
		<FormSectionNames>
			<ListItem>General</ListItem>
			<ListItem>Advanced</ListItem>
		</FormSectionNames>
		<FormSection name="General">
			<FormSectionNames>
				<ListItem>firstParameter</ListItem>
				<ListItem>$GLOBAL.debug</ListItem>
			</FormSectionNames>
		</FormSection>
		<Formsection name="Advanced">
			<parameter name="title">Advanced_Title</parameter>
			<parameter name="initiallyExpanded">false</parameter>
			<FormSectionNames>
				<ListItem>secondParameter</ListItem>
			</FormSectionNames>
		</FormSection>
		<FormItem name="firstParameter">
			<parameter name="label">first_param_label</parameter>
		</FormItem>
		<FormItem name="secondParameter">
			<parameter name="label">second_param_label</parameter>
		</FormItem>
	</Form>
</Folder>

The translation file (CustomConnector_en.properties) would contain:

title_key=This is the title/heading that appears at the top of the form
Advanced_Title=This is the title heading for the section for Advanced Users
first_param_label=First Param Label
second_param_label=Second Param Label