Custom Field Management - Configuration XML

This document outlines structure of the configuration XML. 

<CustomFields> Element

<CustomFields>

   <Organization/>

   <Person/>

</CustomFields>

Attributes

None

Elements

Organization	Contains definitions specific to the Organizations Page
Person	Contains definitions specific to the Person page

---

<Organization> Element

<Organization>

   <Tab/>

</Organization>

Attributes

None

Elements

Tab	Contains definitions specific to the Organizations Page

---

<Person> Element

<Person>

   <Tab/>

</Person>

Attributes

None

Elements

Tab	Contains definitions specific to the Organizations Page

---

<Tab> Element

<Tab title="Tab Title" id="1">

   <FieldSet/>

   <Grid/>

</Tab>

Attributes

title	The name of the title as it will appear on the Organization of Person page
id	The id that will identify the tab. Must be unique within a parent element

Elements

FieldSet

Defines a collection of fields within a tab.  A tab can contain multiple FieldSets.  Each FieldSet is edited as a set of fields.

---

<FieldSet> Element

<FieldSet title="FieldSet Title" id="1">

   <Field/>

</FieldSet>

Attributes

title	The name of the title as it will appear on the Organization of Person page
id	The id that will identify the fieldset. Must be unique within portal settings

Elements

Field

Define the custom filed

---

<Field> Element

<Field title="Label" id="1" type="string" class="date">

   <Option/>

</Field>

Attributes

title	The name of the title as it will appear on the Organization of Person page
id	The id that will identify the tab. Must be unique within portal settings
type	Determines the type of the field, how it is displayed on the screen.  Possible values are -  string text box that supports string value date displays a date drop-box  checkbox checkbox with a label checkboxbr checkbox with a new line at the end of it dropbox drop-box with predefined values.  NOTE: you will need to provide the Option element textarea multi-line text box
class	Determines validation of the field.  You can combine multiple valued separated by space.  Possible values are - required Makes the field required within the fieldset email Validates that the value in the field is formatted as an email ([email protected]) url Validates that the value is formatted as an url date Validates that the value is a date dateISO Validates that the value is a ISO date number Validates that the value is a number.  Can contain comma and period for formatting digits Validates that the value is a string of numbers creditcard ???

Elements

Option

Needed for field of type dropbox.  Contains the list of elements for the drop-down

---

<Grid> Element

<Grid title="title" id="id">

   <Column/>

</Grid>

Attributes

title	The name of the title as it will appear on the Organization of Person page
id	The id that will identify the grid. Must be unique within portal settings

Elements

Column

Defines the elements and columns within a table

---

<Column> Element

<Column title="Column Name" id="1" type="string" class="date">

   <Option/>

</Column>

Attributes

title	The name of the title as it will appear in the table header
id	The id that will identify the column. Must be unique within a parent element
type	Determines the type of the column, how it is displayed on the screen.  Possible values are -  string text box that supports string value date displays a date drop-box  checkbox checkbox with a label checkboxbr checkbox with a new line at the end of it dropbox drop-box with predefined values.  NOTE: you will need to provide the Option element textarea multi-line text box
class	Determines validation of the column.  You can combine multiple valued separated by space.  Possible values are - required Makes the field required within the fieldset email Validates that the value in the field is formatted as an email ([email protected]) url Validates that the value is formatted as an url date Validates that the value is a date dateISO Validates that the value is a ISO date number Validates that the value is a number.  Can contain comma and period for formatting digits Validates that the value is a string of numbers creditcard ???

Elements

Option

Needed for field of type dropbox.  Contains the list of elements for the drop-down

---

 Example

<?xml version="1.0" encoding="utf-8" ?>

<CustomFields>

  <Organization>

    <Tab title="Test tab" id="tab1">

      <FieldSet title="Test fields" id="fieldSet1">

        <Field title="Field date" id="field2" type="date" class="date" />

        <Field title="Field string" id="field1" type="string" class="required" />

        <Field title="Field email" id="field3" type="string" class="required email" />

        <Field title="Is Worker" id="isworker" type="checkbox" class="" />

        <Field title="Is Manager" id="ismanager" type="checkboxbr" class="" />

        <Field title="Is aaa" id="aaa" type="checkbox" class="" />

        <Field title="Type" id="type" type="dropdown" class="" >

          <Option value="" title="[Not Set]"></Option>

          <Option value="Tech" title="Technical"></Option>

          <Option value="Biz" title="Business"></Option>

        </Field>

      </FieldSet>

    </Tab>

    <Tab title="test tab 2" id="tab2">

      <Grid id="grid1" title="Test Grid">

        <Column title="#" id="columnwho" type="string" class="number"></Column>

        <Column title="String" id="column1" type="string" class="required"></Column>

        <Column title="Date" id="column2" type="date" class="date"></Column>

        <Column title="Email" id="column3" type="string" class="required email" gridVisible="false"></Column>

        <Column title="Is Worker" id="isworker" type="checkbox" class="" />

        <Column title="Is Manager" id="ismanager" type="checkboxbr" class="" />

        <Column title="Type" id="type" type="dropdown" class="" >

          <Option value="" title="[Not Set]"></Option>

          <Option value="Tech" title="Technical"></Option>

          <Option value="Biz" title="Business"></Option>

        </Column>

      </Grid>

    </Tab>

  </Organization>

  <Person>

    <Tab title="Test tab" id="ctab1">

      <FieldSet title="Test fields" id="fieldSet1">

        <Field title="Field string" id="field1" type="string" class="required" />

        <Field title="Field date" id="field2" type="date" class="date" />

        <Field title="Field email" id="field3" type="string" class="required email" />

        <Field title="Manager name" id="field4" type="string" class="" />

      </FieldSet>

      <Grid id="grid1" title="Test Grid">

        <Column title="String" id="column1" type="string"></Column>

        <Column title="Date" id="column2" type="date"></Column>

        <Column title="Email" id="column3" type="string" class="email"></Column>

      </Grid>

    </Tab>

  </Person>

</CustomFields>