Versions Compared

Key

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

The modules.xml has a certain structure which is used when a new Security Profile is created or when an existing one is updated. This feature enables the users to configure the permissions for each module (create, delete, read, edit).

Attributes

NameDescriptionValue
moduleid

Unique Identifier

Any
modulenameA name that describes the moduleAny
moduledescriptionA description that describes the moduleAny
modulemainmenuoptionidThe identifier of the main menu option the entity belongs to.Any of the main menu option ids defined in the menu options metadata file
relatedmodulesA set of related modules

3.5.1. Related Modules

featuresA set of module related features

3.5.2. Features

skinsA set of skins/wiki/spaces/V4Development/pages/4917313.5.3. Skins
leftmenuoptionsA set of module related menu options3.5.4. Left Menu Options
Code Block
themeEclipse
languagexml
titleExample
collapsetrue
<moduleconfig>
	<modules>
		<module>
			<moduleid>CONTACT_INFORMATION</moduleid>
			<modulename>Contact Information</modulename>
			<moduledescription><![CDATA[Contact Information is all the information which is needed in order to contact a customer or a prospect customer, which can either be a physical person or a company.]]></moduledescription>
			<modulemainmenuoptionid>CRM1412</modulemainmenuoptionid>
			<relatedmodules></relatedmodules>

			<features>
				...
 
					<feature>
						<featureid>CONTACTS</featureid>
						<featurename>Ability to create, view and maintain Contact Information.</featurename>
						<featuredescription>Record the contact information for any physical person or company the company is to interact with. This can belong to a customer, prospect customer, partner, or external sales agents and reps. Record its type (physical person or company), name, addresses, phones, emails, country of residence, ID number, date of birth, company name, number of employees, registration number and more.</featuredescription>
						<featuremenuoptionid>CRM1412</featuremenuoptionid>
						<commonprocesses>
							<process>
								<id>CREATE_CONTACT</id>
								<name>Create Contact</name>
								<description>Create a new Contact.</description>
								<methods>
									<method>
										<ejbname>CRMUIContactInformation</ejbname>
										<methodname>createButton</methodname>
									</method>
								</methods>
							</process>
							<process>
								<id>VIEW_CONTACT</id>
								<name>View Contact</name>
								<description>View an existing Contact.</description>
								<methods>
									<method>
										<ejbname>CRMUIContactInformation</ejbname>
										<methodname>loadForm</methodname>
									</method>
								</methods>
							</process>
 
							...
							
						</commonprocesses>

						<additionalprocesses>
							<process>
								<id>ADD_ADDRESS</id>
								<name>Add address</name>
								<description>Add address for a contact.</description>
								<methods>
									<method>
										<methodname>addAddressesButton</methodname>
										<ejbname>CRMUIContactInformation</ejbname>
									</method>
								</methods>
							</process>
							<process>
								<id>REMOVE_ADDRESS</id>
								<name>Remove address</name>
								<description>Remove address from a contact.</description>
								<methods>
									<method>
										<methodname>removeAddressesButton</methodname>
										<ejbname>CRMUIContactInformation</ejbname>
									</method>
								</methods>
							</process>
 
							...
					</additionalprocesses>
				</feature>
 
				<feature>
					<featureid>CONTACT_INFO_WEB_API</featureid>
					<featurename>Integrate to other systems using Contact Information Web API</featurename>
					<featuredescription>Contact Information Web API.</featuredescription>
					<featuremenuoptionid />
					<webapis>
						<webapi>
							<id>CONTACT_INFO_SHOW</id>
							<name>contact_information/show</name>
							<description>Show Contact Information Web API</description>
							<classname>CRMAPIContactInformationBean</classname>
							<method>show</method>
						</webapi>

						...
					</webapis>
				</feature>
			</features>
			
			<leftmenuoptions>
				<id>CRM1400</id> <!-- CONTACT INFORMATION -->
				<id>CRM1412</id> <!-- CONTACT INFORMATION > Contact Information -->
				<id>CRM2400</id> <!-- MODULE CONFIGURATION -->
				<id>CRM2401</id> <!-- MODULE CONFIGURATION > Contact Information -->
				<id>CRM2409</id> <!-- MODULE CONFIGURATION > Contact Information > Categories -->
				...
			</leftmenuoptions>

		</module>
 
		...
 
	</modules>

	<skins></skins>

	<loginmodules>
		<moduleid>CONTACT_INFORMATION</moduleid>
		...
	</loginmodules>
</moduleconfig>