Versions Compared

Key

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

This section describes how custom data entry pages are 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 PagesDeveloping data entry pages (Deprecated).

Create New 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 ..under <custom_project>/web/WebContent/pages/dataEntry/<module_name>

...

As you can see in the example above, for the name, alternative code and log information components, generic components were used. For more information on generic components and how to use them, go to Use Generic Components (Deprecated).

Customise Existing Data Entry Pages

To extend the system's release functionality, by adding new components to an existing data entry page, both custom data entry definition and layout files must be created. To extend the system's release functionality, by just changing the layout of the existing components, only a custom data entry layout file must be created. Both definition and layout files must be created under  ..<custom_project>/web/WebContent/pages/dataEntry/<module_name> in your custom project's directory.

The custom data entry definition file must follow this naming convention: <release_definition_page_filename>Custom.xml and include the new components ONLY.

...

Ui expand
titleCustomise Data Entry Page Example
Code Block
languagexml
titlecontactInformationCustom.xml
collapsetrue
 <?xml version="1.0" encoding="UTF-8"?><page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/dataEntry.xsd">
	<id>contactinfo/contactInformation</id>
	<datapath>name</datapath>
	<module>CONTACT_INFORMATION</module>
	<functioncall>
		<functions>
			<function>
			</function>		
		</functions>
	</functioncall>
	
	<datasources>
		<datasource>
			<key>form</key>
			<classname>com.crm.web.generator.datasource.DTODatasource</classname>
		</datasource>
	</datasources>
	<mainmenu>
	</mainmenu>
	<main>
		<components>
			<component>
				<id>cmpHomeType</id>
				<name>key_home_type</name>
				<elements>
					<textbox>
						<id>txtHomeType</id>
						<label>key_home_type</label>
						<datapath>ciuserfield2</datapath>
					</textbox>
				</elements>
			</component>
		</components>
	</main>
	<details>
		<tabs>
		</tabs>
	</details>
</page>
 
Code Block
languagexml
titlecontactInformationCustomlayout.xml
collapsetrue
 <?xml version="1.0" encoding="UTF-8"?><page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/dataEntryLayout.xsd">
	<mainmenu>
		<components>
			<component><id>cmpHome</id></component>
			<component><id>cmpNew</id></component>
			<component><id>cmpEdit</id></component>
			<component><id>cmpDelete</id></component>
			<component><id>cmpSave</id></component>
			<component><id>cmpSaveInModal</id></component>
			<component><id>cmpCancel</id></component>
			<component><id>cmpActions</id></component>
		</components>
	</mainmenu>
	<main>
		<view>
			<type>list</type>
			<screenareas>
				<screenarea>
					<leftscreenarea>
						<sections>
							<section><id>secMainInformation</id></section>
							...
						</sections>
					</leftscreenarea>
				</screenarea>
			</screenareas>
		</view>
		<sections>
			<section>
				<id>secMainInformation</id>
				<name>key_main_information</name>
				<disable>false</disable>
				<left>
					<components>
						...
						<component><id>cmpHomeType</id></component>
					</components>
				</left>
				...
			</section>
			...
		</sections>
	</main>
	<details>
		<tabs>
			...
		</tabs>
	</details>
</page>

Templates Properties File

The templates properties file (templates.properties) is used for defining the default data entry layout file, generally or per unitcommunity, when more than one layout files exist per data entry definition page. Templates properties file , and must be created under ..under <custom_project>/web/WebContent/pages/dataEntry in you custom project's directory. 

To define the default layout of a data entry page, you have to add the following line to templates.properties file: <directory_name>/<definition_page_filename>~mp~defaultfile_path>~organisation~default=<directory_name>/<layout_filename>.xml

To define the default layout of a data entry page for a specific unitcommunity, you have to add the following line to templates.properties file:  <directory_name>/<definition_page_filename>~channeltypes~<unitfile_path>~community~<community_id>=<directory_name>/<layout_filename>.xml

Note that .xml is omitted from definition_page_file_path. 

If no default layout page is specified for a specific unitcommunity, the default layout page will be used by the system. If no default layout page is specified either, the release layout page will be used.

Code Block
languagexml
titletemplates.properties
collapsetrue
contactinfo/contactInformation~mp~defaultcontactInformation~organisation~default=contactinfo/contactInformationCustomlayout.xml
contactinfo/contactInformation~channeltypes~37AABC37AAF75489FC89EEA94C59024DcontactInformation~community~37AABC37AAF75489FC89EEA94C59024D=contactinfo/contactInformationCustom2layout.xml

...