Versions Compared

Key

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


Table of Contents

Description

The CRMConfig file is located in the metadata folder (/Crm/WebContent/metadata/modules.xml)  and has an XML structure. This structure is used when a new Security Profile is created or when an existing one is updated. This feature enables the users to configure the module permissions (create, delete, read, edit).

...

Panel
id0

Modules

A CRM.COM business module is a set of features that implement specific business scenarios.

Child pages (Children Display)

Attributes

Include PageRelated Modules
NameDescriptionValue
moduleid

Unique Identifier.

Any
modulenameA name that describes the module.Any
moduledescriptionA description that describes the module.Any
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.

 

Related Modules

featuresA set of module related features

 

include
.

Features

Features
skinsA set of skins
 
./wiki/spaces/V4Development/pages/491731
leftmenuoptionsA set of module related menu options
include
.Left Menu Options
Left
settingmenuoptionsA set of module related setting menu optionsSetting Menu Options

...

Example

Expand
titleModules


Code Block
languagexml
themeEclipse
titleModules
<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>
<process> <id>EDIT_CONTACT</id>
 
				
<name>Edit Contact</name>
			
<description>Edit an existing Contact
.
</description> <methods> <method> <ejbname>CRMUIContactInformation</ejbname> <methodname>editButton</methodname> </method> </methods> </process> <process> <id>DELETE_CONTACT</id> <name>Delete Contact</name> <description>Delete an existing Contact
.
</description> <methods> <method> <ejbname>CRMUIContactInformation</ejbname> <methodname>deleteButton</methodname> </method> </methods> </process> <process> <id>SAVE_CONTACT</id> <name>Save Contact</name> <description>Save a Contact
.
</description>

							
<methods>

						
<method> <ejbname>CRMUIContactInformation</ejbname> <methodname>saveButton</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>
<process> <id>SHOW_INACTIVE_ADDRESSES</id> <name>Show inactive addresses</name> <description>Show inactive addresses for a contact.</description> <methods> <method> <methodname>showInactiveAddressesButton</methodname> <ejbname>CRMUIContactInformation</ejbname> </method> </methods> </process> <process> <id>DEACTIVATE_ADDRESS</id> <name>Deactivate address</name> <description>Deactivate addresses for a contact.</description> <methods> <method> <methodname>deactivateAddressButton</methodname> <ejbname>CRMUIContactInformation</ejbname> </method> </methods> </process> <process> <id>ACTIVATE_ADDRESS</id>
 
					
<name>Activate address</name>
		
<description>Activate addresses for a contact
.
</description> <methods> <method> <methodname>activateAddressButton</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>
<webapi>

						
<id>CONTACT_INFO_CREATE</id> <name>contact_information/create</name>
...
					
<description>Create Contact Information Web API</description> <classname>CRMAPIContactInformationBean</classname> <method>show</method>
<
/webapi> <webapi> <id>CONTACT_INFO_UPDATE<
/
id> <name>contact_information/update</name> <description>Update Contact Information Web API</description> <classname>CRMAPIContactInformationBean</classname> <method>update</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 -->
				
<id>CRM2417</id> <!-- MODULE CONFIGURATION > Contact Information > Industries -->
...
			</leftmenuoptions>

			
			<settingmenuoptions>
				<id>MC_SETTINGS_AND_ADMIN</id>
				<id>MC_CRM_SETTINGS</id>
				<id>CONTACT_INFORMATION_SETTINGS</id>
				<id>CONTACT_INFO_SETTINGS</id>
				<id>CONTACT_INFORMATION_SUPPORTED_TYPES</id>
				
<id>CRM2418<
<id>CONTACT_INFORMATION_CATEGORIES</id> 
<!-- MODULE CONFIGURATION > Contact Information > Industry Sectors --> <id>CRM1413</id> <!-- MODULE CONFIGURATION > Contact Information > Definitions -->

				<id>CONTACT_INFORMATION_INDUSTRIES</id> 
				<id>CONTACT_INFORMATION_INDUSTRY_SECTORS</id> 
				<id>CONTACT_INFORMATION_NAME_DAY_RULES</id> 
				<id>CONTACT_INFORMATION_ANONYMIZATION</id> 
				<id>CONTACT_INFORMATION_KYC_SETTINGS</id> 
			</
leftmenuoptions>
settingmenuoptions>
		</module>
 
		...
 
	</modules>

	<skins></skins>

	<loginmodules>
		<moduleid>CONTACT_INFORMATION</moduleid>
		
<moduleid>COMMUNICATION_CENTER</moduleid> <moduleid>SUBSCRIPTIONS</moduleid> <moduleid>ACCOUNTS_RECEIVABLE</moduleid> <moduleid>FINANCIAL_TRANSACTIONS</moduleid>
...
	</loginmodules>
</moduleconfig>