Professional Documents
Culture Documents
Functional Design Document Microsoft Dynamics CRM
Functional Design Document Microsoft Dynamics CRM
Functional Design Document Microsoft Dynamics CRM
1. Introduction............................................................................................................................................................ 1
4. Reports Design..................................................................................................................................................... 70
4.1. Account/Sales Reports.................................................................................................................................... 70
4.1.1. Weekly Sales Rep Visit Reports for Sales Team.......................................................................................70
4.1.1.1. Overview................................................................................................................................................ 70
4.1.1.2. Filter Criteria.......................................................................................................................................... 70
4.1.1.3. Logic to fetch data.................................................................................................................................. 70
4.1.1.4. Sorting Fields......................................................................................................................................... 70
4.1.1.5. Report Layout........................................................................................................................................ 70
4.1.2. Account Performance Report..................................................................................................................... 71
4.1.2.1. Overview................................................................................................................................................ 71
4.1.2.2. Filter Criteria.......................................................................................................................................... 71
4.1.2.3. Logic to fetch data.................................................................................................................................. 71
4.1.2.4. Sorting Fields......................................................................................................................................... 71
4.1.2.5. Grouping................................................................................................................................................ 71
4.1.2.6. Report Layout........................................................................................................................................ 71
6 Customizations.................................................................................................................................................... 73
5.1. Client-Side....................................................................................................................................................... 73
5.2. Scheduled Services........................................................................................................................................ 76
5.3. Auto Numbering.............................................................................................................................................. 77
1. INTRODUCTION
1
2. CRM ENTITY DESIGN
Note: The relationships are defined for Parent to Child and for the entities having many to many relationships they
are not defined for child to parent entities.
2
1.2. Entity Details
1.1.1.[2.2.1.] Accounts
2.2.28.1 Information
Entity Definition
Service √
Marketing √
Process
Business Process Flows † √
Data Services
Duplicate Detection √
Auditing (This entity will not be edited until auditing is enabled
for the organization) √
Outlook
3
2.2.28.2 Attributes
The following table lists custom attributes to be created for the Account entity.
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Account Name Multi Line 160 Single line of text- Y Y Y Business
Name 1 of Text uneditable Required
5
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Car Rental
6
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Consultant
Contact Us
Contract Manufacturer
Convention Center
Corporation
Customer
Dealer
Department Store
Discount Store
Distributor
Drug Wholesaler
Educational Institute
Embassy
Govt Fire Services
Freight Forwarder
Fulfillment Shipper
GSA
Grocery Store
Ground Agent
Group of Companies
Home Center
Hospital
Hotel
Housing Company
Impound Agency
Industrial
Insurance Company
Internet Lead Service
Investment Offering
Investor
MICE
Marine Agent
Mass Merchandiser
Media
Meeting/Convention
Miscellaneous Vendor
7
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Non-Store Retailer
NGO
Offshore Company
Other
Other Airlines
Paramedics
Partner
Partnership
Pharmacy
Planning Group
Police Services
Retailer
Service Center
Sole Proprietorship
Subcontractor
Supermarket
Supplier
Trading
University
Vendor
Wholesaler
2.2.28.3 Relationships
2.2.28.3.1 1:N Relationship
Primary Searchable Lookup Field Relationship
Related Entity Requirement Level
Entity Name Behavior
Account Y
Account Performance Account Required Referential
Account BSP Y Account
Sales
Account Performance Required Referential
Account Forward Y
Booking
Account Performance Account Required Referential
Account Agreement Y Account Required Referential
Account Cargo Claim Y Consignee Referential
Account Cargo Claim Y Reported By Referential
Account Cargo Claim Y Shipper Referential
Loyalty Y
Account Membership Customer Referential
Account Partner Class Y Partner Referential
Account Price List Y Partner Referential
10
Primary Searchable Lookup Field Relationship
Related Entity Requirement Level
Entity Name Behavior
Account Product Y Partner Referential
Account Group Y Account Referential
2.2.28.4 Forms
11
12
2.2.28.5 Views
13
2.2.28.8.2 <Rule-2>
Logic Update “Account Revenue” with Account Performance record information as follows:
For Corporates: Only take into account those account performance records it associated
Agreement is active
For Travel Agencies: Take into account only account performance records if they are inside
the fiscal year
2.2.28.9 Plugins
Entity Account
Event onCreate
2.2.28.1 Charts
No charts have been identified
2.2.28.2 Auditing
Yes, required. The fields to be audited are mentioned in attributes section.
1.1.2.[2.2.2.] Contact
2.2.29.1 Information
Entity Definition
Entity Type System
Display Name Contact
Plural Name Contacts
Ownership User or Team
14
Define as an Activity Entity X
Display in Activity Menus X
Area that displays this entity
Sales √ Settings X
Service X Loyalty X
Marketing X
Options for Entity
Enable for Interactive Hub √
Process
Business Process Flows † √
Communication & Collaboration
Feedback † X
Notes (includes attachments) † √
Activities † √
Connections † √
Sending Email (if an email field does not exist, one will be
created √
Mail Merge √
Document Management X
Access Teams X
Queues † √
Automatically move records to owner's default queue X
Knowledge Management X
Enable for SLA X
Data Services
Allow Quick Create √
Duplicate Detection √
Auditing (This entity will not be edited until auditing is enabled
for the organization) √
Auditing √
Change Tracking X
Outlook
Reading pane in CRM for Outlook √
Offline Capability for CRM for Outlook √
† - After you enable this option it can’t be disabled
2.2.29.2 Attributes
The following table lists custom attributes to be created for the Contact entity.
Display Schema Search Requirement
Data Type Length Options Editable Audit
Name Name able Type
Mk_amadeusda DateTime N Y Y Optional
Amadeus Date te
Child
Diabetic
Gluten
15
Intolerant
Hindu
Kosher
Low Calorie
Low Fat
Low Lactose
Low Salt
Moslem
Vegatarian
Vegan
Vegetarian
Hindu
Vegetarian Jain
Vegetarian
Lacto-Ovo
Vegetarian
Oriental
Vegetarian Raw
Dr.
Salutation Miss
Status Inactive
Female
Gender Other
MK_Nationalit Lookup Y Y Y
y (Country)
(not found
country in
Nationality target field)
16
National ID MK_nationalid Text 100 Y Y Y
Mk_emailstart Y Y Y
date
Email Start Date and
Date Time
MK_Comment Text Y Y Y
Comments s
2.2.29.3 Relationships
2.2.29.3.1 1:N Relationship
Primary Searchable Lookup Field Relationship
Related Entity Requirement Level
Entity Name Behavior
Agreement Line Y
Contact Item Contact Required Referential
Contact Account Y
Performance Passenger Name Required Referential
Contact Cargo Claim Y Consignee Required Referential
Contact Cargo Claim Y Reported By Required Referential
Contact Cargo Claim Y Shipper Required Referential
Contact Loyalty Y Customer Required Referential
Membership
17
2.2.29.4 Information (Main Form)
2.2.29.5 Views
Default Default Fields in Sort Field & Search
View Name View View Order Field Filter Criteria
Active Contacts Yes Full Name Customer Yes View List of all Active records
First Name (Ascending)
Last name
Primary
Membership
Email
Company Name
Business Phone
18
No Same as Active Same as Active Yes View List of all Inactive records
view view
Inactive Contacts
2.2.29.8 Plugins
Name Mode Message Stage Fields
2.2.29.10 Charts
No charts required
2.2.29.11 Auditing
Fields are captured in the table above.
1.1.3.[2.2.3.] Address
2.2.29.13 Information
Entity Definition
Entity Type System
Display Name Address
Plural Name Addresses
Ownership None
Define as an Activity Entity X
Display in Activity Menus X
Area that displays this entity
Sales X Settings X
Service X Loyalty X
Marketing X
Options for Entity
Enable for Interactive Hub X
Process
Business Process Flows † X
Communication & Collaboration
19
Feedback † X
Notes (includes attachments) † X√
Activities † X√
Connections † X√
Sending Email (if an email field does not exist, one will be X√
created
Mail Merge X√
Document Management X
Access Teams X
Queues † X√
Automatically move records to owner's default queue XX
Knowledge Management X
Enable for SLA X
Data Services
Allow Quick Create X√
Duplicate Detection X√
Auditing (This entity will not be edited until auditing is enabled X√
for the organization)
Auditing X√
Change Tracking X
Outlook
Reading pane in CRM for Outlook √
Offline Capability for CRM for Outlook √
† - After you enable this option it can’t be disabled
2.2.29.14 Attributes
The following table lists custom attributes to be created for the Contact entity.
Display Schema Search Requirement
Data Type Length Options Editable Audit
Name Name able Type
Start Date Mk_startdate DateTime Y Y Y Optional
2.2.29.15 Relationships
2.2.29.15.1 N:1 Relationships
Primary Searchable Lookup Field Relationship
Related Entity Requirement Level
Entity Name Behavior
Account Address Y Parent Required Parental
Contact Address Y Parent Required Referential
20
2.2.29.16 Information (Main Form)
2.2.29.17 Views
Not Required
2.2.29.20 Plugins
Not Required
2.2.29.22 Charts
No charts required
2.2.29.23 Auditing
Fields are captured in the table above.
[2.2.4.] Visits
2.2.28.10[2.2.28.9] Information
Entity Definition
21
Plural Name Visits
Sales √ Settings √
Service √
Marketing √
Process
Business Process Flows † √
Data Services
Duplicate Detection X
Auditing (This entity will not be edited until auditing is enabled
for the organization) √
Outlook
2.2.28.11[2.2.28.10] Attributes
The following table lists custom attributes to be created for the Visit entity. The rest of fields are the OOB ones
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Status Statuscode Option Set Completed (active) Y Y Y Business
Required
(not Pending (active)
editable)
2.2.28.12[2.2.28.11] Relationships
2.2.28.12.1[2.2.28.11.1] 1:N Relationship
Primary Searchable Lookup Field Relationship
Related Entity Requirement Level
Entity Name Behavior
Visit Visit Actions Y Visit Required Referential
2.2.28.13[2.2.28.12] Forms
2.2.28.14[2.2.28.13] Views
2.2.28.18[2.2.28.17] Plugins
Entity Visit
Event onUpdate
23
Logic Can only set Status to “Completed” when all Visit Action records are also completed
2.2.28.4 Charts
No charts have been identified
2.2.28.5 Auditing
Yes, required. The fields to be audited are mentioned in attributes section.
Entity Definition
Define as an Activity Entity √ not selected(if selected means we cant select s,s,s)
Sales √ Settings √
Service √
Marketing √
Process
Business Process Flows † √
Data Services
24
Duplicate Detection √
Auditing (This entity will not be edited until auditing is enabled
for the organization) √
Outlook
2.2.28.20[2.2.28.19] Attributes
The following table lists custom attributes to be created for the Visit Action entity.
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Status Statuscode Option Completed (active) Y Y Y Business
Set(its not Required
Pending (active)
editable)
25
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Owner Ownerid Lookup Y Y Y Optional
(User)
(not
editable)
2.2.28.21[2.2.28.20] Relationships
2.2.28.21.1[2.2.28.20.1] N:1 Relationship
Primary Searchable Lookup Field Relationship
Related Entity Requirement Level
Entity Name Behavior
Visit Visit Action Visit Required Refential
2.2.28.22[2.2.28.21] Forms
2.2.28.23[2.2.28.22] Views
26
2.2.28.25[2.2.28.24] Declarative Workflows, Dialogs and
Actions
2.2.28.7 Charts
No charts have been identified
2.2.28.8 Auditing
Yes, required. The fields to be audited are mentioned in attributes section.
1.1.5.[2.2.6.] Groups
2.2.30.1 Information
Entity Definition
Sales √ Settings X
Service √
Marketing √
Process
Business Process Flows † √
Data Services
Outlook
2.2.30.2 Attributes
The following table lists custom attributes to be created for the Group entity.
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Group Name(no Single Line 100 Y Y Y Business
Name schema of Text Required
with this)
28
2.2.30.3 Relationships
2.2.30.3.1 1:N Relationship
Primary Searchable Lookup Field Relationship
Related Entity Requirement Level
Entity Name Behavior
Group Group Line Item N Name Required Referential
2.2.30.4 Forms
2.2.30.5 Views
2.2.30.5.1 Active Groups
29
2.2.30.8 Business Rules
Not required
2.2.30.9 Charts
Not required
2.2.30.10 Auditing
Not required
Entity Definition
Sales √ Settings X
Service √
Marketing √
Process
Business Process Flows † √
Data Services
Duplicate Detection X
30
Auditing (This entity will not be edited until auditing is enabled
for the organization) X
Outlook
2.2.31.2 Attributes
The following table lists custom attributes to be created for the Group Line Item entity.
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Group name (not Single Line 100 Y Y Y Business
Name available) of Text Required
2.2.31.3 Relationships
2.2.31.3.1 N:1 Relationship
Primary Searchable Lookup Field Relationship
Related Entity Requirement Level
Entity Name Behavior
Group Group Line Item N Name Required Referential
31
2.2.31.4 Forms
2.2.31.5 Views
2.2.31.5.1 Active Group Line items
2.2.31.9 Charts
Not required
2.2.31.10 Auditing
Yes, required. The fields to be audited are mentioned in attributes section.
Entity Definition
Sales √ Settings X
32
Service X
Marketing X
Process
Business Process Flows † X
Data Services
Duplicate Detection X
Auditing (This entity will not be edited until auditing is enabled
for the organization) X
Outlook
2.2.32.2 Attributes
The following table lists custom attributes to be created for the Account Performance entity.
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Month mk_month Option Set Standard Month of Year N N Y Optional
(MonthofY option set
ear)
33
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Currency Transactionc Lookup N Y Optional
urrencyid
2.2.32.3 Relationships
[2.2.32.3.1] 1:N Relationship
Primary Searchable Lookup Field Relationship
Related Entity Requirement Level
Entity Name Behavior
Compensation N
Service Request Detail Service Request Optional Referential
36
2.2.32.4 Forms
2.2.32.4.1 <Form-1>
2.2.32.5 Views
2.2.32.9 Plugins
Business Rule Definition
37
Applicable to Create/Update
Note: any update done through an admin user will not trigger any plugin
2.2.32.10 Charts
Not required
2.2.32.11 Auditing
Yes, required. The fields to be audited are mentioned in attributes section.
Entity Definition
Sales √ Settings X
Service X
Marketing X
Process
Business Process Flows † X
Data Services
Duplicate Detection X
Auditing (This entity will not be edited until auditing is enabled
for the organization) X
Outlook
2.2.33.2 Attributes
The following table lists custom attributes to be created for the Account Forward Booking Performance entity.
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Account mk_account Lookup Optional
(account)
39
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Current FY mk_currentf Whole Optional
Expected yexpectedb Number
Booking ooking
2.2.33.3 Relationships
2.2.33.3.1 N:1 Relationship
Primary Searchable Lookup Field Relationship
Related Entity Requirement Level
Entity Name Behavior
Account Forward N
Booking
Account Performance Account RequiredOptional Referential
2.2.33.4 Forms
2.2.33.4.1 <Form-1>
2.2.33.5 Views
40
2.2.33.7 Declarative Workflows, Dialogs and Actions
2.2.33.7.1 <Workflow-1>
Workflow Definition
Category Workflow
Scope Organization
Logic Set [Bookings Variance] = (Current Year Forward Booking – Last Year Forward
booking)/Last year forward booking
Set [Expected v Budgeted Variance] = (Current FY Expected booking – Last Year
budgeted pax) / Last Year budgeted pax
2.2.33.9 Charts
Not required
2.2.33.10 Auditing
Yes, required. The fields to be audited are mentioned in attributes section.
Entity Definition
41
Area that displays this entity
Sales √ Settings X
Service X
Marketing X
Process
Business Process Flows † X
Data Services
Duplicate Detection X
Auditing (This entity will not be edited until auditing is enabled
for the organization) X
Outlook
2.2.34.2 Attributes
The following table lists custom attributes to be created for the Account BSP Sales Performance entity.
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Account mk_account Lookup Optional
(account)
43
2.2.34.3 Relationships
2.2.34.3.1 N:1 Relationship
Primary Searchable Lookup Field Relationship
Related Entity Requirement Level
Entity Name Behavior
Account Forward N
Booking
Account Performance Account Required Referential
2.2.34.4 Forms
2.2.34.4.1 3.2.1.4.1.1 Main Form
2.2.34.5 Views
2.2.34.9 Charts
Not required
2.2.34.10 Auditing
Yes, required. The fields to be audited are mentioned in attributes section.
Entity Definition
Sales √ Settings X
Service X
Marketing X
Process
Business Process Flows † √
Data Services
Duplicate Detection √
Auditing (This entity will not be edited until auditing is enabled
for the organization) √
Outlook
2.2.36.2 Attributes
The following table lists custom attributes to be created for the Agreement Line Item entity.
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Agreement mk_agreem Lookup Y Y Business
Name entname (Agreemen Required
t)
45
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
of Text
47
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Invoice mk_invoicea Currency Y Y Optional
Amount mount
2.2.36.3 Relationships
2.2.36.3.1 N:1 Relationship
Primary Searchable Lookup Field Relationship
Related Entity Requirement Level
Entity Name Behavior
Agreement Line Y
Contact Item Contact Optional Referential
Agreement Line Y
Agreement Item Agreement Required Referential
Reward Agreement Line Y
Information Item Reward Link Optional Referential
Agreement Line Y
Product Item Product Optional Referential
48
2.2.36.4 Forms
2.2.36.4.1 3.2.1.4.1.1 Main Form
2.2.36.5 Views
2.2.36.5.1 ALI Services QV
Default
View Name View Default Fields in View Sort Field & Order Search Field Filter Criteria
No Created On (Descending) Transaction Type = TSC Service
ALI Services
QV
49
2.2.36.5.2 ALI Tickets QV
Default
View Name View Default Fields in View Sort Field & Order Search Field Filter Criteria
No Created On (Descending) Transaction Type = TSC Tickets
ALI Tickets
QV
Workflow Definition
Category Workflow
Scope Organization
Logic At record creation prepopulate with Cost Center value from Agreement it belongs
to.
2.2.36.8.2 <Rule-2>
50
Logic At record creation prepopulate with Division value from Agreement it belongs to.
2.2.36.8.3 <Rule-3>
Logic At record creation prepopulate with Service Type value from Agreement it belongs
to.
2.2.9.1 Plugins
Logic Agreement Line Items can be recorded if Transaction Date is less than or equal to
Agreement end date or less than or equal to Contract extended date (if this later is
populated).
If Transaction date is outside Agreement validity it cannot be recorded.
2.2.36.9 Charts
Not required
2.2.36.10 Auditing
Yes, required. The fields to be audited are mentioned in attributes section.
1.1.11.[2.2.12.] Agreements
2.2.35.1 Information
Entity Definition
51
Display in Activity Menus X
Sales √ Settings X
Service X
Marketing X
Process
Business Process Flows † √
Data Services
Duplicate Detection √
Auditing (This entity will not be edited until auditing is enabled
for the organization) √
Outlook
2.2.35.2 Attributes
The following table lists custom attributes to be created for the Agreement entity.
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Account mk_account Lookup Optional
(account)
52
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Agreement mk_name Single Line 100 Y Y Business
Name of Text Required
53
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
PARMK
PERMK
RRGMK
RU4MK
RUNMK
SINMK
SYDMK
TNRMK
ZRHMK
ZSEMK
55
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
(Calculated
)
56
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Cost Center mk_costcent Option Set TBD Y Y Optional
er
2.2.35.3 Relationships
2.2.35.3.1 1:N Relationship
Primary Searchable Lookup Field Relationship
Related Entity Requirement Level
Entity Name Behavior
Agreement Line Y Agreement
Agreement Item Name Required Referential
Reward Y Agreement
Agreement Information Optional Referential
Account Y
Agreement Performance Agreement Optional Referential
Agreement Contact Y Agreement Optional Referential
2.2.35.4 Forms
57
2.2.35.4.1 3.2.1.4.1.1 Main Form
2.2.35.5 Views
58
Entity Agreement
Scope Organization
Start when Trigger it on the ribbon and only available when the agreement status is “expired”.
The above process is applicable to only corporate agreements of following types:
Corporate Incentive
Corporate No Incentive
Govt Inc
Govt Non Inc
Group Contract
AD HOC
Logic Process will copy the Agreement Beneficiaries when the Agreement is copied. All other
child records will not be copied over. These Field Values must be copied over:
Account
Agreement Name
Agreement Type
Site
Start Date
Agreement Amount
Residual for Tickets
Exchange Rate
Currency
Agreement Amount Type
Follow-Up/Description
Corporate Travel Amount in First
Corporate Travel Amount in Business
Corporate Travel Amount in Economy
Corporate Travel Amount
Cost Center
Division
Service Type
59
Logic Concatenation: Site + / + Agreement type + Serial + FY
2.2.35.8.2 <Rule-2>
Logic Agreement type= TSC then Status Pending allows editing (only). All other Status make
the record RO (Only applicable for TSCs meaning that when Agreement type <> TSC
then also Status Active allows editing)
2.2.35.8.3 <Rule-3>
Logic With each change from Agreement Status “Pending” to “Active” the Revision number
must be increased by 1.
2.2.9.1 Plugins
Entity Agreement
Logic Per account only one active agreement type must exist
The system must warn the user if he tries to create another agreement of the same
type that is active linked to same account. (not allow it to be created)
Association/Disassociation
Beneficiaries
Entity Agreement
Event onUpdate
60
2.2.35.9 Charts
Not required
2.2.35.10 Auditing
Yes, required. The fields to be audited are mentioned in attributes section.
Entity Definition
Ownership Organization
Sales X Settings √
Service X
Marketing X
Process
Business Process Flows † X
Data Services
Duplicate Detection X
Auditing (This entity will not be edited until auditing is enabled
for the organization) X
Outlook
61
Reading pane in CRM for Outlook √
2.2.37.2 Attributes
The following table lists custom attributes to be created for the Agreement Beneficiary Movements.
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Contact Mk_contacti Lookup N Y Optional
d (Contact)
2.2.37.3 Relationships
2.2.37.3.1 N:1 Relationship
Primary Searchable Lookup Field Relationship
Related Entity Requirement Level
Entity Name Behavior
Agreement
Beneficiary
Contact Movement Contact Optional Referential
Agreement
Beneficiary
Agreement Movement Agreement Optional Referential
2.2.37.4 Forms
Not required
2.2.37.5 Views
Not required
62
2.2.37.7 Declarative Workflows, Dialogs and Actions
Not required
2.2.37.9 Charts
Not required
2.2.37.10 Auditing
Yes, required. The fields to be audited are mentioned in attributes section.
Entity Definition
Sales √ Settings X
Service X
Marketing X
Process
Business Process Flows † X
Data Services
Duplicate Detection X
Auditing (This entity will not be edited until auditing is enabled
for the organization) X
Outlook
2.2.38.2 Attributes
The following table lists custom attributes to be created for the Reward Scheme entity.
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Agreement mk_agreem Lookup Y Y Business
ent (Agreemen Required
t)
64
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
(Calculated
)
2.2.38.3 Relationships
2.2.38.3.1 1:N Relationship
Primary Searchable Lookup Field Relationship
Related Entity Requirement Level
Entity Name Behavior
Reward
SchemeInformati Agreement Line
on Item Reward Link Optional Referential
2.2.38.4 Forms
2.2.38.4.1 3.2.1.4.1.1 Main Form
2.2.38.5 yoViews
2.2.38.9 Charts
Not required
65
2.2.38.10 Auditing
Yes, required. The fields to be audited are mentioned in attributes section.
Entity Definition
Ownership Organization
Sales X Settings √
Service X
Marketing X
Process
Business Process Flows † √
Data Services
Duplicate Detection X
Auditing (This entity will not be edited until auditing is enabled
for the organization) √
Outlook
2.2.40.2 Attributes
The following table lists custom attributes to be created for the Account Category Calculation Paramenter entity.
Edit
Display Schema Search Requirement
Data Type Length Options abl Audit
Name Name able Type
e
Parameter Mk_name Single Line 100 Y Y Y Business
Name of Text Required
(mk_param
etername)
2.2.40.3 Relationships
2.2.40.4 Forms
2.2.40.5 Views
Scope Organization
Logic 1. Gets Parameters from Business: The responsible user will get the parameters
set by the business for the next period.
2. Account list created based on indicators used by the administrator: The account
view/list will be created using the search criteria set by the business. This list is
linked to the record created to capture the threshold parameters
3. Parameters are entered for calculation of categories: All threshold values for the
calculation of the categories are entered. The rest of necessary values are
entered as well (defined during design phase)
4. Categories are calculated for the list of accounts: Actual calculation is
performed by selecting the “Calculate Categories” action. All Accounts in the list
are then updated with calculated categories.
5. Record is marked “applied” and set RO: The parameters record is set to Read-
Only and its status changed to “Applied” indicating that the calculation has been
performed.
2.2.40.9 Charts
Not required
2.2.40.10 Auditing
Yes, required. The fields to be audited are mentioned in attributes section.
Commercial business unit is further divided into 3 BUs i.e. Commercial HQ, Sales & Distribution and Loyalty
Management.
MRU business unit under Sales & Distribution BU will have all Mauritius station related users and teams.
All outstations BUs will be created under Commercial HQ BU and their respective users and teams will be created
under their own BUs. The total outstation BUs to be created and the hierarchy amongst them is as follows
China
Beijing
Chengdu
Guangzhou
Shanghai
India
Chennai
Delhi
Bengaluru
Mumbai
SA
Johannesburg
Cape Town
Durban
69
Australia
Melbourne
Perth
Reunion
St Denis
St Pierre
Madagascar
Antananarivo
Germany
Frankfurt
Malaysia
Kuala Lumpur
UK
London
Spain
Madrid
Italy
Milan
Tanzania
Dar-es-Salam
Switzerland
Geneva
France
Paris
Mozambiqu
e
Maputo
Kenya
Nairobi
Rodrigues
Hong Kong
Singapore
Contact BU BU BU None BU BU BU BU
Agreement BU BU BU None BU BU BU BU
Contact BU BU BU None BU BU BU BU
Group Line Items None BU None None None None None None
Non
Account Performance None e None None None None None None
Non
Account Forward Booking None e None None None None None None
Account BSP Sales Non
Performance None e None None None None None None
Group Line Items Org Org Org None Org Org Org Org
71
Account Performance Org Org Org None Org Org Org Org
Account Forward Booking Org Org Org None Org Org Org Org
Account BSP Sales
Performance Org Org Org None Org Org Org Org
Agreement Line Items Org Org Org None Org Org Org Org
Agreement Beneficiaries Org Org Org None Org Org Org Org
Reward Scheme Org Org Org None Org Org Org Org
Fare Information Org Org Org None Org Org Org Org
Account Category Calculation
Parameter Org Org Org None Org Org Org Org
Loyalty Management Security Roles
Appen Appen
Role Name Entity Create Read Write Delete Share Assign d d to
Loyalty
Loyalty Agent Program None Org None None None None None None
Tier None Org None None None None None None
Tier
Qualification
Rule None Org None None None None None None
Reward None Org None None None None None None
Pule None Org None None None None None None
Rule Action None Org None None None None None None
Transaction BU BU None None None None BU BU
Redemption
Line BU BU None None None None BU BU
Promotion
Registration BU BU BU None BU BU BU BU
Contact BU BU BU None BU BU BU BU
Parent
Loyalty Child
Membership BU BU BU None BU BU BU BU
Beneficiary BU BU BU None BU BU BU BU
Membership
Card BU BU BU None BU BU BU BU
Advanced Miles
Request BU BU BU None BU BU BU BU
Tier Revision
Request BU BU BU None BU BU BU BU
Transfer
Request BU BU BU None BU BU BU BU
Travel Log BU BU BU None BU BU BU BU
Voucher BU BU BU None BU BU BU BU
Activities BU BU BU None BU BU BU BU
Appen Appen
Role Name Entity Create Read Write Delete Share Assign d d to
Loyalty Loyalty Org Org Org None Org Org Org Org
72
Administrator Program
Tier Org Org Org None Org Org Org Org
Tier
Qualification
Rule Org Org Org None Org Org Org Org
Reward Org Org Org None Org Org Org Org
Pule Org Org Org None Org Org Org Org
Rule Action Org Org Org None Org Org Org Org
Transaction Org Org Org None Org Org Org Org
Redemption
Line Org Org Org None Org Org Org Org
Promotion
Registration Org Org Org None Org Org Org Org
Contact Org Org Org None Org Org Org Org
Loyalty
Membership Org Org Org None Org Org Org Org
Beneficiary Org Org Org None Org Org Org Org
Membership
Card Org Org Org None Org Org Org Org
Advanced Miles
Request Org Org Org None Org Org Org Org
Tier Revision
Request Org Org Org None Org Org Org Org
Transfer
Request Org Org Org None Org Org Org Org
Travel Log Org Org Org None Org Org Org Org
Voucher Org Org Org None Org Org Org Org
Activities Org Org Org None Org Org Org Org
74
3.[4.] REPORTS DESIGN
3.1.[4.1.] Account/Sales Reports
3.1.1.1.[4.1.1.1.] Overview
Report on planned Visits for the next 7 days together with the last week per Sales Rep. Visits are listed in a table
and also the associated Visit Actions are to be displayed. This report will be executed from the report section and
not from the Account layout. It will get data from all Sales Reps and their sales visits within the 14 days span
starting from last 7 days and ending with the next 7 days.
Date (due date) Date (Date from the appointment) Start 7 Days ago from
today until one week
ahead from day report is
run
75
3.1.2.[4.1.2.] Account Performance Report
3.1.2.1.[4.1.2.1.] Overview
Report gives are overview of account performance based on revenue.
3.1.2.5.[4.1.2.5.] Grouping
This report will be grouped by Class of Travel.
76
Corporate Account From To Revenue Revenue Total
Code Name Economy Business
(MUR) (MUR)
XXBRCA BANQUE DES MRU LON 18689.86 0 18689.86
MASCAREIGNES
XXBRCA BANQUE DES MRU PAR 617750.92 0 617750.92
MASCAREIGNES
77
6 CUSTOMIZATIONS
3.2.[5.1.] Client-Side
3.2.1.[5.1.1.] Java Scripts
Filter Transaction Subtypes
Entity Transaction
Event OnLoad
Entity Tier
Event OnLoad
Confirm Transfer
Event OnSave
Algorithm Prompt user “Warning: Once the transfer request is saved, the miles will be allocated to
<<to membership #>> balance”.
If user press yes, save record.
Else, cancel save
Algorithm if amount is bigger than Member [Advanced Miles Limit] & User [Advanced Miles Limit]
then
alert user “you have exceeded the Advanced Miles Limit”
reset amount or uncheck transfer all
78
Algorithm if current user can edit [Review Status] and [Create on] does not contain data then
Set [Review Status] to Approved
Event OnLoad
Algorithm Show Compensation Details only when Service Request Type = Complaint
Event OnLoad
Event OnSave
Entity Account
Event OnLoad
Entity Account
Applicable to OnLoad
79
Logic When looking up Sales Reps (users) this must be filtered by those belonging to the same
BU as the current owner of the record.
NOTE: Possibly done with Filtering instead of Java Script
Applicable to OnSave
Logic Don’t allow creation of records to any user in the system regardless of the role. Only
possible to create them via Integration.
Applicable to OnSave
Logic Don’t allow creation of records to any user in the system regardless of the role. Only
possible to create them via Integration.
Applicable to OnSave
Logic Only allow creation of records is account type = Corporate or Account Type = Travel
agency.
Set Agreement RO
Entity Agreement
Applicable to OnLoad
Logic When (Agreement end date has been reached then Agreement Status has to be set to
“Expired” and Agreement must be set RO.
Entity Agreement
Applicable to OnChange
80
End date cannot go earlier than the original end date in future - always extend beyond
the original end date
When you change the End Date -> Set Contract Extended flag to True and Reason as
mandatory
Applicable to OnLoad
ELSE
o Hide Cargo related fields on the Service Request form
Update CLV Loyalty Membership Daily (configurable) Update records where [Last
Transaction Date] = Today
Update Member Balance (Tier & Transaction Monthly (configurable) Update Transaction records
Available miles) where [Expiry Date] = this
month
Requalify Expired Membership Loyalty Membership Monthly (configurable) Requalify members where
[Tier Review Date] month =
current month
Batch Customer Statement Loyalty Membership Every 3 month (configurable) Send email with statement as
an attachment
81
Membership Status Updater Loyalty Membership Monthly (Configurable) Mark membership as
[Dormant] if no MK
transactions in past 3 years
Mark membership as [MK
Dormant] if at least one
partner flight and no MK
flights in past 3 years
82