Skip to end of banner
Go to start of banner

Modules

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

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).

 

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

 

Related Modules

The related modules of a certain module.

Attributes

NameDescriptionValue
moduleidthe unique identifier of the related moduleAny of the main menu option ids defined in the modules metadata file

Example

 Related Modules
Related Modules
<relatedmodules>
	<moduleid>0001</moduleid> <!-- Jobs -->
	<moduleid>0002</moduleid> <!-- Communications -->
	...
</relatedmodules>

featuresA set of module related features

 

Features

The root element of all features of this module. The list of sub-elements is the same list that appears in “Related features” section on the Security Profiles detail page. This element has a set of sub-elements called “feature”, that is, one sub-element for each feature of this module.

Attributes

NameDescriptionValue
featureidUnique identifier.Any
featurenameA name that describes the feature.Any
featuredescriptionA description that describes the feature.Any
featuremenuoptionidThe identifier of the main menu option the entity belongs to, if it exists.Any of the main menu option ids defined in the menu options metadata file
commonprocessesA set of the common processes.

Common Processes

additionalprocessesA set of the additional processes.

Additional Processes

customprocessesA set of the custom processes.Custom Processes
webapisA set of Web API processes.

Web APIs

reportsA set of reports.

Reports

printoutsA set of printouts.

Printouts

interfacesA set of interfaces.

Interfaces

dashboardsA set of dashboards.

Dashboards

Example

 Features
Features
<features>
	<feature>
		<featureid>000001</featureid>
		<featurename>Contact Information Summary Screen</featurename>
		<featuredescription>Search for existing Contact Information in the system using Contact Information summary screen</featuredescription>
		<featuremenuoptionid>CRM1412</featuremenuoptionid>
	</feature>
 
	...
 
</features>

leftmenuoptionsA set of module related menu options

Left Menu Options

Sub-element of the <module> element. This element is added in custom configuration files and only for custom modules. It includes a set of menu options ids (<id> element values found in the custom menu options elements) and it enables the definition of which custom menu options to be displayed.

Attributes

NameDescriptionValue
idThe identifier of the main menu option the entity belongs to.Any of the main menu option ids defined in the menu options metadata file

Example

 Left Menu Options
Left Menu Options
<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>

Examples

<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 -->
				<id>CRM2418</id> <!-- MODULE CONFIGURATION > Contact Information > Industry Sectors -->
				<id>CRM1413</id> <!-- MODULE CONFIGURATION > Contact Information > Definitions -->
			</leftmenuoptions>

		</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>
  • No labels