Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
nameblue

Customising Data Entry Pages

This guide will assist you in customising This section describes how custom data entry pages .

Whilst on a data entry page, the developer will be able to know if that page is custom or not by the links provided on the developer toolbar.

Expand
titleData Entry Page Developer Toolbar

Image Removed

 

In a data entry screen, if under the link “Development” there is an option “Create custom page”, it means that no custom definition file has been created yet. If there is an option “Edit custom page”, it means that a custom definition file has been created. The difference from a custom summary page is that a custom data entry page can have multiple layouts, however only one can be active at any time.

 

Expand
titleCreate / Edit Custom Data Entry Page Links

Image Removed

 

By clicking on the link “Page Designer”, the developer can create new layout files, choose which version to use, copy, delete or edit the current custom layout file.

 

Expand
titleData Entry Page Designer

Image Removed

Creating Custom Definition Files

In order to create custom definition files through the page designer, the developer needs to navigate to the data entry page he desires to modify in the system, and click the link “Create custom page”.

 

Expand
titleCreating A Custom Data Entry Page

Image Removed

 

This creates an empty template of a definition file, in which the developer can override current components, or add his own.

 

Code Block
themeEclipse
languagexml
titleAdding New Data Entry Components
collapsetrue
...
 
	<main>
		<components>
			<component>
				<id>cmpUserField2</id>
				<name>Home Type</name>
				<elements>
					<label>
						<id>lblUserField2</id>
						<value>Home Type</value>
					</label>
					<textbox>
						<id>txtUserField2</id>
						<datapath>userField2</datapath>
					</textbox>
				</elements>
			</component>
		</components>
	</main>
 
...

Creating Custom Layout Files

To create a custom data entry layout page, the developer must first click on the link "Page Designer", and then click on "Create New Page Version". The developer can choose a name to give this layout, since as previously stated, there can be more than one layout page (but only one active). 

 

Expand
titleCreating / Editing Custom Layouts

Image Removed

 

This copies the release layout page, and allows the developer to add/remove sections and components, and have complete control over how the page should be viewed. The developer can also choose to copy an existing custom layout instead of the release, or delete any that are no longer in use.

 

Code Block
themeEclipse
languagexml
titleAdding New Data Entry Layout Components
collapsetrue
...
 
	<screenareas>
		<screenarea>
			<leftscreenarea>
				<sections>
					<section><id>secMainInformation</id></section>
 
					...
 
	<sections>	
		<section>
			<id>secMainInformation</id>


			...
 
				<component><id>cmpUserField2</id></component>
 
...

 

The result of this change can be viewed in the newly created custom data entry page.

 

Expand
titleThe Newly Created Custom Page

Image Removed

 

In the case of having more than one custom layout page, to activate a certain one, the developer must again click on the link "Page Designer", and check the checkbox "Use This Version" of the layout that is required.

 

Expand
titleUsing A Layout Version

Image Removedare created.

 

What does this section cover?

Table of Contents

Create Custom Data Entry Pages

For an introduction to data entry pages, go to Data Entry Pages.

To create a new data entry page, you need to create two XML files: a layout file and a definition file, in your custom projects directory under ../pages/dataEntry/<module_name>

Create Custom Data Entry Definition Files

To extend the system's release functionality, by adding new components to an existing data entry page, the custom data entry definition file must:

  1. Follow this naming convention: <release_page_filename>Custom.xml
  2. Created under ../pages/dataEntry/<module_name> in your custom project's directory.
  3. Include the new components ONLY.

To create a new custom page, the custom data entry definition file must:

  1. Follow this naming convention: <new_page_filename>.xml
  2. Created under ../pages/dataEntry/<module_name> in your custom project's directory.
  3. Include the ALL the components needed.