EAS 4.3 Service Provider Manual PDF

Ensim Automation Suite 4.
Service Provider Manual
Published: 8 April 2016
This document contains information proprietary to Ensim Corporation and its receipt or possession
does not convey any rights to reproduce, disclose, manufacture, or sell anything it might describe. Use
without Ensims specific written authorization is strictly forbidden. Ensim makes no representations or
warranties with respect to the contents or use of this document and it reserves the right to revise this
document any time, without the obligation to notify any person or entity of revisions. Further, Ensim
assumes no responsibility or liability for any errors or inaccuracies, makes no warranty of any kind
(express, implied, or statutory) with respect to the contents or use of the information, and expressly
disclaims any and all warranties of merchantability, fitness for particular purposes, and noninfringement of third-party rights.
Ensim and the Ensim logo are registered trademarks of Ensim Corporation. All other trademarks are the
property of their respective owners.
2016 Ensim Corporation. All rights reserved.
ENSIM CORPORATION
1540 Parkmoor Avenue, Suite D
San Jose, CA 95128
United States
www.ensim.com
EAS 4.2 SERVICE PROVIDER MANUAL

8 APRIL 2016
ENSIM CONFIDENTIAL
2
Contents
About this guide
12
Introduction .............................................................................................................................................. 12
Intended audience and required skills ................................................................................................. 12
Related documentation ........................................................................................................................... 12
Support and feedback ............................................................................................................................. 12
Overview of EAS
14
Getting started with EAS
16
Service Provider Signup ......................................................................................................................... 16

UPN-Suffix .................................................................................................................................... 16
Enabling Resellers ........................................................................................................................ 16
Enabling Agents ........................................................................................................................... 16
Log in to EAS............................................................................................................................................ 18
Dashboard ..................................................................................................................................... 18
Identity Management
20
Service Provider entity and User Management ................................................................................... 20

Authentication for SP users ........................................................................................................ 26
Organizations ........................................................................................................................................... 26
How Self-registration works ....................................................................................................... 26
Creating an Organization ............................................................................................................ 28
Editing Organization ................................................................................................................... 39
Creating an Organization User .................................................................................................. 42
Editing Organization User .......................................................................................................... 46
Searching Organizations ............................................................................................................. 46
Listing Organizations .................................................................................................................. 50
Agents ....................................................................................................................................................... 56
Creating an Agent ........................................................................................................................ 56
Searching Agents .......................................................................................................................... 56
Viewing Agent details ................................................................................................................. 58
Creating an Agent user ................................................................................................................ 58
Viewing Agent user details ......................................................................................................... 59
Editing Agent user ....................................................................................................................... 60
Giving permissions to Agent user ............................................................................................ 61
Deactivating Agent user .............................................................................................................. 62
8 APRIL 2016
ENSIM CONFIDENTIAL
3
CONTENTS
Reset/regenerate Agent user password ..................................................................................... 63

Resellers .................................................................................................................................................... 66
Reseller enablement ..................................................................................................................... 66
Reseller Membership for Service Provider user ....................................................................... 85
Email notifications template ....................................................................................................... 89
Additional currency ..................................................................................................................... 89
Reseller Branding ......................................................................................................................... 89
Creating Reseller User ................................................................................................................. 91
Editing Reseller User ................................................................................................................... 91
Users .......................................................................................................................................................... 92
User search .................................................................................................................................... 92
Activate/Deactivate Users ........................................................................................................... 94
UPN Reuse .................................................................................................................................... 96
Bulk User Import .......................................................................................................................... 97
User Service Assignment........................................................................................................... 100
Bulk User Service Assignment (BUSA) ................................................................................... 101
Product Modeling
106
Introduction ............................................................................................................................................ 106

Service ..................................................................................................................................................... 106
Resource .................................................................................................................................................. 106
Item .......................................................................................................................................................... 107
Item unit .................................................................................................................................................. 108
Billing frequency .................................................................................................................................... 108
Offer ......................................................................................................................................................... 108
Pricing Configuration............................................................................................................................ 108
Pricing .......................................................................................................................................... 108
Installment................................................................................................................................... 109
Reseller Price Plan ................................................................................................................................. 109
Adding Provisioning Resources for RPP ................................................................................ 110
Adding Provisioning Resources for Reseller Price Plan ....................................................... 118
Adding Additional Charges for Reseller Price Plan .............................................................. 123
Adding Reseller Specific Discount ........................................................................................... 125
Degrees of freedom of Items ................................................................................................................ 126
Conflicting Offers .................................................................................................................................. 126
Upsizing and downsizing an order ..................................................................................................... 127
Promotions ............................................................................................................................................. 128
Delete Promotion........................................................................................................................ 131
Configure Association ............................................................................................................... 132
Example: Product modeling with Virtual Private Servers ............................................................... 138
Overview ..................................................................................................................................... 138
Constructs the Items from VPS service definition ................................................................. 138
Add Service ................................................................................................................................. 140
Edit Service.................................................................................................................................. 148
Delete Service.............................................................................................................................. 150
Import Service ............................................................................................................................. 150
Resource Configuration ............................................................................................................. 152
Delete Resource .......................................................................................................................... 163

8 APRIL 2016
ENSIM CONFIDENTIAL
4
CONTENTS
Map PIF Identifier ...................................................................................................................... 165

Download Service ...................................................................................................................... 166
Item Creation .......................................................................................................................................... 166
Base Item ..................................................................................................................................... 166
Bundle Item ................................................................................................................................. 169
Composite Item .......................................................................................................................... 171
View Pricing ................................................................................................................................ 173
Edit Item.................................................................................................................................................. 175
Delete Item .............................................................................................................................................. 177
Create Offer Category ........................................................................................................................... 178
Create Offer ............................................................................................................................................ 180
General Properties...................................................................................................................... 182
Subscription Properties ............................................................................................................. 188
Offer type .................................................................................................................................... 189
Billing Rules ................................................................................................................................ 191
Self-registered organization ...................................................................................................... 193
Item Configuration Details ....................................................................................................... 195
Marketplace Content ................................................................................................................. 208
Catalog Attributes ...................................................................................................................... 209
Provisioning Workflow ............................................................................................................. 210
Notification Macros.................................................................................................................... 213
Edit Offer ................................................................................................................................................ 217
Offer Import/Export .............................................................................................................................. 223
Export/Import file format .......................................................................................................... 223
Offer Export ................................................................................................................................ 223
Offer Import ................................................................................................................................ 224
Copy Offer .............................................................................................................................................. 226
Publish Offer .......................................................................................................................................... 229
Manage Version ..................................................................................................................................... 231
Create Version ............................................................................................................................ 233
Version States.............................................................................................................................. 237
Version announcement and notification ................................................................................. 241
Subscription Alignment Process (with invoice date management) .................................... 242
Search Offer ............................................................................................................................................ 245
Delete Offer ............................................................................................................................................ 246
Activate/De-activate Offer .................................................................................................................... 246
Conflicting Offers ....................................................................................................................... 251
Upsize Configuration ................................................................................................................ 252
Item Group Configuration ........................................................................................................ 254
Order Management
258
Introduction ............................................................................................................................................ 258

Order Creation ....................................................................................................................................... 258
Search Order ............................................................................................................................... 278
Edit Order .................................................................................................................................... 283
Ordering offers having Item groups ........................................................................................ 283
Ordering offers having Add-On Items .................................................................................... 284
Order PDF ................................................................................................................................... 288

8 APRIL 2016
ENSIM CONFIDENTIAL
5
CONTENTS
Impact of Subscription............................................................................................................... 292

Provisioning Operations ....................................................................................................................... 297
Configure provisioned Orders ............................................................................................................. 297
Order States ............................................................................................................................................ 299
Provisioning Workflow......................................................................................................................... 304
Order Approval ..................................................................................................................................... 308
Order Approval Workflow................................................................................................................... 309
Multilevel Approval Workflow ........................................................................................................... 335
User Group Creation.................................................................................................................. 335
Approval workflow association with Offer ............................................................................ 337
Provisioning Operations on Order ...................................................................................................... 342
Order State Transfer Description......................................................................................................... 347
Truncate and Hide order ........................................................................................................... 349
Order Notification ................................................................................................................................. 351
Trial Order................................................................................................................................... 353
AROrderControl .................................................................................................................................... 356
Bulk Order Management ...................................................................................................................... 359
Performing Actions on multiple Orders ................................................................................. 359
Export Orders ............................................................................................................................. 366
EAS Data Model
372
Identity Management ............................................................................................................................ 372

Hierarchy of EAS entities .......................................................................................................... 372
Relationship of tables at Entity level ....................................................................................... 373
Relationship of schemas at user level ...................................................................................... 374
Service Provider Entity .............................................................................................................. 375
Service Provider user ................................................................................................................. 375
Reseller Entity ............................................................................................................................. 375
Reseller User ............................................................................................................................... 375
Agent Entity ................................................................................................................................ 376
Agent User .................................................................................................................................. 376
Organization Entity.................................................................................................................... 376
Organization User ...................................................................................................................... 376
Organization Account details ................................................................................................... 377
Payment Agreement details ...................................................................................................... 377
Product Model........................................................................................................................................ 378
Service .......................................................................................................................................... 378
Resources ..................................................................................................................................... 378
Items ............................................................................................................................................. 378
Offers............................................................................................................................................ 379
Relationship between offer, item and price plan ................................................................... 380
Relationship between offer, category, offer version and subscription ............................... 381
Offer Subscription ...................................................................................................................... 382
Order ....................................................................................................................................................... 382
Logical data structure ................................................................................................................ 382
Relationship between order internal schemas ....................................................................... 384
Orders placed by an organization ............................................................................................ 385
Only purchase order .................................................................................................................. 385

8 APRIL 2016
ENSIM CONFIDENTIAL
6
CONTENTS
Item quantity in an order .......................................................................................................... 385

Item pricing details for an order .............................................................................................. 385
Order contract period ................................................................................................................ 385
Provisioned date, Invoice start date and Cancellation date of an order ............................. 386
Provisioning information details of an order ......................................................................... 386
Order summary .......................................................................................................................... 386
Sub-Order number ..................................................................................................................... 386
Business Contact and Technical Contact of an order ............................................................ 387
Order Import ............................................................................................................................... 387
Invoicing ................................................................................................................................................. 388
Relationship between Service Provider invoice schema ....................................................... 388
Relationship between Reseller invoice schema ...................................................................... 388
Service Bundling
390
Creating Bundled Service ..................................................................................................................... 391

Resource Mapping ................................................................................................................................. 392
Offer Upgrade Options ......................................................................................................................... 394
Assign Bundled Services to Users ....................................................................................................... 395
Finance Module
397
Introduction ............................................................................................................................................ 397

Usage collection ..................................................................................................................................... 397
Binaries ........................................................................................................................................ 397
Tax ........................................................................................................................................................... 399
Configure Tax ............................................................................................................................. 399
Import or Export Tax Codes ..................................................................................................... 400
Provide External Connector-Specific Authentication Data .................................................. 402
Rating ...................................................................................................................................................... 404
BCD (Bill Cycle Day).................................................................................................................. 404
Suspend or Resume Billing ....................................................................................................... 409
Modify Billing ............................................................................................................................. 411
Killing a Process ......................................................................................................................... 412
Mid-Month Billing Rule ............................................................................................................ 413
Skip Billing .................................................................................................................................. 413
Usage Buffer Day ....................................................................................................................... 414
Pro Rata Calculation .................................................................................................................. 414
Upsize .......................................................................................................................................... 414
Downsize ..................................................................................................................................... 416
Upgrade ....................................................................................................................................... 417
Downgrade.................................................................................................................................. 417
Advance Billing .......................................................................................................................... 417
Reimbursements ......................................................................................................................... 418
Suspend ....................................................................................................................................... 418
Resume ........................................................................................................................................ 418
Cancel........................................................................................................................................... 418
Annual Billing ............................................................................................................................. 420
Billing Hole ................................................................................................................................. 420

8 APRIL 2016
ENSIM CONFIDENTIAL
7
CONTENTS
Change of Offer during Subscription period ......................................................................... 420

Differential Billing Mode........................................................................................................... 421
Future Billing .............................................................................................................................. 421
Rating Configuration and Scheduling.................................................................................... 422
Different use cases of Rating of different types of Items ...................................................... 433
Trials............................................................................................................................................. 449
Promotions .................................................................................................................................. 453
Payment and Invoice ............................................................................................................................. 461
Billing Adjustment ..................................................................................................................... 474
Billing Codes ............................................................................................................................... 476
Payment Mode ............................................................................................................................ 479
Custom Fields ............................................................................................................................. 479
PIFs ............................................................................................................................................... 480
Headers in Rated/Unrated Execution Mode .......................................................................... 480
Exported Rated CSV File (Renamed Headers) ....................................................................... 487
Exported Rated XML File (Renamed Tags) ............................................................................ 488
Output File Naming Convention ............................................................................................. 488
Invoice Generator Jar ............................................................................................................................ 488
Application Settings ................................................................................................................... 489
Invoice PDF Generator Jar .................................................................................................................... 492
Application Settings ................................................................................................................... 496
Invoice PDF generation for organization ................................................................................ 498
Reseller Rating and Invoicing .............................................................................................................. 500
Reseller Rating ............................................................................................................................ 500
Reseller Payment and Invoice .................................................................................................. 500
Ticketing
501
Introduction ............................................................................................................................................ 501

Overview of Ensim Ticket System....................................................................................................... 501
Common Terms for Tickets .................................................................................................................. 504
Tickets/Issues .............................................................................................................................. 504
Ticket Category........................................................................................................................... 504
Support Engineer ...................................................................................................................................... 505
Questions and Comments......................................................................................................................... 505
State of Tickets........................................................................................................................................... 505
Workflow ................................................................................................................................................ 506
Roles and Rights .................................................................................................................................... 507
Ticket Notifications ............................................................................................................................... 508
Templates of notification ........................................................................................................... 508
Working mechanism of notification ........................................................................................ 508
Add Support Engineer .......................................................................................................................... 510
List Support Engineer ................................................................................................................ 511
Add Ticket .............................................................................................................................................. 512
Add Ticket from Organization page ........................................................................................ 512
Add Ticket from Order page .................................................................................................... 515
View tickets from List Order page ........................................................................................... 518
Add Ticket from Header Menu ................................................................................................ 518
Search Tickets ......................................................................................................................................... 519

8 APRIL 2016
ENSIM CONFIDENTIAL
8
CONTENTS
Update ticket .......................................................................................................................................... 520

Closing a Ticket ...................................................................................................................................... 521
Email Notification
522
Introduction ............................................................................................................................................ 522

Definition ................................................................................................................................................ 522
Overview of Notification ...................................................................................................................... 523
Notification capability of EAS product ................................................................................... 523
Identifying the Notification ...................................................................................................... 523
Category: Entities................................................................................................................................... 525
Category: Users ...................................................................................................................................... 526
Category: Orders.................................................................................................................................... 528
Category: Trials ...................................................................................................................................... 535
Category: Order alerts ........................................................................................................................... 538
Category: Manual Provisioning ........................................................................................................... 542
Category: Invoice details ...................................................................................................................... 545
Category: Payment ................................................................................................................................ 547
Category: Offers ..................................................................................................................................... 549
Support Tickets ...................................................................................................................................... 551
Virus Scanner .............................................................................................................................. 551
View tickets from List Order for each order ........................................................................... 552
Category: Support Tickets ......................................................................................................... 552
Other Features of Notification ............................................................................................................. 555
Other capability of the EAS notification ................................................................................. 555
Specifying who receives the notification................................................................................. 555
Content of the Notification ....................................................................................................... 555
Edit Notification:.................................................................................................................................... 555
Import & Export of templates .............................................................................................................. 557
Set Default Body .................................................................................................................................... 558
SMTP Mail Configuration .................................................................................................................... 558
SMTP Settings ............................................................................................................................. 559
Reseller customization .......................................................................................................................... 561
Set Email Signature................................................................................................................................ 561
Send demo email.................................................................................................................................... 563
Cart reminder setting ............................................................................................................................ 564
Reporting
565
JasperServer Reports ............................................................................................................................. 568

Integration with EAS ................................................................................................................. 568
Install JRS..................................................................................................................................... 569
Configure JRS.............................................................................................................................. 569
Report Types ............................................................................................................................... 570
Procedures to Generate Reports ................................................................................................................ 571
PIF Mapping ........................................................................................................................................... 575
Item Category Mapping............................................................................................................................ 577
Offer Type Identifier for Reporting............................................................................................................ 578
Impacted Modules in EAS ........................................................................................................................ 578

8 APRIL 2016
ENSIM CONFIDENTIAL
9
CONTENTS
Security
580
Deploying securely ................................................................................................................................ 580

Built-in features ...................................................................................................................................... 581
Branding
583
Introduction ............................................................................................................................................ 583

Scope of branding for Service Provider .................................................................................. 583
Scope of branding for Resellers ................................................................................................ 584
Process to retain branding during EAS upgrade ................................................................... 584
Summary ..................................................................................................................................... 585
Configuring EAS for branding............................................................................................................. 585
Configuring SMB share ............................................................................................................. 587
Customizing the Login page ................................................................................................................ 588
Customizing CSS ................................................................................................................................... 591
Customizing Organization UI.............................................................................................................. 610
Customizing UI labels ........................................................................................................................... 616
Customizing Invoices ............................................................................................................................ 622
Enabling Reseller Branding .................................................................................................................. 623
License Management
625
Ensim Software License ........................................................................................................................ 625

Ensim Software License Management Paradigm .............................................................................. 625
System Configuration
630
Configuration ......................................................................................................................................... 630

About ........................................................................................................................................... 630
Activities ...................................................................................................................................... 631
Address Property Configuration ............................................................................................. 632
Approval Workflow ................................................................................................................... 634
Company ..................................................................................................................................... 635
Countries ..................................................................................................................................... 636
CRM Settings .............................................................................................................................. 637
Currencies ................................................................................................................................... 642
Custom Fields ............................................................................................................................. 643
Dashboard properties ................................................................................................................ 645
DNS Settings ............................................................................................................................... 646
General properties ...................................................................................................................... 646
IDM Configurations ................................................................................................................... 652
Import Service Users .................................................................................................................. 658
Languages ................................................................................................................................... 659
License ......................................................................................................................................... 663
Marketplace Configuration ....................................................................................................... 664
Notifications Templates............................................................................................................. 666
Order Management .................................................................................................................... 679
Payments gateways .................................................................................................................... 681
Payments and Invoice ................................................................................................................ 681
8 APRIL 2016
ENSIM CONFIDENTIAL
10
CONTENTS
Phone Number Inventory ......................................................................................................... 687

Product management................................................................................................................. 689
Provisioning Workflow ............................................................................................................. 691
Registered servers ...................................................................................................................... 694
Reports ......................................................................................................................................... 695
Roles ............................................................................................................................................. 696
Running batch jobs ..................................................................................................................... 710
Service connectors ...................................................................................................................... 710
Synchronization Tool ................................................................................................................. 710
Tool scheduler ............................................................................................................................ 712
Usage Import .............................................................................................................................. 713
Appendixes
714
Appendix A: CSS ................................................................................................................................... 714

Appendix B: Plugins.............................................................................................................................. 716
Appendix C: JasperReports .................................................................................................................. 717
Appendix D: Order PDF ....................................................................................................................... 719
Appendix E: Invoice PDF ..................................................................................................................... 730
Appendix F: Custom Fields .................................................................................................................. 752
Appendix G : Order Data removal ...................................................................................................... 755
Appendix H: SPNEGO Authentication .............................................................................................. 757
Appendix I: Deleting Objects from EAS Database ............................................................................ 759

8 APRIL 2016
ENSIM CONFIDENTIAL
11
About this guide
Introduction
This document will guide the Service Provider to activate the account and setup system configuration in
order to take EAS into operations.
Intended audience and required skills

This guide is intended for Service Provider admin users wanting to setup and configure EAS for others
to use . The users are advised to have basic knowledge of EAS features before using this document.
The functionalities of the following tools are incorporated in the core of EAS and therefore the tools (as
was released separately in EAS 4.1) are deprecated in this release.
1. Order Generator
2.
Invoice Exporter
3.
Unrated Exporter
No description of these utilities will be available in EAS product guides.
Related documentation
Release Notes, Installation Guide and API guide of EAS.
Note: In addition, key information are sometimes displayed using special headings and formats,
such as this one, to make it stand out from regular text.
Support and feedback

For Ensim online support or feedback, use the following links:
https://support.ensim.com to contact Ensim support.

8 APRIL 2016
ENSIM CONFIDENTIAL
12
CHAPTER 1 ABOUT THIS GUIDE
Note: All organizations receive passwords that allow access to the Ensim Support site. If any
organization does not have a password, contact Ensim.
CHAPTER 1
Overview of EAS
Ensim Automation Suite (EAS) provides a complete solution for Ordering, Service Catalog, Product
Modeling, Pricing, Rating, Billing, Invoicing, Reconciliation, Payment, Notification, and Approval
Workflow. As part of the Ensim Automation Suite, it is fully integrated with Ensim Service Operations
Manager (ESOM) and Ensim Service Connectors for a complete billing solution for business applications
and services in private, public, and hybrid cloud environments. EAS is used by service providers to
offer their solutions to organizations and resellers, and by enterprises and government agencies to
provide a consumer like experience for employees and departments ordering IT services. Offers can
easily be created on the fly to allow multiple offers with various pricing and rating plans for any type of
service, item, hardware, software, SaaS, IaaS, etc. Advanced identity, role, and rights management
allows users to be set up as organizations, employees, agents, resellers, and distributors with context
sensitive portals so they can only see what they are authorized to see down to an individual permission
level and the native IDM can easily be integrated to any other IDM solution.
This section describes basic actions which can be performed in different modules of the Ensim
Automation Suite (EAS). These operations enable users to learn the scope and functionalities of EAS in
brief.
EAS consists of the following modules
1.
2.
3.
Identify Management
i.
Service Provider Entity
ii.
Organizations
iii.
Agents
iv.
Resellers
v.
Users
Service Catalog
i.
Services, Resources, Items and Offers
ii.
Subscriptions
iii.
Promotions and Discounts
iv.
Trials
Order Management
i.
Ordering
ii.
Upsizing and Upgrading

8 APRIL 2016
ENSIM CONFIDENTIAL
14
OVERVIEW OF EAS
4.
iii.
Approval Workflow
iv.
Trials
Finance
a.
Usage collection
b.
Rating and exporting rated data
c.
Invoicing and Payments
5.
Ticketing
6.
Notification
7.
Reporting
8.
Branding
Note: EAS consists of Ensim Service Catalog Manager and Ensim Service Operations Manager.
Ensim Automation Suite has been abbreviated as EAS and Ensim Service Operations Manager will
be abbreviated as ESOM throughout this document.
CHAPTER 2
Getting started with EAS
Service Provider Signup

After installing EAS, user must create the Service Provider account in the system. Follow the
steps below to create the account1. Browse to the URL- <baseUrl>/signup .
e.g. http://EAS.example.com:8080/EAS/signup.
Signup form opens.
2. Fill the required details in the fields. During the company signup process, provide
value for the 'Login ID' field and value for the 'Password' field, which are nothing but
the default admin user credentials for the company.
UPN-Suffix
You may skip this section if ESOM is not deployed with EAS.
This UPN-Suffix should be same as the Active Directory UPN-Suffix of the SP entity in
ESOM. While signing up in EAS, the value should be provided by the Service Provider
default admin in ESOM.
This represents the Active Directory domain name which already exists at ESOM side for the
given Service Provider. Users created under Service Provider will have the given value as the
suffix of the Active Directory username.
For example-
Then the actual ESOM login name for Service Provider user will be admin@eas.local.
Enabling Resellers
If you want to use Resellers in EAS, turn the field name Use Reseller Model.
Enabling Agents
If you want to use Agents in EAS turn on the field named User Agent model.
3.
Click 'Save Changes' button to complete company signup process.
After the completion of sign-up process, an email is sent to the Service Provider.

8 APRIL 2016
ENSIM CONFIDENTIAL
16
GETTING STARTED WITH EAS
Note: Company signup process will get locked once the Service Provider account is
created.
Log in to EAS
After the Service Provider account is created, the Service Provider is able to log in to EAS.
1.
2.
3.
Provide the Username and Password.

Select the desired language from the Display Language drop-down list.
Click Login. This action directs you to the EAS dashboard page. Dashboard page
contents varies depending on the type of user (Service Provider, Organization, or
Reseller) who has logged in using his/her credential.
For any role scope, if the permissions are changed, it will be effective after 15 minutes, when
the user logs in again or performs a switch entity.
Note: It is assumed that the system configuration is already done for EAS. For further
details on EAS configuration, refer to System Configuration chapter.
Dashboard
This is the first landing page for the Service Provider admin user after successful log in to the
EAS portal. The Dashboard tab on the navigation bar also redirects user to the dashboard
screen.
The Dashboard page is divided into the following four sections
Content Management Placeholder
Account Information.
Support Information
News and Announcements
Information displayed in the content management placeholder, support and news sections
are configurable from the Configuration-> Dashboard Properties menu. The Account
information section displays the name and basic details of the organization of the logged in
user. The buttons redirect the user to the respective modules.
CHAPTER 3
Identity Management
Service Provider entity and User Management

To view and edit the details of the SP entity, perform the steps below1.
Click the My Organization tab in the navigation bar.
2.
You can see the details of the SP entity.
3.
A section of the page displays with the entity name along with the basic information
4.
List of SP user (paginated) appears to the right side of the page.
5.
You may add a new User by clicking the Add New button.
6.
You will be redirected to the New User page.

8 APRIL 2016
ENSIM CONFIDENTIAL
20
IDENTITY MANAGEMENT
7.
Fill the required details and click Create User button.
8.
New user will be added to the List of Users for the Organization.
To get the details of each SP user1.
Click that particular user. A page with the user details opens as shown in the figure.
IDENTITY MANAGEMENT
To change the permission setting1.
Click the Permissions button.
2.
You will be redirected to the Edit Permissions page.
3.
By editing the permissions of a user, you can take some rights off from the set of rights given by virtue of
the roles assigned to the user.
You can't grant rights in addition to what has already included in the roles assigned to the user.
If required, the set of permissions can be synchronized with the master role definition at a later stage.
IDENTITY MANAGEMENT
4.
After you have permitted the user with the roles, click the Save Changes button.
Note: The above image does not include all items available. This is only a sample.
To edit the information of the selected user1.
Click the Edit button.
2.
You will be redirected to the Edit User page.
IDENTITY MANAGEMENT
3.
The username can only be edited if the right Change Username has been assigned to the user.
4.
Click the Save Changes button to save the new information.
To change the Status of the user1.
Click De-activate User button.
2.
A message is displayed saying user has been de-activated.
3.
The Status field changes from Active to Inactive mode.
EAS allows user to change the status of the user in ESOM if there is an account created on behalf of that user in
ESOM. If the logged in user has the permission to activate/ deactivate the Service Provider users, then activate/
deactivate ESOM user button will also appear. To change the status of the Service Provider users globally other
than the logged in user, follow the steps below1.
If the user account is created in ESOM, then Activate ESOM User button will appear if the user is in
deactivated mode in EAS. If the user is in active mode, then Deactivate ESOM User button will appear.
2.
Click the button accordingly to activate/ deactivate the user globally. The deactivated users will be
prohibit from logging into ESOM.
IDENTITY MANAGEMENT
To reset the password of the User1.
Click the Reset Password button.
2.
Provide a new password and verify it.
3.
Click Save Changes button, to save the new password.
To regenerate the password1.
Click Regenerate Password button.
2.
A message window opens up confirming whether you want to regenerate the password.
3.
Click the OK button.
4.
The system will generate a new password and sent to the Primary Email address of the user.
IDENTITY MANAGEMENT
Authentication for SP users

Besides regular EAS local authentication, EAS supports Active Directory based Kerberos authentication for SP
Users. Service Provider users can SSO into EAS from their devices that are connected to an Active Directory
network. When such users log in to the AD network and visit a specially configured URL of EAS, they are logged
into EAS without being prompted for passwords. The feature allows automatic on-boarding of these users based
on AD Security group membership and relies on enablement of SPNEGO protocol as described here
https://msdn.microsoft.com/en-us/library/ms995329.aspx. Please refer to System Configuration section for details.
Organizations
In EAS, Organizations are entities that represent customers. Organizations can either be created by selfregistration or may be created by the Service Provider, Agents, or Resellers.
How Self-registration works

Service Provider (and Resellers, if allowed) can enable visitors to self-register themselves as Organizations.
As a visitor, click the 'Signup' tab on the portal log-in page. The self-registration form appears.
IDENTITY MANAGEMENT
Provide the required details and click Register. You will be registered as an organization in the EAS portal.
Configuration of organization and account address field as mandatory: The Service Provider can configure
selective address fields of organizations and accounts as mandatory from the Address Configuration menu
under the Configuration tab. While self-registering an organization, the fields, which are set as mandatory in
address configuration, must be provided by the user to complete registration.
On successful registration, an activation email with log-in credentials is sent to the email address specified in the
signup form.
An account is created for the self-registered organization with the same name as the Organization. A default user
is created for the self-registered organization with the provided email address as username and the user is
assigned the Organization super Admin role with default technical contact and business contact for that
organization.
However, a Self-registered Organization's user has neither upn-suffix nor domain name.
Organization creation in Active Directory:
By default, for self-registered organizations the AD OU role is set to Ask in first order'. Hence, the upn-suffix is
auto generated when the organization places its first order for specific services that are provisioned through
ESOM (such as Lync and Exchange).
DNS Registration:
Without the DNS name, orders for domain based services (such as GoogleApps, Hosted Email, and CSP Office
365) cannot be placed. Organization users may log in to the portal and add the DNS domains for which EAS
provides a simple DNS verification process.
Once self-registered, the Organization can place trial orders but are not allowed to purchase them. Service
Provider Operations team may verify and approve these organizations so that they can place regular orders in
the system.
Note: For information on how to enable this feature in EAS, refer to the System Configuration section.
IDENTITY MANAGEMENT
Creating an Organization
To create an Organization, complete the following steps.
1.
2.
Click Entities > Organizations.

Click Add Organization. The Organization Details page appears.
3.
On the Organization Details page, provide the Organization details and address.
4.
Configuration of address field as mandatory: You can configure the selective address fields of
Organizations and accounts as mandatory from Configurations > Address Configuration menu.
To configure selective address fields as mandatory, refer to the Impact of Upgrade chapter in EAS
4.3 Installation Guide.
Organization Custom Fields: You may incorporate additional fields for your Organizations to store
Organization specific data like establishment date, Organization code, fax no, and so on. Refer to the
System Configuration section for information on how to enable the custom fields.
Organization Attribute: The Organization Attribute field appears in the Organization creation page.
This field is required for changing the ownership of the Organization from Service Provider to
enterprise type reseller where each Organization under VO reseller has a unique attribute in ESOM.
This is nothing but an identifier of VO ministries. Since all users are created under one OU in ESOM,
the provider must set an attribute tag against each Organization in EAS. In ESOM this attribute is
used to tag all the end users.
Enable User Management notification: Enabling this field allows user to send user management
related notification to the corresponding primary email address.
User Data Master: This field decides whether user management will be done by EAS or an external
party, that is, Reseller Type 2 who has the permission to manage users.
Click Continue to proceed to Master Accounts Details.
IDENTITY MANAGEMENT
Bill Cycle Day: Bill Cycle Day (BCD) signifies the bill cycle of an order. For example, if the BCD of an
order is set as 5th of a month, then the Rating generates the Invoice against that particular order from
5th of the current month to 4th of the next month.
AD OU Creation: This field indicates the user creation in ESOM. There are two modes of user
creation:
Create now-Limited Admin: Select this field to allow immediate creation of user in ESOM Active
Directory, but with limited rights of Organization admin limited role as set in General Properties.
Delayed creation-Limited Admin: Select this field to allow creation of user in ESOM Active
Directory only during order placement.
User Display Name: This feature includes a custom display name format for a user in Active
Directory. The display name rule is set as either <firstname>.<lastname> or <lastname>.<firstname>
with the former being the default. ESOM has an API, which is used to set this rule for AD
Organization (OU). To set a custom display name, this rule must be set to None.
If ESOM receives a request to create or update an AD User account with property FullName
specified then ESOM will automatically set the value as DisplayName in AD. This is applicable to
all ESOM Organizations with the rule set as None. If FullName attribute is NULL or <blank>,
then username or UPN will be set as display name.
EAS Organization Creation UI provides an option to choose the User Display Name rule as per the
Organization. This value is passed to the ESOM API by the Background Provisioning Engine and
EAS Middleware to be set in Active Directory per Organization.
IDENTITY MANAGEMENT
Corporate ID: The Corporate ID may vary for each account of an Organization.
Use organization address as account address: In the account details section, if the Use organization
address as account address field is selected, the Organization address is considered as the account
address. If it is not selected, you must provide a separate account address.
Organization Address is the official address and Account Address is where the bill or invoice is
sent for the Organization. The Organization and account addresses may be the same depending on
the Use Organization address as account address constraint. If this field is selected, the Organization
and account addresses remain same and the invoice is sent to the Organization address.
However, if this field is not selected, the following page appears, where you must provide a separate
billing address. In the following figure, in the Account Address section, the address fields set as
mandatory are shown in red.
5.
Click Continue to go to the Summary page and then, click Save to create the Organization.
IDENTITY MANAGEMENT
Organization Global Discount

An Organization global discount is a method used by sellers and manufacturers to reward those who purchase in
bulk amounts or in mass quantities. A volume discount for merchants may inspire merchant loyalty.
To enable Organization global discount for an Organization, complete the following steps.
1. Click Entities > Organization.
2. Enable Organization global discount in the Organization Details page.
To set the discount percentage for the discounted Organization, complete the following steps.
1. Select the discounted Organization.
2. Under the Organization Global Discount section, set the discount percentage as required.
IDENTITY MANAGEMENT
Contractual Statement
A property named contractual statement in the Organization details section allows the provider to add
contractual information for the corresponding Organization.
The Contractual Statement is available for printing in the Order PDF using a macro for order PDF. It is also
available in the notification templates.
Help Menu
Help Menu is available for each Organization where Service Provider can set help content in HTML format. It is
recommended that you use the following HTML format.
To get the multilevel and nested sub-menus for help link:
<li class="org-help-menu-heading">Main Help</li>
<li><a href="https://www.google.co.in/" target="_blank">Google.com</a></li>
<li><a href="http://www.ensim.com/" target="_blank">Ensim.com</a></li>
<li class="org-help-menu-sub-heading">Sub Heading</li>
<li class="org-help-menu-sub-heading-content"><a href="https://www.google.co.in/" target="_blank">2.1
Google.com</a></li>
<li class="org-help-menu-sub-heading-content"><a href="http://www.ensim.com/" target="_blank">2.2
Ensim.com</a></li>
<li class="org-help-menu-sub-heading-content org-help-menu-sub-heading">Nested Sub Heading</li>
<li class="org-help-menu-sub-heading-content-2"><a href="(orgHelpLink)" target="_blank">Organization Global
Help Link</a></li>
Or,
To get simple sub-menus for help link:
<li class="org-help-menu-heading">Main Help</li>
<li class=""><a href="(orgHelpLink)" target="_blank">1st Replace</a></li>
<li class=""><a href="(orgHelpLink)" target="_blank">2nd Replace</a></li>
IDENTITY MANAGEMENT
You must add the HTML sample in the Help Menu field as shown in the following figure.
Note: (orgHelpLink) macro is replaced by the value provided in the General Properties section for the field
Organization Online Help URL.
IDENTITY MANAGEMENT
Accounts
An Organization may have multiple accounts. When creating an Organization, it is mandatory to provide an
account name in the account details section. This is the master account. You may add multiple sub accounts from
the Accounts tab.
IDENTITY MANAGEMENT
After creating the accounts, you can set one particular account as the default billable account among multiple
accounts. Billable account can be set to Self where the bill for that particular account will be sent.
IDENTITY MANAGEMENT
Corporate ID
The Master Account Details section of the Organization creation page contains the Corporate ID. The Corporate
ID may vary for each account of an Organization.
IDENTITY MANAGEMENT
The following figure shows the Corporate ID for the master account.
IDENTITY MANAGEMENT
Default technical and business contacts

The Technical and Business Contact is set by default at the Organization level. However, the default Technical
and Business Contact can also be assigned at the account level.
Only those users are listed in the Technical and Business contact drop-down list whose Technical/Business
contact permissions are enabled. All users who belong to that account will be listed first and then rest of the users
of that Organization will be listed under the From other accounts group.
Organization DNS name

For each Organization, there may be several domain names. For each domain name there will be a corresponding
entry in ESOM. However, for multiple domain names of an Organization, only a single entry is made in ESOM.
To view multiple domain names for an Organization, complete the following steps.
1.
2.

Select an Organization. The details of the Organization are displayed on the right. The domain names and
their details are displayed under the Suffix tab.
The modifications that are made for a domain, the record will be tracked in the entry of ESOM.
Multiple entries were created in ESOM for each domain name. Currently, only a single entry is made for multiple
domain names of an Organization. It is not mandatory that the entry in ESOM must be same as the domain name,
but it is recommended that you provide the same name to avoid confusion.
IDENTITY MANAGEMENT
Editing Organization
Select an organization and click Edit on the organization details page. In EAS, the upn-suffix can be edited for an
organization if the AD OU Role is set to Delayed Creation- Limited Admin and there are no active orders (such
as orders in draft or approved state) present under that organization. Once it is provisioned, an account is created
in ESOM hence cannot be edited. If there are orders actively present under the organization and the AD OU Role
is set to Create Now- Limited Admin, then the upn-suffix can never be edited rather the email ID can be edited.
Change Organization status

To change the status of the Organization, complete the following steps.
1.
On the General Properties tab, under the General Properties section, click Change.
2.
The selected BOOLEAN field reflects the present status. To change the status, select the required check
box.
IDENTITY MANAGEMENT
The Verified status implies that the Service Provider has created the Organization and its users.
The Self registered status implies that a visitor has created the same through the Sign-up process.
The Black listed status implies that the Organization is not allowed to log in or place orders in EAS. The
Service Provider can treat Organizations that are not paying their payments in time as black listed
Organizations.
The Closed status implies that the Service Provider has closed the Organization account.
Change Organization ownership

To change the ownership of the Organization, complete the following steps.
1.
Under the General Properties tab, under the Organization owner information section, click Change.
IDENTITY MANAGEMENT
2.
Click List Reseller.
3.
In the list of resellers, select a reseller and click Select.
4.
Click Confirm to change the Organization ownership.
IDENTITY MANAGEMENT
Creating an Organization User

To create new users within an Organization, complete the following steps.
1.
2.
3.
4.
Log in to the EAS portal with the user credentials that have the permission to create new users under
Organizations.
In the list of existing Organizations, click the Organization under which you want to add the new user.
Organization details appear in the right pane.
Click Add User.
The Create User for Organization page appears.
IDENTITY MANAGEMENT
5.
Provide the required details for the Organization user. You can set an Organization user as a default
business or technical contact. During order placement, that particular user is selected as the business and
technical contact. Otherwise, a drop-down list with multiple users is available.
If the IDM policy is turned on, while creating an Organization user, a tool tip displaying the user name
format is available.
User Organization Attribute: External Identifier for the Organization user, which is mainly used for
user creation through APIs.
Display Name: If the User Display Name Rule field is set to None while creating the Organization,
you can provide a customized display name. This value is stored in Active Directory. In EAS, the user
name is displayed as (firstname).(lastname) on the user listing page and user details page.
If you do not set the display name, it appears as (firstname).(lastname) by default.
Credentials stored in EAS: If this field is turned on, password management of this user is enabled in
EAS. If turned off, password management is disabled as the user belongs to an external IDM source.
IDENTITY MANAGEMENT
If the user is provisioned in Active Directory through ESOM, the Active Directory properties should be
added in ESOM provisioning engine server. The following table lists the EAS properties and their
corresponding Active Directory attributes.
EAS Property
AD Property
Company
company
Office/Location
physicalDeliveryOfficeName
Department
department
Job Title
title
For further details on how to add Active Directory attributes in ESOM provisioning engine server, refer
to Setting additional AD attributes for users chapter in ESOM Online Help.
6.
Click Create User to save the new user.
IDENTITY MANAGEMENT
To import multiple users under an organization, complete the following steps.

1.
2.
3.

In the list of existing Organizations, click the Organization under which you want to add the new user.
Organization details appear in the right pane.
Click Import Users.
6.
Click Browse to select the CSV file. The CSV file format is displayed on the Import Users page.
Individual columns in the CSV file represent all the field names of the user creation page. Among these,
some are mandatory fields depending on IDM Policy Configuration.
7.
Click Save Users to save the bulk of users or click Cancel to cancel the save.
Note: If one organization has more than one account then during bulk user import for that
organization, account field in CSV becomes mandatory field.
If the organization has single account, then account field within bulk user import CSV, is not
mandatory. By default the imported users will be created under that single account of that
organization.
IDENTITY MANAGEMENT
Editing Organization User

Click the List Users button on the organization details page. The list of users under the organization will appear.
Click the Edit button to alter the user details. The username can be edited only if the change organizations
username right is given to the user.
Credentials stored in EAS: If this field is turned on, password management of this user is enabled in EAS.
If turned off, password management is disabled as the user belongs to an external IDM source.
Searching Organizations
Two types of search are available for searching the organization.
In case of normal searchUser may search by organization type such as organization of Service Provider, All Reseller and Specific Reseller.
User may also search by Organization Name, Organization ID, Account ID, Vat Number and Domain Name.
User may also search by the keyword, street name, city name or zip code.
In EAS, when selecting organization of a specific reseller, it provides Reseller ID/Name/Vat instead of only
Reseller Name and Vat.
There are three types of search available such as Similar sounding, Starts with and Contains. The Similar
sounding search will be selected by default.
IDENTITY MANAGEMENT
In case of advanced searchHere also the user may search by its organization type such as Service Provider or All Reseller or Specific
Reseller.
User may also search by Account Details or Organization Details or Address Domain.
Organization search may also be performed by the status of the organization that is Verified or Self Registered or
Black Listed or Closed.
IDENTITY MANAGEMENT
Organization search and Account search

In EAS, organization and account related to the existing organization is searchable from normal search and from
advanced search window.
Organization can be searched with the following searching criteriaOrganization name: Organization can be searched with organization name.
Organization ID: Organization can be searched with organization ID.
Successful search results in listing of Organization with pagination applied on the result page.
Account can be searched with the following searching criteriaAccount name: Account can be searched with account name.
Account ID: Account can be searched with account ID.
In EAS, there are two fields in advanced search; corporate ID and Sales Representative.
IDENTITY MANAGEMENT
Successful search results in listing of Accounts with pagination applied on the result page.
Different templates are used for organization search page and account search page.
Note: Search done using organization id or name, the organization along with its account information will be
displayed. Whereas when search done using account id or name, then only the account information will be
displayed.
IDENTITY MANAGEMENT
Listing Organizations
The list of existing organization name appears along with the details.
The
icon allows user to view the list of existing orders against that particular organization.
The
icon redirects the user to the Create order page to place a new order.
Activate or Deactivate Organization users in ESOM

EAS allows the Service Provider to change the status of the organization user in ESOM if there is an account
created on behalf of that user in ESOM. If the logged in user has the permission to activate or deactivate the
organization users, the Activate ESOM User or Deactivate ESOM User button appears. To change the status
of the organization users globally, complete the following steps:
1.
If the user account is created in ESOM and the user is in deactivated mode in EAS, Activate ESOM
User button appears. If the user is in active mode, the Deactivate ESOM User button appears.
2.
Click the button accordingly to activate or deactivate the user globally. The deactivated users are
prohibited from logging in to ESOM.
IDENTITY MANAGEMENT
If Change Organization ID/Account ID privilege is enabled, then the Service Provider can edit their
Organization ID and Account ID.
To edit the Organization ID and Account ID, complete the following steps.
1. Log in to the EAS portal with Reseller credentials.
2. Click Entities > Organization.
3. Select the Organization for which you want to change the ID.
4. Click Edit.
5.
Provide the new Organization ID value.
IDENTITY MANAGEMENT
If the provided Organization ID already exists in EAS, then an error message appears.
While editing the Organizations details, you must provide all the mandatory address fields which are configured
from the Configurations > Address Configuration menu..
6.
7.
After providing the values of all mandatory fields, click Continue to go to the next page and then, click Save
to save the changes.
To change the Account ID, select the Organization and on the Accounts tab, click Edit Account.
IDENTITY MANAGEMENT
8.
Provide the new Account ID value.
If the provided account ID already exists in EAS, then an alert message is displayed.
IDENTITY MANAGEMENT
IDENTITY MANAGEMENT
While editing an account, if the Use organization address as account address option is selected, then the you
must provide all the mandatory address fields of the account, which are configured from Configuration >
Address Configuration menu.
IDENTITY MANAGEMENT
Agents
An Agent is an entity with users who sell Offers from Service Providers catalog.
Creating an Agent
You can create a new Agent in EAS by following the steps below-
1. Log in to the EAS as Service Provider.

2. Click the 'Agents' tab.
3. Click 'Add Agent' button, the following page appears.
4. Fill the required details and click the 'Save' button.
Searching Agents
To search for Agents, execute the steps below-
1. Log in to the EAS as Service Provider.

2. Click the Agents tab.
3. Search panel will be visible at the left side of the page.
IDENTITY MANAGEMENT
4. There are four search criteria to filter out the search. Put the desired keyword and click the Search button.
IDENTITY MANAGEMENT
Viewing Agent details

To view the agent details execute the steps below1.
2.
3.
Click the 'Agents' tab.

The entire existing agent list will appear.
Click any of the Agent from the list. Details will appear at the right side of the page.
Creating an Agent user

To create a user for the agent, follow the steps below1.
2.
3.
4.
5.

All the existing agents will be listed.
Click any of the agent in the list under which you want to add the new user.
Agent details will be shown at the right panel.
Click the 'Add User' button at the bottom of the right panel.
6.
Add user form will open.
IDENTITY MANAGEMENT
7.
Put the required details and then click the 'Create User' button to save the changes. Click the 'Cancel'
button to discard save operation.
Viewing Agent user details

To view the details of an Agent User, follow the steps below1.
2.
3.
4.
5.

Search for the list of agents.
Select the desired agent and click the 'List Users' button.
The list of users of that agent appears.
Click a user and the details will appear on the right side of your page.
IDENTITY MANAGEMENT
Editing Agent user

After creating an agent user you can edit the information related to this users by the following steps1.
2.
Click any of the agent user.

User details will be shown at the right panel.
3.
4.
Click the 'Edit' button.

Edit page will open up.
5.
Make the changes and click 'Save Changes' button, click the 'Cancel' button to discard the changes.
IDENTITY MANAGEMENT
The username can be edited only if the right Change Agent's Username is given to the Service Provider.
Giving permissions to Agent user

To edit permission of the existing users under an agent, follow the steps below1.
Click the 'Permissions' button.
2.
Edit Permission page will open up.
IDENTITY MANAGEMENT
3.
Make the changes and click 'Save Changes' button, click the 'Cancel' button to discard the changes.
Deactivating Agent user

To de-activate a user under an agent, follow the steps below1.
Click the 'Deactivate User' button.
IDENTITY MANAGEMENT
2.
The User will be de-activated successfully.
Reset/regenerate Agent user password

In case of local IDM policy Reset and Regenerate password action will be active for the user and corresponding
notification mail will be sent to the user's email id. But when local IDM policy is not in use Reset and Regenerate
password field will be deactivated and no notification mail corresponding to these actions will be sent to the
user's email id. So in that case it is recommended to disable the corresponding notification templates under
'Configuration >> Notification'.
1.
Click the 'Reset Password' button.
IDENTITY MANAGEMENT
2.
The Reset Password page opens up. Provide the New password and Verify password and click 'Save
Changes' button.
3.
A notification mail will be sent to the user along with the new password.
Here are the possible steps to Regenerate Agent User Password1.
Click the 'Regenerate Password' button.
IDENTITY MANAGEMENT
2.
A confirmation message window opens up as shown below.
3.
4.
Click the 'OK' button to regenerate the password.

The new password will be sent to the users mail address.
IDENTITY MANAGEMENT
Resellers
Reseller enablement
A Reseller is an entity that acts as an intermediate between Service Provider and organizations that purchases
item with the intention of reselling them rather than consuming or using them. This is usually done for profit.
Reseller Price Plan (RPP) is a collection of resource specific pricing, set by a service provider for its reseller.
Pricing for Resellers is done on provisioning and non-provisioning (setup fee) attributes of different services. The
Service Provider assigns a copy of Offer to the Reseller with this Reseller Price Plan. This reseller pricing set by
the Service Provider will be common for all the resellers under that Service Provider but the difference will be
created by the discount amount, which will vary from reseller to reseller.
Resellers are the individuals or companies who purchase resources or services from Service Providers, and offer
those resources or services for sale to others. As a Service Provider, you may want to sell your service via the
reseller channel in order to reach out to a larger market that can be better served by resellers. This guide provides
an overview of the features and functions of the reseller module.
Resellers are one of several channels, which Service Providers can use to reach out to a larger market. Typically,
a reseller is an entity that avail services and offers with the intention of reselling them rather than consuming or
using them internally. The resellers act as an intermediary, between the Service Provider and the Organizations
and provide their own marketing, sales, pricing, billing, and sometimes branding.
All resellers, regardless of the type, can perform certain actions in the system as described below:
1. Can brand the portals with their logo and skins.
2.
Can set / change the price of items that they sell to their organization.
3.
Can set / change the names of the items and offers in their own catalog.
4.
Can directly invoice and receive payment from their organization.
In EAS, we categorize an Offer into two For sale to direct Organizations:
IDENTITY MANAGEMENT
These Offers are also known as Provider to Organization Offers. These offers can be ordered by the
Organizations from their respective catalog, and can be sold by Service Providers and Resellers to
Organizations.
For sale via Resellers:
IDENTITY MANAGEMENT
Note: Type 3 resellers support enterprise use cases. These resellers will get exclusive offers in their
catalog. Currently this will support some limited use case. Full implementation will be available in future
release.
These Offers are also known as Provider to Reseller Offers. Service Provider can publish these offers to Type2 resellers. Upon publication, these offers become Provider to Organization and hence available for selling to
reseller's Organizations. These Provider to Reseller Offers of the Service Provider cannot be ordered by or for
an Organization and therefore do not appear in external catalog. The Resellers can change the price structure
of the published Offers for their Organizations.
IDENTITY MANAGEMENT
In EAS, conceptually there are two types of resellers as discussed belowType 1 Reseller
In EAS, Type 1 resellers are always assigned directly under Service Provider. The Type 1 Reseller is typically the
one that has reached to a large market segment. A service provider is primarily interested in dealing with such
resellers who commit a large volume of business with Service Provider.
These Resellers can contact/deal directly with the Service Provider and can perform any operation (if Service
Provider permits access) except service and resource creation (however, there are cases where this can be possible
based on Service Provider relationship, network access, etc.). There are several permission settings available that
the Service Provider can set for a reseller. In addition, Service Provider can set a discount percentage on an offer
applicable globally for all the resellers. The pricing may also be adjusted for resellers on offers for flexibility.
Type 2 Reseller
The Type 2 Reseller is an entity that deals with a smaller market segment or commits a lower volume of business.
Service Provider may want their direct resellers of Type 1 to own Type 2 resellers as their sub-resellers and
thereby increase the market reach.
Type 2 resellers can access the created offers, by the Service Provider or Type 1 Reseller, (as exposed to them in
their catalog) and sell those offers. They can append offers with non-provisionable services, set their own pricing
and branding, but cannot sign up further sub-resellers in EAS.
Note: In EAS 4.2, Type 2 resellers are not supported as sub-resellers of Type 1 Resellers. This feature will be
supported in later version of EAS. However, in EAS, you can still do direct business with such resellers by
creating Reseller Type 1 with restricted permissions.
IDENTITY MANAGEMENT
The pictographic view of the concept of Type 1 Reseller and Type 2 Reseller is displayed below:
Restrict Type-2 Reseller:

Type-2 reseller can have published offer only. Service Provider can restrict some of its type-2 reseller to change
only pricing of existing items and price tag of market place contents in its published offers.
e.g., Service Provider has two Resellers R1 and R2. Service Provider published an offer O1 to both Resellers.
Based on some business, Service Provider wants to allow R1 to make changes on pricing of items and price tag of
market place contents but there are no such restriction for R2. i.e. R2 is allowed to edit and save any contents i.e.,
General properties, Billing Rules, item configuration, market place contents, provisioning properties etc.
To restrict a Reseller to change price of items and price tag (Marketplace Content) of an offer, Service Provider
will have an option during creating or editing Type-2 Reseller.
By default this option will be disabled, Type-2 Reseller will have no such restriction.
IDENTITY MANAGEMENT
Provide following details to create a Value Added Item:

Item Code: User should provide Item code.
Item Name: User should provide Item name.
Provisioning information required: If required, to provisioned the Offer user can select Provisioning information
from the list.
Resource Reference: User should select reference for resource to create value added item. It should be Null
Order Item.
Item Type: User shuld select type of Item from the drop down.
Type 3 Reseller
A large Enterprise typically has multiple business units or branches yet shares a common/central business
agreement with the service provider. Typical examples of large enterprises are
1. A central government entity with various branches, ministries or departments
2.
A corporation with many divisions or branches
3.
A university with many campuses or departments
EAS has the following features for such an Enterprise:

1. Service Provider can create a type 3 reseller that represents the Framework Agreement for the
Enterprise. Each of the business units can be represented as an Organization under the reseller
2.
The Service Provider can create Provider to Reseller Offers for a specific Enterprise and publish them.
By doing so, the Service Provider can maintain separate pricing and SLA with a specific Enterprise.
Organizations under the Enterprise may then order from offers published by the Enterprise.
3.
The Enterprise can brand the EAS portal.
4.
The business units can be hosted on a single Active Directory Organizational Unit in ESOM for
seamless collaboration for all the users.
5.
Rich set of SOAP APIs to integrate on-premises Enterprise Service Catalog for fulfilment of service
requests.
IDENTITY MANAGEMENT
Reseller Implementation for Telcos

Agents and Reseller channels can be completely turned on or off in EAS by a simple configuration change. While
the Agent model is relatively simple to manage, Resellers needs to be effectively managed by Service Providers as
the revenue model is directly impacted by this. Reseller users generally have most of the same rights as Service
Provider, users except for certain functions such as system level changes, global configurations, service creation,
resource creation/editing etc.
There are two types of reseller in EAS. The product model is vastly different between the two types of resellers as
explained below1. Reseller Type 1 In this model, the Resellers can create Items and Offers of their own and manage them.
The Service Providers can invoice the reseller based on Reseller Price Plan defined on a Service.
2.
Reseller Type 2 In this model, the Resellers cannot create Offers but can sell Offers created and assigned
to them by the Service Provider. The Resellers are invoiced based on the price defined in the Offer of the
Service Provider. The Resellers can change the price of the Offer for their organizations.
Resellers can be given options to create and own Organizations under them. The Organizations owned by a
Reseller are not visible to another Reseller in the system. The Service Provider allow the Resellers to sell to
Organizations Owned by Reseller or Vice versa.
For more knowledge about reseller, follow EAS 4.2 Reseller Manual
Enterprise Implementation
Standard use cases of Service Provider/Telco channel are well understood but a multi-tenant platform with the
advanced capabilities of EAS opens up many creative opportunities for a variety of enterprise use cases. Some of
these are outlined below.
IDENTITY MANAGEMENT
Use case 1 A university with Reseller model

A University IT Organization acting as the Service Provider to the University. They have 12 campuses and set up
each one as a Reseller. Each Reseller may create their own Offers or may be limited only to resell Offers created
by the Service Provider. Reseller isolation allows a limit on what each reseller may resell (i.e. Offer created by
Service Provider may be viewed by one reseller and not another).
Each user that wants IaaS can self-register or can be created by the reseller (or top level IT Organization) and have
their own Organization but more like Account under a parent organization. As the technical and business
contact, they can place orders and configure orders, respectively, as they like, limited to the Offers published by
their reseller. If granted in their role scope, they may also create additional account users and assign them rights
(up to an equal level to them as they see fit) and those account users may place orders and or approve orders (as
rights assigned to them in their role scope). Account users as end users can also be created so that only
operational control panel access is granted or all user (of any kind) can be locked and only enabled at the top level
Service Provider via IDM integration.
Use case 2 A university without Reseller model
Instead of setting up each campus as a reseller, the University allows each campus to be signup (or created) as an
Organization. The campus default organization admin account user then creates multiple accounts and account
users. These account users (if assigned the rights) can then place orders for offers and the admin may allow selfapproval or retain approval rights themselves.
Note: Every user in the system must always have a unique user id, even if in different Organizations as EAS
ID is separate from Roles and a user may have many different roles assigned to them in many Organizations
and entities as defined in the system by the top-level admin.
Note: Two organizations can never share the same name or domain name. The Organization name uniquely
identifies the organization and certain offers that require domain names (email, etc) must be set up
uniquely to a certain Organization.
Use case 3 A technology company with multiple branches

ModernTech Corporation, A midsized IT oriented Enterprise with two branch offices in Boston and San
Francisco, wants to roll out virtual machines on demand for their employees. There are two possibilities to
structure the Entities and Identity
Option 1 Each of the branches of the company has many subdivisions and users and is organizationally
structured as per the geographic location of the office. Each branch can be setup as one Organization. Each
Organization can have multiple Accounts, one for each department or team. This model provides isolation and
separation of management of accounts and budgeting per branch office.
IDENTITY MANAGEMENT
For example; the employees of the IT departments may have dual memberships
1. In the Organization Account of their departments
2.
In the Service Provider Entity.
Option 2 The functional structure of the company doesnt follow the geographic location of the branches. The
departments are formed based on employee roles across the two branches. In this use case, one Organization can
represent the Enterprise while each functional team can be represented as one Account under the single
Organization.
IDENTITY MANAGEMENT
IDENTITY MANAGEMENT
Reseller Functionality in ESOM

Historically, ESOM modeled Reseller accounts from Active Directory security point of view. Each Reseller is
created as an Organizational Unit (OU) in Active directory with its own set of users, as a sub-OU of the Service
Providers OU. The OU of an Organization, which is owned by a Reseller, is created as a sub-OU under the OU of
the reseller. While this model ensured additional level of security, it does not allow flexibility from sales channel
management point of view. The following scenario explains the Reseller and Organization ownership model in
ESOM.
In the old model, Reseller accounts created in Active Directory; hence, Reseller users can directly log into the
ESOM portal and can configure services of their organizations. A Reseller user has full control of the accounts and
other details of the organization. In such a scenario, if an organization sold services by two Resellers, privacy of
subscription data breaches.
In business practices however, a Reseller is a sales channel and often specialized to sell and support specific
services. For example, a Service Provider may sell VDC service via one reseller while engage another reseller to
sell Storage solutions. In such a scenario, the entire set of organizations in EAS would be available to Service
Provider, Agents and all Resellers of Service Provider to place orders for them. It is also possible that Resellers
bring on organizations of their own into EAS and therefore may want to keep exclusive rights to sell services to
those organizations.
IDENTITY MANAGEMENT
The proposed model

When ESOM deploys with EAS in front, the Resellers, Organizations, their ownership and privacy of subscription
data is ensures by EAS. The recommended way to deploying OU of organizations in ESOM is to maintain a flat
structure rather than hierarchical. Individual Reseller accounts cannot created in ESOM and therefore, Reseller
users cannot directly log in to ESOM to manage organizations and subscription. EAS provides an SSO (Single
Sign On) session for the Reseller users to log into ESOM in the context of a subscription of a given organization
(for which the Reseller has access rights) to view and configure the service. The ownership, sales rights to the
organizations, and access to subscription data maintained solely in EAS. The Service Provider, being the highest
authority in the system, continues to have direct login access to ESOM and rights to view and maintain all
organizations and service configuration in Active Directory.
It is important to note that EAS deploys an integration layer (aka middleware) to provision organization OUs in
ESOM. The middleware is also responsible for generating SSO tokens for Reseller users so that the following
conditions met:
1. The SSO token generates in the context of a subscription in EAS.
2. In the SSO session, the reseller user given access to only the specific service for which the subscription
created.
3. In the SSO session, the Reseller user impersonated as the default administrator of the organization in ESOM.
4. All impersonation event details logged into EAS and ESOM for auditing.
IDENTITY MANAGEMENT
Example use cases

Consider two resellers in EAS called R1 and R2. The Service Provider on-boards a set of organizations into EAS.
The OU layout in ESOM creates as follow-
The following orders executes in EAS 1. Reseller R1 sells Microsoft Exchange (Order # 0001) and SharePoint (Order # 0002) to organization C1.
2. Reseller R1 sells SharePoint (# 0003) to C2.
3. Reseller R2 sells Microsoft Exchange (# 0004) to C2.
4. Service Provider sells Dynamics CRM (# 0005) to C2.
Use cases of R1
When R1 logs in EAS, the user will see three orders - # 0001, # 0002 and # 0003. When he clicks on 'Configure'
button on # 0003, the SSO session to ESOM will allow the user to configure only SharePoint service for C2. The
fact that C2 also has a subscription of Microsoft Exchange (# 0004) should hidden to the user.
R1 users do not have any user accounts in ESOM and cannot log in to ESOM directly without going through the
EAS SSO action for the specific organization and specific service of their own in ESOM.
Use cases of R2
R2 is only entitled to see # 0004 in EAS and hence can only SSO into ESOM in the context of the organization C2
only to configure Microsoft Exchange and has no visibility into the subscription of SharePoint (# 0003).
Note: No Organizational Unit is created for any reseller in ESOM.
Use cases of Service Provider

Service Provider users will have instance of their own in ESOM and can logged in directly with their AD
credentials. They can view all subscriptions of all organizations regardless of who created the subscriptions.
Use cases of Organization
Organizations have their own AD OU and users in ESOM. They can directly log in to ESOM. The users with
admin rights can view all subscriptions and users. End users can able to configure and view the services that
assigned to them.
IDENTITY MANAGEMENT
Organizations and their ownership

EAS allows the resellers to on-board their own organizations into the system or sell to a global set of
organizations on-boarded by the Service Provider. The Service Provider has full control of the rights that allow or
disallow a reseller to perform these activities.
For a large Service Provider, the entire organization database may be maintained in a legacy CRM system hosted
at the Service Providers premises. All the resellers are allowed selling offers to these organizations only.
Alternatively, the Service Provider may allow the resellers to bring him his own organizations, which are only
accessible to the specific reseller and not reachable by another reseller of the Service Provider. However, service
provider can sell to that resellers organization if he chooses to do so at the time of creating reseller entity.
When Service Provider creates a reseller entity, he can control the following rights of the reseller.
Can create offer: Selecting this field enables the reseller to create their own offers.
Can sell to Service Providers organizations: Selecting this field enables the reseller to sell offers to their
own organization as well as the Service Providers organization.
Can own organizations: Selecting this filed enables the Reseller to own organization within it.
Service Provider can sell to Resellers organization: Selecting this field enables Service Provider to sell
orders to resellers organization.
Note: For Type-2 resellers, Can create offer must be unchecked. Service Provider can publish offers to them
to sell. For more details, please refer to the product model section.
It may so happen that a single organization City of Heaven buys items from Service Provider and multiple
resellers. In the following illustration, four organizations of the Service Provider have purchased item from
different existing resellers, as bellow-
IDENTITY MANAGEMENT
IDENTITY MANAGEMENT
Creating a Reseller
A Service Provider admin can create a Reseller through the EAS UI. To create a Reseller, complete the following
steps.
1.
2.
3.
4.
Log in to the EAS portal as the Service Provider.

Click Entities > Resellers.
Click Add Reseller.
In the Reseller Entity page, provide the basic details, such as reseller name, email address, username
suffix.
Mention the Content URLs and the Address. In EAS, every Reseller may have their individual log-in page
with different branding applied on it. When creating a Reseller, the Service Provider can provide a
unique identifier for that particular Reseller in the Customized login URL field.
For example, if Contoso is used as a unique identifier, when this Reseller wants its own log-in page for
an organization user, it must use the following URL:
http://<hostname>:<port>/<application folder name>/Contoso
Note: A Reseller must provide the unique identifier for its own Organization users. Otherwise, the
user is created under the Service Provider.
Login content URL: Set the desired dynamic content URL in this field. EAS log-in page for a
particular Reseller replaces the Service Providers dynamic content with the provided URL content in
the mentioned field.
Portal URL: This field allows the Reseller to set its customized portal URL. If the Reseller has its own
domain name, then instead of using the Service Providers default URL, it can provide its own portal
URL to access the application.
Home URL: Provide the URL for the content management placeholder of the dashboard page.
Support URL: Provide the support URL for the Reseller dashboard page.
News URL: Provide the news URL for the Reseller dashboard page.
IDENTITY MANAGEMENT
5.
After you provide the value for the mandatory fields, click Continue to move to the Business Model
section.
6.
Under Business Model, select the following fields.

Import business model from template: This field helps to select a business model template from the
drop-down list. Depending on the selected template, the permissions is implied.
Currency: Select the default currency for the Reseller.
Branding: Set the branding option for the Reseller.
Discount from Service Provider: Set the discount percentage for an individual reseller entity.
Publish catalog now: This check box helps to enable or disable the permission of a Reseller to create
an Offer. For example, if the Reseller does not have the permission to create an Offer, the Reseller
must use the Offers published by the Service Provider. If the field is selected, all Offers marked for
the Reseller are published to the Resellers catalog.
Can sell to Service Providers organizations: Enable this field to allow the Reseller to sell Offers to
their own Organization and the Service Providers Organization.
Can own Organizations: Select this Boolean field to enable the Reseller to own the Organization
within it.
Service Provider can sell to Resellers Organization: Select this Boolean field to enable the Service
Provider to sell orders to the resellers Organization.
Can Perform User Management on Service Provider's Organization: Enable this field to allow
Reseller Type-2 and Type-3 to manage the Service Provider owned Organizations. This field is kept
disabled for Reseller Type-1.
IDENTITY MANAGEMENT
Can edit only items price and price-tag of an Offer: Enable this field to restrict the Reseller to edit
the item pricing and contents of the Marketplace Content tab.
Mark as Reseller template: This Boolean field allows you to save the template as a business model.
Allow usage import: Enable this field to allow the Reseller to import usage data from Tool Scheduler.
7.
Click Continue to move to the Admin User section.
8.
Provide the value for the mandatory fields, such as First name, Last name, Email address, Language, and
so on. To assign the logged in user as a reseller member, select the Assign yourself as a member check
box.
Click Continue to move to the Summary section, which displays the profile summary.
9.
10. Click Save to save the Reseller.

The Service Provider can edit their Reseller ID, irrespective of the reseller type. To edit the Reselelr ID, complete
the following steps.
1. Log in to EAS portal as the Service Provider.
2. Click Entities > Reseller. Search a Reseller to change ID.
3. Select the Reseller whose ID you want to modify and click Edit.
IDENTITY MANAGEMENT
4.
Provide the required Reseller ID value.
If the provided Reseller ID already exists in EAS, an error message is displayed.
5.
Click Continue to move to the next step and then click Save to save your changes.
Switch entity: For any Service Provider, if the Assign yourself as a member option is selected at the time of
Reseller creation, then using the switch entity option, the Service Provider can log in to the Reseller account and
edit Resellers Organization ID and Account ID of those Organizations.
IDENTITY MANAGEMENT
Reseller Membership for Service Provider user

In EAS SP can get membership to reseller entity by one of the following methods Option 1: Assign membership to SP while creating a Reseller
(Required permission name: Add Self as a Reseller)
At the time of reseller entity creation:
Log in as SP user, Navigate to Entities Resellers add reseller go to third page of the step Admin User
select Assign yourself as a member option
Option 2: Assign membership to SP from a list of Resellers

a. From reseller listing page:
Log in as SP user, Navigate to Entities Resellers select a Reseller Assign yourself
IDENTITY MANAGEMENT
If the Service Provider has a valid Reseller membership but the membership is inactive, then the Service Provider
cannot switch to Reseller entity using the Impersonate icon.
b.
Impersonation: SP users can now easily impersonate and act on behalf of the Reseller administrators.
IDENTITY MANAGEMENT
While impersonating to a reseller, it is possible to define specific Roles with which the impersonation
will take place. Follow the steps below to directly login as Reseller memberi.
ii.
iii.
Login as Service Provider

Click Entities-> Resellers tab.
Click the Login icon, and the SP will directly log in to EAS as that Reseller member with Reseller
Super Admin role.
Option 3: Giving membership to other SP users

(Required permission name: Assign Membership to Reseller)
Log in as SP user, go to Entities My organization select a user Assign membership to Reseller.
Here you will get the option to choose the reseller entity as well as the role you want to assign.
IDENTITY MANAGEMENT
As per the current behavior always Reseller Super Admin role is assigned by default in case of Assign Self. To
make it more generic we need to enhance the feature, by associate a specific reseller role for a given service
provider role at the time of enabling the permission Assign Self as a Member of Reseller . At the time of
enabling the above said right, the user will get a dropdown with all reseller roles present in the system, to select
one from the list. When a SP user will take a membership under reseller entity he will be assigned a reseller role
which was set at the Primary Role of logged in SP user. As per this, in case of switch entity reseller will logged in
with the role assigned for the membership, not with the Reseller Super Admin role.
IDENTITY MANAGEMENT
Email notifications template

Service Provider can assign the list of existing templates to its reseller. Reseller can modify the subject, body and
description as per requirement.
Additional currency
Resellers can have their own additional currency.
Reseller Branding
There are two types of branding available for the Reseller. These are
1.
Basic Branding :
In this type of branding, the Reseller can change the followingi.
Portal logo image: this image will be displayed on the portal with a predefined size (120 px * 68
px). Before uploading the image, make sure that the image should be in .png format.
ii.
Invoice logo image: this image will be used during invoicing. The image format must be in .png
format.
iii.
CSS alteration: make changes to the all.css file and then upload this CSS file. It will change the
look and feel of your portal according to the changes you have made in the all.css file.
In basic branding you will not have any option to change other setting like change the icon
images etc. except the above three (portal logo, invoice logo, all.css file).
2.
Advanced Branding :
In such kind of branding, the Reseller can change the invoice logo image and the CSS (Cascading Style
Sheet) to change the look and feel of their portal.
The invoice logo image will be chosen by the Reseller admin arbitrarily.
One reseller can change the icon images and portal logo image and the CSS styles by editing the files
under defaultTheme.zip.
This defaultTheme.zip file can be downloaded by the following way
i.
After log in to the EAS as Reseller admin user, click the Configuration tab.
ii.
Click the Branding link (Service Provider must set basic or advanced branding for this reseller).
Following form will open-
IDENTITY MANAGEMENT
iii.
Click the Download Default Template button to download the defaultTheme.zip file.
Note: Resellers cannot brand the external CSS files or JS library.
IDENTITY MANAGEMENT
Creating Reseller User

To add reseller user, follow the steps below
1.
Log in to the EAS as Service Provider.
2.
Click the Resellers tab.
3.
Click the Search button. It will list all the existing reseller.
4.
Select any of the reseller from the list, organization details will be shown up at the right side of the page.
5.
Click the Add User button at the bottom of the panel at the right side of the page. It will takes you to the
create reseller user creation page.
6.
Put the required details on the various fields and click the Create User button to create a new reseller
user.
Editing Reseller User

Click the List Users button on the reseller details page. The list of reseller users will appear. Click the Edit
button to alter the reseller user details. The username can be edited only if the right Change Reseller's Username
is given to the Service Provider.
IDENTITY MANAGEMENT
Users
User search
The users can be searched by selecting any of the criteria such as Login Name, First Name, Last Name, Email
Address or Phone Number. Click the search button to view the list of users.
This page lists the entity for which the user belongs. If the user belongs to multiple entities then all the entity lists
are displayed here. Else, it displays the particular entity id, role, membership status and effective status.
IDENTITY MANAGEMENT
Display Name: If the User Display Name Rule field is set to None while creating the Organization, you can
provide a customized display name. This value is stored in Active Directory. In EAS, the user name is displayed
as (firstname).(lastname) on the user listing page and user details page.
If you do not set the display name, it appears as (firstname).(lastname) by default.
IDENTITY MANAGEMENT
Activate/Deactivate Users
In EAS, user status can be changed from three levels
Global Level
Entity Level
Entity User Level
Logged in user having the following rights can accomplish global activation/deactivation through global user
search
i.
Activate/Deactivate Portal Login of Users in the Entity and User level.
ii.
Activate/Deactivate Portal Login of Users in the Organization level.
iii.
Activate/Deactivate Portal Login of Users' in the Agents level.
iv.
Activate/Deactivate Portal Login of Users' in the Reseller level.
Service Provider users are allowed to activate/deactivate any user irrespective of who is the actual creator of that
particular user if the rights are assigned.
In the Global leveli.
Click the Entities-> Users tab and search for the desired users.
ii.
Deactivate button will appear against each user. The Deactivate button disables the user globally
belonging to each entity. The deactivated user will not be able to login via any of the entities to which it
may belong. If the user is deactivated, Activate button will appear and this enables the user to perform
all its actions accordingly.
In the Entity leveli.
Select a user and the list containing the entities will be displayed to which the user belongs.
ii.
In each tab, the Deactivate button will appear against each user. The Deactivate button disables the
user for that entity. The deactivated user will not be able to login only via that entity. If the user is
deactivated, Activate button will appear and this enables the user to perform all its actions accordingly.
IDENTITY MANAGEMENT
In the Entity User leveli.
If the user is deactivated from the list user section under Entities-> Organizations tab, then that user
will appear in this list but the Deactivate button will be disabled.
ii.
This particular user will not be able to login into the organization entity.
IDENTITY MANAGEMENT
Product Modeling is at the heart of Ensim Service Catalog Manager (EAS). It allows product managers to define
offers that are available for Organizations to buy. EASs product model is meant for creating offers with flexible
combination of items and pricing options that can be provisioned automatically with Ensim provisioning systems
(EAS). Here is a high level summary of the capabilities of EAS item model
Creation of offers with flexibility to choose items
Flexibility of pricing options nonlinear pricing (tiers)
Reservation and Pay-per-use based pricing
One-time and recurring charges
Order flexibility to provide/increase/decrease quantity of items of an offer
Collection of metering data and applying metering rules(usage collection)
Discount and promotions.
UPN Reuse
EAS allows Service Provider to change the status of the organization user in AD if there is an account created on
behalf of that user in AD. If the logged in user has the permission to activate/ deactivate/delete/re-create the
organization users in AD, then activate in AD (if user is deactivated in AD)/ deactivate in AD (if user is activated
in AD)/Create in AD (if user is removed from AD or not created in AD) user button will appear. Deletion of AD
user will also be possible by clicking deactivate button, if no AD based service is assigned to the user.
To change the status of the organization users globally, follow the steps below1.
If the user account is created in AD, then Deactivate in AD button will appear if the user is in active
mode in AD. If the user is in deactivate mode, then Activate in AD button will appear.
2.
Click the button accordingly to activate/ deactivate the user globally. The deactivated users will be
prohibit from logging into AD.
3.
If the user has no AD based services and activated in AD, then the user can be deleted from AD. Clicking
the Deactivate in AD button, a confirmation popup with a checkbox called Remove from Active
Directory will appear. If Remove from Active Directory checkbox is checked user will be removed
from AD, else user will be only deactivated in AD on clicking the OK button.
IDENTITY MANAGEMENT
4.
Once the user is in deleted/pending/failed state in AD, Create in AD button appears to create the same
user in AD. To do so please refer to the page below.
Bulk User Import

Bulk User Import procedure allows Service Provider to import users in bulk in different Organizations using a single CSV
file. The operator needs Create/Deactivate/Edit User and Bulk_user_import rights enabled. Bulk user import method
works under the conditions described below1. Service Provider can import users in different organizations (own Organizations) at a time using a single CSV file.
2.
Service Provider can import users in different organizations of Resellers in bulk using a single CSV file, if Service
Provider can sell to Reseller's organizations rights is available for that Service Provider.
3.
A permission called Import Users in bulk must be enabled for the user.
Pre-requisites for CSV file creation
IDENTITY MANAGEMENT
a.
Import or create users for multiple Organizations by uploading a well formed CSV file. File format must have
.csv. User Import CSV file contains following fields accountId(1), userName(mandatory), password, language(5),
primaryRole(7), secondaryRole, firstName(mandatory), lastName(mandatory), phoneNumber(mandatory),
mobileNumber, faxPhoneNumber, primaryEmail(mandatory), secondaryEmail, streetAddress1(mandatory),
streetAddress2, city, stateProvince(mandatory), zipPostalCode, countryCode(2), isBusinessContact(3),
isTechnicalContact(3), faxCountryCode, faxAreaCode, adUserName(4), organisationId.
b.
If the target Org contains more than one account ID then the account ID must be provided in the CSV file or else
the system will import the User under the master account.
c.
If Organization contains only one account then either account ID or organization ID needs to be provided.
d. If the primary Role is not specified in CSV then the application will assign Organization Service User Role by
default. If the Organization Service User Role is not present in the application then primary Role must be
specified in the CSV file.
Follow the steps below to import user:

1. Click the Entities->Users tab.
2.
Click the Import User button.
3.
Import CSV file using the page displayed below-
Following conditions need to be satisfied for User creation:

Sl. No
ORG-ID
Given
Account id
given
Exists multiple
Account
Under which
account?
Yes
Yes
ORG &
Account
combination
valid?
No
Yes
1
2
Yes
Yes
NA
NA
No
No
NA
NA
Yes
No
Dont import user

Import user under
given account
Dont import user
Import user under
the default account
3
4
Yes
Yes
IDENTITY MANAGEMENT
No
Yes
NA
NA
Import user under

the given account
IDENTITY MANAGEMENT
User Service Assignment

A Service Provider or Technical contact or any administrator having Can Configure all services permission on EAS can
configure the assigned services by logging in to portal.
Assign Service
To assign a service to an organization user, perform the following actions:
1.
Select the organization for which the order of the service is provisioned.
2.
List the users of the organization.
3.
Click the
4.
The service assignment page appears. Drag and drop the service from Available Services to the assignment
section. In the screenshot below McAfee service is used for demonstration.
5.
Click Save Changes button and the user will be redirected to the corresponding service control panel section.
icon to assign service.
IDENTITY MANAGEMENT
6.
Fill in the required details and click the Save button to assign the desired service to the user.
Bulk User Service Assignment (BUSA)

It is possible to assign a service to a set of users in bulk, with same configuration to all under one Organization.
There is a page with 3 simple steps to do this:
Step 1-Choose Service & Order
Step 2- Choose Users
Step 3-Finalise
The service specific fields during service assignment will be dynamically populated from service definition.
Service Provider needs to perform some configuration setting in the Service, Resources and Offer. After doing
the configuration settings and placing an order successfully the service can be assigned to the users using the
BUSA menu. The list of configurations to be done are:
1. The option Bulk assignment allowed at Service definition must be turned on
2. Some specific fields in Service needs to be populated
3. The automated Service connector must have been written to support BUSA. Presently only MS Exchange
connector supports this feature.
Example steps for MS Exchange i)
ii)
iii)
To perform bulk assignment for MS Exchange please turns on two flags at service level a) Has user
management and b) Bulk assignment allowed. Mention Help message for bulk assignment this
message convey how BUSA flow will behave in UI for MS Exchange.
Create resource group for mutually exclusive resources on service details page.
E.g. either of mailbox types basic, standard, enterprise can be assigned to a user. Need to group them as
resource group, give a resource group name which will be appeared as label for mutually exclusive order
items in BUSA UI.
Some PIF resources of user only type required to add as per MS Exchange service specific data. E.g.
Mailbox type values User, Room
The main purpose of this feature is to eliminate the bottlenecks of time and complexity of assigning same services
with same configuration to a large number of users one by one. As this will perform a repetitive task of assigning
service automatically there will be less chances of mistakes in the steps while assigning service to many users at a
time.
BUSA Workflow
1.
Embedded message: A text field in service definition explains BUSA flow.

Impact
i. If this field value is available show the message in BUSA 1 st step.
ii. Service xml tags and import/exports of service xml are also impacted.
1.
Resource group label: This label will be used for mutually exclusive items in BUSA UI 1 st step. After creating
resources /importing service xml, in service definition/edit UI click configure button -> in popup UI select
resources which can be mutually exclusive[list of resources with checkbox] and input group label[text box].
2.
Bulk assignment allowed: A check box in service level to decide whether BUSA is allowed on that service. If
IDENTITY MANAGEMENT
turned on service will be displayed in BUSA UI otherwise not.

There will be a checkbox (Screenshot required)
In Resource Configuration,
1. For Order Item Resources, there will be a checkbox Available for Users to choose whether a specific Order Item
can be assigned to users at the time of Bulk Service Assignment. When selected, the billing will be made for this
resource.
i.
For mutually exclusive Order Items - while checking Available for Users option for Order item Resource,
Group label will be visible for a group of resources to choose for BUSA in Service Description screen.
ii. For order items which are not mutually exclusive Item name will be used as label.
(Screenshot required)
For setting Resource Group Label for a list of Order Item Resources (which are mutually exclusive) configured during
Service creation or during editing a Service from UI for on-boarded services. The name of the Resource Group will be
visible in BUSA Step 1.
2. For Provisioning Information (PIF) resources, there will be two options:
i.
User Only This option should be selected if the PIF is used in BUSA. Only Free Text and Boolean type is
supported.
ii.
Order Only (Default selection) - This option should be selected if the PIF is used during Order
creation.(screenshot required)
For user service assignment through BUSA, service specific elements needed for provisioning user service needs to be
added as provisioning resources of type User Only in the service. For example, to provision Exchange service to
user servive specific elements are in XML format as follow
<serviceSpecificData>
<typeOfMailbox>User</typeOfMailbox>
<diskQuotaThreshold>80</diskQuotaThreshold>
<typeOfArchive>None</typeOfArchive>
<archiveQuotaLimit>0</archiveQuotaLimit>
<hideFromAddressList>false</hideFromAddressList>
<mobileDevicePolicyName>None</mobileDevicePolicyName>
<umPolicyName>None</umPolicyName>
<resetPINOnLogon>false</resetPINOnLogon>
<deleteAttachments>false</deleteAttachments>
<deleteComments>false</deleteComments>
<deleteSubject>false</deleteSubject>
<addOrganizerToSubject>false</addOrganizerToSubject>
<automateCalenderProcessing>false</automateCalenderProcessing>
</serviceSpecificData>
Here typeOfMailbox, diskQuotaThreshold, typeOfArchive etc. are should be added as provisioning resources of
type User Only. At the time of performing BUSA for specific order of specific service, PIFs value should be
provided in BUSA UI.
The resource ID must match with xml tag name - for typeOfMailbox tag, the corresponding resource ID must be
typeOfMailbox.
In Offer, Item Configuration, all the order items which are selected to be mutually exclusive, should get the
Exclusive checkbox checked(Screenshot required)
In the BUSA Step 1, the sequence of displaying Order Item and PIFs will be as belowa. Mutually exclusive Order Item
IDENTITY MANAGEMENT
b.
Non-exclusive Order Item
c.
PIFs
Steps:
Step 1 (Choose Options):
1. Select Service and provide Service specific information required (Items, quotas and user PIFs) to assign the
Service to users.
2.
The Service specific information fields will be dynamically populated from Service definition. The Service model
needs extension to capture what options are mandatory for provisioning Service to user.
3.
Embedded Message(How to) This contains some text that needs to be composed in the Service during service
creation or by editing a service, used to display as inline help to the operator while assigning service.
4.
Click Next to move to the Choose Users screen.
Step 2 (Choose Users):

1. A default list will be populated using the search criteria Show users without Service, All Accounts. No other
filters are applicable from EAS database.
2.
By default 100 users (maximum) will be displayed in one page and then paginated.
3.
Operator can select all users based on the selected search criteria.
There are 3 basic search criteria:
i.
Show Users Without Service
IDENTITY MANAGEMENT
ii.
Show Users With Service
iii.
Show All Users

a.
For example, if we select an account say ACC0555510 and it has 200 users then all 200 users will be
selected. No need to navigate and select users. Moreover the individual user selection checkbox will be
disabled.
4.
Operator can select all users on the current page by checking the top level checkbox.
Step 3 (Summary):
1. Displays # of users selected for Service Assignment.
2.
Displays the Service properties defined for the assignment.
3.
Can send email to users if Send email to users is turned ON after assignment is done successfully. If it is OFF no
mail will be sent.
For example, if the users are already enjoying the service (via a different portal) then they should not receive an
email as it will be confusing.
4.
If the selected user count exceed 100 then we will not display the user list. Instead we will display the actual
count of the users.
For example, if in an account 200 users are selected then we will not show the details of any user. A message will
be displayed as You have selected 200 users. The changes will be applied to all selected users.
Note: This is to handle extreme load cases where an account may have 1000 users. Supposedly 100 is an
optimum threshold.
IDENTITY MANAGEMENT
On click of Finish, a confirmation will be asked and then process will start asynchronously. The page will be moved to
Action Log where user service assignment will be displayed in a reverse chronological order.
Generation of Service specific data in XML format

Service specific data for different services will be different. XMLs for service specific data will be placed in a
physical path Application root/resources/serviceSpecificXML/. Naming convention for these XMLs will be as
internalServiceID_serviceSpecificData.xml. E.g. for Exchange 2013 the XSD file name will be
Exchange2013_serviceSpecificData.xml and physical path for the same will be as followApplication root/resources/serviceSpecificXML/Exchange2013_serviceSpecificData.xml
Tag names of this XML structure should match with resourceID of user PIFs, if a match found replace the tag
value else skip.
CHAPTER 4
Product Modeling
Introduction
Product Modeling is at the heart of Ensim Automation Suite (EAS). It allows product managers to
define offers that are available for Organization to buy. EASs product model is meant for
creating offers with flexible combination of items and pricing options that can be provisioned
automatically with Ensim provisioning systems.
Service
A service is a technical abstraction of a anything that can be provisioned to an organization for
consumption. Some of the Services that can be automated for provisioning with EAS are listed
below:
Virtual Data Centers on VM Ware, System Center provides remotely hosted servers
MS Exchange 2013 provides email services on Microsoft Exchange 2013
Google Apps - provides office and business productivity applications in the cloud
CSP Office 365 provides MS office and business productivity applications on cloud
BroadWorks provides VoIP services for enterprises
EMC Mozy provides online backup services
Symantec.Cloud Web and Email security services
Resource
The resources are the attributes of a service from technical provisioning perspective.
Resource can be of two types1.
Provisioning Information-
These non-provisionable resources may appear as organization specific inputs to

provision the order.
E.g. Login ID is needed at the time of ordering by the organization himself or by the
reseller at the time of ordering.
2.
Order Item-

8 APRIL 2016
ENSIM CONFIDENTIAL
106
PRODUCT MODELING CHAPTER 4
These provisionable resources can be used to make items.
These items will be used to make Offers for ordering.

E.g., a VDC (Virtual Datacenter) service can be made of the following resources
i.
ii.
iii.
iv.
CPU
Memory
Disk
IP Address
In EAS, items will be associated with the above-mentioned resources.

At the time of ordering, the items will be assigned with some quantity, which will represent the
quota value of the resource for provisioning. If Pay-per-use option is enabled, then the
organization can exceed the reservation quota at runtime and consume more of the resources for
additional cost.
Item
An item is a business abstraction of a Service Resource. For example VPS-CPU can be defined to
an item that entails CPU resource of a VPS of an organization. Items are of the following types
Base Items made of a resource directly.
Item Bundle made of a certain quantity of a base item. This way it is ensured that this item
can be purchased only in multiple of the specified quantity.
Composite Items made of different base items of certain quantity .
Item bundles are used to define additional quantities of an item that can be ordered as add-ons.
For example, the organization can ask to increase the memory by multiple of 1 GB. Composite
items are useful for defining a minimum baseline features that the organization must buy 1
CPU, 2 GB RAM and 100 GB Disk-space.
Item types : reserved & pay-per-use

An item can be offered in a way that the organization has to commit to the amount purchased for
invoicing purposes. This is a reserved type item. Items can be offered as Pay-per-use (PPU) in
which the organization pays based on how much he actually consumes after the reservation
quota completes.
Example of reservation Organization purchases a VPS with 500 GB of reserved disk at a
committed price of $ 10. But if he uses 550 GB instead, he will pay for additional 50 GB of disk at
the rate determined by a PPU model.

8 APRIL 2016
ENSIM CONFIDENTIAL
107
Item unit
Every item has a unit of measurement. The same resource (say disk) could have different units of
measurement as Reservation and Pay-per-use (PPU) item. Example reservation of disk could
be specified in terms on gigabyte, whereas PPU disk could be measured by the number of hours
it was consumed for: GB-hour. The resources define the units and the items must use the correct
units for measurements based on their types.
Billing frequency
EAS supports four tariff frequencies
Initial Charges: Applicable to items which typically invoiced once. Example setup fee,
training material etc.
Monthly, Yearly: Applicable to reserved items, the fees are to be rated monthly, or annual
basis.
Instalments: Applicable for billing reserved items for a fixed number of months.
Daily, Hourly: Applicable for PPU items that are charged as per number of hours/days
consumed, but Items are rated on Bill Cycle Day.
Offer
An Offer is a business abstraction of combination of items, pricing, billing and provisioning rules.
These offers can be then made available for the organizations for purchase. In EAS, the Catalog
consists of Offers that are constructed using Items of resources of a particular Service.
Pricing Configuration
A pricing scheme that defines the amount, that is asked for when an Offer is sold.
Pricing
A pricing rule (Price Structure) by which an item is sold. The pricing rules are of three types
Flat Rate- Consists of only one flat rule, example 500 GB of disk: price $ 10.
Tiered absolute
Tiered relative
In tiered model, the price varies non-linearly with the quantity of the item.

8 APRIL 2016
ENSIM CONFIDENTIAL
108
Installment
Installment means finite amount of billing for a specific period. Installment is applicable on all
the items, whether it is non-provisionable or provisionable items. In reality, installment should be
applicable in non-provisionable items only. This is because, say for internet service
(provisionable item), at the end of installment period either the service will stop or resume free
service. This concept is not at feasible in reality.
The tariff frequency is always Monthly for installment. Hence, for item type Pay-per-use,
installment is not applicable as it is not a fixed amount. Only the provider can set installment on
the pricing of an item within the offer.
Reseller Price Plan

Reseller Price Plan (RPP) is a collection of resource specific pricing, set by a provider, for the
resellers (Type 1) under it.
A Reseller is an entity, who is using EAS to sell services of the service provider or his own.
Hence, pricing charged to them is based on the service, so that the service provider can bill the
reseller based on resellers consumption of each service.

8 APRIL 2016
ENSIM CONFIDENTIAL
109
The resellers act as an intermediary, between the Service Provider and the Organizations and
provide their own marketing, sales, pricing, billing, and sometimes branding.
Resellers can create their own items and offers. Hence, item-specific pricing under offer set by
Service Provider cannot be used to bill the reseller which is the case with the Organization. In
Reseller Price Plan, Service Provider will attach available base item pricing to a resource as
explained in the following section and will bill the reseller according to the usage of the
resources. The Service Provider can also include additional charges (explained below).
Note: The items based on a Resource of a particular Service. The usage of item is
synonymous to the usage of the Resource.
The items are of three types, namely, Reservation, Pay-per-use and Non-provisionable. Therefore,
the usage of resource can be of type Reservation, Pay-per-use and Non-provisionable. The
Reseller Price Plan sets the list price of a selected item of each type to the resource for the
organization.
Pricing for Resellers (Type 1) is defined on provisioning and non-provisioning (onetime Setup
Fee, Recurring Support fee) attributes of different services. This pricing of items for all Type1
resellers, will be common for all the resellers (Type 1) under that Service Provider but the
difference will be created by the discount amount which will vary from reseller to reseller.
Reseller can sell these items to their Organizations with price and discounts defined by the
reseller itself.
This procedure is describe below
Adding Provisioning Resources for RPP

In this context, the Resource Provisioning denotes all the available resources in the form of
item.
To set the pricing for Provisioning Resources, please follow the mentioned steps1.
Login with Service Provider credential.
2.
Go to the CatalogItem and RPP tab and click

8 APRIL 2016
icon to add Reseller Price Plan.
ENSIM CONFIDENTIAL
110
3.
4.
Select a resource from the 'Provisioning Resources' tab.

To its right, under the heading 'Select Pricing for Reseller Price Plan' three tabs are there,
namely, 'Reservation Pricing' and 'Pay-per-use(PPU) Pricing' [if base items are created with
this selected resource]. The base Item only because this is directly related/connected with the
resource and the services.
5.
Click a tab and a drop-down list of all the base items of the corresponding type will be
available. In this list the only the base item will be listed. This is because all rest of the item,
i.e., bundle item and the composite item, can be made up of the base Item itself.
6.
Select one base item from the list.
7.
If a reseller price for that item is available, it will show. Otherwise, click the checkbox 'Add
Reseller Price' to add the reseller price for the selected item. This pricing is available only at
that time when the price is set for the Reseller. At the time of setting pricing for the
Organization this pricing should not allowed.

8 APRIL 2016
ENSIM CONFIDENTIAL
111
8.
Once done click the Ok button.
9.
To edit the RPP click Edit Reseller Price button and update the information. Click ok
button.

8 APRIL 2016
ENSIM CONFIDENTIAL
112
10. If no charges are applicable, click the link 'Do Not Charge'.
11. If a reseller price is available and any changes are required, click the button 'Edit Reseller
Price'.

8 APRIL 2016
ENSIM CONFIDENTIAL
113
12. Once done, click Add to Reseller Price Plan beside the item drop down to add it to reseller
price plan.
Note: If click Do not Charge, then Default Discount for all Resellers will not appear.
13. Click the Save Details button.

8 APRIL 2016
ENSIM CONFIDENTIAL
114
Please note that once a type (reservation, PPU) of price is added to RPP, it cannot be added again.
E.g., if reservation pricing for a resource has been added to RPP, no other reservation pricing can
be added for that resource unless the previous one is removed. This is because we add price for
the pricing type, not for any particular resource. Hence once the pricing is set no need to set it
second time. This can be possible if the existing one will be deleted.
Adding Additional Charges for Reseller Price Plan

Additional charges are typically some cost set by the provider to their buyer on the items with
non-provision-able resource. These are non-provisioning elements and will be applicable under
every circumstance once added to RPP.
To set the pricing for Additional Resources, please follow the mentioned steps:
1.
2.
Go to the CatalogItems & RPP tab and click
3.
4.
5.
Select a resource from the 'Additional Resources' tab.

If no pricing is available, click the button 'Add Reseller Price' to add pricing.
Once done, click the button 'Add to Reseller Price Plan' to add it to RPP.

8 APRIL 2016
ENSIM CONFIDENTIAL
115
6.
Once a charge is added to RPP, add operation is not possible again unless the previous one is
removed. So that the duplicity does not take place.

8 APRIL 2016
ENSIM CONFIDENTIAL
116
Reseller specific discount

Two types of discount are there; namely Default discount and Reseller specific discount.
The term Default Discount is set at the item level for the reseller. That means, when any reseller
pay to the Service Provider for any item then the Service Provider will allow the default discount
to the reseller for that item. This discount should be same for all the resellers.
The term Reseller Specific Discount means setting variable discount for the reseller
individually. That is, if Service Provider wants then he/she can set different discount on the item
pricing for different reseller.
To set the Reseller Specific Discount, please follow the mentioned steps:
1.
2.
3.
Once Reseller price plan is saved, a tab appears named, 'Configure Reseller Specific
Discount' to reset the discount for item as well as discount for resellers.
4.
After clicking the 'Configure Reseller Specific Discount Select a reseller from the drop
down box Select Reseller.
5.
Put the number to set discount for that particular reseller to the text box Apply. The
discount will be calculated in percentage.

8 APRIL 2016
ENSIM CONFIDENTIAL
117
6.
7.
Click the button Apply to All to set the discount to set reseller discount for every item that
the selected reseller have and for which the reseller price Structure is set and assigned.
However, individual reseller discounts can also be changed and different discount on
different resources for the selected reseller can be set. To do so, the Reseller Discount for
each resource can be set separately since this field appears in an editable mode.
Adding Provisioning Resources for Reseller Price Plan

In this context, the Resource Provisioning denotes all the available resources in the form of
item.
To set the pricing for Provisioning Resources, please follow the mentioned steps1.
2.
Go to the CatalogItem and RPP tab and click

8 APRIL 2016
ENSIM CONFIDENTIAL
118
3.
4.
Select a resource from the 'Provisioning Resources' tab.

To its right, under the heading 'Select Pricing for Reseller Price Plan' three tabs are there,
namely, 'Reservation Pricing' and 'Pay-per-use(PPU) Pricing' [if base items are created with
this selected resource]. The base Item only because this is directly related/connected with the
resource and the services.

8 APRIL 2016
ENSIM CONFIDENTIAL
119
5.
Click a tab and a drop-down list of all the base items of the corresponding type will be
available. In this list the only the base item will be listed. This is because all rest of the item,
i.e., bundle item and the composite item, can be made up of the base Item itself.
6.
Select one base item from the list.
7.
If a reseller price for that item is available, it will show. Otherwise, click the checkbox 'Add
Reseller Price' to add the reseller price for the selected item. This pricing is available only at
that time when the price is set for the Reseller. At the time of setting pricing for the
Organization this pricing should not allowed.
8.
Once done click the Ok button.

8 APRIL 2016
ENSIM CONFIDENTIAL
120
9.
To edit the RPP click Edit Reseller Price button and update the information. Click ok
button.
10. If no charges are applicable, click the link 'Do Not Charge'.

8 APRIL 2016
ENSIM CONFIDENTIAL
121
11. If a reseller price is available and any changes are required, click the button 'Edit Reseller
Price'.
12. Once done, click Add to Reseller Price Plan beside the item drop down to add it to reseller
price plan.

8 APRIL 2016
ENSIM CONFIDENTIAL
122
13. Click the Save Details button.
Please note that once a type (reservation, PPU) of price is added to RPP, it cannot be added again.
E.g., if reservation pricing for a resource has been added to RPP, no other reservation pricing can
be added for that resource unless the previous one is removed. This is because we add price for
the pricing type, not for any particular resource. Hence once the pricing is set no need to set it
second time. This can be possible if the existing one will be deleted.
Adding Additional Charges for Reseller Price Plan

Additional charges are typically some cost set by the provider to their buyer on the items with
non-provision-able resource. These are non-provisioning elements and will be applicable under
every circumstance once added to RPP.
To set the pricing for Additional Resources, please follow the mentioned steps:
7.

8 APRIL 2016
ENSIM CONFIDENTIAL
123
8.
9.
Select a resource from the 'Additional Resources' tab.
10. If no pricing is available, click the button 'Add Reseller Price' to add pricing.
11. Once done, click the button 'Add to Reseller Price Plan' to add it to RPP.
12. Once a charge is added to RPP, add operation is not possible again unless the previous one is
removed. So that the duplicity does not take place.

8 APRIL 2016
ENSIM CONFIDENTIAL
124
Adding Reseller Specific Discount

Two types of discount are there; namely Default discount and Reseller specific discount.
The term Default Discount is set at the item level for the reseller. That means, when any reseller
pay to the Service Provider for any item then the Service Provider will allow the default discount
to the reseller for that item. This discount should be same for all the resellers.
The term Reseller Specific Discount means setting variable discount for the reseller
individually. That is, if Service Provider wants then he/she can set different discount on the item
pricing for different reseller.
To set the Reseller Specific Discount, please follow the mentioned steps:
1.
2.
3.
Once Reseller price plan is save, a tab comes named, 'Configure Reseller Specific Discount'
to reset the discount for item as well as discount for resellers.

4.
After clicking the 'Configure Reseller Specific Discount Select a reseller from the drop
down box Select Reseller.
5.
Put the number to set discount for that particular reseller to the text box Apply. The
discount will be calculated in percentage.

8 APRIL 2016
ENSIM CONFIDENTIAL
125
6.
7.
Click the button Apply to All to set the discount to set reseller discount for every item that
the selected reseller have and for which the reseller price Structure is set and assigned.
However, individual reseller discounts can also be changed and different discount on
different resources for the selected reseller can be set. To do so, the Reseller Discount for
each resource can be set separately since this field appears in an editable mode.
Degrees of freedom of Items

The Offer defines the variations of quantities of an item within an Offer. This allows the
organization to order additional quantities of an item within the same order. For example, after
the initial purchase of a VPS, the organization may want to increase the RAM of disk-space
reservation based on increased demand.
Trial
An Offer can be ordered for trial for a specific period, called the trial period. No charges are
applied for the trial order, other than the pay-per-use items in the order. Notifications can be sent
to the organization before the trial expires. Configurations can be made for auto purchase after
expiry and selection of offers to which the purchase is possible. The degree of freedom of items
is not applicable to the trial offer.
Conflicting Offers
Under same service, some Offers cannot be ordered simultaneously, by the same organization,
due to business or technical reasons. Such Offers are termed as the Conflicting Offers. This has to
be explicitly decided by the Service Provider.
For example, if Offer A conflicts with Offer B then Offer B cannot be ordered if Offer A has been
ordered and vice versa.

8 APRIL 2016
ENSIM CONFIDENTIAL
126
Upsizing and downsizing an order

After the order is provisioned, the organization might want to increase and/or decrease the
quantity of items available in the offer. Since the items have different base price, the Service
Provider can estimate whether upsize or downsize occurred, by setting weights to the items of
the offer. The procedure for deciding whether it is an upsize/downsize has some rules.
Rules applied on item weights for Order upsize/downsize

Rule applied to items having weight set as 0
Case 1: If all item weights are 0 (zero) in an Offer, upsize/downsize all allowed as edit.
Case 2: Only 0 (zero) weighted item quantity changes and others remains same.
Item
Weight
Quantity
Increase/decrease
P1
0
10
P2
-1
10
STATIC
P3
>0
10
As per above table data, while P1 item quantity is increased or decreased and P2 and P3 item
quantity is remain same, offer upsize as well as downsize will take place successfully.
2. Rule applied to items having positive and negative weight
Item
P1
P2
P3
Weight
0
-1
>0
Quantity
10
10
10
Increase/decrease
RULE/change
Click upsize
a) If rules for upsize = true then upsize will take place.
b) If rules for upsize = false then upsize will be failed.
Click downsize
a) If rules for downsize = true then downsize will take place.
b) If rules for downsize = false then downsize will be failed.
Rules for upsize

1) For weight (-1)

8 APRIL 2016
ENSIM CONFIDENTIAL
127
For any one of the items of negative weight If (new quantity of the item >= previous quantity of the item) => upsize
[Doesnt matter what is the case for positive weighted items]
2) For weight >0 (positive weight case)
a) SUM(new quantity) >= SUM(previous quantity)
OR
b) SUM(new Individual Item Quantity*weight) >= SUM(previous Individual Item
Quantity*weight)
3) For a group of items where only quantity changes for zero weight items and other remains same
a) Click Upsize => upsize will take place
b) Click Downsize => downsize will take place
Rules for downsize

1) For weight (-1)
For any one of the products of negative weight If (new quantity of the item < previous quantity of the item) => downsized
[Doesnt matter what is the case for positive weighted items]
2) For weight >0 (positive weight case)
c)
SUM(new quantity) < SUM(previous quantity)
OR
d) SUM(new Individual Item Quantity*weight) < SUM(previous Individual Item
Quantity*weight)
3) For a group of items where only quantity changes for zero weight items and other remains same
c)
Click Upsize => upsize will take place
d) Click Downsize => downsize will take place
Promotions
Promotions are accessible only by Service Provider role users with additional role detail
checkboxes to read and manage promotions. Follow the steps below to read/manage the
Promotions
1.
Log in to EAS portal with the Service Provider credentials.
2.
Click the CatalogPromotions tab.
3.
A list of all the existing promotions will appear.
4.
The Promotions are searchable based on the Promotion Name/Active/Inactive and

Availability start date and Availability end date.

8 APRIL 2016
ENSIM CONFIDENTIAL
128
Multiple Promotions may be assigned for a single Offer. But, only a single promotion can be
applied to an offer during order.
Add Promotion
To add promotion with any offer-
1. Log in to EAS portal with the Service Provider credentials.

2. Click the CatalogPromotions tab.
3.
A list of already created promotions shall appear.
4.
Click the Add New Promotion button.
5.
The Add Promotion Details window will appear, enter the desired information.

8 APRIL 2016
ENSIM CONFIDENTIAL
129
The promotion can be applied only when it is in Active state. Service Provider may mark a
promotion Inactive at any time. It does not affect existing subscriptions that have this promotion
applied. EAS will no longer allow this promotion for new orders even if it is within Promotion
Availability period.
6.
Click the Save Promotion button.
7.
The confirmation Dialog box appears. Click OK.
8.
A message for successful operation appears.
Edit Promotion
To edit promotion of any offer, please refer the steps below:
1.
Click the CatalogPromotion to be edited.
2.
The details of the Promotion shall appear.

8 APRIL 2016
ENSIM CONFIDENTIAL
130
3.
Click the Edit Promotion button.
4.
Make the required changes.
5.
Click Save Promotion button.
Delete Promotion
To delete promotion from any offer, please refer the steps below:
1.
Click the CatalogPromotion to be deleted.
2.
The details of the Promotion will appear.
3. Click the Delete button.

8 APRIL 2016
ENSIM CONFIDENTIAL
131
Configure Association
Promotions can be applicable to the items and offers. Follow the steps below to assign a
Promotion to Offers
1.
Click the promotion to assign it to the offers. The details of the active promotion appear to
the right hand side of the page.
2.
Click the Assign to Offer button.
3.
Select the Category from the drop-down to which the Offer belongs. The list of Offers under
that category appears.
4.
Click the Offer to which the promotion needs to be assigned. Promotion details appear that
describes the details of promotions associated to it. Click the associate promo button to
associate this particular promo to this offer.

8 APRIL 2016
ENSIM CONFIDENTIAL
132
If this Promotion is already associated to this particular Offer then the Promotion can be
edited or De-associated from the Offer.
5.
In EAS, promo can be associated as per specific currency. To add or edit the promotion, select
the offer where each currency will be displayed in different tabs. Select a particular currency
tab where the Associate Promo button will be displayed.
6.
Click the Associate Promo button and the configure promo page appears to the right side of
the page containing three tabs for setting the general properties, offer discount and item
discount.

8 APRIL 2016
ENSIM CONFIDENTIAL
133
7.
The General Property tab holds the promotion mode configuration as per the currency. The
detail description of the two modes of promotion is as follows
a.
Opt-in: Default promotion to be applied on the order of the Offer to which it is

associated. Each Offer can have only one Promotion applicable in this mode. The Offer
may have a promotion applicable in Opt-in mode and zero or many Promotions
applicable using the Promotion-code. If all the Promotions are Active and the Available,
the Offer can be ordered by entering one of the codes, the promotion corresponding to
the code will get applied. If no code entered then the promotion in Opt-in mode will get
applied.
b.
Promotion-code: This mode allows setting a character code that must be entered during
order, to utilize this promotion. Promo code should be unique per currency. i.e. PROM1
which is a promo code used for USD currency as well as for EUR currency but not twice
for same currency. Multiple promotions in this mode can be applicable over single Offer.
However, only one code can be entered during order and the corresponding promotion
will be applied.
8.
If the Continue promo even if upgrade/downgrade field is checked, then during upgrade
or downgrade from one offer to another, the organization will continue to get the promotion.

8 APRIL 2016
ENSIM CONFIDENTIAL
134
If promotion is applied to an offer and field called promotion will be available on product
upgrade/downgrade then this promotion will be copied to the new offer.
If any offers are already assigned to the new offer then the copied promotion with the
existing promotions will be available with the new offer (after upgrade or downgrade
operation).
But if the above Boolean field is set to false then this promo will not be copied with new offer,
but if the new offer has its own promos then only these pre assigned promos will be available
with the new offer.
Note: No Promotion stacking is allowed. One and only one Promotion can be applied to the
Offer. The Promotion to be applied is decided at the placement of the order.
9.
Click the Offer Discount tab to configure the discount on the Offer. In the offer level, the
provider needs to set an absolute value for each currency at offer level. Based on the users
buying currency the corresponding promo value will be applied.
The descriptions of the fields in this tab are as follows

a.
Mode of discount: Possible modes are one time, recurring, till offer termination. By
default it is set to the option None.

8 APRIL 2016
ENSIM CONFIDENTIAL
135
If the Recurring mode is selected then the time period needs to be entered.
b.
Discount amount: The discount amount in the entire offer should be entered.
Note: The discount at the Offer can be set in the form of amount only.
The discount over the individual items of the Offer can be in the form of amount or
percentage.
10. Click the Item Discount tab to configure the discounts on the individual items in the Offer.
A list of items in the Offer appears. In the item level, Provider will define the absolute value
for the promo in different currencies for each Item level. Based on the users buying currency
the corresponding promo value for each item will be displayed on the order wizard.
11. Click the item to which the discount has to be set.

8 APRIL 2016
ENSIM CONFIDENTIAL
136
Note: The discount on the individual items of the offer can be in the form of amount or
percentage.
12. Select the appropriate discount type from the drop-down, enter other configuration details
and click Save/Update button.

8 APRIL 2016
ENSIM CONFIDENTIAL
137
Example: Product modeling with Virtual Private Servers

Overview
We will construct an Offer for sale with Virtual Private Servers (VPS). The Offer, allows the
product manager to define a flexible model to meet his business targets. At the same time, it will
allow organizations to choose a combination of items in an Offer that is suitable and cost effective
for his requirements. Last but not the least, the model should allow automated provisioning of
the orders and collect usage data for invoicing (Refer to Finance Module chapter, for further
details on usage collection). In the following sections we will examine how the requirements are
fulfilled in a sample Offer for VPS.
Constructs the Items from VPS service definition

In order to provision VPS automatically through ESOM, the first and foremost job is to identify
the provisionable resources of VPS service. The resource definition must come from the ESOM. In
the above example, the service is assumed to have the following resources1.
2.
3.
RAM : Memory for VPS

Disk : Disk space for VPS
IP : External IP address for VPS
At the Offer level, the product manager can include more items which dont have any
provisioning implication. For example, a setup fee for this VPS. Such items are made of a special
resource called NULL Resource.
It is important to note that the ESOM definition of a service is not mandatory if provisioning is
expected to happen manually. For example, it is perfectly possible to sell a Training Service in
which the Service Provider makes presentation and offers practical training on any subject.
However, EAS still requires recognizing the service called Training Service and that can be
made of only Null Resources if no measurement is required or even resources with
measurements that have no connection with provisioning.
Resource units: Historically, the resources are measured by some units. The Units could be
different for Reservation and PPU based items made of the resource as depicted in the above
diagram. It is important to note that typically the provisioning system will measure resources
with their reservation units, e.g., disk space will be measured by Gigabyte. But the invoicing for
PPU disk space could be done in GB-Hour unit. EAS allows the product manager define and
assign units to the resources. Default unit is Number, which is not editable.

8 APRIL 2016
ENSIM CONFIDENTIAL
138

8 APRIL 2016
ENSIM CONFIDENTIAL
139
Add Service
To add a service, complete the following steps.
1. Log in to the EAS portal with Service Provider credentials.
2. Click Catalog > Services. Available services are listed, if any. Service is searched based on
Service Internal ID, Service Name, Search Tag or Vendor Name.
3.
To create a service, click Add Service.
4.
To add a service, provide the following information.

8 APRIL 2016
ENSIM CONFIDENTIAL
140
Service Name: The name of the service.
Internal Service ID: This will is used to identify the service uniquely.
Subscription Type: This field is used to separate out multiple modes of provisioning of the
same service under different circumstances. For example, in case of Mozy services, for online
backup, there are two modes Single User and Multi User. Therefore, for Mozy service
mention the mode as the field value.
If for any service no mode is there, set it as Default.

8 APRIL 2016
ENSIM CONFIDENTIAL
141
Vendor Name: The name of the vendor. In the Marketplace, this vendor name displays while
placing an order with the offers created from this service. For example, if service name is MS
Exchange 2013, then the vendor name should be Microsoft 3 (displays at the time of order
placement in Marketplace).
Search tag: This field helps the organizations to set the search words for the services. When
an organization user logs in to the EAS portal, it can search that service with those search
tags easily. No need to type the whole service name each time to search the same.
Environment specific information: The service specific description in details. As this is not a
mandatory field, this field should not be copied at the time of Import/Export.
Suggested service: This field appears where user may check multiple services other than the
selected service. This contains a Configure button, clicking which the list of services
appears. After placing an order with one of the suggested services, the list of services are
displayed to the user. The user can select a service to list the corresponding offers and select
one of the offers to place an order.
Provisioning delay notification threshold: The notification template regarding the delay of
the order provisioning that is sent to the email address of the concerned person after the
provided time in this field.

8 APRIL 2016
ENSIM CONFIDENTIAL
142
Private DNS: This field allows you to brand your hosting services and differentiates you as
an independent hosting provider. If Private Domain Name (DNS) required field is selected,
at the time of ordering or provisioning the service, provide the domain name.
Allow multiple orders on same DNS name: This field allows creation of multiple orders
under the same private domain. If this field is selected, the user is allowed to select multiple
orders on the same DNS.
Usage collection required: This field decides whether usage report is required by this service
or not in organization login. If this field is selected, the Service Provider can see the usage
button in the order history page that will display the usage of that particular service. If not,
the Service Provider cannot see the usage button in the order history of the order containing
that service.
Requires Active Directory Service domain: This field specifies that to fulfill order through
the ESOM System, the service requires this Organization Unit in active directory.
Has user management: If this field is selected, it allows the provider to assign that
particular service to the organization user who has ordered based on that service. If this field
is not selected, that service will not be available for assignment to the organization user.
Need phone numbers: This field allows the organization users to purchase phone numbers
to enable voice calls for some specific EAS connectors, such as BroadWorks and Lync. If this
field is selected, the Service Providers can create items based on this service where resource
ID must be set as phone number quota.(Refer to phone number inventory configuration
section)
Order Association Rule section contains the following three rules.
Associate if placed on same private domain name: Orders placed on the same private
domain will be automatically associated with each other if this Boolean filed is selected
provided that the fields Private Domain Name (DNS) required and Allow multiple
orders on same DNS name are selected. Organization inputs will be copied from the
placed order to the associated one. If the previous order placed on a domain is still in the
draft mode, then order cannot be associated on the same private domain.
Never Associate orders: If this Boolean field is selected, offers created from this service
can be ordered by the organizations without any association among these offers.
Always Associate orders: If this Boolean field is selected, at the time of multiple order
creation from the same service, EAS will check for the offers created from the same
service and associate one of those with the current offer, provided that the fields Private
Domain Name (DNS) required and Allow multiple orders on same DNS name are
selected. If the previous order placed on a domain is still in the draft mode and another
order placed on some other domain is provisioned, then the order will be associated to
the private domain whose previous order is provisioned.
Change Control section specifies the change events as follows:
Track change of sales agent: This field is used to notify provisioning tools that the sales
agent has been changed for a provisioned order.

8 APRIL 2016
ENSIM CONFIDENTIAL
143
Track change of technical contact: This field is used to notify provisioning tools that the
technical contact has been changed for a provisioned order.
Track change of organization information: This field is used to notify provisioning tools
that the organization information has been changed for a provisioned order.
Dynamic Validation Required: This option determines whether this service will use
dynamic validation of order items and provisioning information. The following types of
validations are available:
Using Automation Connector: This option allows EAS automation connectors to call
their respective APIs for order validation.
Using External Source: This option allows EAS to perform validation using a script
hosted on the same or different application server. EAS triggers an HTTP host request to
the specified URL with optional username and password fields provided for basic
authentication.
One-time provision: This field specifies that the service will be provisioned for One-time.
For example; service for mobile handset is provisioned only once, at the time of purchase.
Hosted Service (recurring): This field specifies that the service will be provisioned on a
recurring basis. After provisioning of the service, the monthly rating calculation is done on
various resources of this service, based on the usage amount in one month. Recurring based
provisioning of the service can be of two types:
Manual Provision: Implies that the BPT jar will not process orders made from the
services. The services will be provisioned outside the system, based on information
supplied within email notification for fully manual or semi-automated provisioning
flows. The email is sent automatically with SSID, the provider must use the manual
system to provision and configure.

8 APRIL 2016
ENSIM CONFIDENTIAL
144
Automatic Provision: The service will be provisioned automatically. On selecting this

Boolean field, the drop-down list provides the options through which the service will be
provisioned. The services may be provisioned through Ensim Unify Shared via
Middleware or Ensim Service Catalog Manager platforms.
If Ensim Unify Shared via Middleware platform is selected, a check-box named use
EAS control panel appears, which if checked will display a Configure button. EAS
provides a front-end plugin through which the user can perform the order provisioning
by clicking the Configure button. If this field is not selected then the order will be sent to
ESOM via middleware for provisioning.
If Ensim Automation Suite platform is selected for automatic provisioning, Service

Provider can configure the Connector Name. Selection of this platform enables the
Configure button to be displayed on the service details section.
In EAS, for BPA the Send access credential to Technical contact is enabled for manual
service. In the Access Information area, (username), (password), and (link) access macros
must be provided for BPA specific services.
To set the connector name follow the steps belowi.
Click the desired service and the details will be displayed on the right side of your screen.
ii.
Click the Configure button.

8 APRIL 2016
ENSIM CONFIDENTIAL
145
i.
The Connector Configuration pageappears. Select the desired connector name and click the
Associate Service button. For example, let us take an example for Microsoft Lync 2013.
If the desired connector name is not listed in the drop down box.
ii.
The connector will be associated and displayed as shown below-
Reseller can configure field specifies that resellers will also be able to configure this
particular service.
Agent can configure field specifies that agent will also be able to configure that particular
service.
Send access credentials to technical contact

8 APRIL 2016
ENSIM CONFIDENTIAL
146
This field used when a service is being Automatic Provisioning through EAS only and the
service is associated with the EAS connector as well.
If this checkbox is check at the time of service creation, then required access credentials for
accessing the service will be provide to the technical contact through the mail only. On checking
this field a textbox appears where Service Provider can add the details for Access information in
specified format. To add the access information in multiple languages click the
the mail template click View notification template link.

8 APRIL 2016
icon. To view
ENSIM CONFIDENTIAL
147
5.
After the required details have been filled, click the Save Changes button.
Edit Service
Service details present in the EAS can be edited by the following steps1. Log in to the EAS portal. Click CatalogServices.
2. Available services will be listed. Click any of the listed services to edit the same.
3. Click the Edit Service button.
4.
To edit a service, update the following details.

8 APRIL 2016
ENSIM CONFIDENTIAL
148

8 APRIL 2016
ENSIM CONFIDENTIAL
149
5.
Make the required changes and click the Save Changes button. A confirmation box appears.
Delete Service
To delete a service, follow the steps below1. Click the CatalogServices tab.
2.
A list of all the services appears. Select the service to be deleted. Click the delete button
Delete Service button.
3.
A window pops up to ensure the delete decision. Click Yes to delete the service. The service
will get deleted successfully.
Note: A service cannot be deleted if at least one Offer created with Items that belong to that
service exists.
Import Service
To import a service from external location, follow the steps below1. Click the CatalogServices tab.

8 APRIL 2016
ENSIM CONFIDENTIAL
150
2.
Click the Import service button.
3.
Browse the location for the service serviceNameXml.xml to be imported. To do so click

Choose File button.
4.
5.
6.
The XML files for those services that are provisioned through ESOM will be available in the
path mentioned belowGo inside the ServiceXMLs folder.
All the service XML files can be found within this ServiceXMLs folder.
After the file is uploaded, click the 'import' button to add service.
Click the import button. The service will then be included in the list.

8 APRIL 2016
ENSIM CONFIDENTIAL
151
An attempt to import an existing service will be unsuccessful with the following screen-
Note: For some specific service (CRM, SharePoint etc.), we need to configure certain
resources of that particular service after importing those service XMLs by the above
mentioned steps. For CRM, resource named as Instance Name has to register the hostname
of the CRM farm server. For SharePoint service, resource called SharePoint Site URL needs
to add the entire registered domains that are present in ESOM portal.
Resource Configuration
Service resource can be configured in EAS by following the steps below1. Log in to the EAS with Service Provider credentials.
2. Click CatalogService.
3. Click any of the service for which resource will configured. Service details will be listed at the
right side of the screen.
4. Click the Configure Resources button.

8 APRIL 2016
ENSIM CONFIDENTIAL
152
5.
All the available resources under the selected service should be listed (if any). In this page
Add/Edit/Delete Resources are possible.
Add Resources
Resource can be added to the selected service. There are two types of resource available in EAS
Provisioning Information
Order Item (default selection)

8 APRIL 2016
ENSIM CONFIDENTIAL
153
Add Order Item resource

To add the Order Item resources, go through the following steps:
1.
2.
3.
Click the CatalogServices tab.

Click Configure ResourcesAdd Resource button.
By default Boolean field Order Item is selected.
4.
Put the required details like Resource Name, Resource ID and select reservation unit and
pay-per-use unit from the drop down for a resource to assign units to that resource. Once the
resources configured with proper units, the product manager can define items. The following
is the description of the terms used in the form-
Pay per use allowed: If true, then extra usage will be allowed and invoiced as per PPU model
else the extra usage will be not permitted.
Default quantity: The quantity set here will be the default quantity for that particular
resource.
Resource category: This specifies as an identifier of a group, consists of multiple resources of

same type and configured under same service.
Metering Rule: To calculate the Pay per Use Amount, these rules are needed. Depending
upon our requirement any of these can be chosen.

8 APRIL 2016
ENSIM CONFIDENTIAL
154
On selecting this option, for PPU usage, Pro rata calculation will be done.
If pro rata is chosen, Organization will be billed only for the day for which the service is available
to them. For example: if the Organization will use the service for 1 day then they need to pay for
that day only not for the whole month.
For PPU based items, metering of usage data of the resource is very crucial to determine the
amount payable. Each resource has its own metering mechanism; however EAS collects usage
data from ESOM provisioning system on a daily basis.
Certain types of resources are metered as streams while some resources are measured by their
instantaneous value. The following examples will clarify the difference
1.
Network Traffic: this is measures as a usage stream. Daily usage collection will give the
consumption of last 24 hours. To calculate the consumption in a given month, the sum
total of all the days usage data needs to be considered
2.
Disk Space: this is measured as instantaneous value. A daily usage data will merely give
the sample values at the instance of collection for every day. The Service Provider may
decide to apply one of the following rules to arrive at a value for invoicing
a.
Average of daily values over the month
b.
Minimum of daily values
c.
Maximum of daily values
For very costly resources like IP address, one may chose Maximum whereas for most resources
Average can be used. EAS supports all three possible rules to choose from.
5.
Click the Save Details button to save a new item specific resource for the service.
Edit Order Item resource

To edit the resources, please follow these steps:
1. Click the Configure Resource button.
2. A list of all the resources appears. Click the resource which you want to edit from the list.
3. Click Edit Resource button.

8 APRIL 2016
ENSIM CONFIDENTIAL
155
4.
Make the required changes and click the Save Details button to save the changes.
5.
A confirmation dialog box pops up for creation. Click OK button to save the changes.

8 APRIL 2016
ENSIM CONFIDENTIAL
156
Note: Resource plays a very significant role in provisioning the offer. Therefore, edit
resource carefully.
Add Provisioning Information resource

To add the Provisioning Information resources, go through the following steps1. Click the CatalogServices tab.
2. Click Configure ResourcesAdd Resource button.
3. Select the Provisioning Information option.
4.
Put the Resource Name, Resource ID. The following is the description of the terms used in
the form-
In EAS a field named, Description in resource level under Provisioning Information has
been added. This information will be displayed as multilingual inline help text beside each
PIF at the time of placing order in the third order page(Provisioning Information).
Two options are there: namely Ask in every order and Ask in first order. These fields are
related for the order association. Organization input fields required for creating one order of
a service will be copied to the associated order of the same service where organization input
field having this field set as true will not be editable. Other copied organization input will be
editable.
If the option Ask in every order is selected, the OI fields were asked to fill for every new
order. In case of Ask in first order the OI fields were asked to fill for only first order.
Unique field restricts a user to put duplicate values. For example, if the provisioning
information email ID is created and a value say aaa@example.com is given at the time of
ordering. Then in next order this value will be not accepted. For uniqueness you must
provide different value.
If Mandatory field is checked then at the time of ordering you have to provide this value.

8 APRIL 2016
ENSIM CONFIDENTIAL
157
Editable after provisioning field allows editing of the resource even after order has been
provisioned.
Input type: For any resource, at the time of provisioning if any additional input is required
then these values can be set by selecting the desired Input type.
i.
By default, the input type will be Free text.
A default value for the new resource can be set for Free text. This field is optional. Click
icon to get the detailed help.
ii.
To set password for creating organization specific resource choose the input type called
Email ID. You can set the email id of technical contact. To do so, click the checkbox Use
email address of technical contact.

8 APRIL 2016
ENSIM CONFIDENTIAL
158
iii.
While creating organization specific resource, some cases may come where one resource
of organization information is mandatory information.
For example, if any organization wants News Subscription to be mandatory, follow the
steps below:
iv.
Create a resource called News Subscription (as per example). For that, insert the
information required and select the input type as Boolean type.
Once done click Save Details.
While creating organization specific resource, you can set the level of domain. The
domain level can be second level domain or any domain.

8 APRIL 2016
ENSIM CONFIDENTIAL
159
v.
While creating provisioning specific resource, some cases may arise where one domain
may be used by multiple organizations for ordering. Such cases are handled by the input
type called URL.
The Protocol Type can be set to HTTP or HTTPS or Either. Either means
protocol type is not set from the service level and the user will get an option to select
the field from the orders page where a drop-down will be available. User who is
placing the order can determine the value amongst HTTP and HTTPS.
The Domain Type can be set to Shared domain only or Organizations domain
only or Either. Shared domain means multiple organizations can place order
through the same domain. Service Provider can set the shared domain values in the
fields available below. Organization domain resembles private domain which is
meant for that perticular organization. Selecting this value will acquire the private
domain value provided. The option Either means the domain type is not set at the
service level and an option will appear in the order page where a drop-down will be
available. The user can determine the value while placing the order.

8 APRIL 2016
ENSIM CONFIDENTIAL
160
The Input type can be set to either No further information required, Hostname
Prefix required or Virtual Path required.
No further information required means at the time of ordering user neednot provide
any information except the Protocol type or Domain Type.
Hostname Prefix required means at the time of ordering user needs to provide a
prefix before the hostname provided.
Virtual Path required means at the time of ordering user needs to provide a virtual
path after the provided hostname.
To configure shared domains for the resellers click the Configure for Reseller
button. The form with the list of resellers appears where the Service Provider can set
the shared domains for each reseller.
To list all resellers, click List Resellersand choose any perticular reseller by providing the
Reseller ID.

8 APRIL 2016
ENSIM CONFIDENTIAL
161
vi.
5.
While creating provisioning specific resource, some cases may arise where you can set
some list of values that require at the time of provisioning the service. You can set those
values.
Click the Save Details button to save the newly added organization specific resource. Click
OK button.
Edit Provisioning Information Resource

To edit the Provisioning Information Resources, go through the following steps:
1.
Click the Edit Resources button.

8 APRIL 2016
ENSIM CONFIDENTIAL
162
2.
Make the required changes, the assigned resource units can be changed too then click the
Save Details button to save the changes. Click OK button.
3.
Some cases may occur where one provisioning information should be dependent on another
provisioning information. For such a case, there is an input type called Boolean in EAS.
Delete Resource
The service resources can be deleted, if it is not required or no longer will be used. Follow the
steps below to delete various resources against different services1. Click the CatalogServices tab.
2. Click Configure ResourcesDelete Resource button.

8 APRIL 2016
ENSIM CONFIDENTIAL
163
3.
Confirmation for delete box pop up should be open up. Click Yes to confirm the delete
operation otherwise click the No button to cancel the delete operation.
4.
Click OK button, once confirmed.

8 APRIL 2016
ENSIM CONFIDENTIAL
164
Map PIF Identifier

Map PIF Identifier allows you to set a rank against each of the resources. Based on this ranking,
the resource names are displayed in the generated reports.
For further details on mapping PIF identifiers, refer to the

8 APRIL 2016
ENSIM CONFIDENTIAL
165
PIF Mapping section.
Download Service
To download a service, follow the steps below1. Click the CatalogServices tab.
2.
A list of all the services appears. Click the service which you want download and click the
download button
3.
The above service is downloaded to a default location in an .xml format.
Item Creation
Base Item
A base item is an item directly created based on the resources. In the above model, the product
manager defines three base items
VPS-RAM : for selling memory
VPS-Disk : for disk space
VPS-IP : for IP address
To create a base item, follow the steps below1. Log in to the EAS portal with Service Provider credentials.
2. Click the CatalogItems &RPP tab.
3.
4.
5.
Available services will be listed, if any. Item search based on item name, item description,
unique GUID and item code.
Click the service (for example, Virtual Private Server (VPS)) under which the item should be
added.
Click the Base Item button at the right side of the page. A base item creation page will open
up. Fill the required information.

8 APRIL 2016
ENSIM CONFIDENTIAL
166
The following is the description of the terms used in the form
Item Code: This field is internal reference for the item created.
Unique Identifier: This field, also known as Universal Unique Identifier (UUID), is external
reference for the item.
Item Name: This field contains the name of the item. You can change the item name at offer
level.
Cost Margin Details: A vendor, or a supplier, is a supply chain management term that
means anyone who provides goods or services to a company or individuals. A vendor often
manufactures Inventory/stock items and sells those items to customers.
Vendor Costing
The Cost at which the vendor sells the product to Service Provider is referred to as the
Vendor costing.
Adding Vendor Costing:
For reference of Service Provider, two costing are there for each Item (Base Item, Item Bundle,
and Composite Item). Namely:
Primary Vendor Cost: Cost at which the vendor sells the product to Service Provider.
Bill of Materials Cost: Includes cost of primary vendor cost and additional expenses(for
example, raw materials, components and assemblies, configuration etc.) of Service Provider
to provide the service.
To set vendor cost two editable fields, namely Bill of Materials Cost and 'Primary Vendor
Cost' are added in Item creation form. These two costs will remain same for all Offers for an
item.

8 APRIL 2016
ENSIM CONFIDENTIAL
167
Primary Vendor cost <= Bill of Materials Cost

Note: Bill of Material Cost and Primary Vendor Cost will also get reflected in the
Add Pricing page of an Item in Offer level as a tooltip while creating an Offer in our
future release. It will help in calculating the selling price for the admin user of service
provider who will create the offer with that item.
Provisioning Information Required: This field contains the list of provisioning information
that may be required at the time of ordering the item. With this item, the selected
provisioning information must be provided at the time of ordering else, the ordering will not
be successful. More than one option can be selected.
Description: Provide the description of the item. To set the description in Multilanguage
please select the
6.
icon. Click OK button.
Click the Save Details button to create a new base item.

8 APRIL 2016
ENSIM CONFIDENTIAL
168
7.7.
Bundle Item
The product manager wants the organizations to add more Diskspace to their existing VPS. The
idea is to allow organizations to choose additional Diskspace at the time of ordering or later.
However, it is required to purchase in multiples of certain amount, say 10 GB. In order to achieve
this, EAS allows the product manager to define bundles of disk space with the said amount. One
bundle item can have only one quantity specified. If the intention is to offer in multiples of 5 GB
and 10 GB, then two bundles need to be defined and included in the Offer.
To create a bundle item, follow the steps below1.
2.
3.
4.
Log in to the EAS portal with proper credential.

Click the CatalogItems & RPP tab.
Click the service (for example, Virtual Private Server (VPS)) under which the item should be
added.
Click the Item Bundle button at the right side of the page. A item creation page will open
up. Fill the required information.
Note that two types of item bundling are possible.
a-> Reserve type :- The reserve bundle type only includes reserve item of a service.
b-> PPU type:- The PPU bundle type only includes PPU item of a service.
A default bundle type of the Bundle item is reserve. Bundle type can be changed through a
'Bundle Type' select option in configuration details block.

8 APRIL 2016
ENSIM CONFIDENTIAL
169
The Quantity field is mandatory and accepts only Integer value. An entry other than integer
value will show an error message as follows-
5.
Click the Save Details button to create a new bundle item.

8 APRIL 2016
ENSIM CONFIDENTIAL
170
Marking manual items at Item level

This feature will help the offer creation process more blended. There will be options to choose a
type for items which are not required to be provisioned, still needs to be a part of the offer as
Manual. There will be four options a user can choose:
1. Reserved (Automatic)
2.
Reserved (Manual)
3.
Pay-Per-Use(Automatic)
4.
Pay-Per-Use(Manual)
The main purpose it will serve is treating the Non-Provisionable Item types as Reservation
(Manual) and PPU (Manual). E.g. manual items, goods and various charges, installation charge,
training cost etc.
In the new implementation, base item and bundle item creation page will show 4 options Reservation (Automatic)
Reservation (Manual)
Pay-per-use (Automatic)
Pay-per-use (Manual)
EAS backend code will separate out the item type and sub-type and mark the database
accordingly. For example, if Reservation (Manual) type is selected, the value of item_type column
will be "Reservation", and the value of item_sub_type column will be 2.
Composite Item
We come to the most complex part of the item creation. The idea of creating a heterogeneous
composite item is to sell the selected set of items (with specified quantities) as mandatory option.
In case of VPS, the product manager may want to sell a combination of RAM and Disk as follow:
1 GB of RAM

8 APRIL 2016
ENSIM CONFIDENTIAL
171
100 GB Disk
In order to force this combination as mandatory, he can create a composite item VPSSubscription. For further increase of RAM and Disk, the Offer will include those items
separately.
To create a bundle item, follow the steps below1. Log in to the EAS with Service Provider credential.
2. Click the CatalogItems & RPP tab.
3. Click the service (Virtual Private Server (VPS)) under which the item should be added.
4. Click the Composite Item button at the right side of the page. A item creation page will
open up. Fill the required information.
5.
Click the Save Details button to create a new composite item.
Note: Automated usage collection is not supported in service bundling in this release. But manual
usage collection for PPU based items is supported.

8 APRIL 2016
ENSIM CONFIDENTIAL
172
View Pricing
To view the item pricing firstly we have to create the pricing. To view the item pricing or the
price Structure for the items, follow the steps below1.
2.
3.

Click the service name called Virtual Private Server.
Click the item for which the pricing should be set. Item details will be shown up at the right
panel of the page.
4.
Then click the View Pricing at the bottom of the right panel. The page contains the already
created Pricing (if any) for the item.

8 APRIL 2016
ENSIM CONFIDENTIAL
173
In the above image, the pricing name with the image

denotes the reseller pricing for the
itemComputing unit for VPS, which is described later.
Note: Adding/Editing organization pricing is at Offer level and reseller (Type-1) price is
at Reseller Price Plan level.
In case no pricing for the item is set, the following page will be shown-

8 APRIL 2016
ENSIM CONFIDENTIAL
174
Edit Item
To make any changes in item follow the steps below1.
2.
3.

Click the service name called Virtual Private Server(for example).
Click the item which you want to edit. Item details will be shown up at the right panel of the
page.
4.
Then click the Edit Item at the bottom of the right panel.

8 APRIL 2016
ENSIM CONFIDENTIAL
175
If the selected item is Base Item then the following page will come up. Make the required
changes and click Save Details to save the changes.
If the selected item is Bundle Item then the following page will come up. Make the required
changes and click Save Details to save the changes.
If the selected item is Composite Item then the following page will come up. Make the
required changes and click Save Details to save the changes.

8 APRIL 2016
ENSIM CONFIDENTIAL
176
Delete Item
To delete an item follow the steps below1.
2.
3.

Click the service name called Virtual Private Server(for example).
Click the item which you want to delete. Item details will be shown up at the right panel of
the page.
4.
Then click the Delete Item at the bottom of the right panel. Click Ok.

8 APRIL 2016
ENSIM CONFIDENTIAL
177
Create Offer Category

To create a new Offer category follow the steps below1.
2.
Log in to the EAS portal with Service Providers credential.

Click the CatalogOffers tab.
3.
Click the Add Category button and fill the required details.
4.
Click the Save Changes button to save the category.

8 APRIL 2016
ENSIM CONFIDENTIAL
178
Download Catalog
The 'Download Catalog(csv)' button helps to download and save the EAS catalog that contains
the list of offers in CSV file format. This button will be available only if the logged in user is
Service Provider/Reseller with 'Create Category' permission.
The Service Provider user has the opportunity to download the catalog that contains the offers
created by him only or the offers created by him and all resellers.
The reseller user can download the catalog that contains only his offers (offers created by the
reseller himself and the assigned offers for which the pricing has been set)
To Download Catalog file follow the following steps1.
Click the Download Catalog (CSV) button, downloads all the offers (in CSV format) in
which Display in Marketplace option is selected, at the time of offer creation (refer to the
Marketplace Content section in Create Offer).
2.
To download the offer two options are there; namely All Offers and Only your Offer.
By selecting the Boolean field All offers all the existing offers can be downloaded to any
specified location choose by you; whereas
By selecting the Boolean field Only your offer, all the offers that you are created will be
downloaded to any specified location choose by you.
3.
Once downloaded successfully, the CSV containing the list of created offers is dumped to the
marketplace.

8 APRIL 2016
ENSIM CONFIDENTIAL
179
Create Offer
This section describes how to create a Flex VPS Offer. In this offer, a product manager intends
to sell a basic VPS subscription, with options to reserve IP addresses and Disk bundles, and allow
Disk space consumption based on Pay-Per-Use model. Additionally, in the first invoice a charge
for setup fee is proposed. Offer comprises of a Price Structure that consists of a set of Price
Structure Functions chosen for the items in the offer. The Price Structure is shown in the table
below:
Item Name
Price Structure Function
Degrees of Freedom
VPS-Setup
VPS-Setup-Plan
1 (one and only one)
VPS-Subscription
VPS-Subscription-Plan
VPS-Extra Disk
VPS-Extra-Disk-Plan
0..* (optional, any quantity)
VPS-Disk
VPS-Disk-PPU-Plan
VPS-IP
VPS-IP-Plan
1..* (at least one, or more)
To create a new Offer, complete the following steps.

1.
2.
3.
Click Catalog > Offers.

In the list of categories, click the category under which the Offer should be created.
Click Add Offer. The Select sales channel and service form appears.

8 APRIL 2016
ENSIM CONFIDENTIAL
180
Before creating an offer, the user should choose the service on which they want to make the
offer and the type, and whether the offer is for direct customer or for publishing to Type-2
reseller. The following two fields are available.
i.
For sale to direct Organizations: Select this field to make the offer available in the
catalog of the organization user of the Service Provider, and Type-1 reseller. These Offers
are also known as P2O (Provider to Organization) Offers.
ii.
For sale via Resellers: Select this field to make the offers available to publish for Type-2
resellers. These offers are not available in the catalog of the organization user of the
Service Provider.
Note: Type-3 resellers support enterprise use cases. These Resellers gets exclusive offers in
their catalog. Currently, the support is provided to limited use cases; it will be completely
implemented in a future release.

8 APRIL 2016
ENSIM CONFIDENTIAL
181
Exclusive offer can also be created for T2 Resellers, like Enterprise resellers. While creating a
new offer, if the option For sale via Resellers is selected, a drop-down list with the
following choices appears.
a.
All type 2 resellers: The offer is created for all Type 2 resellers and published to a specific
or all type 2 resellers with same currency in offer.
b.
Specific reseller: If this option is selected, a text box appears followed by a search button.
The Product Manager can put a Reseller ID in the text box, or can search for a specific
reseller from the dialog box that appears after clicking the search button.
Note: Reseller can be searched using Reseller ID or Reseller name.
These are also called Provider to Reseller (P2R) Offers. Service Provider publishes these offers
to Type-2 resellers for selling to Resellers Organization. These P2R Offers of the Service
Provider cannot be ordered by or for an Organization. Thus, it does not appear in external
catalog. The Resellers have the option to change the price structure of the published Offers
for their Organizations.
The Offer attributes defines their behavior.

To create an Offer, provide the values in sections listed below:
General Details
Offer Type
Billing Rules
Item Configuration Details
Marketplace Content
Catalog Attribute
Provisioning Workflow
Notification Macros
General Properties
This section appears by default after clicking the Add Offer button in the EAS UI to create a
new Offer.

8 APRIL 2016
ENSIM CONFIDENTIAL
182
The General Details form is divided into four sections:

1.
2.
3.
4.
Basic Details
Constraints
Upgradability
Data retention and notification before data wipe.
Each section has the following terms.

1.
Basic Details
Category Name: Select a name from the dropdown list for the offer.
Unique Identifier: This field is an external reference for the item created.
Catalog ID: This field can define an identifier for this Offer that uniquely identifies it in
the item Catalog.
Tariff code: Put the tariff code in this field.
Display Name (English): Enter the display name for the offer.
Description: Enter any description of the item.
Activation Status: The activation status can be set to activated or deactivated. By default
the status set as deactivated. In Deactivated status, this item cannot be ordered. To
order it, select the Activated status.

8 APRIL 2016
ENSIM CONFIDENTIAL
183
Search tag: This helps the organizations to set the key words for the services. After
logging to EAS portal, this helps an organization to look for the service quickly using the
keywords.
Lock further editing: This field does not allow to edit the Offer in future after it has been
saved.
2. Constraints
At-Least-One constraint: This field can be set for every individual items. This implies,
those items have to be ordered at least one in quantity at the time of creating an order
with the Offer. To set this constraint for the first time, the following dialog box appears.
Therefore, it is mandate to save the offer for the first time, and then this attribute can be
accessed.
For example, an offer P is created with the combination of 4 different items, prd-1, prd-2,
prd-3, and prd-4. Among these items At-Least-One constraint field has been selected
against prd-1 and prd-3. While creating a new order with offer P, quantity has to be set at
least one against prd-1 and prd-3, else the order creation process does not complete. For
Configuration procedure, refer to Edit Offer section.
Depends-on constraint: This field puts dependency on the items based on the constraints
set on those items. To set this constraint for the first time, the following dialog box
appears.
Therefore, it is mandatory to save the offer for the first time for this attribute to be
accessible.
For example, within an offer P, prd-1 is dependent on prd-2 based on the selection of this
field. At the time of creating a new order with offer P, prd-1 cannot be purchased until
prd-2 is purchased. For Configuration procedure refer to edit offer section.
Organization Global Discount: To set the organization global discount at offer level,
follow the steps below:
1.
2.
Select the check box to enable the organization global discount option.
Click Configure beside this field to set a discount percentage.

8 APRIL 2016
ENSIM CONFIDENTIAL
184
3.
The Limit Organization Global Discount dialogue box appears.
Therefore, the organization global discount is set on both, the organization level and the offer
level. The following table explains the organization global discount rules.
Discount
percentage set at
Organization
level
10
Discount
percentage
set at Offer
level
10
Discount
percentage
applicable
Description
10
10
10
Offer and discounted organization support 10%

discount. So, the organization gets 10% discount.
Though, the organization offers 10% discount, the
offer supports only 5%. So, the organization gets 5%
discount.
Though, the offer supports 10% discount, the
organization is only applicable for 5% discount. So,
the organization gets 5% discount.
3. Upgradability
Upgradable to: This value determines the possible upgrade paths to allow organizations
to upgrade or downgrade the offer.
Upgrade weight: The Upgrade weight determines which offer is considered higher and
consequently determines if the transition is an upgrade or downgrade. The upgrade
path lists all offers under the selected service for the new offer. It is unidirectional. To
allow upgrade (or downgrade) both ways, define the path in both offers.
Upsize allowed: Select the check box to allow upsize of any item within this offer.
Input quantities by increments: Select the Input quantities by increments check box to
allow the users to set Differential Quantity that is, the quantity that has been added or
deducted during upsize or downsize operation.

8 APRIL 2016
ENSIM CONFIDENTIAL
185
Downsize allowed: Select the check box to allow downsize of an item within this offer.
Message during upgrade: Select this check box to show the custom message when an
offer is upgraded.
Select this check box to add a global icon to show the message in the language mentioned
by the EAS UI. Refer to the following figure.
Click the
button to open the Add Names in Multiple window.
Set the custom message in specified language.
Contract Period: This defines the number of days (or months or year as the case may be)
a sales contract is valid for this Offer. During this, contract upgrade is allowed to the
organization, but downgrade may not be allowed if not permitted. By default, the
contract period must be 2 years. Manually set the contract period 0 to waive off the
contract duration.

8 APRIL 2016
ENSIM CONFIDENTIAL
186
Max number of orders of this offer per organization: This field shows the max times the
offer is available at the time of ordering for each organization.
4. Data retention and notification before data wipe
Data Retention Period: After the cancellation of the item, data of the specified
organization is retained at the service platform. After the data retention period is over,
the data is cleared from the system.
Expiry of the data retention period is notified for 3 times. To do so, set the time in the
notification mode. To set the notification mode, first select the check box, and then enter
the number of days (prior to expiry of the data retention period). Refer to the following
figure.
Apart from the standard fields provided, users may want to add additional information
to store Offer specific data (such as, Organization, Offer, Item, and so on). Depending on
the requirement, these fields are included for the Offer. EAS provides twelve additional
custom fields. These fields can be enabled or disabled, or Service Provider user can set
the field mandatory by using the configuration section. This enabled custom field is
visible in offer under General Properties tab.

8 APRIL 2016
ENSIM CONFIDENTIAL
187
By default, these custom fields are not available. To make any changes, the Service Provider must
configure the custom fields from the configuration section.
Subscription Properties
Subscription refers to the process of Business Contact ordering a service for a fixed minimum
period of time instead of month to month; either a Service Provider requirement to have a
minimum commitment or as an incentive to the buyer (to get a better price by committing to
a longer period). The Organization may use the month to month service until the orders is
cancelled by the BC or the Service Provider.
To enable the subscription for an offer, complete the following steps.

1) There are two offer subscription options: Month to Month, and Termed Subscription.
Enable Termed Subscription for the offer. If the option is not enabled, the offer is set
as Month to Month.
2) The Subscription Properties section contains the subscription period and subscription
notification reminder along with enforcement rule (that is, the offer is renewed or
cancelled automatically after the subscription period is over). The organization can
viewed and modified this choice after the order is provisioned or in any stable state.
3) 3 notifications are configured to be sent to the Business Contact and Technical
Contact before the expiry date of the offer.

8 APRIL 2016
ENSIM CONFIDENTIAL
188
Offer type
The following page appears when no service is selected under Item Configuration Details tab.
Discount for Type-2 Resellers: Service Provider can set the discount for Type-2 reseller.
Select the check box to enable the discount option. This check box is selected by default. Click
the text box next to this field and set a discount percentage (must be less than 100). To set the
reseller discount, set the discount in the offer level (that is, this discount percentage is set on
base price by the service provider for resellers while publishing this offer).
Available as: The following options are available under offer type.
i.
Purchase Only- This option allows the purchase option for the offer.
ii.
Trial Only- This option allows the trial option for the offer.
iii.
Trial Purchase Both- This option allows the trial and purchase option for the offer.
iv.
Upgrade from Trial- This offer is available in trial mode. After ending of the trial period,
it can be purchase.
The following page appears for Trial Only and Trial Purchase Both options.

8 APRIL 2016
ENSIM CONFIDENTIAL
189
The form contains the following components:

Trial Period: Provide the duration of trial.
Purchase before expiry: This option allows organization to purchase the offer before the
expiry period. To enable this option, make sure that check box is selected.
After the trial period is over, there are two ways to purchase the offer. There are two radio
buttons for the purchase option:
i. Opt In: The auto purchase option is not available In Opt option. After the trial period
expires, user has to buy the item manually. A list of offers is available in the Trial
Upgrade option. User may select multiple options among which one can be purchased
after expiry.
ii.
Opt Out: After this option is selected, the Auto purchase option becomes available.
After the trial period expires, the offer automatically becomes chargeable. In the Trial
upgrade to drop-down list, user can select one of the offer to which the trial offer is to
be upgraded after expiry.
Notification before expiry: Before the trial period of the offer expires, an alert message is
sent to the user. There are three check boxes. Select the first notification check box to send an
alert message that the trial period is about to end. As the expiry date arrives near, the second,
and then the third notifications are sent.
Note: To set the Offer type, add at least one item to the Offer to determine the Service
over which the Offer is based. The list of Offers appears where the trial offers are
Upgradable.

8 APRIL 2016
ENSIM CONFIDENTIAL
190
Billing Rules
EAS supports two modes of payment for the organizations in terms of ordering offers :
Invoice in Advance
Invoice in Arrears.
Also in offer level, there are two payment modes for self-registered organization and registered
organization.
For the self-registered organizations, by default payment mode is Invoice in Arrears. With this
payment mode, Self-registered organization can place the order, but cannot approve the same.
Registered or verified organizations can also place and approve the order.
Under the Configuration > Payment and Invoice tab, there are three payment modes:
Invoice in Advance
Invoice in Arrears
As in Offer Settings
Service Provider or Reseller can set the payment mode from the configuration section. When
Invoice in Advance or Invoice in Arrears options are set from configuration, the payment mode
reflects on every order for all types of organizations.
When the As per the offer setting option is set, the payment mode saved for the offer is
considered for Registered and Self-registered organizations.
Rating actions (Pro-rated or Full month) can also be configured on the order actions.
In Pro-rated rating action the organization is charged for the particular days the service is
available to them.
In Full month rating action, the organization is charged for the whole month irrespective of the
day on which the order action is fulfilled.
Service Provider sets the rating action for provision and upsize.
If Provision and Upsize are set as Pro-rated, then the organization is charged only for the
particular days of services available to them for either case.

8 APRIL 2016
ENSIM CONFIDENTIAL
191
If Provision is set to Full month and Upsize is set to Pro-rated, then the organization is charged
from the first day of the month irrespective of the provisioned date until upsized. Again, the
organization is charged for upsize only for the particular days of services available to them.
When upsize rating option is set to full month, the following options are available to the
Organizations:
1.
2.
3.
Upsize Now
Upsize on a specific date
Upsize starting from next month.
If the user selects the Upsize Now option, the following rules are applicable:
If Provision is set to Pro-rated and Upsize is set as Full month, then the organization is charged
from the date of provision until the order is upsized. Again, the organization is charged for the
upsized order from the date of provision to the end of the month.
If Provision and Upsize is set to Full month, then the organization is charged from the first
day of the month irrespective of the provisioned date until upsized. Then the organization is
charged for upsize from the first day of the month to end. If the customer chooses upsize
from the beginning of the next month, then charge on upsize is applicable from the beginning
of the next month
If user choose upsize on specific date, then upsize charge is effective from that specified date.
For example, if the date is 1st day of the next month, then the upsize starts from next month.
However, if the specific date is in between a month, then upsize charge is applicable from
that day and pro rata is applicable.
Note: Full month upsize billing is created if user chooses upsize starting from next month
option.
It is recommended to initiate downsize, upgrade, and downgrade from the beginning of the next
month, and cancelled on the last date of the month.
While adding or editing an offer, under the Billing Rules section, a field accepts value from 1 to
28. If the order placed with this offer is deactivated or cancelled on or before this day from the bill
cycle day, there is no billing for that order for that fiscal month.

8 APRIL 2016
ENSIM CONFIDENTIAL
192
Self-registered organization
When you click the offers, organizations redirect to the order page with their payment
agreement, which includes one of the above mentioned payment mode. These payment modes is
found under Configuration > Payment and Invoice (Service Provider login).
Under Payment Agreement tab, Service Provider or Reseller can set the payment mode.
Under the Configuration > Payment and Invoice tab, there are three payment modes:
1. Invoice in Advance
2. Invoice in Arrears
3. As per the offer settings
The new payment mode is implemented mainly for the self-registered organizations.
Note: Self-registered organizations are not EAS organizations. These are the non-verified
organizations who wants to buy EAS offers through market portal.
The As per the offer settings payment mode redirects the organizations to the offer, which the
user wants to order, to check the payment mode of the selected offer. If a discount is already set
for the offer, then that amount gets deducted at the time of invoice.
In offer level, two payment modes, Invoice in Advance and Invoice in Arrears, are present in selfregister organization and registered organization.
For the self-registered organizations, the payment mode is set to Invoice in Arrears by default.
With this payment mode, Self-registered organization can place the order but cannot approve it.
A registered or verified organizations has the authority to place and approve the order.

8 APRIL 2016
ENSIM CONFIDENTIAL
193
Billing Actions:

8 APRIL 2016
ENSIM CONFIDENTIAL
194
Item Configuration Details

Click Item Configuration Details to set item pricing.
Billing Properties:
Invoice at Zero quantity: Invoice is generated even if the quantity of any item of the Offer during
ordering is zero, if the check box is selected.
Invoice at Zero price: Invoice is generated even if the billed amount is zero, if the check box is
selected.
Billable Offer: If this option is selected, the Orders of this Offer are rated.
Enable discounts while ordering: One-off discount is applicable for selling process. If one-off
discount is applicable to an Offer, provider can offer a discount to an order (Organization users
cannot). The approved discount limit of sales representative or provider may be less than the
discount applied to the order. In this scenario, though the user has order approval rights, to the
user cannot approve it.
Discount Approver Email: An email is sent to this address when an approver's discount
approval limit is less than what the order contains. For multiple email addresses, enter semicolon
separated list into the text box. Each offer can override this value in edit offer screen, if discount
is enabled for it.

8 APRIL 2016
ENSIM CONFIDENTIAL
195
Provider can add Distribution List (DL) from Product Management. When provider allows
One-off discount, a text box appears which accepts an email value, and provider can set DLs
email ID on that field.
To set Offer specific DL, refer to the following figure.
The user has discount approval percentage up to 20%. The maximum discount offered is greater
than the approval rights. In this case, the user cannot approve the orders. The user must click the
Seek Approval button. An email is sent to the discount approver email set in the offer level.

8 APRIL 2016
ENSIM CONFIDENTIAL
196
DL has the authority to approve or reject the order.
The following page appears when DL clicks the Reject Discount button.
On rejection, an email is sent to the approver requested for DLs approval.
Pricing display format: Order displays price according to selected price format. There are two
types of price format: Four digits are displayed after decimal, or two digits are displayed after
decimal.

8 APRIL 2016
ENSIM CONFIDENTIAL
197
Item name: Select the Item name available in the dropdown list.
Purchase Option: Select the appropriate purchase option for this item. There are 6 purchase
options available:
i.
ii.
Mandatory: Selecting this purchase option implies the item must be purchased.
Zero or More: When this purchase option is selected, the item is optional with the
purchase. Either, the number of items is selected 0 or any positive integer value is given
as an item quantity at the time of ordering.
iii.
Optional Unselected: This option gives the choice to select or clear the item at the time of
ordering.
iv.
One or more: If this purchase option is selected, then the selection of item is mandatory
with the purchase at the time of ordering. A minimum of 1 or any positive integer value
as item quantity must be entered.
v.
Custom: This purchase option is selected at the time of offer creation. When the option is
selected, a dialog box appears where the custom range and quantum must be provided.
vi.
Optional Selected: When ordering, if this purchase option is selected, then the default
quantity shows 1. If option is cleared, then quantity shows 0.
To create a new Price Structure for an item, click Price. The following form appears.

8 APRIL 2016
ENSIM CONFIDENTIAL
198
The Add Plan form contains the following components.
Price code: Provide the price name. This is used for price identification. You can generate
more than one pricing for an item.
Type: There are three types of price: Flat Rate, Tiered Absolute, and Tiered Relative (refer
to the Modes of Tiered Pricing section for more information).
Modes of Tiered Pricing

In Flat Rate price type, each item has a fixed price. You are required to provide the Billing name
and the unit price for that particular item.
In Tiered-Absolute type, the values are provided in a range (or tier). There may be number of
tiers available. However, in Tiered-Absolute, a specific tier is selected which fits the given value.
The unit price is selected from that particular tier.
In Tiered-Relative type, the values are provided in different tiers with different quantity range.
The minimum value of a range must start from Zero (0) and maximum value can be up to
Unlimited (-1). In Tiered-Relative, the given quantity value is distributed among each tier and
calculated accordingly.
Select Tiered Absolute and Tiered Relative to open a drop-down list with Starts with and Ends
with values.
Range Min: This field does not appear when the PPF type is with Flat Rate. When the
Pricing type is tiered, this field should hold the minimum value of each tier. You can edit
the field when Starts with mode is selected for the tiered type. The value for the first
Price Structure Element tier always remains 0.
Range Max: This field does not appear when the Flat Rate is selected under Pricing type.
If the Pricing type is tiered then this field should hold the maximum value of each tier.
This field is editable when the Ends with mode is selected for the tiered type. The value
for the last Price Structure Element tier should always be Unlimited.
To add a new range, click the

8 APRIL 2016
icon and to remove a particular range, click the
icon.
ENSIM CONFIDENTIAL
199
For example, there are four Billing Names with the value ranges (refer to the following
figure).
1.
In Absolute mode the cost is calculated as: Total amount * cost of the tier of the total
amount:
35 items have a price of:
For billing name (VPSCU4): 35 * (From 30 To 40 items) $7 = $245
49 items have a price:
For billing name (VPSCU6): 51 * (From 50 +) $5 = $255
2.
In Relative mode the cost is calculated as:

For billing name (VPSCU): 10 * (From 1 To 10 items) $10 = $100
Total: $305
For billing name (VPSCU5): 9 * (From 41 To 50 items: ) $6 = $54
Total: $394
For billing name (VPSCU6): 1 * (From 51 +) $5 = $5
Total: $405

8 APRIL 2016
ENSIM CONFIDENTIAL
200
Relative mode provides each line on the bill, but not the total. Absolute has only one line in
the invoice.
Billing frequency: The Billing frequency contains two possible selections in the dropdown
list: Initial Charges and Monthly.
Commissionable: Contains check box to decide if Agent commission is applicable. If yes,

then enter the commission percentage.
Installment: Billing in installment basis refers to the limited amount of billing for a specific
period. In this field, specify the period of billing for the item. For example, to bill an item for
5 months, enter 5 in the text field. Enter -1 to specify the item to be billed until cancellation of
the order.
Note: For the order containing aged item, EAS does not allow to upgrade, downgrade,
upsize, or downsize of the order.
Billing name: Provide the billing name for each tier.
Unit Price: Holds the price of a single unit for the particular tier.
Specify Discount:
EAS allows provider to give discount on each tier of every price of the items. The sellers (Service
Provider, Reseller and Agent) give this discount to the organizations at the time of placing the
order.
To enable discount model for EAS, Service Provider or Reseller must activate the Allow one-off
discount field on the global configuration level.
Go to the Configuration > Product Management page and then check the Allow one-off
discount option.
When the global flag for discount is turned on, discount fields against each tier becomes
available at the offer level.
Each tier at the offer level has the following discount fields.
i.
Min Disc (Minimum discounted amount);
ii.
Max Disc (Maximum discounted amount).
Note: In these three fields, Service Provider or Reseller must put the discounted amount. If
no discounted amount is set, then the default the base price is taken as the resource price at
the time of ordering.
Values on these fields indicates the discount range on a particular tier.

8 APRIL 2016
ENSIM CONFIDENTIAL
201
At pricing level, the Dont allow sales representative to grant one-off discount field
determined if the discount is applicable on a particular price.
When the field is set to true, all the discount fields gets deactivated. The discount is applicable
for that pricing.
At offer level, the Allow one-off discount field is present under the Configuration > Product
Management section. This field determines if the sellers can see the discount at the time of
placing the order for the organization.
Discount capability
The Approve Order with discount up to field under the Configuration > Roles section
decides the capability of individual sellers. The seller with the required authority sets this
capability in percentage.
The following example describes the overall scenario of this approval capability.
The market price of one item is $100 for the first tier.
Discount range for this tier is $60 to $60, in which minimum discounted amount = $90, and
maximum discounted amount = $90. Seller-1, who wants to sell the order made from this offer,
can see the unit price amount on the order page. For example, if the discount capability of the
seller is set to 10% under Configuration > Roles, this seller can sell this item for at least $90.
When an organization wants to buy the item at less than $65, Seller-1 is not permitted to fulfill
the request.

8 APRIL 2016
ENSIM CONFIDENTIAL
202
In EAS, BPA specific item can be created, such as Unit price item, by using the Unit Price and
Link check boxes, and the Profit Margin field.
To attach the pricing to the item, click Ok.

8 APRIL 2016
ENSIM CONFIDENTIAL
203
Rank: Provides the Serial Number for each offer.

Trial Quantity: The offer is ordered for trial only when the offer type is Trial Only and
Trial and Purchase. The trial quantity allows to enter a specific quantity of
corresponding item when the offer is ordered for trial. The default trial quantity is zero.
Exclusive: In provisioning pespective, item can be of two type:
Additive Item: An additive item has no limitations or dependency regarding
provisioning. A user can buy or use any quantity. For example, Exchange Diskspace.
These items are billed till the time they are used. There is no option to Upgrade these
items.
Exclusive Item: Exclusive items are the items which are dependent on each other about
provisioning.. A user cannot use two exclusive items simultaneously. Ideally, there should
be one or more pairs of exclusive items.

8 APRIL 2016
ENSIM CONFIDENTIAL
204
Note: The Composite Item should be additive. The composite item cannot be exclusive
because it is composed of other base items.
PPU Limit: This configuration is available for item of resource type Pay-per-use only. The
PPU limit allows to provide the maximum usable quantity for this item.
Click the
icon to add the item to the offer.
Similarly, add all the required items in the offer. The orders placed on this offer is invoiced
based on the quantity of the items added in this offer.
Note: In case of PPU items, usage limit can be set up to a fixed value.
After associating an item to an offer, a new check box is introduced in EAS 4.3 to support
usage input method on per item basis, that is, usage can be calculated per service request
for automated usage collection or manual usage collection (manual input).
If this check box is selected, the usage for that corresponding item is calculated based on
per service request. This check box is selected only for pay-per-use items.
Note: The name has been changed to Usage per service from Usage per service
request.
Edit item name: Click the

icon beside the item name column to edit the pricing of the
item. On changing the item name in an offer, the change reflects globally for that
provider and their organization. When complete, click the
Click the

8 APRIL 2016
icon.
icon to set the multilingual.
ENSIM CONFIDENTIAL
205
Edit Pricing: Click the

click Save Price.
Click the
icon to prevent price from editing, deleting the item from offer, or
changing the Purchase Option.
Click the
icon to remove the item added to the Offer. In case if the item is mandatory
purchase option, the item cannot be removed as the remove icon is not displayed.
When the
icon beside pricing column to edit the pricing of the item and
icon is clicked, click the
icon to unlock the item. The item must be
unlocked to perform price editing, deleting the item from offer, or changing the Purchase
Option.
On editing the pricing, the Reseller gets three billing frequencies, such as Monthly,
Daily, Hourly.
Edit the price details from this webpage and then click Save Price.

8 APRIL 2016
ENSIM CONFIDENTIAL
206
The quantity of the items of a service that are not set in the offer can be set here and the
organization which orders this offer is not invoiced for these resources. The following figure
shows the page where you can enter the fixed values for item quantities.
Moreover, when one item is added, specific informations of related organization is displayed in
tabular format. The filtering of those information list is required at the time of ordering.

8 APRIL 2016
ENSIM CONFIDENTIAL
207
Marketplace Content
The following figure shows the various attributes related to the marketplace.
Commercial info link: Commercial URL for every offer is provided through this
Commercial info link file. When the offer list populates under Offers tab, then this link
opens in a different window for every offer. Refer to the following figure.
Click the
Image url: URL of the image for the offer is displayed on the dashboard page. To add the
same, click Add.
Display in catalog: If this Boolean check box is selected, then this offer shows in the
marketplace.
link to open the commercial link of the VPS Offer 19 in a separate window.

8 APRIL 2016
ENSIM CONFIDENTIAL
208
The boolian field Display Featured Item confirms the offer to display in the catalog.
Display order is used to set the position to show the offer in the Marketplace catalog. For
example, if display order is set to 4, then the offer displays in the fourth position of the
catalog as shown in the Marketplace.
Minimum monthly price: Minimum monthly price of the offer is displayed on the
dashboard page. To set the price in different languages, click the
icon.
Catalog Attributes
In this section, various features are added about the offer which is displayed on the dashboard
page.
For example, in a mobile phone catalog many features are listed, like:
Fast connectivity
Media support
1.
Click the
icon to add multiple feature.
To remove any extra feature, click the

8 APRIL 2016
icon.
ENSIM CONFIDENTIAL
209
2.
The features can be shown in different languages. To set the features in different
languages, click the
icon, set the languages, and then click Ok.
Provisioning Workflows are available to fulfil orders with Ensim Service Operations Manager in
an automated fashion. Moreover, life cycle of an order is managed with sophisticated email
notification that must be manually fulfilled outside the system.
EAS supports 4 types of provisioning workflow:

1.
Fully Automated Workflow: This implies that the Background Provisioning Task (BPT) jar
picks up orders made by the services for Provisioning automatically.
2.
Fully Manual Workflow: This implies that BPT jar does not process orders made by the
services. The services is provisioned outside the system, based on information provided in
new email notification for manual or semi-automated provisioning flows. The email is sent

8 APRIL 2016
ENSIM CONFIDENTIAL
210
automatically with SSID. The provider must use the manual system to provision and
configure.
3.
4.
Semi-automated Workflow-1: This implies that the Provisioning APIs are available and the
technical provisioning is automated, but to make the service completely available to the
organization some additional manual tasks must be performed. The provisioning work flow
is same as the Fully Manual Workflow.
Semi-automated Workflow-2: This use case is for fully API integrated services that require
some manual configurations, such as DNS, Firewall, or even a training program to use the
service. Till then, billing must not be activated. The provisioning work flow is same as the
Fully Manual Workflow.
Semi-Automated workflow is a combination of both: manual and automated tasks. Some
provisioning operations require the manual steps to be performed along with the necessary
API calls.
In Semi-automated workflow 2, some manual steps must be performed before and after API
calls. When the order is approved, Provisioning Engine checks the workflow of the offer. If
pre-notification status is set to true, then Provisioning Engine updates the database and
changes the status to "Provisioning". Notification module sends the pre-manual notification
email to the operation team of the provider stating to complete the pre-manual tasks. An
operation team member (with permissions) edits the order, updates all the respective details,
and clicks the Proceed to provision" button next to order status under order details. The
confirmation window appears with a message I confirm the all necessary manual steps have
been completed and necessary information have updated in the order form to proceed for
automatic provisioning for next, with two options: cancel and proceed buttons. When you
click the proceed button, the order proceeds to provision. Provisioning engine again picks
up the order and calls the respective API to fulfil the order. After getting successful response
from the API call, provisioning engine provisions the order and notification module is sends
as the post notification email to operation team of the provider to complete post manual
tasks. After the post manual tasks are complete, provider has to start billing and customer
can use the service.

8 APRIL 2016
ENSIM CONFIDENTIAL
211
5.
some manual configuration or a training program to complete the fulfilment, but billing
should start after the provisioning API call is complete.
Approval workflow
Approval workflow: After ordering the Offer, the order must be approved (click Approve on the
order details page). The logged in user approves the offer if he has the right to approve the order.
He can also send an email to the business contact to seek approval.
Organization can approve check box: When the Organization can approve checkbox is not
selected, the following fields appear for setting the details to send the approval email.
a.
To: Enter the list of email addresses separated by semi-colon (;) or a comma (,).
b.
CC: A non-editable label to show the business contact of the organization.
c.
Language: Dropdown list with list of the enabled languages. By default, the EN
(English) selected.
d. After clicking the View notification template, it is redirected to the sample

template of the notification is sent to the organization.
If the check box is selected, an organization can approve his orders. In case of the Fully Manual,
Semi Automated Workflow-1, and Semi Automated Workflow-2, if the
check box is selected, then the Approval Notification setting gets hidden. The notification setting
must be filled up by the user.

8 APRIL 2016
ENSIM CONFIDENTIAL
212
When the order is approved, a notification is sent to the Business Contact of the order about it.
The email address of the Business Contact is auto populated in TO field.
EAS 4.0 supports the Provider must approve approval workflow.
If
check box is selected, then approval is required from both ends: the
provider, and the organization, to change the state of the order from draft to approved. As a
provider or organization, click Approve beside the order. The order state changes to Pending
Approval and notification email is sent to the other entity depending on the authority clicking
the Approve button first.
When a provider clicks the Approve button, the email is sent to the operation team, and for the
organization, notification email is sent to the Business Contact (BC) of the Organization.
Both the email addresses for provider and organization are given at the time of creating the
entity.
The field Order must be approved before must be provided for each offer. The order gets
cancelled when the Approve button for a drafted order is not clicked within the given time
period.
Notification Macros
Notification macro is used to store some explicit value which is displayed at the time of sending
notification to the organizations. To set the value, make sure that the check box is selected. Provide the
respective value for each macro. Usually, 12 notification macros can be set.

8 APRIL 2016
ENSIM CONFIDENTIAL
213
The following figure shows the list of notification macros.
1.
Select the check box beside each macro and explicitly mention the value like Provisioning actions,
Opt-out trial disclaimer, Opt-in trial disclaimer, Offer description, and How to use.
2.
After clicking the Save button, one notification email is sent to the BC and TC of the selected offer
with the details that is provided for the macros.
Click the
3.
icon for further details and guidelines on the configuration of notification macros.
Terms and Conditions:

The content of Terms and Conditions section in offer could be both, basic HTML or a URL.

8 APRIL 2016
ENSIM CONFIDENTIAL
214
For an Offer, if the Terms & Conditions macro is enabled (check box is selected), then at the time of
drafting an order on this offer a window appears displaying the content specified in the terms and
conditions section.
If the content is inline HTML, then the window show the HTML content. If the content is an external
URL, then the window displays the contents pointed to by that URL.
An order is drafted after the user accepts the terms and selects the I Agree button.
Note: For an order, the Terms & Conditions section appears only at the first draft.

8 APRIL 2016
ENSIM CONFIDENTIAL
215
In EAS, version management of the Terms and Conditions is introduced. Every change is stored in the
view history and corresponding email notification is sent with the updated Terms and Conditions.
EAS must support multiple versions of the Terms and Conditions captured with the date. The first
version of the Terms and Conditions is created when product manager marks it as a required field for the
first time in an offer. If the offer is not ordered yet, the Terms and Conditions content is changed to
prevent the creation of a new version. Otherwise, a new version is created and the offer points to the
latest one.
"Copy" or "Publish" of an offer copies current version of the Terms and Conditions. History of the Terms
and Conditions is ignored.

8 APRIL 2016
ENSIM CONFIDENTIAL
216
Edit Offer
To edit an offer, complete the following steps
1.
Log in to the EAS portal.
2.
Click Catalog > Offers.
3.
In the list of categories, select the category to which the Offer to be edited belongs.
If the offer is for the organization, the following detail page appears.
4.
Select any pricing in the Pricing column. The following page appears with the
pricing details.

8 APRIL 2016
ENSIM CONFIDENTIAL
217
5.
Click Edit. The Offer form appears with the preset details.
6.
Edit the required fields.
Tag to Reseller: If the offer is not published to the resellers, then change the Tag
to reseller option by modifying the offer.
Upgradable to: To configure the Upgradable to option, click Configure.
The Boolean fields, such as At-least One constraint, Add-On Items, and Limit
Organization Global Discount are under the Items Configurations Details section.

8 APRIL 2016
ENSIM CONFIDENTIAL
218
At-Least-One constraint: For an individual item, to set the Boolean field At-Least-One
constraint as true, select this Boolean field and click Configure.
Add-On Items: 'Depends-on constraint' is modified to 'Add-on Items'. Prior to EAS 4.2,
there was no option to associate the quantity of the dependent item with the primary
item. Currently, some rules have been set in the offer level. According to the selected
rule, the quantity of the secondary item is displayed on the order page. To configure the
settings for the Add-On Items field, select this field and click Configure.

8 APRIL 2016
ENSIM CONFIDENTIAL
219
To add the Add-On item and configure the rule, complete the following steps.
1.
Select the Primary Item and the Add-On Item from the respective drop-down lists
and click the
icon.
2.
3.
4.
Click the Configure

icon to set the rules for the Add-On items.
Select the rule and click Done.
Click OK.
Rules for Add-On item:

A. Specified At the time of Ordering: Retains the existing behavior.
B. Can be less than or equal to [scaling factor] times of Primary Item: Limits the
quantity of the Add-On item based on the quantity of the primary item. In other words,
the quantity of an Add-On item is specified while placing an order, but cannot exceed the
given limit.
C. Must be equal to [scaling factor] times of Primary Item: Fixes the quantity of the
secondary item while placing an order based on the quantity of the primary item. It
cannot be specified while placing an order.
D. Can be less than or equal to [constant]: Sets a constant value as the upper limit of the
quantity of an Add-On item.
E. Must be equal to [constant] added at the time of order and subsequent order action:
A fixed quantity of an Add-On item is added during the order upsize or downsize.

8 APRIL 2016
ENSIM CONFIDENTIAL
220
Refer to the following example for better understanding:

Example 1
Google apps seats are available with postini service. If google apps seats are purchased,
then postini service is purchased automatically. To configure the same, the following
rules are introduced:
Dependent items quantity will depend on the primary item quantity: If X quantity
of google apps seat is purchased, n*X (n is the scaling factor) number of postini
service (secondary item) is automatically added to the order.
Dependent items quantity as a constant number: For any number of google apps
seat being purchased, n number of postini service (dependent item) is added to the
order, where, n is a constant number.
Example 2
With every Google apps seats, the postini service is optional. If a customer buys 5 Google
apps seats, then the customer can additionally buy up to 5 postini services. However, the
customer can opt not to buy at all. To configure the same, the following rule is
introduced:
Add-on Item with Editable Dependent Quantity: If X quantity of google app seat is
purchased, then quantity of the postini service is keyed in between 0 to n*X, where n
is the scaling factor.

8 APRIL 2016
ENSIM CONFIDENTIAL
221
Not Available for Sale: When editing the price of the item under the offer, another
purchase option is displayed, that is, Not Available for Sale. Once the item pricing is set,
it is up to the Service Provider to decide whether he/she wants to sell to the organization
or not. If not, then edit the purchase option under Item Configuration Details. This
option is visible only if the offer is saved and ready for ordering because only while
placing an order, it is decided whether the item is available for sale or not. If the purchase
option of the item is set to Not Available for Sale, then the item is not available for
further order placement. After assigning an item to Not Available for Sale, set the
upgrade weight of that item to zero so that it is not applicable to the upsize or downsize
rule.
7.
Click Save Offer to save the changes made to the Offer. After the changes are saved,
the following message is displayed.

8 APRIL 2016
ENSIM CONFIDENTIAL
222
Offer Import/Export
Prior to EAS Service Provider Product Manager/Ensim Support used to create the offer/s in staging setup
manually. Offer export/import is a new feature enabling export / import of a single Offer to be copied and
pasted from one EAS source system (E.g., Staging System) to another EAS target system (E.g.,
Production System) of the same version (i.e. 4.1 to 4.1, 4.2 to 4.2, etc.) via XML file transfer. In the Service
Provider Catalog, both Provider to Orgs (P2O) and Provider to Resellers (P2R) Offers can be exported
and imported. However P2R Offers will not get published automatically to Resellers. Publishing an Offer
should be done after importing the offer.
A new right 'Export / Import Offer' is created to permit a user to perform export / import functions when
enabled. This right is limited to this operation only.
Export/Import file format

Files are transferred in XML format only (with tree structure of product model). CSV is not supported (as
it is a linear structure). Files cannot be edited between export and import.
There will be one XML file generated per Offer. For single Offer export, a single xml file will be
generated. The XML file can directly be imported. The XML file name will be in the following format:
(Offer name-GUID).xml
Offer Export
In EAS, only a single Offer is implemented. For this operation, an Export button will be visible as in
sreenshot below. By clicking Export button, an XML file will be generated that will have the following
information:
Offer Owner ID
Offer properties
Offers service details
Offers service related resources
Service Items used in the Offer.
Pricing, Discounts and Configuration settings (min/max etc.) of the Items in the Offer
Subscription and Billing properties of the Items / Offer
Offer macros (like TOs & CCs, PIFs, and custom fields. Global Level settings of Custom
Fields Offer and Item Custom Fields will be not be included in the export / import and
must be configured directly in the target system. The values of the Custom Fields that are
part of the Offers and Items will be included irrespective of whether those all enabled or
disabled in the source system. Based on Custom Fields settings, values will be visible in
Offer and Item create/edit form.
EAS system version (this will be used to compare the EAS version on the source and
target systems. They must match for an import to be possible).

8 APRIL 2016
ENSIM CONFIDENTIAL
223
Items not included in the export are; up/down-grade path, promotion information.
Note: Trial Offers will be exported and imported. All Trial Offer properties such as; auto convert /
terminate at end of trial are covered by the export / import feature.
To create an Offer in EAS, it typically has a service, resources, and Items. The XML file will have a single
Offers details along with its service, resources, and Items. If the Service, related resources and items are
not available in the system then the import mechanism will auto-create those and import the offer in the
system.
Note: The Offer will export only with the latest aligned version in the Catalog of that Offer (i.e.
historical data of versions will not be exported). This may be added in a future version.
Offer Owner ID is the login ID of the user who has created the offer. The same Owner ID needs to be
available in the target system to import an Offer.
Offer Import
In EAS, only a single Offer XML can be imported. If service and resources are not available in the target
platforms Service Provider catalog, import will create them using the data from the XML file (as all is
capture as part of the export job). While all Items are captured in the export XML, they will be ignored in
the import if they already exist in the target platform Database and only Offer data will be imported (and
linked to the existing Items as applicable).

8 APRIL 2016
ENSIM CONFIDENTIAL
224
Using Offer identifiers, the feature will check whether the Offer is already available in the system or not.
If not, then Provider to Reseller and Provider to Organization Offers will be imported into the SP catalog.
However, if the Offer already exists, then an error message will be displayed (Offer already exist) and
the import of that Offer will be skipped). To import and replace an Offer that already exist in the target,
the user must first delete the existing Offer in the target, and then import it from the source.
Service Provider will see a list of successful and unsuccessful imported Offers from the 'Action Log' with
error message/code for the unsuccessful Offers. The user should then correct the blocking issue and
reattempt the import. Since, updating of existing Offers is not allowed; the import tool will automatically
ignore prior successfully imported files.
By clicking the Import Offer button, a page will open as below:
Choose the Category name from the drop down list and Browse the XML file to be imported. Finally,
click the Import Now button.

8 APRIL 2016
ENSIM CONFIDENTIAL
225
WARNING: Modifications of the XML are not supported and any impact from improper use are not part
of Ensim support and require paid professional services to rectify any issues caused.
Copy Offer
Copy offer refers to the process of making an exact replica of any offer with the same display
name as well. Copy an offer is possible only within the same provider (copy offer to
himself/herself) as well as for service provider to Type-1 reseller. Copy option can be available for
all type of offer; whether it can be For sale to direct Organization as well as For sale via
Resellers. If any provider wants to make some minor changes on a particular offer, then copy
offer is the best way to do so. This will reduce the manual effort and time as well. When a copy
offer is given to Type-1 reseller then they can configure the price, edit the item etc. of that offer.
The Type-1 reseller can sell that offer and as per the resource consumption, an amount will
charge to them by the service provider.
Steps to copy any offer:
1. Click CatalogOffers tab.
2. Click the offer you want to copy.
3.
In the right hand side, click the Copy button.

8 APRIL 2016
ENSIM CONFIDENTIAL
226
4.
Either click the radio button Copy this offer for yourself to copy the offer to yourself or
click the radio button Copy this offer to a reseller to copy the offer to Type-1 reseller. Click
OK button.

8 APRIL 2016
ENSIM CONFIDENTIAL
227
If Copy this Offer for yourself is selected then there are two ways to perform this action:
I. If the selected Offer is Provider to Reseller then there is an option called Copy as P2O If
this option is checked then that Provider to Reseller Offer will be copied as P2O ,
otherwise the copy will be a Provider to Reseller Offer
II. If the selected Offer is Provider to Organization then there is an option called Copy as
P2R. If this option is checked then that Provider to Organization Offer with be copied as
P2R, otherwise the copy will be a Provider to Organization Offer.

8 APRIL 2016
ENSIM CONFIDENTIAL
228
Publish Offer
Service provider can publish any existing offer to the Type-2 reseller. This is because Type-2
reseller cannot create his or her own offer. After publish, the whole offer along with the category
will be available for the Type-2 resellers. After that the Type-2 reseller can configure the price of
the offer, can edit the item name in the offer for their organization. Follow the steps below:
1. Click CatalogOffers tab.
2. Click the offer you want to publish to Type-2 reseller.
3.
In the right hand side, click the Publish button.

8 APRIL 2016
ENSIM CONFIDENTIAL
229
4.
5.
6.
7.
Either click the radio button Publish this offer to all Type-2 reseller to publish this offer to
all the existing Type-2 resellers, else click the radio button Publish this offer to a specific
Type-2 reseller to publish this offer to any specific reseller.
In case if you select the radio button Publish this offer to a specific Type-2 reseller,
provide the Type-2 reseller ID to whom you want to publish the offer.
Click OK button.
In the select action page, you'll have a number of options to choose from.
Using the Publish this Offer to all Type-2 Resellers option the user can make it visible
for all Type-2 Resellers under the Service Provider,
Specific Type-2 Reseller will be able to view the offer if the Publish this offer to a
specific Type-2 Reseller option is chosen with the relevant reseller ID.
Note: This will publish the offer to all Type-2 Resellers under Service Provider. The
Resellers will be able to edit pricing and add "Value-added items" to the Offer.
8.
Republish an already published offer can be done either in active mode or inactive mode.
Selecting the Publish as Active option will make it appear in the catalog of the Type-2
Reseller. Besides, the visitors and Organizations will also be able to view this offer with
immediate effect.
On the other hand, the Publish as Inactive option will prevent it from appearing in the
catalog immediately (i.e. it prevent to appear in front of Type-2 Resellers Organizations).

8 APRIL 2016
ENSIM CONFIDENTIAL
230
So, only the Type-2 Resellers under the Service Provider will be able to view it and will
also be able to make it visible in the catalog for the visitors and Organizations.
Note: For an already published option, selected options will be ignored and the
status of the Resellers' Offer will be retained.
9.
The Push Offer can be implemented only during republishing. It changes the Type-2
Resellers Offer during re-publish, irrespective of whether the fact that the Type-2 Reseller has
edited or ordered it and the Order is in subscription period. The only scenario when all the
attributes will be republished is when this option is not selected and the Reseller edits or
Orders own copy.
Note: In case the offer has already be published to the Reseller and even if no change has
been made, pricing and groups won't be updated or added.
Offer Custom Fields will be copied over to the target offers in case of copy/publish/re-publish
actions on Offers.
Manage Version
Versioning helps to distinguish and keep track of the changes among the previous and current
offers.
In EAS, new version of the Offer is created when the following changes are made:
1. Price of one or more items are changed in an Offer
a. Increase or decrease the unit price for an item
b. Change the structure from flat rate to tiered
c. Change from relative to absolute tiers
2. An item(s) is not available for sale any more
3. Introduce a new item(s)
For example, an offer named VPS Offer 1 with a default version Version 1 consists of two
items:
VPS IP with price of 50$
VPS Disk space with price of 76$

8 APRIL 2016
ENSIM CONFIDENTIAL
231
CASE 1:
The price of VPS IP is increased from $50 to $75 and item VPS Disk space price is decreased from
$76 to $70. To manage the price, a new version named Version 2 is available with the latest price
changes. If this version is aligned, all new organizations go through the latest price and existing
organizations go through according to the configuration of the newly created version.
CASE 2:
There may be another case, that VPS Disk space is no more available. To handle this type of
situation, a new version will be introduced with the purchase option of VPS Disk space Not
available for sale. When this version is aligned, new Organizations will not able to see two items
in that offer. VPS Disk space does not appear during ordering.
You can create new versions for P2R offers with the following features:
Pricing of existing Items can be changed:
o
Increase or decrease the unit price for an item
Changes occurred in the structure from flat rate to tiered and otherwise
Changes occurred from relative to absolute tiers or otherwise
New Items can be added to the Offer
Item from the previous version can be removed, if no order has been placed for the Offer
New version can be published to the particular Reseller

8 APRIL 2016
ENSIM CONFIDENTIAL
232
Create Version
To create a version, complete the following steps.
1.
2.
3.
Click the Catalog > Offers tab. The list of categories appears.
Select the category to which the Offer belongs.
Select the Offer and click Manage Versions.
This page displays all versions of the selected Offer including the version created at the time of
Offer creation. If the entire previous version is Aligned or Deprecated, a new version can be
created. By default, the current Offer is the first version in aligned state with non-editable fields.

8 APRIL 2016
ENSIM CONFIDENTIAL
233

8 APRIL 2016
ENSIM CONFIDENTIAL
234
The Create New Version form contains the following components:
Description for Notification: This is used as the body of the version announcement
notification sent to the Organization. All relevant details about this version should be
specified here.
To set the description in different languages, click the

8 APRIL 2016
icon.
ENSIM CONFIDENTIAL
235
Align later (Manual): To manually align the version with the Offer later, select this
option. After the version is approved, the Align Now button appears. For P2R
version alignment, click this button to align the version with the Service Providers
offer.
Align this version to <reseller>: This option is applicable to P2R offers. As P2R offers
are meant for resellers, creating a new version for P2R offers is not required if the
newly created version is not aligned with resellers offer. If this option is selected,
resellers having the previous version of this offer are aligned with the new version.
On selecting this option, the Include resellers orders or subscriptions for
alignment option is enabled. This option further requires the following inputs:
Align to all reseller: It implies that in this version, the offer is aligned to all
Resellers having the previous version of this offer.
Align to specific reseller: This option enables Resellers having a previous
versions of the Offer aligned to the current version. Selection of multiple
Resellers are possible for version alignment.
Schedule alignment of version for a future date (Automatic): After the version is
approved, to align the version on a particular date, you can set that date. On that
particular date, the batch job awakes and aligns the Order. By default, the batch job
awakes once a day.
For P2R version alignment, first, the Service Providers offer is aligned with the new
approved version and then, the resellers copy of the offer is aligned based on the
selections.
Date of Alignment: The date of alignment is a mandatory field. To schedule the

alignment for a future date, provide the future date.

8 APRIL 2016
ENSIM CONFIDENTIAL
236
Include subscriptions for alignment: This flag is used to control the alignment of the
existing subscriptions. For P2R version alignment, the Include resellers orders or
subscriptions for alignment option appears instead. If the Align this version to
<reseller> is selected, this option is enabled to alignment of all Resellers orders.
If this flag is turned on, all subscriptions (existing Orders) associated with this Offer
are aligned with the new version along with the version alignment. Otherwise, all the
existing subscriptions remain in the older version. To align these subscriptions later
with the new version, click Align Subscriptions.
4.
Make the required changes for the new version and click Save Version to save the changes.
The following confirmation dialog box appears.
5.
Click OK to confirm. The version is saved in the Draft state.
Initially, the user gets only the Save Version button at the time of creating a new version. When
the offer is saved, the user gets two buttons (Approve and Save Version). If you click approve,
the user gets three buttons (Send Notification, Revert to Draft, and Align Now). To get the
version announcement notification, you must click Send Notification and then click Align Now.
A Version Announcement notification is sent to the selected reseller or all resellers. If the Notify
organization users, during announcement and alignment of this version flag is turned on, the
announcement notification is sent to all technical and business contacts with active subscription
of the previous version of the offer.
Version States
An Offer version has the following states:
Draft: In this state, all fields are editable. When the version is in draft state, only product
managers can view it; it is not visible to the Organization. After the version is saved as a
Draft, the Approve button appears and the version can be approved and published.

8 APRIL 2016
ENSIM CONFIDENTIAL
237
Approved: After the version is reviewed, click Approve to change the state of the version
from Draft to Approved. In the confirmation dialog box, click OK.

8 APRIL 2016
ENSIM CONFIDENTIAL
238
In this state, the Send Notification, Revert to Draft, and Align Now buttons appear.

8 APRIL 2016
ENSIM CONFIDENTIAL
239
You cannot edit the approved version. To revert it to the Draft state, click Revert To Draft.
To set the notification, click Send Notification for Version Announcement.
If the Align later (Manual) option is selected, you must align the existing subscriptions
manually. To align the version with the active subscription, click Align Now and in the
confirmation dialog box, click OK. After aligning the orders, the promotions are not
continued.

8 APRIL 2016
ENSIM CONFIDENTIAL
240
Aligned: If the Include subscriptions for alignment option is selected, the existing
subscriptions are automatically aligned to the latest version. Otherwise, you must align the
existing subscriptions manually (as described earlier). In the aligned state, all fields are noneditable. The version is visible in the catalog (replaces the old version).
If you want to upsize or downsize an existing subscription that is not automatically
realigned, the user will see the new version of the Offer for upsize or downsize. Such
subscriptions get realigned with the new version when upsized or downsized.
For orders aligned from the version UI, the updated PIFs are displayed on the order page.
Alignment failed: If all offers are not aligned, the version is in the Alignment failed state.
Deprecated: When a new version is created, the previous version is Deprecated. In this
state, no new Order can be placed and it does not appear in the catalog. When existing
Orders on this version are being upsized or downsized, the newly published version is
available instead of the deprecated version.
When an Offer is created for the first time (version 1), the version is already published. The
Draft, Approved and Published states are applicable from the next version (that is, when a
new version of the existing offer is created). However, any change related to the Offer Name,
Upgrade options, and Provisioning Workflow does not affect the version of the Offer.
Version announcement and notification

Version alignment is a process of aligning a version with its Offer. After the alignment process of
a version is complete, the new version becomes the current version of the Offer and is available
for ordering. Version announcement informs the user about the changes in the existing Offer.
EAS sends a notification to announce the change in advance and after the new version is aligned.
a. A new template is available that can be mailed in advance to all business and technical
contacts (BC and TC) having an active subscription of that Offer. You can customize the
content of the template. If the subscription is not active, the BC and TC are not available.
b. After the changes are implemented, a regular upsize email template is sent. Additional
conditional variable and macro are available to effectively communicate with the BC and
TC.
c. The Order is in the 'To be upsized' state after the order is aligned with the new version.

8 APRIL 2016
ENSIM CONFIDENTIAL
241
For sending mails regarding version announcement and alignment, the following notification
templates are available.
Version announcement notification: Template to announce a new version that will be published
in future to TC and BC. The product manager can manually send this email to all relevant BC and
TC by clicking on a button associated to the version of the Offer. This email is sent to all TCs and
BCs who have an active subscription of that Offers previous version. Though this button is
available in the Approved and Published states, it is typically used in the Approved state.
Version alignment notification: Template to announce successful synchronization with a new
version to TC and BC. This template is used if the system synchronizes the version (batch job or
script). This template is sent as an additional notification with the regular upsize notification. If a
user performs an upsize from the UI, only the regular email for upsizing is sent.
Subscription Alignment Process (with invoice date management)

If alignment of active subscriptions is not performed during version alignment, it can be
performed after the version becomes Aligned.
In 'Version Management', select an 'Aligned' version and then click Align Subscriptions.
The following webpage appears.

8 APRIL 2016
ENSIM CONFIDENTIAL
242
Before aligning the subscriptions, invoice start date should be specified.

If Start invoicing according to the new plan as soon as subscription is aligned is selected,
current system date at the time of alignment is saved as the invoice start date.
If Start invoicing according to the new plan from a specific date is selected, the specified date
in the input field is saved as the invoice start date.
Billing or Invoice starts from this date after alignment of subscription is over.
Regardless of this selection, the subscription alignment process is started as soon as the Align
Subscriptions button is clicked.
If a delay in execution is foreseen due to some reason (for example, huge number of subscriptions
to align) it is recommended that the second option is selected.
A mail is sent to the BC and TC of the subscriptions notifying about the version alignment. A new
template is available that can be sent to the BCs and TCs of those active subscriptions.
The subscription is in 'To be upsized' state after the alignment is complete.
It is also possible that before subscription alignment occurred, an order is upsized. In such a
scenario, the order approval process enforces that the alignment is done properly before being
approved.
P2R Subscription Alignment

If alignment of resellers offer and active subscriptions is not performed during the version
alignment of P2R offer, it can be performed after the version becomes Aligned.

8 APRIL 2016
ENSIM CONFIDENTIAL
243
In 'Version Management', select an 'Aligned' version, and then click Align resellers copy.
The following webpage opens.
On selecting Include resellers orders or subscriptions for alignment, the invoice management
options are displayed.

8 APRIL 2016
ENSIM CONFIDENTIAL
244
Search Offer
Offer will be searched based on item name, catalog id, offer description as well as unique GUID.
The searching will takes place irrespective of offer category.
To search any offer three options are there:
Provider to Reseller: On select will display all Provider to Reseller offers. To search any particular
Provider to Reseller offer(Offer sale via Reseller), put the search criteria in the text field and click
icon.
Provider to Organization: On select will display all Provider to Organization offers. To search
any particular Provider to Organization offer, put the search criteria in the text field and click
icon.
De-activated: On select will display all Deactivated offers. To search any particular de-activated
offer, put the search criteria in the text field and click
icon.
On selecting all the three options in one go, all the deactivated offers of Provider to Reseller and
Provider to Organization will display.

8 APRIL 2016
ENSIM CONFIDENTIAL
245
Delete Offer
Follow the steps below to delete the Offer
1. Click the CatalogOffers tab. The list of categories will appear.
2. Select the desired category in which the Offer to be deleted belongs.
3. Select the Offer to be deleted. The Offer details will appear.
4.
Click the Delete Offer button to delete the offer.
Activate/De-activate Offer
The offer can be ordered only when the Offer status is Activate. Two ways are there. First is to
set it during offer creation.

8 APRIL 2016
ENSIM CONFIDENTIAL
246
Second way detailed below. Follow the steps below to activate/de-activate the Offer1.
2.
3.
4.
Log in to the EAS portal with the Service Provider credentials.

Click the CatalogOffers tab. The list of categories will appear.
Select the desired category in which the Offer belongs.
Select the Offer. The Offer details will appear.
In case of Provider to Reseller offers (offers which can be sale via resellers only):

8 APRIL 2016
ENSIM CONFIDENTIAL
247
De-activate all Copies:

Type-2 Reseller sells only those offer that is publish by service provider to them. A
reference of the original offer is mapped with the copied offer. This is mapped so that the
service provider has full control on the entire offer of the Type-2 reseller (published by
service provider). If Service provider wants to deactivate any offer then, that offer can
deactivate from the list of Type-2 reseller also.
Edit Reseller Discount:

The discount model for a published offer is as follows-

8 APRIL 2016
ENSIM CONFIDENTIAL
248
a.
There was an entity level discount per type-2 reseller, which was applicable for all
the Offers published to that Reseller.
b.
Offer level discount in the Provider to Reseller to be published to type-2 Resellers,

which was applicable to all the type-2 Resellers who get the published Offer.
c.
Discount can be edited per offer per type-2 reseller. For example, Type-2 Reseller R1
has Offer O1 as a publication from Service Provider with Provider to Reseller
discount set as 10%. There are other type-2 Resellers in the system, who also got the
offer O1 with 10% discount. The Service Provider wants to change the discount for
O1 for R1 only. This can be done by selecting the Provider to Reseller and clicking
Edit Reseller Discount. This will show a paginated list of all the Type-2 Resellers
who have this Provider to Reseller as a publication. From the list, select or search R1
and change the discount, say to 12%. Effectively, R1 will be getting 12 % discount for
O1 while others are still getting 10%.
In case of Provider to Organization (Offers which can be sale directly to the organizations)
offers:

8 APRIL 2016
ENSIM CONFIDENTIAL
249
5.
Click the Activate/Deactivate button.
View Service Provider Configuration:

Note: This is available for Type-2 Reseller only.
Resellers can view the Provider to Reseller Offer that has been published by the Service Provider.
To perform this1. Log in to the EAS portal with the Service Provider credentials.
2. Click the CatalogOffers tab.
3. A list of available categories will appear. Select the desired category.
4. A list of Offers available under that category will appear.

8 APRIL 2016
ENSIM CONFIDENTIAL
250
5.
6.
Select an offer and click 'View Service Provider Pricing'. This will show the Items in the
original Provider to Reseller offer along with pricing.
For a more detailed view, click 'View Service Provider Configuration'. This will show all the
details of the original Provider to Reseller offer.
Conflicting Offers
To set the Conflicting Offers, follow the steps below1.
2.
3.
4.
5.

A list of available categories will appear. Select the desired category.
A list of Offers available under that category will appear.
Click the Configure button under the level Conflict, to set the conflicting Offers with this
particular Offer.
6.
The window containing the Offers that belong to the same Service will appear.

8 APRIL 2016
ENSIM CONFIDENTIAL
251
7.
8.
Check offers that shall conflict with this Offer.

Click the Ok button.
Note: There exist multiple Offers that conflict with one particular Offer.
Upsize Configuration
To assign Upsize Configuration, follow the following steps1.
2.
3.
4.
5.
6.

A list of available categories will appear.
Select the desired category.
A list of Offers available under that category will appear.
Click the Configure button to set the weights of individual items in the particular Offer to
configure for Upsize under the level Weight.
7.
A window appears that contain the list of items included in the Offer.

8 APRIL 2016
ENSIM CONFIDENTIAL
252
8.
9.
Check the boxes alongside the item of which the weight will be assigned and enter the
weights as required.
Click the Ok button.

8 APRIL 2016
ENSIM CONFIDENTIAL
253
Item Group Configuration

An item group combines items according to the criteria best meeting the needs of organization;
for exampleThere might be a case where an organization is given an option to buy one item from a group.
Consider the following use caseSay one-offer has three items where all these three items has different financial scheme set by
Service Provider. The organization can opt for one of them at the time of ordering.
Create item groups

Group can be created upon the items inside the offer. To create an item group, follow the steps
below1.
2.
Logged in as Service Provider admin user. Create on Catalog>Offers.

Click any of the listed category. Click the Configure button against any of the offer within
this category under the label Group.
3.
A new page Add new Group will come up. Click Create Group button.

8 APRIL 2016
ENSIM CONFIDENTIAL
254
4.
Provide a group name in the text field named as Create Group. A list of all the items
appears.
5.
Choose items (must be two or more) from the list. Mark one of them as the default selection
for that group. This item displays at the time of ordering as default item. Click 'Save Group'
to save the group.
Items, which are already been used for creating an item group, will not be available when the
Provider creates another item group, i.e. One item cannot be used to create more than one
group.
At the time of ordering, only the selected item within a group will be used to create the final
order.
6.
7.
View/update/remove group
Groups can be edited, viewed, removed under this section. Click the View/update/remove
group tab. All the groups can be viewed.
To update the group, follow the steps below1.
2.
Logged in as Service Provider admin user. Click Catalog>Offers.

Click any of the listed category. Click the Configure button against any of the offer within

8 APRIL 2016
ENSIM CONFIDENTIAL
255
3.
4.
5.
6.
Update the list of item by de-selecting the unwanted items from the group. For de-selecting
the item, uncheck the Selected item. The unchecked item will not be displayed in the group.
Click one of the Boolean field under default item section to set the default item displayed at
the time of ordering.
Click Update Group button to save the changes.
To remove the item group, choose the group name from the list and click the Remove
Group button.
Add item to existing group

Under any existing group, an items can be added too. All unchecked items comes into list of
available item to create a new group.
To add items in the existing group, follow the steps below1. Logged in as Service Provider admin user. Create on Catalog>Offers.
2. Click any of the listed category. Click the Configure button against any of the offer within

8 APRIL 2016
ENSIM CONFIDENTIAL
256
3.
4.
Select items to be added.

Click Add to group button. The item will be successfully added to the selected group.
Upgrade and downgrade impact on Order:

Assume that an order on offer OFFER1 is being upgraded to an offer OFFER2 and that OFFER1
has the following grouped items:Item1, Item2, Item3 from which Item2 has been ordered.
OFFER2 has a group with Item2,Item4.
If OFFER2 has a group with Item2 in it then the order will use it as the ordered item(even if it is
not the default item in its group) and continue with the same ordered quantity as in OFFER1 (can
be changed). Item2 could not be change to Item4.

8 APRIL 2016
ENSIM CONFIDENTIAL
257
CHAPTER 5
Order Management
Introduction
Order management is the core of EAS. An Order in EAS represents the instantiation of an Offer for an Account of an
Organization with quantities of Items, PIFs, Custom Fields, Business Contact and Technical Contact among many
other attributes. An Order goes through many phases of approvals and state transition for fulfilment and
provisioning.
Order Creation
This section deals with the creation of orders. Orders can be placed as follow
1. Service Provider can place an order for its Organizations.
2.
Service Provider can place order for Resellers Organizations (only if the Service Provider can sell
to resellers organization is set to true for that reseller).
3.
Organization can itself place an order.
4.
Reseller can place order for its Organizations.
5.
Reseller can place order for Service Providers Organizations (only if Can sell to providers
organization is set to true for that reseller).
6.
Agent can place order for the organizations under Service Provider.
The following work flow describes the process of placing an order by Service Provider/Reseller/Agent user
for the organization.
1. Log in to the EAS Portal with Create Order permission.
2.
Click the Create Order link under Orders tab. The organization search page opens.
3.
Search and select the organization for which the order is to be drafted.
4.
Click the
Order
button to view the existing orders of the same organization. Or click the Create New
button, a page opens that displays a list of Categories and the Offers under the selected
category.

8 APRIL 2016
ENSIM CONFIDENTIAL
258
ORDER MANAGEMENT CHAPTER 5
5.
Click the desired Category to view the Offers under that Category.
6.
The above page displays an Offer. Flex VPS Offer is the Offer name, Starting at $ 23.99 / month is
the minimum monthly price of the Offer configured at Offer creation. The Promo tag indicates that
promotion is available on this Offer. Click the
button for more information about the particular
Offer. Click the trial button Try (trial period) to order the Offer for Trial.
Click the Order button of the corresponding Offer to draft an order for that Offer. The create order
page appears.
Step 1: Select Items

The selected Offer for order includes items that are listed along with individual pricing and discount
details.

8 APRIL 2016
ENSIM CONFIDENTIAL
259
The user can provide the desired quantity of items within the limits set by the Product manager in the Offer
configuration.
7.
Select an Item from the Group
The Item with a

tag is the default Item of the group included in the Offer. Click the
button to
select another Item from the group. For more details about group please check the Ordering offers having
groups section.

8 APRIL 2016
ENSIM CONFIDENTIAL
260
8.
Specify the quantity of Items to be ordered.
The quantity of Items in the Offer is editable unless the purchase option of the Item is Mandatory. The
default quantity will get ordered if the quantity remains unedited.
Following is a table describing the possible purchase options on an Item
Image in
Quantity
column
Purchase
Option
Minimu
m
quantity
possible
Maximum
quantity
possible
Default
quantity set
Mandatory
Zero or More
Unlimited
One or More
Unlimited
Optional
Unselected
Optional
Selected

8 APRIL 2016
ENSIM CONFIDENTIAL
261
Custom
Minimu
m value
set at
offer
level
Maximum
value set at
offer level
Default value
set at offer level
Not available
for sale
Same as before
upsize/downsiz
e
Same as before
upsize/downsiz
e
(only on
upsize/downsiz
e)
The Service Provider/Reseller might wish to remove an item from the offer even after orders on the offers
exist by configuring the purchase option of the item as Not available for sale. For those orders, the
upsize/downsize will allow to continue with the already ordered item quantity.
Note: The Service Provider/Reseller must change the item weight to zero; so that the quantity of the Not
available for sale item can be changed to zero else can continue with the already ordered quantity.
The Item subtotal column displays the calculated chargeable amount of the individual Item based on the
pricing and quantity. In case of a Pay-per-Use(PPU) Item, the text Pay-per-Use is displayed, as this type of
Item cannot be ordered with a particular quantity. PPU Items are charged depending upon the usage
(Invoice in Arrears).
The quantity column of the Pay-per-Use Item has a text field to enter a certain usage quantity that helps to
view the probable invoice amount for that Item for budgetary estimates. The actual usage and payable
amount for the Pay-per-Use Item will be calculated based on real consumption.
The chargeable amount for individual Items in the Item subtotal column includes the volume discount (set
for individual Offer) if the Organization is a distributor.
For Service Provider/Reseller users, all the promo codes associated with the selected offer are listed in a
drop-down menu. One of them should be selected from the list to apply to the order.

8 APRIL 2016
ENSIM CONFIDENTIAL
262
When an order is placed on an account and the promo is available in that currency which is associated with
that account, then promo discount will be displayed within order screen.
9.
Providing One-Off discount
The discount model for Item helps product managers configure the minimum, maximum and default
discount on each item. The service provider/reseller user can provide different discounts to organization.
The above page displays the percentage discount for the items for which the Allow sales representatives to
grant one-off discount is checked. Click the percentage to change the discount for this particular order; a
window appears that allows editing the discount of the item tier.
Click OK button to save the new discount.

8 APRIL 2016
ENSIM CONFIDENTIAL
263
Click the Continue button to proceed to next step of drafting the order.
Step 2: Contact Details
The details of the account of Organization for which the order is to be placed and the Contact details must
be entered in this step.
The Service Accounts drop down holds the list of accounts held by this organization (Order is placed for a
particular single account of the organization).
10. Enter the Account Details

Select the organization account for which the order is to be placed. The Billable Account corresponding to
the selected Service Account will be displayed. The Billable Account is the account that is payable for the
orders of the Service Account. In other words, if the Billable Account for the Service Account is same as the
service Account then the Billing Address will hold the address of the Service Account else the Billing
Address will hold the address of another account mentioned as the Billable Account of the selected Service
Account.
Enter the Agent Id of the agent to be assigned to this order. This agent will then be able to perform actions
such as upgrade/downgrade/upsize/downsize to this order for the organization (When the agent logs in,
this order will be visible under the Order tab and can perform the permitted actions). The agent
assignment is applicable only when the Service Provider creates the order.
Enter the Order custom number. This is a string value that makes the custom search for this order by the
service provider/reseller user (the provider user who creates the order) more efficient.
Enter the comments if required. This comment might hold the brief description or any information of this
order.
11. Enter the Contact Details
Enter the email address of the Business contact and Technical Contact.
Business Contact: Any one of the organization users of this organization must be appointed as the Business
Contact in order to take the business actions/decisions such as Approve orders (Order approval discusses
in details later). He receives the notifications for Order Approval and Seek Order Approval.
Note: The Business Contact assignment is mandatory.

8 APRIL 2016
ENSIM CONFIDENTIAL
264
Technical Contact: Any one of the organization users of this organization must be appointed as the
Technical Contact.
Note: The Technical Contact assignment is mandatory.
Default technical and business contacts per account

While provider place an order on a particular account, then the account default BC, TC will be populated
under the contact details screen. If default Technical/Business contact is not added in the account level then
organization default Technical/Business contact will be populated under the BC/TC contact details page.
Note: If BC or TC tries to place an order then by default that user should be selected as a default
Technical/Business contact for that particular order though account level default BC or TC is available.
Assigning Business and Technical Contact

The Business Contact window will list the available Organization users of this Organization with the
Business Contact role enabled. Click the desired organization user and click the Assign button.
Click the
button to change the assignment.
The Add User button allows creating a new Organization user. Click the Add User button if there does
not exists any Organization user in this Organization with the Business Contact role enabled or a user
other than those in the list needs to be the business contact. A window for new usercreation opens.

8 APRIL 2016
ENSIM CONFIDENTIAL
265
Enter the details and click Save Changes. A message, User Added successfully is displayed. This user is
then listed in the Business Contact assignment window, as above.
The Business Contact is set for each order and might be different for different orders.
If the Organization has only one user with the Business Contact role enabled during the order creation,
then this user will be involuntarily selected as the Business Contact. If the Business Contact window does
not show any user even if there exists Organization users, it means none of the user has the Business
contact role enabled. In such situation this role needs to be edited (Click Organization link under Entity
tab, search the Organization, click List Users, select the user for Business Contact assignment, click
Permissions button, enable the Business Contact role and click Save Changes).
Note: The logged in user needs to Login again in order to see the changes made in any permission.
The Offer being ordered belongs to a particular Service. If this Service has Provisioning Information
resources (firstName@tc), (lastName@tc), (mobile@tc) of type Free Text; then the information for
Technical Contact will get auto-populated.
Note: Follow the same steps as business contact for assigning Technical Contact.
12. Enter the provisioning information
Step 3: Provisioning Information

Enter the Organization specific information configured in this Offer.

8 APRIL 2016
ENSIM CONFIDENTIAL
266
In the version of EAS 4.0(and prior), order forms already had two custom fields, the visibility of which are managed
through the message.properties file. From EAS, twelve fields (Custom fields) supported. Service provider can
configure the custom fields from Custom Fields section under Configuration menu. The number of enabled
Custom fields will appear under provisioning information tab in order screen, custom fields will also be displayed
in Order PDF and in the notification. Only Service Providers can configure (enable, disable, set mandatory) the
custom fields from Custom fields tabs under Configuration section. Service Provider / Resellers (Type-1 & Type2), Agents provide data on the custom fields. The only difference is that order Custom Fields will have an additional
customization option Visible to Org by which Service Provider can restrict Organization user will to view these
Custom Fields (both read/write by same flag).
a
In Order form the Custom Fields will appears under Provisioning Information tab, if enabled.

8 APRIL 2016
ENSIM CONFIDENTIAL
267
The Service Provider needs to manipulate and configure the custom fields from the configuration section.
Order Association
The order can be associated to the previous provisioned order (of same organization) of same service so that
the same Provisioning Information can be used. The association rule is dependent on the Order Association
Rule configuration at service. Any one of the following rules is selected at Service configuration
Never Associate orders
Always Associate orders
Associate if placed on same private domain name
An Associate Order button will be available if the configured association rule is Associate if placed on
same private domain name.
Note: If the Association rule configured for Service is Associate if placed on same private domain name
then the offer must include the DNS configuration as Organization specific information required at the time
of ordering.
Click Continue button to proceed to next step of order draft.

8 APRIL 2016
ENSIM CONFIDENTIAL
268
Site Address:
In the provisioning information section of the order creation page, a free text field appears if the information
is of type "free text".
This field will automatically adjust into a multi-line text area in case of multiple-lines of information.
Dynamic Order Validation:

If a service ordering is set to be validated at the service level (refer to Dynamic Validation Required section
in the Add Service category) on the PIF entry page of the EAS Order Wizard, when the user clicks the
Continue button, dynamic order validation is performed on order items and provisioning information. This
validation of order item and provisioning information is based on connector supported parameters.

8 APRIL 2016
ENSIM CONFIDENTIAL
269
Step 4: Summary
This is the last step that provides the summary of entered information of Account and Contacts, Item
summary and provisioning information with the Add to CART button to finally draft the order.
13. Click Place Order button.

In the Offer level if the macro called Terms and Conditions is enabled and that macro contains value, then
clicking this button, the content will be displayed in a dialog box with two buttons. They are
Agree
Disagree

8 APRIL 2016
ENSIM CONFIDENTIAL
270
Click Agree to accept the order and save it as a draft. If clicked on Disagree the order page will stay on
the same page and will not commit to database (= no draft order created).
This will be visible to Service Provider, Reseller, Agents and Organization. This will be displayed only in
the following order management use cases,
i.
When a new order is being drafted for the first time
ii.
iii.
When an order is being drafted for upgrade

When the order is being drafted for downgrade
The content will not be displayed for the following use cases will not involve for new offer
i.
Editing a draft
ii.
Upsize draft
iii.
Downsize draft
iv.
Cancelation
v.
All other activities.
The Terms and Conditions macro need to be enabled by the Product Manager set the HTML content. The
macro has a limit of 4000 bytes per language.
If this is not set in offer level, then the order is placed without this dialog box.
The order creation is complete and the order remains in the Draft state.
An Organization can have a limited number of orders for a particular offer. This number is configured at
Maximum number of orders of this offer per organization in offer.
The order must be approved to get provisioned.

8 APRIL 2016
ENSIM CONFIDENTIAL
271
T&C needs to be accepted during order actions like drafting, upsizing, downsizing, upgrading, downgrading etc. in
order screen. Order always displays the latest T&C as pointed by the offer. For each order line, order history page in
UI will keep the reference to the T&C that has been accepted during ordering.
There is an exception for draft mode. If the terms and conditions are changed after placing an order which is in draft
state, then while approving the order user will see the old terms and conditions with which the order was placed
even if the new version is different. The latest terms and conditions are displayed in the order screen.
No abort for drafts

Abort action can be performed for orders in draft/pending approval/approve state. Abort action can also be
performed for trial orders. After the order is aborted, order state will be displayed as Aborted. Abort email
will be triggered to BC,TC and Agent(if assigned) when the order is aborted in pending approval/approve
state. No email will be sent when an order is aborted in draft state.
when the order is rejected in provisioning state order will be reverted back to Draft state and the Abort
button will be available and corresponding email will be sent to BC, TC and Agent (if assigned).
abort in draft state-----------

8 APRIL 2016
ENSIM CONFIDENTIAL
272
abort in pending approval-------------

8 APRIL 2016
ENSIM CONFIDENTIAL
273
abort in approved state---------------

8 APRIL 2016
ENSIM CONFIDENTIAL
274
On receiving the email, the Business contact must click the link in the email and login in to EAS to approve
the order.
8 APRIL 2016
ENSIM CONFIDENTIAL
275
The following window appears when the user clicks on Approve button to directly approve the order
The provider user can choose to approve now or on the date he specifies. This approach is termed as
Moment of Execution. Choose the desired moment for execution of approval and click Approve Now
button.
Note: The Organization user should have the permission to approve the order even if the Organization can
approve configuration is set to true.
A confirmation dialog box appears. Click OK button to finally approve the order and is submitted for
provisioning. The order enters the Approved state.
Click See More button to place another order. Click Exit button if the drafting of order is complete;
redirected to the List Order page.

8 APRIL 2016
ENSIM CONFIDENTIAL
276
Provisioning System ID: The term Provisioning system id is service specific. Therefore, in service level user
can set the proper term of that field and this will be displayed on the order screen.
Order Originator: Originator is the creator of an Order. There are two types of originator; Base Order
Originator and sub order originator.
In the Order details page, the Base Order Originator is displayed.
If Order contains only one order line, then only base order originator will be displayed in Order
History page.
If the Order contains multiple order lines, then both base order and sub order originator will be
displayed in Order History page.

8 APRIL 2016
ENSIM CONFIDENTIAL
277
The life cycle of the order starts when the order is created (placed/drafted). The words create, place and
draft implies same meaning and can be used interchangeably.
The highlighted text in the above screenshot denotes that the order is in Draft state (the configuration for
this order state representation is described in the Order Configuration section).
The order can also be approved/seek approval by clicking the Approve/Seek Approval button in the
above page.
The View button displays the information of installment items
Click the Generate Quote button in the above page to generate an Order PDF.
Search Order
Users can search Order in two ways: Basic Search and Advanced Search.
Basic Search
Basic Order search gives limited options to perform searches. To search an Order follow the
steps below:
1. Click the Orders tab.
2. User will get the following options within basic Order search
Order ID
Subscription ID
Organization ID
Organization Name
Base Order Originator: Originator is the creator of an Order. In this field, the user
can provide last name or email address of Originator to search an Order.
Status
Creation Date (Start Date, End Date)

8 APRIL 2016
ENSIM CONFIDENTIAL
278
Advanced Search
In this case, user will have more search criteria to find Orders. To search an Order follow the
steps below:
1. Click the Orders tab.
2. Click the Advanced search button to search the Order with additional information.

8 APRIL 2016
ENSIM CONFIDENTIAL
279
There are few changes in advanced search for EAS
Organization Name/ID: Order Search will be done with Organization Name and
Organization ID also.
Service Provider can search own orders and orders of Resellers and Agents
Specific Reseller ID: In EAS, a new criteria is added (Reseller ID) while choosing Specific
Reseller from Service Providers advance search
Sales Representative ID: User can search Orders that are associated with Sales
Representative ID.
Offer Name: In EAS beside this Offer name text box an Offer name selector is available in
two types of scenarios:
i.
User can type Offer name with text box
ii.
User can click that Offer selector and choose proper Offer

8 APRIL 2016
ENSIM CONFIDENTIAL
280
Clicking Offer name selector and a window will appear.
By default, all the offers with category will be listed alphabetically. User can choose Offer
by writing the Offer name and search. The particular Offer will be displayed with its
category.
Status: User can select status (such as Upsized, Downsized, Provisioned failed etc.) of
Order for searching.
Base Order Originator: Order search will be done based on Order Originators
o Last Name

8 APRIL 2016
ENSIM CONFIDENTIAL
281
Email address
Subscription Period: Users can Search by Subscription Period with 1 year, 2 years etc. A
text-box, which allows numeric values along with a drop down list, will be displayed for
this. The list drop-down options will be months, years.
Search by Date and Relevance: Order Search will also be done for Orders whose
anniversary date is within a range of 2 dates, Start Date and End Date respectively.
User can search by the following criteria:
1. Date of Approval
2. Billing Start Date
3. Provisioned Date
4. Date Of Cancellation
5. Date Of Creation
6. Date Of Migration
7. Subscription Started
8. Subscription Ended
Provisioning Information (PI): If Offer is selected by Offer name selector then two
scenario will happen
Case 1. The Offer is having provisioning information
Case 2. The Offer does not have any provisioning information
For Case 1, field will visible named as Provisioning information. All Provisioning
Information will visible within dropdown.
If PI other than Boolean type is selected, a text box will appear which is of type free text.
For Case 2 where Boolean type PI is selected, a check box will appear which accepts
either selected or unselected value.
Search Migrated Orders, Show Hidden Orders and Trial only: In EAS user can search
Migrated Orders, Hidden Orders and Trial Orders.

8 APRIL 2016
ENSIM CONFIDENTIAL
282
Edit Order
The Edit button appears when the order is in transient state.
Ordering offers having Item groups

Case 1: Creating an Order
While placing such an order involving offers containing groups the default item of the group is displayed
on the page with the change button. But, on clicking the change button, a dialog box appears having all the
items in that group (item names are displayed in that dialog box). Once one of the items is selected, the
dialog box closes and the existing group item on the page is replaced by the selected item.
Case 2: Editing an Order
An ordered item from a group can be replaced by another item in the same group for orders only in the
draft state.
Case 3: Upsizing or Downsizing an Order
Ordered item from a group cannot be replaced by any other item in that group once the order is
provisioned, however, the ordered item could be upsized /downsized just like any other order items.
Case 4: Upgrading or Downgrading an Order
If an order with an offer is having a product group with Item1 and Item2 and Item 1 is selected and
provisioned, then there are following probabilities 4a. If the to be upgraded/downgraded offer has a group with item1 in it then the upgrade/downgrade
order can continue with item1 with purchased quantity populated default or user can select another
item from the group (New quantity is to be selected if required)
4b. If the to be upgraded/downgraded offer does not have any group but item1 is present then the
upgrade/downgrade order can continue with item1 with purchased quantity populated default (New
quantity is to be selected if required)
4c. If the to be upgraded/downgraded offer has a group with no item1 in it and the offer does not have
a standalone item1 then the upgrade/downgrade order should discontinue item1.
4d. If the to be upgraded/downgraded offer has a group with no item1 in it but the offer have a
standalone item1 then the upgrade/downgrade order should continue with item1 with purchased
quantity populated default (New quantity is to be selected if required).

8 APRIL 2016
ENSIM CONFIDENTIAL
283
Ordering offers having Add-On Items

Case 1: Creating an Order with the rule Specified at the time of Ordering. While placing an order on the
offers containing this rule, the secondary item can be purchased only if the primary item is purchased.
However, according to the rule, there is no restriction for the quantity of secondary items.
Case 2: Creating an Order with the rule Can be less than or equal to n times the quantity of Primary Item.
While placing an order, on the order wizard, the quantity of the secondary item can be keyed between 0 to
n*primary quantity. For example, if the primary item is Google apps seats and the secondary item is
postini service, where value of n = 5 as set in the offer level, on the order wizard, the quantity of the
postini sevice to be purchased can be 0 to 25, according to the rule 0 to n*x (where Google apps seats
quantity is 5).

8 APRIL 2016
ENSIM CONFIDENTIAL
284
Case 3: Creating an Order with the rule Must be equal to n times the quantity of Primary Item. While
placing an order on the order wizard, the quantity of the secondary item cannot be keyed in. However, the
number of secondary items is n*primary quantity. For example, if the primary item is Google apps seats
and the secondary item is postini service, where value of n = 5, on the order wizard, the quantity of the
postini service displays 25 according to the rule n*x (where Google apps seats quantity is 5).
Case 4: Creating an Order with the rule Can be less than or equal to n. While placing an order on the
order wizard, the quantity of the secondary item can be keyed in. However, the number of secondary items
is 0 to n. For example, if the primary item is Google apps seats and the secondary item is postini service
where value of n = 5, on the order wizard, the quantity of postini service to be purchased can be 0 to 5
according to the rule 0 to n, irrespective of the quantity of Google apps seats.

8 APRIL 2016
ENSIM CONFIDENTIAL
285
Case 5: Creating an Order with the rule Must be equal to n automatically added at the time of Order and
subsequent Order Action. While placing an order on the order wizard, the quantity of the secondary item
cannot be keyed in. However, the number of secondary items is n. For example, if the primary item is
Google apps seats and the secondary item is postini service where value of n = 5, on the order wizard,
the quantity of the postini service displays 5 according to the rule n, irrespective of the quantity of Google
apps seats.
Upsizing of one-time Item (Independent item): One-time items can be upsized at any time. The operation
Downsize is not applicable to one-time items. The invoice once paid cannot be refunded, as the service has
been already delivered.

8 APRIL 2016
ENSIM CONFIDENTIAL
286
Upsize of dependent one-time Items: Upsize of one-time item can be linked to a primary item. Downsize is
not applicable to one-time items. Consider the example of a User Seat product that has a recurring charge
and a one-time configuration charge. In EAS, two items are created and linked as described above. Rule set
in the offer level as Must be equal to n Automatically added at the time of order and subsequent order
action. Using this rule, the secondary item is added irrespective of the primary quantity, where value of
n = 5.
Example:
1. Primary Item: User Seat - $10 / seat / month
2. Secondary Item: Setup Charges - $5 / seat, one-time.
An order of 10 seats Primary item is placed.
1. 10 * $10 = $100 / month
2. 5 * $5 = $25, one-time
Later, it is upsized to 15 (incremented by 5). The following additional costs are borne by the buyer due to
the upsize:
1. 5 * $10 = $50 / month
2. 5 * $5 = $25, one-time
The order wizard displays both increments $50 for monthly recurring charges and $25 for one-time.
Downsize of dependent one-time Items: the buyer decides to downsize the seats to 12. However, the
following is displayed to the user on the order page:
1. 3 * $10 = $30 / month for primary item (Reduction)
But there should not be any reimbursement of 5 * $5 for the one-time secondary item. The Order page
should not display any changes for the one-time secondary item. The Order page displays 10 as the quantity
against the one-time item.
Provisioned order:

8 APRIL 2016
ENSIM CONFIDENTIAL
287
Upsizing order:
Order PDF
The Orders in EAS can be viewed or downloaded as a PDF and printed. EAS uses Jasper reports library to
render the PDF. The look and feel of the PDF can be customized in Jaspersoft Studio.
User could download order PDF only in draft state. EAS 4.2 onwards, user can download order PDF for all
order states. The System Configuration chapter describes how this feature can be enabled or disabled per
Order state. The BC of an order will always see a button to download the PDF while other users need
Create Order permission to perform this task. The name of the buttons are also configurable.

8 APRIL 2016
ENSIM CONFIDENTIAL
288
The PDF can be generated by clicking the Generate Quote (text of this button is configurable), which is
present on the right pane of the list order page as shown below:

8 APRIL 2016
ENSIM CONFIDENTIAL
289
Order PDF sample is as follows:

8 APRIL 2016
ENSIM CONFIDENTIAL
290
Note: The Generate Quote button will not be available for the draft order if the order is placed for Trial.
To generate the PDF for trial order enable the option Enable for Trial in the configuration page.
Order PDF sample with differential quantity is as follows:

8 APRIL 2016
ENSIM CONFIDENTIAL
291
Impact of Subscription
1) Once provisioned, Order summary page will show the subscription info i.e. subscription end date
(this time calculated w.r.t. the start date) and a button to decide what to do with the subscription
after the period = renew or cancel.
2) Downsize and Downgrade is not allowed for the subscribed order from the end user side.
3) Downsize and Downgrade is allowed for the subscribed order from the SP side.
4) Organization can upsize / upgrade with immediate effect, after the Order is provisioned. This
operation can be performed anytime during the period.
5) A flash message will be available in order summary page containing the subscription details like
start date, end date for the end customer users.

8 APRIL 2016
ENSIM CONFIDENTIAL
292

8 APRIL 2016
ENSIM CONFIDENTIAL
293
6) After subscription period, the order should be cancelled or renewed depending on the
enforcement rule (auto cancel / auto renewed).
The page displays the renewed offer:
The page displays the cancelled order:

8 APRIL 2016
ENSIM CONFIDENTIAL
294
View Usage of Resources

The View Usage button will appear for a particular Order, if the View Service Usage right is enabled.
View Usage button will appear for a particular Order in its Order Details section as follows:
Note: For Order states Draft, Approved, Provisioning, Submit for Approval and Abort, the View Usage
button will not appear.

8 APRIL 2016
ENSIM CONFIDENTIAL
295
Clicking View Usage button will redirect to a new tab that displays resource specific Usage either in
monthly basis or in between start date and end date. User can view Usage in two different mode; Tabular
and Graphical.
Graphical Monthly Usage view:
Graphical Monthly Usage view:
Note: To get the Usage view, the ordered resource must have usage quantity available in EAS database.
Monthly Usage View support for last 3 months.

8 APRIL 2016
ENSIM CONFIDENTIAL
296
Provisioning Operations
The Organization user might require making changes to the order, like changing the quantity of the Items
or move to another Offer. Buttons are made available on the order page to perform these operations.
The following actions can be performed to make changes to the order
1.
Upsize: Upsize means increase the quantity of items in the offer ordered. You can upsize items of
Reserved, One Time, and Installment types.
2.
Downsize: Downsize means decrease the quantity of Items in the order. This action can be
performed only by the Provider (Service Provider/Reseller) and Agent of the Organization.
Note: The Upsize/Downsize actions are possible (respective buttons will be available on the order details
page) only if the offer ordered has the permission for these individual actions.
3.
Upgrade: means upgrading the ordered offer to another offer of higher upgrade weight. Here, the
offer changes (upgrades) whereas, the order remains same.
4.
Downgrade: means downgrading the ordered offer to another offer of lower upgrade weight. Here,
the offer changes (downgrades) whereas, the order remains same.
5.
Cancel: means stop the provisioning of service.
6.
Suspend: means stop the provisioning of service temporarily.
7.
Resume: means resume the suspended provisioning of service.
The Abort action (not a provisioning operation) can be performed only until the provisioning of the order
has not begun.
Note: The opportunity to perform these actions completely depends on the status of the order. The detailed
description of the order states is done in the Order states section.
Configure provisioned Orders

The Configure button will appear once the order is provisioned. User can configure the ordered service.

8 APRIL 2016
ENSIM CONFIDENTIAL
297
The Configure button redirects the user to the corresponding connector self-service UI.

8 APRIL 2016
ENSIM CONFIDENTIAL
298
Order States
The order undergoes multiple state changes during its life cycle. Some state changes depend on the possible
changes made to the order. There are in total 43 order states. The order states are named in a fashion such
that the name itself helps to understand the order behavior. The states can be grouped, based on the naming
pattern as tobe-, -ing, -ed prefixed/post fixed to the actions described above.
When the user performs some actions (changes) on the order, the order enters the tobe-action state. The
BPT jar picks the orders in these states and changes the state to -ing state. The BPT jar changes the -ing
states to -ed state once the provisioning process completes.
These states can be grouped, based on the stability, into the following
1. Start state:
The life cycle of the order starts in this state. It is the initial state of the order. Every order begins with this
state as soon as the user places the order. The Draft state is the start state.
2. Draft states:
When Upsize/Downsize/Upgrade/Downgrade action is performed, the order enters the corresponding draft
states and awaits the approval procedure.
e.g. Upsize Draft state
3. Approval pending states:
The order enters this state when the Seek Approval request is sent and remains in this state until approved
by Business Contact/Assigned person. This state is bypassed if the direct approval is performed.
e.g. Upsize Approval Pending state
4. TO-BE states:
The names of the intermediate state have tobe- as prefix. The tobe- prefix denotes that the draft order has
been approved and the order is waiting to be picked by the Background Provisioning Task (BPT). The BPT
changes the order state to the fixed next corresponding state, an Intermediate state. The user can only
Cancel the order when his order is in this state. No other action can be performed on the order when the
order is in the intermediate state until it reaches the next stable state.
e.g. to be Upsized state
For example: An order in Upsizing state cannot make transition to Suspended state, until it reaches the
Upsized state.
5. ING/Intermediate state:
The names of the ING state has -ing as the postfix. The -ing postfix denotes that the BPT had picked the
order and the process of applying the changes is in progress. The orders in these states have a fixed next
state. The Reject to Draft and View History buttons will be available when the order is in Intermediate
state such as provisioning, downsizing, downgrading, upsizing and upgrading. These use cases are valid
only for fully manual workflow.
e.g. Upsizing state
6. Stable states:
The user can make changes to the order only when the order is in stable state.
8 APRIL 2016
ENSIM CONFIDENTIAL
299
The names of the stable states has -ded postfix. This postfix denotes that the requested action on the order
has been successfully completed. The following actions can be performed only when the order is in a stable
state
a. Upgrade
b. Downgrade
c. Upsize
d. Downsize
Note:
The Aborted and Approved state cannot be termed as a Stable state because it appears in the order
life cycle before the initial provisioning of the order.
The Failed state is not a proper Stable state because it appears in the order life cycle due to failure in
provisioning process and therefore is a Failed state.
The Cancelled state is not a proper Stable state because it appears in the order life cycle due
removal of order data and therefore is a Final state.
to
The Suspended state is not a proper Stable state because the provisioning is discontinued until the
order is resumed.
e.g. Upsized state
5. Failed states:
The order enters the failed state when the provisioning of the order fails. The Undo button made available
on the order page helps the order to re-enter the last previous stable state.
e.g. Upsize Failed state
6. Final states:
It is the last state of the order life cycle. No state transition is possible after this state. The order life cycle
ends in this state. The Cancelled state is the Final state.

8 APRIL 2016
ENSIM CONFIDENTIAL
300
The list of states in EAS are enumerated in the following table
Order Status Id
3
4
5
6
7
8
9
10
11
12
13
14
15

8 APRIL 2016
Order Status Code
Description (state type, action performed, fixed

next state)
Draft(S1)
This is a Start state. Denotes that user has placed

the order. The order remains in this state until
approved. The order can be edited (without any
state change).
Approved (S2)
To be cancelled (S3)
Cancelling (S4)
Cancelled(S5)
Provisioning(S6)
Provisioned(S7)
To be suspended(S8)
Suspending(S9)
Suspended(S10)
To be resumed(S11)
Resuming(S12)
Resumed(S13)
To be upsized(S14)
Upsizing(S15)
Denotes that the order has been approved and

ready for the initial provisioning. The order can
either be Aborted or enter the Provisioning state.
This is a TO-BE state. Denotes that the order
cancel action has been performed.
This is an Intermediate state. Denotes that the
cancellation process is in progress.
This is a Final state. Denotes that the order has
been cancelled. The order finally dies. The data
retention period is expired and therefore the
order data has been removed.
initial order provisioning process is in progress.
This is a Stable state. Denotes that the initial order
provisioning is completed, order has been
successfully provisioned.
This is a TO-BE state. Denotes that the action to
suspend the order has been performed.
order suspension process
Denotes that the order has been successfully
suspended for the duration until it resumes.
This is a TO-BE state. Denotes that the action to
resume the suspended order has been performed.
process for resuming the suspended order is in
progress.
This is a Stable state. Denotes that the suspended
order has been resumed.
upsize has been approved and is waiting for BPT
for provisioning the upsize request.
process of upsizing the order is in progress.
ENSIM CONFIDENTIAL
301
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

8 APRIL 2016
Upsized(S16)
Provisioning failed(S17)
To be upgraded(S18)
Upgrading(S19)
Upgraded(S20)
To be downgraded(S21)
Downgrading(S22)
Downgraded(S23)
Suspended for
cancelation(S24)
Suspended for
Cancelling(S25)
Upsize draft(S26)
Upsize failed(S27)
Upgrade failed(S28)
Downgrade failed(S29)
Upgrade draft(S30)
Downgrade draft(S31)
Approval pending(S32)
Upsize approval
pending(S33)
This is a Stable state. Denotes that the order had

been successfully upsized.
This is a Failed state. Because of unsuccessful
completion of the provisioning, the order goes to
the Provisioned Failed state. The retry button
makes transition to the Approved state.
upgrade has been approved and is waiting for
BPT for provisioning the upgrade request.
process of upgrading the order is in progress.
been successfully upgraded.
downgrade has been approved and is waiting for
BPT for provisioning the downgrade request.
process of downgrading the order is in progress.
been successfully downgraded.
This is a Stable state. Denotes that the data
retention period of the order has expired.
data retention period of the order has expired and
the process of removing the order data is in
progress.
This is a Draft state. Denotes that the upsize
action has been performed and the order upsize is
to be approved.
This is a Failed state. Denotes that the upsize
provisioning process has failed.
This is a Failed state. Denotes that the upgrade
This is a Failed state. Denotes that the downgrade
This is a Draft state. Denotes that the upgrade
action has been performed and the order upgrade
is to be approved.
This is a Draft state. Denotes that the downgrade
action has been performed and the order
downgrade is to be approved.
This is an Approval Pending state. Denotes that
the action, Seek Approval for initial provisioning
has been performed.
the action, Seek Approval for upsizing the order
has been performed.
ENSIM CONFIDENTIAL
302
34
Upgrade approval
pending(S34)
35
Downgrade approval
pending(S35)
36
37
38
39
40
41
42
43
Aborted(S36)
To be downsized(S37)
Downsizing(S38)
Downsized(S39)
Failed(S40)
Downsized Draft(S41)
Downsized Failed(S42)
Downsize approval
pending(S43)

the action, Seek Approval for upgrading the
order has been performed
the action, Seek Approval for downgrading the
order has been performed.
Denotes that the drafted order has been aborted.
The order can only be edited. On edit, the order
enters the Draft state.
downsize has been approved and is waiting for
BPT for provisioning the downsize request.
process of downsizing is in progress.
been successfully downsized.
This is a Failed state. This state is reached from
the Suspending/Resuming/Suspended for
Cancelling states due to unsuccessful process.
This is a Draft state. Denotes that the downsize
action has been performed and the order
downsize is to be approved.
This is a Failed state. Denotes that downsize
the action, Seek Approval for downsizing the
order has been performed.
The order undergoes multiple state changes during its life cycle. The order state transitions are described in
detail in the Order state transition description section.

8 APRIL 2016
ENSIM CONFIDENTIAL
303
The Provisioning Workflow decides the level of automation for the provisioning process. The provisioning
process takes place when the Provisioning Operations are performed. The level of automation depends on
the API calls available for the provisioning operations. The availability of API calls denotes that the
provisioning for that operation is Automated. The notifications will be sent to the respective Technical
Contact/Business Contact whenever the API call is not available (Manual). To view the Provisioning
Workflow Configuration, click the Provisioning Workflow link on the Configuration tab.
Select the required provisioning workflow from the drop-down to view the configured details of that
workflow. The table under the drop-down describes the properties for each provisioning operation for that
provisioning workflow. The Properties Information window explains the value entered for the properties
for the individual provisioning operation.
Note: The Provisioning Workflow to be followed for order provisioning depends on the Offer ordered. The
provisioning Workflow is associated to the Offer during Offer creation.
Moment of Notification: Denotes the day of month at which the notification will be sent for the particular
provisioning operation. The Send on column holds one of the three types of parameters to denote the day
for advance notification as follows

8 APRIL 2016
ENSIM CONFIDENTIAL
304
Zero - Indicates that the email will be sent without any delay.
Positive value - indicates that if the provisioning operation completes on or before that day of the month,
notification will be sent immediately. Otherwise, it will be sent at the beginning of the next month .e.g., if
the value is 25, then notification for all the order that are provisioned on or before 25th day of that month
will be sent immediately; else at the beginning of next month.
'Not available' denotes that there is no moment of notification as send notification is false. The three types of
Provisioning Workflow are as follows
1.
Fully Automated:
It is to be used for services that are fully API integrated with EAS using service connectors. Ensim
has fully integrated solution for services like Hosted Exchange, Sharepoint, EMC Mozy,
Broadworks etc. If you are using this workflow, billing for the order will be started as soon as the
order action is performed.
The API calls for all the provisioning operations are available. Notifications will not be sent.
Deferred billing is not required. The advance notification will be sent 5 days before the end of that
month.
2.
Fully Manual:
It is to be used for services that are not integrated with service connectors. Therefore these services
are to be provisioned externally. Notifications will be sent out by the system for order actions
performed in the portal. Billing will not be started until the order action is manually marked as
completed in the portal.
The API calls for all the provisioning operations are not available. Notifications for all the
provisioning operations will be sent. Deferred billing is not required. The advance notification will
be sent 5 days before the end of that month.

8 APRIL 2016
ENSIM CONFIDENTIAL
305
3.
Semi-Automated Workflow1:
This use case is for services that can be automatically provisioned for the first time but successive
operations can't be performed for lack of API integration. The provisioning action will not be
notified. The rest of the operations will be notified.
The API call is available only for the Provide provisioning operation (Automated). The rest
provisioning operations are Manual (API calls unavailable). Notification will be sent only when the
Provide provisioning operation has been performed. The advance notification will be sent 5 days
before the end of that month.
4.
Semi-Automated Workflow-2:
This use case is for fully API integrated services that require some manual configuration like DNS,
Firewall, or even a training program to start consuming the service and until then, billing should
not be activated.
The API calls for all the provisioning operations are available. Notification is sent only for provide
provisioning operation. Deferred billing is required only for provide operation. The notification
will be sent immediately after provisioning.

8 APRIL 2016
ENSIM CONFIDENTIAL
306
5.
Semi-Automated Workflow-3:
This use case is for fully API integrated services that require some manual configuration or even a
training program to complete the fulfillment but billing should start as soon as provisioning API
call is completed.
The API calls for all the provisioning operations are available. Notification is sent only for provide
provisioning operation. No Deferred billing required. The notification will be sent immediately
after provisioning.
The Provisioning Workflow is configured at the Offer level under the Provisioning Workflow
section during creation of Offer.
Note: The order follows the Provisioning Workflow of the offer over which the order has been placed.

8 APRIL 2016
ENSIM CONFIDENTIAL
307
Order Approval
There are three ways for approving an order.
1. Organization must approve
2. Provider must approve
3. Both, Organization and Provider, must approve
Organization must approve
The Provider user, on login, can see Approve as well as Seek Approval button for the draft order. Click
the Approve button to directly approve the order or the Seek Approval button to seek the Organization
Business Contacts (BC) approval. A notification for seek approval for the order is sent to the BC. The order
state changes from Draft to Approved on approval and Draft to Pending Approval on seek approval.
The Organization user, after login, can see an Approve button. Click the Approve button to approve the
order. The order state changes from Draft to Approved.
Provider must approve
The Provider user, on login, can see an Approve button for the draft order. Click the approve button to
approve the draft order. The order state changes from Draft to Approved.
The Organization user, on login, can see Seek Approval button. Click the Seek approval button to send
approval request at the email address set at the offer level Approval workflow configuration. The order
state then changes from Draft to Pending Approval. Notification is sent to BC of the Organization as well
as at the email set at the offer level approval workflow configuration.
The Provider user, on login, can see a Approve button. Click the Approve button to approve the order. The
order state changes from Draft/Pending Approval to Approved.
Both, Organization and Provider must approve
This approval procedure does not include Seek Approval button. Both organizations, on login, can see an
Approve button. Whichever user (Organization/Provider user) approves first, the order state changes from
Draft to Pending Approval. On approval of the remaining user, the order state changes from Pending
Approval to Approved.

8 APRIL 2016
ENSIM CONFIDENTIAL
308
Order Approval Workflow

UI Enhancement in order approval workflow: New buttons have been added for ease of approval process.
EAS has addressed the inconsistencies that existed in previous versions where only first draft orders were
allowed to be approved from inside the order screen. Edit orders, up-/down-size of orders and up-/downgrade of order workflows were incomplete in this regard. EAS addresses all these to make the approval
workflow consistent throughout the order life cycle. Refer to the following workflow diagrams for further
illustration:
In order UI:
Approval workflow without one-off discount
A. Approver type : Provider only
1.
Provider non-approver
a. Create order
Organization approvers options when clicked on Save as Draft button:
Can find the order in pending order list (for organization approver, the draft orders and
pending for approval type orders are listed).
Can edit the order.
Can seek Service Providers approval.

8 APRIL 2016
ENSIM CONFIDENTIAL
309
Organization approvers options when clicked on Submit for Approval button:
b.
Can find the order in pending order list.

Cannot edit the order.
Edit

Can edit the order.
2.

Provider approver
a. Create

8 APRIL 2016
ENSIM CONFIDENTIAL
310

Can edit the order.
Organization approvers options when clicked on Place Order button:
b.
The order will not be listed in pending order list.

Until the order is provisioned, no modifications will be allowed.
Edit

8 APRIL 2016
ENSIM CONFIDENTIAL
311

Can edit the order.
Organization approvers options when clicked on Place Order button:
The order will not be listed in pending order list (the default list of pending orders only
displays draft and pending approval orders).
B. Approver type: Organization only

3.
a. Create

8 APRIL 2016
ENSIM CONFIDENTIAL
312
Can find the order in pending order list (for organization approver, the list of drafts and
pending approval orders will be displayed).
Can edit the order.
Can approve the order.
b.

Edit

8 APRIL 2016
ENSIM CONFIDENTIAL
313

Can edit the order.
4.

Provider approver
a. Create

8 APRIL 2016
ENSIM CONFIDENTIAL
314

Can edit the order.

Organization approvers options when clicked on Approve button:
b.

Edit

8 APRIL 2016
ENSIM CONFIDENTIAL
315

Can edit the order.



8 APRIL 2016
ENSIM CONFIDENTIAL
316
C. Approver type: Both Provider and Organization must approve

5. Provider non-approver
a. Create

Can edit the order.
Can complete organization part of approval for the order.
i.
This will notify Service Provider for final approval. Sales Representative needs to
be ccd so that SR is aware of the changes made by the organization.
ii.
Order state will be changed from DRAFT to PENDING APPROVAL.
b.

Need to wait until Service Provider approves the order. Organization approver can perform
the final approval.
Edit

8 APRIL 2016
ENSIM CONFIDENTIAL
317

Can edit the order.
i.
This will notify Service Provider for final approval. Sales Representative needs to
be ccd so that SR is aware of the changes made by the organization.
ii.
6.

Need to wait until Service Provider approves the order. Organization approver can perform
the final approval.
Provider approver
a. Create

8 APRIL 2016
ENSIM CONFIDENTIAL
318
Can find the order in pending order list (for organization approver, the draft and pending
approval orders are listed).
Can edit the order.
i.
This will notify Service Provider for final approval.
ii.
Organization approvers options when clicked on Approve and Submit button:

Can complete organization part of approval for the order
i.
This would change the order state from PENDING APPROVAL to APPROVED.


8 APRIL 2016
ENSIM CONFIDENTIAL
319
b.
Edit
Can find the order in pending order list (for organization approver, the draft and pending
approval orders are listed).
Can edit the order.
iii.
iv.
Organization approvers options when clicked on Approve and Submit button:

Can complete organization part of approval for the order
ii.
This would change the order state from PENDING APPROVAL to APPROVED.

8 APRIL 2016
ENSIM CONFIDENTIAL
320

Approval workflow with one-off discount

D. Approver type : Provider only
7.
a. Create
Organization approvers options when clicked on Save as Draft button or Submit for Approval
button:
Cannot find the order in pending order list.


8 APRIL 2016
ENSIM CONFIDENTIAL
321
Note: A Provider approver whose discount limit is greater than the orders discount
will get an additional button labelled as Deny Discount in the order details page. The
button will enable the provider approver to deny the approval request and send the
order to draft, additionally this will end an email to the submitter. User can always
click the Approve button to approve the order with given discount and submit for
provisioning.
b.
Edit
button:
8.

Provider approver
a. Create

8 APRIL 2016
ENSIM CONFIDENTIAL
322
Organization approvers options when clicked on Save as Draft button or Place Order button
with more than 5% discount:

Organization approvers options when clicked on Place Order button with less than or equal to
5% discount:
Cannot find the order in pending order list (the default listing of pending orders only
display draft and pending approval orders).

8 APRIL 2016
ENSIM CONFIDENTIAL
323
b.
Edit
Organization approvers options when clicked on Save as Draft button or Place Order button
with more than 5% discount:


8 APRIL 2016
ENSIM CONFIDENTIAL
324
Organization approvers options when clicked on Place Order button with less than or equal to 5%
discount:
Cannot find the order in pending order list (the default listing of pending orders only
display draft and pending approval orders).
E. Approver type: Organization only

9.
a. Create
button:



8 APRIL 2016
ENSIM CONFIDENTIAL
325
b.
Can approve the order and send it to provisioning.
Edit
button:


10. Provider approver

a. Create
8 APRIL 2016
ENSIM CONFIDENTIAL
326
button with more than 5% discount or clicked on Approve button with more than 5% discount:

Organization approvers options when clicked on Submit for Approval button with less than or
equal to 5% discount:


8 APRIL 2016
ENSIM CONFIDENTIAL
327
Organization approvers options when clicked on Approve button with less than or equal to 5%
discount:
b.

Edit

8 APRIL 2016
ENSIM CONFIDENTIAL
328
Organization approvers options when clicked on Submit for Approval button with less than or

discount:
F.

Approver type: Both Provider and Organization must approve

11. Provider non-approver
a. Create

8 APRIL 2016
ENSIM CONFIDENTIAL
329
button:
b.

Edit

8 APRIL 2016
ENSIM CONFIDENTIAL
330
button:

12. Provider approver

a. Create

8 APRIL 2016
ENSIM CONFIDENTIAL
331
Organization approvers options when clicked on Save as Draft button or Approve and Submit

Organization approvers options when clicked on Approve and Submit button with less than or


8 APRIL 2016
ENSIM CONFIDENTIAL
332
discount:
b.

Edit

8 APRIL 2016
ENSIM CONFIDENTIAL
333

Can edit the order
i.
ii.

8 APRIL 2016
ENSIM CONFIDENTIAL
334
Organization approvers options when clicked on Approve and Submit button with less than or

i.
Order state will be changed from PENDING APPROVAL to APPROVED.
Organization approvers options when clicked on Approve and Submit button with more than 5%
discount or clicked on Approve button with more than 5% discount:

discount:

Multilevel Approval Workflow

Order approval workflow can now have multiple steps each of which is to be performed by either the Provider or
the Organization users. The number and the sequence of steps can be defined by the Provider. A group of users can
be assigned to be the owner of the steps and email distribution lists can be configured to notify the approvers to
perform required actions on the orders.
These are the steps to configure a multi-level approval workflow:
1.
Define a group of users
2.
Create approval workflow with approval steps
3.
Associate approval workflow with offer
User Group Creation

Follow the steps below to configure user groups:
1.
2.
3.
Navigate to My Organization menu from the Entities tab

Click Add User Group button and then click Add New Group button to add or update user
groups.
Fill in the required details such as, Group Name, Group Code, Description, Broadcast Email List.

8 APRIL 2016
ENSIM CONFIDENTIAL
335
4.
5.
In the add users to group section all the Service Provider users will be listed. Click in + button to
add the users or delete icon to remove a particular user from the user group.
Click Save button.
To view the list of added users, click the Users added link.
You can search by group name, email address.

Note: For details on Approval Workflow creation, refer to System Configuration.

8 APRIL 2016
ENSIM CONFIDENTIAL
336
Approval workflow association with Offer

Approval workflow: An order needs to be approved before it gets fulfilled. Approval Workflow determines
who can approve the order (per step basis) and whom to notify for seek approve/approve action (for each
step).
In EAS, approval workflow settings can be done from this section
Attached Workflow: This is the place in offer form where you attach an approval workflow to the offer.
Select the appropriate workflow from the dropdown list to attach it to the offer. The selected workflow
details are displayed along with the approval steps in the Attached Workflow Details section.
Approval Notification DL: This email address will be notified when the approval step does not have a
group code assigned to it, or it has a group code without a DL. This email address will be cc'd whenever an
organization-type step completes. Also, this email id will be cc'd in the email to order's Business Contact
(BC) for the final approval step.
Language: Drop-down box containing list of all the enabled languages with default EN (English) selected.
After clicking the View notification template, it is redirected to the sample template of the notification to
be sent to the organization.
Set approval threshold time: if this field is enabled, then Order must be approved within field will
appear where the provided can set a time span in hours for each offer. The system will reject the order if the
order is not approved within the given time period.

8 APRIL 2016
ENSIM CONFIDENTIAL
337
Approval workflow in action

For the above example, if the Organization approver places an order and checks it out from his cart, the first
approval step Approval by Organization will be completed and order state will become pending
approval. An email will be sent to the Service Provider DL requesting to approve the next step.
Service Provider then need to log in to EAS and approve the order, finishing the last step which will finally
approve the order and send for provisioning. Order approval email will be triggered to orders BC, TC,
agent (if assigned), sales representative (if assigned) and offers Approval Notification DL will be ccd in the
email to BC.

8 APRIL 2016
ENSIM CONFIDENTIAL
338
Un-Approve/Reject Order Back to Draft:

8 APRIL 2016
ENSIM CONFIDENTIAL
339
Un-approve button will be available for all pending approval states. Note that, the label Un-approve
could be changed to a more suitable term without affecting the Un-approve button that appears in
Approved and to be states.
If any of the approvers rejects the Order with rejection comments, then the order will be reverted back to
Draft state and the comments will be sent in notification.

8 APRIL 2016
ENSIM CONFIDENTIAL
340
Approval Completion Status: Line Graph

Order approval status can be viewed from the order history and order details pages. It is represented as
linear graph with spherical symbols representing each approval step: blue for completed step and grey for
incomplete steps. Approval comments will be displayed for each completed steps (if exists) by hovering
over it.

8 APRIL 2016
ENSIM CONFIDENTIAL
341
Approval completion status does not appear for single level approval workflows and for the cases when
number of approval steps exceeds five.
Provisioning Operations on Order

The provisioning operations like upsize/downsize/upgrade/downgrade can performed on an order only
when the order is in a stable state. The corresponding buttons are available on the order screen
The button is available only if the corresponding configuration for the action is set at the offer level.
For example, the upsize is allowed whereas downsize is not allowed because the offer is configured
accordingly.
Click the Upsize button to upsize the order. Alter the quantity as desired and continue with the procedure.
After performing an action, the order enters an Intermediate state.
If the Provisioning workflow is automated (API call available), the order waits for the scheduled
Background Provisioning Task jar that performs the provisioning process.
If the Provisioning Workflow is manual (API call not available), the order details page hold a button for
manual provisioning. For example, the following page displays the Mark as provisioned button to
manually change the order state from 'Provisioning' to 'Provisioned'.

8 APRIL 2016
ENSIM CONFIDENTIAL
342
Click the Order history button to view the order history

8 APRIL 2016
ENSIM CONFIDENTIAL
343
If the Provisioning Workflow is Semi-Automated Workflow-2, and Deferred Billing is required, provider
user must login and click Initiate Billing to start the billing for the order. Billing can be started from the
current date or from a specific date in future.
In EAS for BPA specific order, click the Confirm Order icon in the provisioning state and provide the
values as shown below-

8 APRIL 2016
ENSIM CONFIDENTIAL
344
The username, password and the link will be sent to the TC of the specific order via mail.

8 APRIL 2016
ENSIM CONFIDENTIAL
345
A diagrammatic representation of the order states and the state transitions is given bellow

8 APRIL 2016
ENSIM CONFIDENTIAL
346
Order State Transfer Description
The life cycle of an order starts when a Offer is ordered. The state of the order is the Draft state when the
order is placed. The drafted order needs to be approved. If the user approves (had permission to directly
approve the order), the order enters the Approved state until provisioning process begins. And if the user
does not have the permission to approve the order, the user seeks approval, the order enters the Approval
pending state. The Business Contact approves the order and then the order enters the Approved state.
The BPT jar lifts the order in Approved state and changes the order state to Provisioning state.
If the API for the provide provisioning operation is available then the BPT jar completes the provisioning
process and changes the order state to Provisioned, else the service provider has to explicitly click the
Mark as Provisioned button made available on the order details page in case of manual provisioning (API
for provide operation not available). If the successful completion of provisioning fails, the order enters the
Provisioning failed state. A Retry button is made available on the order details page. Clicking the Retry
button to change the order state to Approved so that the process of provisioning can be repeated.
The user can abort the order when the order is in Draft, Approved or Pending approval state. If aborted,
the order enters the Aborted state.
8 APRIL 2016
ENSIM CONFIDENTIAL
347
The Provisioned state is a stable state. The provisioning Operations such as Upgrade, Downgrade, Upsize,
Downsize, Suspend, and Cancel can be performed on the order when the order is in the stable state.
When the Upsize provisioning operation is performed on the order, the order enters the Upsize draft
state. The order remains in this state until the upsize action is approved. If the user has the permission to
directly approve the upsize draft, the order enters the to be Upsized state. If the user does not have the
permission to approve, the user can seek approval to upsize the order. On seeking approval, the order
enters the Upsize approval pending state. The Business contact receives the seek approval notification and
approves the upsize of the order for the Organization. On approval by the Business Contact, the order
enters the to be Upsized state. The BPT jar lifts the order in to be Upsized state and changes the order
state to Upsizing state.
If the API for the upsize provisioning operation is available then the BPT jar completes the upsize
provisioning process and changes the order state to Upsized, else the service provider has to explicitly
click the Upsized button made available on the order details page in case of manual provisioning (API for
provide operation not available). If the successful completion of upsize provisioning fails, the order enters
the Upsize failed state. A Retry button is made available on the order details page. Clicking the Retry
button to change the order state to to be Upsized so that the process of upsize provisioning can be
repeated. The Discard Draft button will undo the Upsize Draft attempt and the order state will be the last
stable state.
The order state transition for the Upgrade provisioning operation is same as that for the Upsize. Refer the
state transition diagram above and relate with the state transition description for the Upsize operation to
understand the transitions for the Upgrade provisioning operation.
When the order enters the to be Downsized or to be Downgraded states, it remains in this states until
the end of the month so that the downsize/downgrade action can be reverted by clicking the Undo last
change button. The order then enters the last stable state. At the end of the month, the BPT changes the
order state to Downsizing/Downgrading. If the API for downsize/downgrade operations exist then the
BPT performs the required provisioning operations and changes the order state to
Downsized/Downgraded. If the API for downsize/downgrade does not exist then the
Downgraded/Downsized button will be available to manually change the state to the corresponding
stable state after the completion of provisioning.
The user can cancel the order when the order is in Upsize draft, to be Upsized or Upsized state. If the
order is cancelled, the order enters the to be cancelled state. The order remains in this state till the end of
the month. At the end of the month, the BPT changes the order state from to be cancelled to Cancelling, if
the API for Cancel provisioning operation is available. On completion of the cancelling process, the order
state changes to Suspended for Cancellation and remains in this state until the end of the Data Retention
Period of the Offer. If the API for Cancel provisioning operation is not available, the Mark as button
appears when the order is in Cancelling state. The provider (Service Provider/Reseller) user or agent user
can change the order state from Cancelling to suspended for Cancellation by clicking the Mark as
button. The order remains in this state until the Data Retention period of the order. The BPT lifts the order
in Suspended for Cancellation state when the Data Retention period expires and changes the order state to
Suspended for Cancelling. The order enters the Cancelled state when the process of data wipe
completes.
User may provide the reasons for cancellation while cancelling an order. EAS comes packaged with most
common reasons codes. To add additional reason codes for order cancellation, SQL scripts must be executed
in the DB. For further details on adding reasons for order cancellation, refer to EAS Installation Guide.
8 APRIL 2016
ENSIM CONFIDENTIAL
348
Truncate and Hide order

This feature enables the provider to truncate any existing orders in EAS application that are in stable states.
A Truncate button is available on the order details page while the order is in any of the following states1. Aborted
2. Provisioned
3. Upsized
4. Downsized
5. Upgraded
6. Downgraded
7. Suspended
8. Resumed
9. Cancelled
Truncate button will appear against the orders, if and only if right under the provider (Service Provider
and Reseller) super admin role named Truncate and Hide orders is enabled.
While provider clicks on the Truncate button against any of the order, the order hides from EAS portal and
started to get wipe out from ESOM database (ESOM end).
After successful deletion of the order from ESOM, the order state changes from the stable state to
Cancelled state.
Note: These hide orders always exist in EAS database even after state of the order changed to cancelled
from any of the stable state. Provider can search these hide orders from advanced search option of orders
available in EAS.
The Suspend provisioning operation can be performed when the order is in any of the stable states. When
the suspend operation is performed, the order enters the to be Suspended state. The BPT jar lifts the order
in the to be Suspended state and changes the state to Suspending. If the API for the Suspend operation is
available, the BPT jar changes the order state to Suspended after the process of suspension completes. If
the API for Suspend operation is unavailable, the user should manually click the suspended button made
available on the order details page.

8 APRIL 2016
ENSIM CONFIDENTIAL
349
The Resume provisioning operation is possible only when the order is in Suspended or Suspended for
cancellation state. When the Resume operation is performed, the order enters the to be Resumed state.
The BPT jar lifts the order in the to be Resumed state and changes the state to Resuming. If the API for the
Resume operation is available, the BPT jar changes the order state to Resumed after the process of
suspension completes. If the API for Resume operation is unavailable, the user should manually click the
Resumed button made available on the order details page. If the BPT jar remains unsuccessful in the
suspending/resuming operations; the order enters the Failed state. The Rectify Failure button is available
when the order is in this failed state.
When the order enters the Cancelled state, the life cycle of the order ends.

8 APRIL 2016
ENSIM CONFIDENTIAL
350
Order Notification
The order notifications depend on the Provisioning Workflow of the ordered Offer. The notification mails
are sent to the Technical Contact, Business Contact and Agent (if assigned).
1.
Seek Approval notification to the Business Contact

The Organization user seeks approval for his order by sending the seek approval e-mail notification
to the Business Contact of his Organization when he does not have the permission to approve the
order
2.
Approval notification to Business Contact, Technical Contact and Agent (if assigned).
When the order of the Organization gets approved, notification is sent to the Agent (if assigned)
and the Business Contact and Technical Contact of the Organization.
3.
Order Expiry notification to Business Contact, Technical Contact and Agent (if assigned).
The order enters to be cancelled state, when the Cancel provisioning operation is performed. The
order enters the to be Cancelled state. The Order Expiry notification is sent to the when the
Process on configuration of its Provisioning Workflow is met. The order remains in this state until
the Data retention period of the Offer.
4.
Data Wipe notification to Business Contact, Technical Contact and Agent (if assigned).
5.
When the data retention period completes, the Data Wipe notification is sent to remove (wipe) the
details of the order form the database. This notification is sent when the order enters the Cancelled
state.
Order abort notification to Business contact, Technical Contact and agent (if any)
The Abort order state can be reached from Draft and Approved state only. This notification is
sent when the Abort action is performed when the order is in Approved state.
Fully Automated
In Fully Automated workflow, the following e-mail notifications are sent
1.
Order Provisioned notification to the Business Contact, Technical Contact and Agents (if
applicable). This notification is sent for successful completion of all provisioning operations.
2.
Order Upgrade request notification to the Business Contact, Technical Contact and Agents (if
applicable).
3.
Order Downgrade request notification to the Business Contact, Technical Contact and Agents (if
applicable).
4.
Order Upsize request notification to the Business Contact, Technical Contact and Agents (if
applicable).
5.
Order Downsize request notification to the Business Contact, Technical Contact and Agents (if
applicable).

8 APRIL 2016
ENSIM CONFIDENTIAL
351
6.
Order Suspend request notification to the Business Contact, Technical Contact and Agents (if
applicable).
7.
Order Resume request notification to the Business Contact, Technical Contact and Agents (if
applicable).
Fully Manual
If the Provisioning Workflow of the Offer ordered is Fully Manual then the notifications are sent to the third
party. The Notification Settings in the Provisioning Workflow configuration of the Offer configures the email address of the third party along with the language of the notification.
In Fully Manual workflow, the following e-mail notifications are sent
1.
Provisioning notification to the Third Party.
2.
Upsizing notification to the Third party.
3.
Downsizing notification to the Third party.
4.
Upgrading notification to the Third party.
5.
Downgrading notification to the Third party.
6.
Suspending notification to the Third party.
7.
Resuming notification to the Third party.
8.
Cancelling notification to the Third party.
9.
Manual termination of suspended order notification to the Third party.
10. New SSID generation notification. New SSID is generated for the order when the order enters any
of the Provisioning/Upgrading/Downgrading states. This notification is sent to the Business Contact
and CC to Agent (if any) to inform the generated SSID of the order.
Following are the Order alert notifications are sent to the email address specified in the To field of the
corresponding notification template
1. Order failed notification.
2.
Notification is sent when any of the provisioning operation fails and the order enters the failed
state.
Order delayed notification
3.
Notification is sent if the time difference between the approved state and stable state exceeds the set
threshold (Set at the Service level). Moment of Execution is also taken into consideration.
Order Suspended notification

8 APRIL 2016
ENSIM CONFIDENTIAL
352
4.
Notification is sent when the order enters the suspended state.

Order Resumed notification
5.
Notification is sent when the suspended order is successfully resumed.

Cancellation Reconsideration notification
The order remains in the Suspended for Cancellation state when Cancel action is performed on the
order until the Data Retention period ends. In this state, notification alerts are sent to the Business
Contact only. The configuration for sending this alert is done at the creation of Offer.
Trial Order
Draft a trial order
The process to place a trial order is same as that of purchase order as mentioned before. Click the Try
button and continue with the order process.
If the number of order instances (trial and purchase) reaches the Maximum number of orders of this offer
per organization; no more trial order can be placed by the Organization. If any Trial order expires and one
instance of order is available; only the Service Provider/Reseller can place a trial order for that Organization.
Trial options
An Offer can be ordered for trial. The trial offer has a fixed trial period and Auto-upgrade setting (Refer to
the product model section for the Opt-in and Opt-out modes of Auto-upgrade in Trial configuration of
Offer).
The order is in the Draft state when the trial offer is ordered. The trial order undergoes same state
transitions as any other order as described above until it enters the Provisioned state.
Once the trial order is provisioned, the trial order can be upgraded before the trial period ends. The term
Upgrade of trial indicates replacing the trial Offer by the purchase of same/different Offer. The trial order
auto-upgrades to the particular preset Offer after the trial period ends if the ordered trial offer has Opt-out
mode trial configuration. The user must explicitly upgrade to a desired Offer from a preset list of Offers
before the trial period ends if ordered trial offer has Opt-out mode trial configuration. The user will receive
notification alerts before the trial expires depending upon the notification settings in the trial configuration
of the trial offer.
Note: The trial order cannot be Upsized or Downsized.
8 APRIL 2016
ENSIM CONFIDENTIAL
353
State Transitions of Trial Order

The order state transition of the trial order depends on the Autopurchase trial configuration as follows
Opt-in mode:
The order remains in the Provisioned state during the trial period. The further state transition shall take
place in the following two conditions
1.
The order enters the to be Cancelled state if the trial period ends (trial expires).
2.
The order enters the Upsize draft state if the user explicitly purchases the same Offer before
expiry.
3.
The order enters the Upgrade draft state if the user explicitly purchases different Offer before
expiry.
Opt-out mode:
The order state transition from Provisioned to to be Upgraded takes place implicitly when the trial
expires as well as when the user upgrades the order before trial expiry.

8 APRIL 2016
ENSIM CONFIDENTIAL
354
1.
The order enters the to be Upsized state if the trial period ends (trial expires) and the auto
purchase of same Offer takes place.
2.
The order enters the to be Upgraded state if the trial period ends (trial expires) and the auto
purchase of different Offer takes place.
3.
The order enters the Upsize draft state if the user explicitly purchases the same Offer before
expiry.
4.
The order enters the Upgrade draft state if the user explicitly purchases different Offer before
expiry.
The process of transition of states from to be Upgraded to Upgraded depends on the Provisioning
Workflow of the Offer purchased. Once upgraded, the order is no more a trial order but a purchase order
and the state transitions take place same as any other order.
Note: The trial order also requires approval. The Approval process for a trial order is same as that of the
Purchase order.

8 APRIL 2016
ENSIM CONFIDENTIAL
355
AROrderControl
The term AROrderControl stands for Accounts Receivable Order Control.
Order for the Organization accounts are invoiced at the start of each month for the previous month. The
Organization is expected to make the payment accordingly. If the Organization fails to make the required
payment within the due date mentioned in the invoice, he has to pay the late fees mentioned in the invoice
of the next month. A Organization is termed as a bad payer if he crosses the threshold timestamp set for
the delayed payment.
The AROrderControl jar performs the required checks and takes the appropriate action on the orders of the
bad payer Organization accordingly. The AROrderControl jar will Cancel/Suspend/Resume or take no
action on the orders placed by the bad payer Organization based on the order state and payment made by
such Organization.
The AROrderControl jar takes a CSV file from a particular folder location, Source, as input. The CSV file
contains the list of orders of the bad payer Organizations and the corresponding action to be taken to
change their order states. The jar performs the state transitions accordingly. The actions taken by the jar is
tabulated below

8 APRIL 2016
ENSIM CONFIDENTIAL
356

EAS 4.0 : ORDER STATE TRANSITION DETAILS
N
r
State Name
Stable/Interm
ediate State
Next State
Is Service
Active
and
Usable?
Bad payer Actions

SUSPEND
RESUME
Draft
Stable State
An order starts from Draft state and next

state would be either approved or aborted
state.
No
NO ACTION
Approved
Stable State
Next order state would be either

provisioning or aborted state.
No
NO ACTION
To be
cancelled
Stable State
Yes
NO ACTION
Cancelling
Intermediate
State
Yes
NO ACTION
No
NO ACTION
No
NO ACTION
Next order state would be cancelling

state.
Next order state would be 'suspended for
cancellation' and cancelled state.
Cancelled
Stable State
Not applicable
Provisionin
g
Intermediate
State
Provisioned
Stable State
Yes
To be
suspended
Stable State
Next order state would be either

Provisioning failed or provisioned state.
Next order state moves to upsize draft,
downsize draft,downgrade draft,upgrade
draft, to be cancelled and to be suspended
state.
Next order state would be suspending
state.
Yes
NO ACTION
Suspending
Intermediate
State
Next state would be suspended,Failed and

Previous stable state.
Yes
NO ACTION
10
Suspended
Stable State
Next state would be to be cancelled

and to be resumed state.
No
11
To be
resumed
Stable State
12
Resuming
Intermediate
State
An order goes only

Resuming state.
Next state would be Failed and Resumed
state.
13
Resumed
Stable State
same as provisioned
Yes
TOBE
SUSPENDED
NO
ACTION
14
To be
Upsized
Stable State
Next state would be upsizing state.
Yes
TOBE
SUSPENDED
NO
ACTION
15
Upsizing
Intermediate
State
Next state would be upsized and upsized

failed state.
Yes
16
Upsized
Stable State
same as provisioned
Yes
TOBE
SUSPENDED
NO
ACTION
17
Provisionin
g failed
Stable State
After order state failed directly

goes to the Retry state.
No
NO ACTION
NO
ACTION
18
To be
upgraded
Stable State
Next state would be upgrading state.
Yes
NO ACTION
19
Upgrading
Intermediate
State
Next state would be upgraded

failed and upgraded state.
Yes
NO ACTION
20
Upgraded
Stable State
same as provisioned
Yes
Stable State
Next state would be downgrading state.
Yes
NO ACTION
Intermediate
State
Next state would be downgraded

or downgraded failed state.
Yes
NO ACTION
21
22
To be
downgrade
d
Downgradi
ng

8 APRIL 2016
TOBE
SUSPENDED
NO ACTION
NO
ACTION
TOBE
RESUME
D
No
NO ACTION
No
NO ACTION
CANCEL
TOBE
CANCELLE
D
TOBE
CANCELLE
D
TOBE
CANCELLE
D
TOBE
CANCELLE
D
NO ACTION
TOBE
SUSPENDED
NO
ACTION
TOBE
CANCELLE
D
TOBE
CANCELLE
D
TOBE
CANCELLE
D
ENSIM CONFIDENTIAL
357
23
24
25
26
Downgrade
d
Suspended
for
cancelation
Cancelling
suspended
order
Upsize
Draft
Stable State
same as provisioned
Yes
TOBE
SUSPENDED
NO
ACTION
TOBE
CANCELLE
D
Stable State
Next state would be to be resume and

cancelling suspended order state.
No
NO ACTION
TOBE
RESUME
D
NO ACTION
Intermediate
State
The order goes only in

cancelled state.
No
NO ACTION
Stable State
Next state would be approved

or update approval pending state.
Yes
NO ACTION
27
Upsize
Failed
Stable State
Next state would be 'to be upsized' and 'to

be cancelled' state.
Yes
TOBE
SUSPENDED
NO
ACTION
28
Upgrade
Failed
Stable State
After upgrade failed order directly

goes to the provisioned state.
Yes
TOBE
SUSPENDED
NO
ACTION
29
Downgrade
Failed
Stable State
Next state would be 'to be upgrade' and 'to

be cancelled' state.
Yes
TOBE
SUSPENDED
NO
ACTION
30
31
32
33
34
35
Upgrade
Draft
Downgrade
Draft
Approval
Pending
Upsize
Approval
Pending
Upgrade
Approval
Pending
Downgrade
Approval
Pending
Stable State
Stable State
Stable State
Next state would be upgraded

approval pending state.
Next state would be downgrade
approval pending state.
Next state would be abort and
approved state.
Yes
NO ACTION
Yes
NO ACTION
No
NO ACTION
Stable State
Next state would be to be

updated state.
Yes
TOBE
SUSPENDED
NO
ACTION
Stable State

upgrade state.
Yes
TOBE
SUSPENDED
NO
ACTION
Stable State

downgrade state.
Yes
TOBE
SUSPENDED
NO
ACTION
36
Aborted
Stable State
Not applicable
No
37
To be
downsized
Stable State
Next state would be downsizing state.
Yes
38
Downsizing
Intermediate
State
Next state would be downsized and

downsize failed state.
Yes
39
Downsized
Stable State
same as provisioned
Yes
40
Failed
Stable State
Not applicable
No
NO ACTION
41
Downsized
Draft
Stable State
Next state would be 'to be downsize' state.
Yes
NO ACTION
42
Downsized
Failed
Stable State
Next state would be 'to be downsize' and

'to be cancelled' state.
Yes
TOBE
CANCELLE
D
TOBE
CANCELLE
D
TOBE
CANCELLE
D
TOBE
CANCELLE
D
TOBE
CANCELLE
D
TOBE
CANCELLE
D
NO ACTION
TOBE
SUSPENDED
NO
ACTION
TOBE
CANCELLE
D
NO ACTION
TOBE
SUSPENDED
TOBE
SUSPENDED
NO
ACTION
NO
ACTION
TOBE
CANCELLE
D
TOBE
CANCELLE
D
The output file is saved in another folder location, Completed, meant for it. After execution the input CSV
file form the Source folder is deleted. Condition might arise where the input folder location has many CSV
files waiting for the jar. In such situation the jar lifts the CSV files one at a time in the chronological order
and performs execution one after the other.

8 APRIL 2016
ENSIM CONFIDENTIAL
358
Note: The order state transition performed by the AROrderControl jar on the orders of the bad payer
Organizations is described in the Badpayers States.xlsx sheet attached along with this document.
Bulk Order Management

Performing Actions on multiple Orders
EAS allows Service Providers to import orders (subscriptions) that have been provisioned and invoiced
from third-party methods prior to deploying EAS. Once the Orders are imported into EAS, these Orders can
be managed from EAS for all future actions such as upsize, downsize, upgrade, downgrade, and cancel.
In EAS, Import Order feature is used for the following purposes:
Import Orders with Last Order Action only from other BSS: Orders from other BSS systems can be
easily migrated into EAS through this order import method. In EAS, they are equivalent to new Orders.
Thus, this method imports orders with Draft, Approved, or Provisioned states.
Import Orders with All Order Actions from other BSS: This serves the same purpose as the previous
one. However, if the order contains multiple order actions, for example, create, increase quota, decrease
quota, and so on, then all the order actions can be imported with this method.
Create fresh Orders: New Orders can be placed in bulk using a CSV file.
Upsize Orders: Upsize operations on a large set of Orders can be easily performed by this method.
Downsize Orders: Downsize operations on a large set of Orders can be easily performed by this
method.
Upgrade Orders: Upgrade operations on a large set of Orders can be easily performed by this method.
Downgrade Orders: Downgrade operations on a large set of Orders can be easily performed by this
method.
Change Price: Price of Items can be changed ad hoc across multiple Orders.
Convert Manual Orders to Automatic Orders: This method is used in the following cases.
a.
At times, Product Managers want to launch a new service quickly. However, due to the lack of
the automated connector or lack of the provisioning API support by the service vendor, Product
Managers are compelled to launch with manual Offers. When the volume of business grows
and automation becomes necessary, connectors are developed and deployed. While the
connector works smoothly for all new Orders (placed after the deployment of the connector),
connector-specific data for the existing Orders (manually provisioned) may need to be
reconciled with the connector. This method can be used in such cases.
b. This import method should be used to migrate from Ensim Service Operations Manager
(ESOM) based service to the newly introduced WPA-based service. Existing Orders (ESOM
Service based orders) should be exported to a CSV file through the Order Export method and
the same should be imported to EAS after changing the service configuration. For more
information, refer to the ESOM to EAS Migration Guide.

8 APRIL 2016
ENSIM CONFIDENTIAL
359
Note: For Promo Offers, Order Import can be done only in case of Create fresh Orders and Import
Orders with Last Order Action only from other BSS.
To import Orders from other BSS systems to EAS, complete the following steps. The process is same for all
purposes.
1.
Click Orders > Import Orders.
2.
To import orders based on your choice, under Choose the purpose, select the required option. For
example, if you select the Import Orders with All Order Actions from other BSS option, the order
is imported with all historical actions along with the current order action.

8 APRIL 2016
ENSIM CONFIDENTIAL
360
Note: For more information on a purpose option, select that purpose to display the inline help.
3.
Click Download Sample CSV to download a sample CSV file format. Fill the downloaded CSV file
with all required data and save it in any location on your computer. To upload the CSV with
relevant data in the correct format, click Choose File and select the correct file from the correct
location.
Note: Use a single CSV file to import orders with all historical actions. Do not split order actions in
different CSV files. If you import an order with the last action only, further historical order actions
cannot be performed using order import for that particular order.
4.
Click Next to navigate to the next page.
5.
Map the EAS internal headers to the appropriate column headers in the uploaded CSV and click
Next. Mandatory fields are marked with asterisk (*).
Note: Previous mapping history is saved for every purpose you select. If you change the CSV
column headers, you must map the modified headers again. Mapping of PIFs and Connector
data is not saved.
Either Offer GUID or Offer name and either Item GUID or Item name are mandatory for
mapping, if you choose the Create Fresh Orders, Import from other BSS, Upgrade Orders,
Downgrade Orders, or Change Price.
6.
Click Next and select the check box to enable sending email to Technical Contacts and Business
Contacts of the order.

8 APRIL 2016
ENSIM CONFIDENTIAL
361
7.
Click Import Now to start the process.
8.
To view previous imports click View previous imports.
Note: The list of imported orders is displayed based on the order import action performed by
the logged in user.
9.
On the Previous Order Imports page, perform the following actions:
For a Completed or Failed import, click Show Details to view activity details.
The following figure shows the activity details after a successful Order import.

8 APRIL 2016
ENSIM CONFIDENTIAL
362
The following figure shows the activity details of a failed Order import.

8 APRIL 2016
ENSIM CONFIDENTIAL
363
For a Completed import, click Download in the Success CSV column to download a CSV
file with all successfully imported orders for a single import process.
For a Failed import, click Download in the Failure CSV column to download a CSV file
with all failed imported orders for a single import process.
For any single successful or failed import process, if you click the Download button in the opposite
CSV column, the system displays the alert message, File not available to download. For example,
if you click the Download button in the Success CSV column for a failed import, no file is available.

8 APRIL 2016
ENSIM CONFIDENTIAL
364
Note: Export Order CSV can be used for Import Order after modification of data for specific
purposes.
Out-of-scope cases
Although the import process is very generic in nature and the Importer tool is written in a Service agnostic
way, the following use cases are not supported by the tool.
1. Importing trial subscriptions: Subscriptions that are still in trial phase and has not been purchased,
cannot be imported by the tool. You must wait until those trials are converted to paid Offers and
then migrate into EAS.
2.
Importing subscriptions in a transient state: Subscriptions that are in a transient state and are
expected to be automatically converted to another stable state, should not be imported. For
example, a subscription is in Provisioning or Cancelling state should not be imported. You must
wait for the subscription to be fully Provisioned or Cancelled.
3.
Importing orders from other BSS with all Historical actions: Upgrade and Downgrade is out of
scope.
Note: For further details on Import Order, please refer to the EAS 4.3 Bulk Order Operations
QRG.

8 APRIL 2016
ENSIM CONFIDENTIAL
365
Export Orders
You can easily produce reports of orders managed in Ensim Automation Suite (EAS) in Comma Separated
Values (CSV) format. These CSV files can be used for analytics, reporting, and to perform bulk order
operations, such as upsize, downsize, price change, and so on.
This feature is available to the Service Provider and Reseller users who have permission to export orders.
While, Service Provider users can export any order from the system, the Reseller users can only export
orders owned by them. The import procedure for these operations cannot process the same order multiple
times in one input file. Therefore, both export with the last order action and export with all historical actions
are possible.
To export orders, complete the following steps.
1.
Click Orders > Export Orders.
2.
Under Export Orders, fill in the fields to export orders based on your choice.
Based on the following export options, the structure of the CSV files differ.
Output Content: If you select the With Price option, the price tiers are printed one tier per line.
The same item is repeated in the CSV lines if there are multiple tiers.
Order Action History: If you select the Only Last Action option, only one order line is printed
else, all order lines are listed in chronological order in the CSV file.
You may select multiple status, such as draft, upsize, downsize, and so on.
8 APRIL 2016
ENSIM CONFIDENTIAL
366
4.
To export the CSV file, click Export Now. The following figure shows the Export Orders status in
the Activity log after a successful export. To download an exported file (only in CSV format), click
the Download icon.

8 APRIL 2016
ENSIM CONFIDENTIAL
367
These output files can be used to perform bulk Order operations, such as upsize, upgrade, downsize, and
downgrade as described in the previous section. However, the export must be done with only the last order
action and not with the history, because the import process for these operations cannot process the same
Order multiple times in one input file.
The following table lists the CSV file headers.
HEADER
PROVIDER_ID
PROVIDER_NAME
RESELLER_TYPE
ORGANIZATION_ID
ORGANIZATION_NAME
ORGANIZATION_UPN_SUFFIX
MASTER_ACCOUNT_ID
SERVICE_ACCOUNT_ID
SERVICE_ACCOUNT_NAME
BILLING_ACCOUNT_ID
BILLABLE_ACCOUNT_NAME
EXTERNAL_BILLING_ID
PAYMENT_AGREEMENT_NAME
TECHNICAL_CONTACT
TECHNICAL_CONTACT_PRIMARY_EMAIL
TECHNICAL_CONTACT_PHONE_NUMBER
BUSINESS_CONTACT
BUSINESS_CONTACT_PRIMARY_EMAIL
BUSINESS_CONTACT_PHONE_NUMBER
ORDER_ID
SUBORDER_NUMBER
ORDER_CREATION_DATE
CREATED_BY
CREATOR_ORG_TYPE
8 APRIL 2016
DESCRIPTION
This represents the ID of the provider.
This represents the provider name.
This represents the type of Reseller that is, type 1, type 2, or
type 3.
ID is the unique Organization ID for which the order was
created.
It represents the name of the Organization for which the
order was created.
It represents the UPN Suffix of the Organization for which
the order has been created.
This represents the name of the master account to which this
Order has been placed.
This represents the unique ID for a Service Account of an
Organization under which the Order was placed
This represents the name of a Service Account of an
Organization under which the Order was placed.
This represents the unique ID of a billable account to which
this Order is to be billed.
This may or may not be same as the Service Account of the
Order.
This represents the name of a billable account to which this
Order is to be billed. This may or may not be same as the
Service Account of the Order.
The name of the payment agreement applicable for this
order.
This is the log-in name of the technical contact.
This is the primary email of the technical contact.
This is the phone number of the technical contact.
This is the log-in name of the business contact.
This is the primary email of the business contact.
This is the phone number of the business contact.
Order number is the unique ID of that Order.
Every Order has a sub order number along with the order
number.
The sub Order Number changes with each action performed
on a particular order.
The date on which the order was created.
Username of the user who created the order.
Organization type of the user who created the order.
ENSIM CONFIDENTIAL
368
BILL_CYCLE_DAY
It represents the day on which the particular is to be billed subject

to other conditions.
Refer to EAS documentation for further details.
LAST_EDIT_DATE
PURCHASE_ORDER_NUMBER
ORDER_STATE
The last date on which order was edited.
MIGRATION_STATUS
APPROVED_BY
APPROVED_BY_ORG_TYPE
PROVISIONED_BY
PROVISIONING_SYSTEM_ID
PROVISIONING_ID_DETAILS
IS_TRIAL
TRIAL_TO_PURCHASE_DATE
SUBSCRIPTION_ID
SUBSCRIPTION_PERIOD_LENGTH
SUBSCRIPTION_PERIOD_UNIT
EAS has 43 states of Orders. Please read product

documentation for further details.
This indicates whether the order is migrated from other
system and its current state of migration.
It represents the username of the user who approved the order.
It represents the Organization type of the user who approved the
order.
It represents the username of the user who provisioned the order.
It represents the ID generated by provisioning system.

It represents the details entered at the time of provisioning the
order.
This indicates whether the order is a trial.

SSID is a unique ID generated by EAS for the Order. The ID
changes when the Order is upgraded or downgraded to
another Offer.
It represents the length of the subscription period for the
corresponding Offer (for example, 1, 2, 3............n).
It represents the unit of the subscription period for the
corresponding Offer (for example, month, year, hour, or
day).
Note: the Subscription period is present for information
only.
SUBSCRIPTION_START_DATE
It represents the date on which the subscription started.
SUBSCRIPTION_END_DATE
ITEM_ID
ITEM_CODE
It represents the date on which the subscription ended.
ITEM_NAME
ITEM_DESCRIPTION
ITEM_UNIT
UNIT_NAME
PROMO_CODE
PROMO_APPLY_DATE
DIFFERENTIAL_QUANTITY
8 APRIL 2016
Item ID is the unique ID of the corresponding Item.

It represents the Item Code of an item of the corresponding
Order.
Depending upon the Billing language of the Organization
the corresponding name of the Item will be printed.
If the language specific name is not registered in EAS, the
English name will be printed.
This field contains the description of the item of
corresponding order.
It represents the code for the unit of the item as registered in
EAS (for example, Nr for Number, GB for Gigabytes).
Unit Name represents the unit for the item (for example,
Number, Gigabytes).
It represents the promo code used to apply promo to an
order.
It represents the date on which the promo has been applied
to an item.
This represents the change in quantity of an item if an item
ENSIM CONFIDENTIAL
369
DATE
PROVISION_DATE
is either upsized or downsized.

For example, if an item quantity has been upsized from 10 to
15, the differential quantity will be 5.
It represents the total quantity after summing up all the
tiered quantities of an item.
It represents the date on which the job has been executed.
The date on which the order was provisioned.
FIRST_PROVISION_DATE
The date on which the order was first provisioned.
BILLSTARTDATE
BILLSTOPDATE
Bill start date.

Bill stop date.
BILLING_FREQUENCY_LENGTH
It represent the length of the billing frequency for the

corresponding item. (for example, 1,2,3............n)
It represent the unit of the billing frequency for the
corresponding item.
The possible values aremonth and year only.
For example, if an item is priced for 2 years, the unit will be
year while the length will be 2.
It represents the unique ID of the Offer in EAS.
Name of the Offer.
NET_QUANTITY
BILLING_FREQUENCY_UNIT
OFFER_ID
OFFER_NAME
APPROVAL_WORKFLOW_NAME
It represents the name of the approval workflow attached with the

Offer.
APPROVAL_TIME_STAMP
TARIFF_CODE
Approval timestamp is the date and time when the Order

was approved.
It represents the tariff code of the corresponding Offer.
CATALOG_ID
It represents the catalog ID of the corresponding Offer.
INVOICING_MODE
Replaces the 'mode' field. Use this field instead of the 'mode'
field.
It represents the Service ID of the order.
SERVICE_ID
SERVICE_NAME
SALES_AGENT_ID
AGENT_NAME
SALES_REPRESENTATIVE
It represents the Service Name of the order.

ID is the unique Agent ID of the system through whom the
order has been created for an Organization.
This name represents the Agent name through whom the
order has been created for an Organization.
This field represents the username of the sales representative if it is
internal else the email ID of the external sales representative.
If the With Price option is selected for Order Exporter, the CSV output file contains the following extra headers.
HEADERS
NET_PRICE

8 APRIL 2016
DESCRIPTIONS
It represents the cost of the tier after considering one-off discount as
approved for this Order.
ENSIM CONFIDENTIAL
370
TIER_MIN_VALUE
TIER_MAX_VALUE
PRICE_PLAN_ID

8 APRIL 2016
Note: Organization Global Discounts and Promo discounts are not

included in the price.
Min Value is the minimum value of a tier range.
Max Value is the maximum value of a tier range.
Price Plan ID.
ENSIM CONFIDENTIAL
371
CHAPTER 6
EAS Data Model
EAS has a very flexible and advanced Order management module. It is often required to pull various
reports from the database on growth of Organizations, Orders, Users, and Revenue. This document
describes the logical and physical (DB) data structures used by EAS for Order management. To use this
document the reader must have knowledge of relational DB schema and SQL programming. The document
uses constructs of PostgreSQL while EAS is supported on SQL Server and Oracle as well.
Identity Management
This section describes the data model for the Entity management in EAS.
Hierarchy of EAS entities

Service Provider is at the top level of EAS entity hierarchy. Under Service Provider, Resellers, Agents and
Organizations are present. Resellers can also have their own organizations. Below diagram will define the
hierarchical architecture of EAS entity management system:
SERVICE PROVIDER
RESELLER
AGENTS
ORGANIZATION
ORGANIZATION

8 APRIL 2016
ENSIM CONFIDENTIAL
372
EAS DATA MODEL CHAPTER 6
Relationship of tables at Entity level

reseller_organization
customer_organization
id
org_id
id
billing_language_id
org_id
communication_langua...
owner_base_org_id
currency_id
customer_id
creator_org_id
default_tech_contact_id
reseller_id
default_busi_contact_id
login_url_identifier
organization_attribute
representative
organization
id
entity_id
date_time_format
partner_organization
id
org_id
service_provider_organization
id
org_id
currency_id

8 APRIL 2016
ENSIM CONFIDENTIAL
373
Relationship of schemas at user level

service_provider_user
id
serviceprovider_org_id
base_user_id
operation_status_id
customer_user
id
customer_org_id
base_user_id
domain_accout_map_id
operation_status_id
base_user
id
entity_id
partner_user
language_id
id
user_name
partner_org_id
primary_role_id
base_user_id
global_id
cust_acc_hid
ad_user_name
reseller_user
id
reseller_org_id
base_user_id
operation_status_id

8 APRIL 2016
ENSIM CONFIDENTIAL
374
Service Provider Entity

organization is the parent table that contains the record of all entities (SP, Reseller, Agent, and
Organization). Details of Service Provider Organization is stored in organization and
service_provider_organization tables. The following query will retrieve the Service Provider organization
details:
select service_provider_organization.id, org_type, currency_id, organization.created_on,
use_reseller_model, use_marketplace from service_provider_organization, organization where
service_provider_organization.org_id=organization.id;
Service Provider user

base_user is the parent table for all users (SP, Reseller, Agent, Organization). Details of Service Provider
users are stored in base_user and service_provider_user tables. The following query will retrieve the
details of a Service Provider user:
select language_id, serviceprovider_org_id, base_user_id, istech_contact, isbusiness_contact,
oss_provision_date, operation_status_id, created_datetime from base_user, service_provider_user where
base_user.id=service_provider_user.base_user_id and
base_user.user_name='<service_provider_user_login_name>';
In the above query, <service_provider_user_login_name> is the Service Provider user login name displayed
in EAS UI.
Reseller Entity
Organization). Details of Reseller entities are stored in organization and reseller_organization table.
Below query can be used to retrieve the details of a reseller entity based on the reseller ID:
select reseller_organization.id, org_type, organization_name, CONCAT(street_addres1,' ',street_addres2,'
',city,' ',state_province,' ',postal_code) as address, email, create_datetime, billing_language_id,
communication_language_id, creator_org_type from organization, reseller_organization where
organization.id=reseller_organization.org_id and reseller_organization.reseller_id=<reseller_entity_id>;
In the above query, <reseller_entity_id> is the Reseller ID displayed in EAS UI.
Reseller User
base_user is the parent table for all users (SP, Reseller, Agent, Organization). Details of reseller users are
stored in base_user and reseller_user tables. Below query can be used to retrieve the details of a reseller
user based on the user login name:
select reseller_user.id, base_user_id, operation_status_id, created_datetime, creator_base_org_id,
creator_org_type, creator_base_user_id, language_id, primary_role_id from base_user, reseller_user where
base_user.id=reseller_user.base_user_id and base_user.user_name='<reseller_user_login_name>';
In the above query <reseller_user_login_name> is the reseller user login name displayed in EAS UI.

8 APRIL 2016
ENSIM CONFIDENTIAL
375
Agent Entity
Organization). Details of agent entities are stored in organization and partner_organization tables. Below
query can be used to retrieve the details of an agent entity based on the agent ID:
select partner_organization.id, org_type, is_enabled, organization.created_on, is_sales_agent,
is_support_agent, date_time_format from organization, partner_organization where
organization.id=partner_organization.org_id and partner_organization.par_id=<agent_entity_id>;
In the above query, <agent_entity_id> is the agent ID displayed in EAS UI.
Agent User
base_user is the parent table for all users (SP, Reseller, Agent, Organization). Details of agent users are
stored in base_user and partner_user tables. Below query will display the details of a partner user based
on the user login name in EAS:
select partner_user.id, base_user_id, created_datetime, creator_base_org_id, creator_org_type,
creator_base_user_id, language_id, primary_role_id from base_user, partner_user where
base_user.id=partner_user.base_user_id and base_user.user_name=<agent_user_login_name>';
In the above query, <agent_user_login_name> is the agent user login name displayed in EAS UI.
Organization Entity
Organization). Details of organization entity can be retrieved from organization and
customer_organization tables. Below query can be used to retrieve the details of an organization based on
organization ID displayed in EAS UI:
select customer_organization.id, org_id, org_type, customer_org_name, organization.created_on,
distributor_since, organization_email, owner_base_org_id, owner_type, legal_language, comm_language,
master_account_id, report_enabled, report_dl from organization, customer_organization where
organization.id=customer_organization.org_id and
customer_organization.customer_id=<organization_entity_id>;
In the above query, <organization_entity_id> is the organization ID displayed in the EAS UI.
To check the organization Contractual Statements and Help & Support link, please execute the below
query:
select customer_org_name, contractual_statement, download_link from customer_organization where
customer_id=<Organization_entity_id>;
In the above query, <organization_entity_id> is the organization id displayed in the EAS UI.
contractual_statement column will display the contarct statement of the organization.
download_link will display the help and support link provided for the organization.
Organization User
base_user is the parent table for all users (SP, Reseller, Agent, Organization). Details of customer user can
be retrieved from base_user and customer_user tables. Below query will display the customer user
details based on the organization user login name displayed in the EAS UI:

8 APRIL 2016
ENSIM CONFIDENTIAL
376
select customer_user.id, customer_org_id, base_user_id, base_user.create_datetime, primary_role_id,

istech_contact, isbusiness_contact, operation_status_id, ad_user_name, creator_base_org_id,
creator_base_user_id, creator_org_type from base_user, customer_user where
base_user.id=customer_user.base_user_id and base_user.user_name='<organization_user_login_name>';
In the above query, <organization_user_login_name> is the organization user login name displayed in the
EAS UI.
Organization Account details

While creating an organization an account is also created known as Master Account. Later more accounts
can be added for the organization.
The below query will retrieve the details of the master account:
select account_id as master_account_id, account_name, billing_language, communication_language, code as
currency_code, symbol from customer_account, currency where account_id=(select master_account_id from
customer_organization where customer_id=<organization_entity_id>) and
customer_account.currency_id=currency.id;
In the above query, <organization_entit_id> is the organization ID displayed in EAS UI.
To retrieve all the accounts associated with an organization, use the below query:
select customer_account.id, account_id, account_name, billing_language, communication_language, code as
currency_code, symbol, billable_to from customer_account, currency where
customer_account.currency_id=currency.id and customer_id=<organization_entity_id>;
In the above query, <organization_entity_id> is the organization ID displayed in EAS UI and billable to
returns the id of the customer_account.
To retrieve the default business contact of an organization account, please execute the below query:
select concat(first_name,' ',last_name) as name, user_name as eas_login_id from user_contact, base_user where
user_contact.user_id = base_user.id and user_contact.user_id=(select default_bc from customer_account where
account_id=<account_id>);
In the above query, <account_id> is the id of organization account displayed in EAS UI under Account tab
of organization details panel.
To retrieve the default technical contact of an organization account, please use the below query:
select concat(first_name,' ',last_name) as name, user_name as eas_login_id from user_contact, base_user where
user_contact.user_id = base_user.id and user_contact.user_id=(select default_tc from customer_account where
account_id=<account_id>);
In the above query, <account_id> is the id of organization account displayed in EAS UI under Account tab
of organization details panel.
Payment Agreement details

Payment Agreement is the financial contract between the Service Provider and the organization or Service
Provider to Reseller. Payment agreement is applicable on accounts, so the payment agreement details can be
retrieved using the account information.
To retrieve the payment agreement details of an organization account present under Service Provider, use
the below query:
Select agreement_name, invoice_payment_mode from payment_agreement where id=(select
payment_agreement_id from customer_payment_agreement where cust_account_id=(select id from
customer_account where account_id=(Select master_account_id from customer_organization where
customer_id=<organization_entity_id>)))
In the above query, <organization_entity_id> is the organization ID displayed in EAS UI.
8 APRIL 2016
ENSIM CONFIDENTIAL
377
Product Model
This section will describe the data model of EAS Product Model which includes, Services, Resources and Offers.
Service
A service is a technical abstraction of a (hosted) application that can be provisioned for an organization for
usage. The below query will retrieve the details of the services present in EAS system:
select id, display_order, internal_service_id, service_name, subscription_type, delayed_period,
allowmultipleorder_samedomain, container_type, dependon, require_access_token,
configuration_allowto_reseller, configuration_allowto_agent, usage_data_allowed, sales_agent_change_event,
cust_info_change_event, tech_cont_change_event,search_tag, escm_ctrl_panel_require, vendor_name,
phone_inventory_required, has_user_management from services;
Resources
The resources are the attributes of a service from business or from (technical) provisioning perspective.
Resources can be of two types
a. Order Item.
b. Provisioning Information.
The below query will retrieve the details of the resources present under a service based on the service name:
select service_id, resource_id, resource_name, default_value, is_overusage, allow_unlimited,
is_customer_specific, rating_rules, reserved_unit, ppu_unit, is_mandatory, is_unique,
editable_after_provision from system_units, unify_service_resources_meta where service_id=(select id from
services where service_name=<service_name>');
In the above query, <service_name> is the display name of a service which is displayed in EAS UI.
Order Item and Provisioning information resources can be distinguished by the field is_customer_specific.
If the value of this field is 0, then the resource is of Order Item type.
If the value of this field is 1 then the resource is of Provisioning Information type.
Items
An item is a business abstraction of a Service Resource. Items are of three types
a. Base Item
b. Bundle Item
c. Composite Item

8 APRIL 2016
ENSIM CONFIDENTIAL
378
The below query will retrieve all items present under a specific service based on the service name:
select service_item.service_id, internal_item_id, item_name, resource_name, item_type, is_composite,
is_bundle, unique_guid, product_desc from unify_service_resources_meta, service_item where
unify_service_resources_meta.id=service_item.unify_resource_reference and service_item.service_id=(select
id from services where service_name=<service_name>');
In the above query, <service_name> is the display name of the service displayed in EAS UI.
To retrieve the item type, use the below query:
select internal_item_id, item_type_map_meta.item_type from item_type_map_meta, service_item where
service_item.item_type=item_type_map_meta.id and item_name='<item_name>';
In the above query, <item_name> is the name of the item displayed in EAS UI.
Offers
An offer is a presentation of combination of items. These offers can be then made available for the
organizations for purchase. In EAS, the Catalog consists of Offers that are constructed using Items of
resources of a particular Service.

8 APRIL 2016
ENSIM CONFIDENTIAL
379
Relationship between offer, item and price plan

price_plan_function
id
item_id
price_plan_type
tariff_frequency
creator_org_id
aging_unit
price_plan_components
id
price_plan
id
service_item
price_plan_element
price_plan_id
id
service_id
service_id
id
service_item_id
unify_resource_reference
item_id
price_plan_element_id
item_type
price_plan_element
atf_type
creator_org_id
currency_id
pp_element_ref_id
unique_guid
provider_id
product_tariff_type
good_type_ref
item_for_feature
product_offer
id
price_plan_id
category_id
status
contract_period_unit
locked_by
distributer_func_id
reseller_func_id
owner_id
original_offer_id
creator_org_id
current_version_id
unique_guid
offer_type
main_service_id
current_terms_and_cond...

8 APRIL 2016
ENSIM CONFIDENTIAL
380
Relationship between offer, category, offer version and subscription

offer_version_details
id
version_id
offer_version_def
price_plan_component_id
id
offer_id
approved_by
drafted_by
version_name
version_iden
announcement_action_id
alignment_action_id
offer_subscription_details
id
offer_id
product_offer
id
price_plan_id
category_id
status
offer_category
id
locked_by
creator_org_id
distributer_func_id
category_iden
reseller_func_id
owner_id
original_offer_id
creator_org_id
current_version_id
unique_guid
offer_type
main_service_id
current_terms_and_conditions

8 APRIL 2016
ENSIM CONFIDENTIAL
381
To retrieve the offer details, use the below query:

select display_name, catalogue_id, description, upgrade_category, upgrade_weight, price_plan_id, category_id,
data_retention_period, data_retention_period_unit, contract_period, contract_period_unit,
allow_multiple_instances, aloc, doc, upsizing_allowed, downsizing_allowed, use_selling_discount,
use_buying_discount, reseller_discount, approval_threshold_hour, main_service_id, item_differential_qnty_req
from product_offer where unique_guid='<offer_unique_GUID>';
In the above query, <offer_unique_GUID> is the offer GUID displayed in EAS UI.
The below query will retrieve the item pricing details present in the offer:
select * from price_plan_element where price_plan_element in (select price_plan_element_id from
price_plan_components where id in (select price_plan_component_id from offer_version_details where
version_id=(select current_version_id from product_offer where unique_guid='<offer_unique_GUID>')));
To retrieve the price_plan_type of items present in an offer, use the below query:
select item_id, price_plan_element, price_plan_type_meta.price_plan_type from price_plan_type_meta,
price_plan_function where price_plan_function.id in(
select price_plan_element_id from price_plan_components where id in(
select price_plan_component_id from offer_version_details where version_id =(select current_version_id
from product_offer where unique_guid='<offer_unique_GUID>'))) and
price_plan_function.price_plan_type=price_plan_type_meta.id;
Offer Subscription
Subscription refers to the process of Business Contact ordering a service for a fixed minimum period of time
instead of month to month, either as a requirement from the Service Provider to have a minimum
commitment or as an incentive to the buyer to get a better price by committing to a longer period.
The below query will retrieve the offer subscription details of an offer based on the offer unique GUID:
select * from offer_subscription_details where offer_id=(select id from product_offer where
unique_guid=<offer_unique_GUID>');
Order
This section will describe the data model used in Order management system in EAS.
Logical data structure

Order data structure basically stand upon two schema
a. Order Line: It represents the set of Items, Quantities and Price for a given Order. Every time the
Order is upsized, downsized, upgraded and downgrades, the new set of Items, Quantities and Price
will be stored in a new Order line.
b. Order Master: It binds all the associated order lines in one common structure. Order Master
contains the pointer to the linked list of Order Lines.

8 APRIL 2016
ENSIM CONFIDENTIAL
382
The below architecture is the linked list representation of order:
The above linked list can be explained by using the below architecture

8 APRIL 2016
ENSIM CONFIDENTIAL
383
Relationship between order internal schemas

order_summary
order_master
id
id
payable_to
order_number
order_number
current_order_line
service_id
customer_account_map...
product_offer_id
created_by
status
trial_to_purchase_ref_id
pwf_id
cust_payment_agreeme...
active_orderline_id
payable_to
created_by
connector_server_details...
approved_by
external_order_system_hid
renew_to_offer
subscribed_line_id
currency_hid
order_cust_specfic_inp
id
order_line_id
unify_res_id
synergy_order_line
id
orderid
status
contact_period_unit
original_prod_offer
business_contact
tech_contact
order_service_item
id
order_line_id
unify_resource_reference
item_type
service_id
possible_val_meta_id
service_item_id
product_group_id
edit_by
prev_line_id
data_retention_unit
reason
ssids_id
pwf_id_ref
version_id
associated_promo_id
prev_state
current_subscription_line
draft_initiator
terms_and_conditions_id

8 APRIL 2016
ENSIM CONFIDENTIAL
384
Orders placed by an organization

Orders are either placed by the service provider on behalf of the organization or by the organization users
for own organization. The below query will retrieve all order details placed for a specific organization:
select order_number, order_creation_date, current_order_line, user_name as order_placed_by, code as
currency_code from currency, base_user, order_master where order_master.currency_hid=currency.id and
order_master.created_by=base_user.id and customer_id=<organization_entity_id>;
In the above query, <organization_entity_id> is the Organization ID displayed in EAS UI.
To retrieve the order list based on organization name, use the following query:
select order_number, order_creation_date from order_master where customer_org_name='<Organization_Name>'
In the above query, <organization_name> will be taken as input.
Only purchase order

To retrieve only the purchase orders (excluding the trial orders) based on an organization, use the below
query:
select order_number, order_creation_date, current_order_line from order_master where
customer_id=<organization_entity_id> and is_trial=0
In the above query, <organization_entity_id> is the organization id displayed in EAS UI.
Item quantity in an order

The below query will retrieve the details of items present in an order along with the current quantity with
which the order was placed:
select internal_item_id, item_name, product_desc, quantity from service_item, order_service_item where
service_item.id=order_service_item.service_item_id and order_service_item.order_line_id=(select
current_order_line from order_master where order_number='<order_number>');
In the above query, <order_number> is the order number displayed in EAS UI.
Item pricing details for an order

The below query will retrieve the pricing details of the items present in an order:
select order_item_id, item_name, min_value, max_value, tier_name, base_price, quantity,
(base_price*quantity) as total from order_atf_code, order_service_item, service_item where
order_atf_code.order_item_id=order_service_item.id and
order_service_item.service_item_id=service_item.id and order_atf_code.order_item_id in (select id from
order_service_item where order_line_id=(select current_order_line from order_master where
order_number='<order_number>'));
Order contract period

The below query will retrieve the contract period for an order which is set in the offer level:
select display_name, concat(contract_period, ' ', time_period) as contract_period from product_offer,
time_periods_meta where product_offer.contract_period_unit=time_periods_meta.id and product_offer.id =
(select product_offer_id from order_summary where order_number='<order_nummber>');
8 APRIL 2016
ENSIM CONFIDENTIAL
385
Provisioned date, Invoice start date and Cancellation date of an order

To retrieve the provisioned date, invoice start date and the cancellation date of an order, use the below
query:
select provisioned_date, invoice_start_date, cancelation_date from synergy_order_line where
orderid=(select id from order_master where order_number='<order_number>')
Provisioning information details of an order

To retrieve the provisioning information details of an order, please use the below query:
select * from order_cust_specfic_inp where order_line_id =(select current_order_line from order_master
where order_number='<order_number>');
Order summary
The below query will retrieve the order summary:
select id,order_number,cdbid,service_id,product_offer_id,order_creation_date from order_summary where
order_number= '<order_number>';
Sub-Order number
To check the sub-order numbers for an order, please execute the below query:
select id as synergy_order_line_hibernate_id, sub_order_number from synergy_order_line where orderid=(select
id from order_master where order_number=<order_number>');
In the above query, <order_number> will be taken as input that is displayed in the EAS UI.

8 APRIL 2016
ENSIM CONFIDENTIAL
386
Business Contact and Technical Contact of an order

To retrieve the details of Business Contact of an order, use the following query:
select id,user_name,create_datetime,last_login,activation_token from base_user where id=(select
business_contact from synergy_order_line where id=(select current_order_line from order_master where
order_number= '<order_number>'));
To retrieve the details of Technical Contact of an order, use the following query:
select id,user_name,create_datetime,last_login,activation_token from base_user where id=(select
tech_contact from synergy_order_line where id=(select current_order_line from order_master where
order_number= '<order_number>'));
Order Import
To retrieve the order import job details, execute the below query:
select * from order_importer_job
To retrieve the successful order import details, execute the below query:
select * from order_import_success_csv;
To retrieve the failed order import details, execute the below query:
select * from order_import_failure_csv;

8 APRIL 2016
ENSIM CONFIDENTIAL
387
Invoicing
On purchasing an offer, organizations need to pay the invoice based on the pricing specified for each items within
that offer. There may be one-time charges, monthly charges, charges based on the usages of various items of the
offer, etc.
Relationship between Service Provider invoice schema

invoice_master
id
order_id
order_item_id
invoice_details
id
master_ref_id
start_date
ppe_id
end_date
quantity_in_ppe
is_recurring
billed_amount
tariff_type_id
is_discount
is_promo
is_trial_old
is_stored_per_tier
is_trial
aged_item_ref_id
Relationship between Reseller invoice schema

reseller_invoice_master
id
reseller_invoice_details
reseller_id
id
order_id
reseller_master_ref_id
service_item_id
ppe_id
base_service_item_id
start_date
end_date
tariff_type_id
discount_percentage
aged_item_ref_id

8 APRIL 2016
ENSIM CONFIDENTIAL
388
To retrieve the details of Rating tool execution from first execution date till current date, please use the
below query:
select id, start_date_time, end_date_time, status, jar_type, invoicing_period, completed, jar_running_state,
job_instance_id, submitted_by, submitted_time, job_schedule_details_id, executed_command_line from
invoice_generator_status;
To retrieve the details of Rating execution for a specific date, please execute the below query:
select id, start_date_time, end_date_time, status, jar_type, invoicing_period, completed, jar_running_state,
job_instance_id, submitted_by, job_schedule_details_id, executed_command_line from invoice_generator_status
where CAST(submitted_time as DATE)= 'YYYY-MM-DD';
In the above query, date will be taken as input that needs to be provided in the format YYYY-MM-DD.
To retrieve the job details, execute the below query:
select job_id, job_name, schedule_time, criteria_string, job_status, is_active, execution_type, escm_jar_config_id,
submitted_by from job_schedule_details;
To retrieve the total invoice for an order from the invoice start date till current date, please execute the
below query:
select sum(billed_amount) as total_invoice from invoice_details where master_ref_id in (select id from
invoice_master where order_id=(select id from order_master where order_number='<order_number>'));
In the above query, <order_number> is the Order ID displayed in EAS UI.
To retrieve the total invoice amount of an order for a particular month, execute the below query:
select sum(billed_amount) as total_invoice from invoice_details where master_ref_id in (select id from
invoice_master where order_id=(select id from order_master where order_number='<order_number>') and
start_date>='<start_date>' and end_date<='<end_date>');
In the above query, <order_number> is the Order ID displayed in EAS UI.
<start_date> is the start date of the month.
<end_date> is the end date of the month.

8 APRIL 2016
ENSIM CONFIDENTIAL
389
CHAPTER 7
Service Bundling
In the prior releases of EAS, it was possible to bundle multiple manual services together and also one
automated service with one or more manual services.
In this release EAS introduces the concept of parent (bundled) and child services and uses mapping of
Resources and PIFs to achieve the desired product modelling. It is also possible to define upgrade options
from Offers of child services to Offers of parent services or between Offers of parent services. Service
provisioning, assignment to users and self-service UI is aware of service bundles to enforce consistency
across all the services included in the bundle.
Product managers can bundle multiple automated services into a single Offer. With this feature, EAS allows
the following combinations (included but not limited to) to be sold:
1.
Bundling multiple Automated services e.g.,

Hosted Exchange and McAfee Security
GoogleApps and Symantec Security
Microsoft Services pack of Exchange, SharePoint and Lync
2.
Bundling multiple Automated services with multiple Manual services e.g.,

IaaS (automated) with Network Management (manual)
CSP Office365, Azure with Managed Technical Services
3.
Bundling multiple Manual services of any kind
EAS introduces two terms Bundled Service (also known as Parent Service), and Child Service. Child
Services are the regular services from a single vendor, while a Bundled Service is made of more than one
Child Services. The resources of the Bundled Service are mapped to one or more resources of the child
services. Combo Items and Offers are created on the resources of the Bundled Service. The provisioning
workflow detects the child services and resources, and automatically provisions them in the specified
(configurable) sequence. The process of creating an Offer from a bundle service is outlined below:
1.
2.
3.
4.
5.
6.
Create a Bundled Service

Map resources to child services
Create Items from the resources of the Bundled Service
Create Offer from the Items
Define Upgrade options
Define other business rules

8 APRIL 2016
ENSIM CONFIDENTIAL
390
SERVICE BUNDLING CHAPTER 7
Note: That management of bundled service differs from that of a child service only in steps #1, #2, and
#5 which are elaborated in the subsequent sections. The rest of the process of managing and ordering
the Offers of a bundled service is same as that of a regular/child service, which is already described in
the previous chapters.
Creating Bundled Service

To bundle the services, complete the following steps.
1.
Create a Service and turn on the bundling option. This service will be marked as a bundled service.
2.
Click Map Child Services to map the child services.
3.
The list of regular services (that is, all non-bundled services) will be displayed. Select the desired
services (will be the child services of this bundled service) and set the provisioning sequence.
Provisioning sequence of child services within the Bundled Service will be the sequence in which they
will get provisioned when the Order is fulfilled or the service is assigned to users. If two or more
services have same provisioning sequence then provisioning engine will pick any one of them in
random order.

8 APRIL 2016
ENSIM CONFIDENTIAL
391
4.
Click Ok to successfully map the Services.
Note:
If any of the child service of bundle service is single instance then the bundle service itself should be
single instance.
You may still create regular Offers from the child services.
Resource Mapping
The resources of the parent service will consist of one or more composite resources (order item resources
and PIF resources). One composite resource will be mapped to one or more resources of the child services.
Mapping of parent resource to resources of child services can be done in EAS UI. The child services are
essentially regular Services in EAS while it is only the Parent Service that has a mapping rule for the
resources.
To map the resources for bundled service, follow the steps below1. Select the desired resource and click Map in the Resource Information section.

8 APRIL 2016
ENSIM CONFIDENTIAL
392
2.
The list resources will be displayed with respect to the child services. Select a particular service,
check the required resource name and set the Multiplication Factor value. This Multiplication Factor
helps in creating multiple combinations of quantities in the parent service from a single resource of
the child service. Multiplication Factor is mandatory, default value is one.
3.
Click Ok to map the child resources successfully.

8 APRIL 2016
ENSIM CONFIDENTIAL
393
Note: The Multiplication Factor is not applicable for Provisioning Information type resource hence,
while mapping such resources, the multiplication factor field will not appear.
Offer Upgrade Options

EAS allows upgrading from Offers of a single service to an Offer of a bundled service and Offer of a bundled service
to Offer of the same bundled service. For example, upgrade from Microsoft Exchange Offer to a combo Offer of
Exchange, SharePoint, and Lync. EAS allows automatic downgrades from Offers of bundled Services to Offers of
child services and Offer of bundled service to Offer of the same bundled service. For example, a downgrade from a
combo Offer of Exchange, SharePoint, and Lync to a Microsoft Exchange Offer.
Offer upgrade path:
1.
For the offers of child services, the upgrade path will display all the offers of the same service as well as all
the offers of the bundled services that has this service as a child.
2.
For the offers of bundled service, the upgrade path will display the offers of the same bundled service and
offers of child services.
When an order (on an Exchange service) is upgraded to a combo Offer of (Exchange, SharePoint, and Lync) EAS
will automatically perform the following tasks:
1.
Update the quotas of Exchange
2.
Newly provision Lync and SharePoint
When an order of combo Offer (Exchange, SharePoint, and Lync) is downgraded to an Exchange Offer, EAS will
automatically perform the following tasks:
1.
Update the quotas of Exchange
2.
Remove Lync and SharePoint
Note: Upsize for bundled Offer of any item with zero quota is not supported. No new service will be added
during order downgrade.

8 APRIL 2016
ENSIM CONFIDENTIAL
394
Assign Bundled Services to Users

EAS bundling allows product managers to define Items that represents a combination of seats of the child services.
For example an Enterprise Seat in the Microsoft pack may consist of
1.
2.
3.
One Enterprise Email account (Exchange Service)

One VoIP Account (Lync Service)
Access to SharePoint sites (SharePoint Service)
When a user is assigned an Enterprise Seat, EAS will assign all three services to the user. The process is explained
below with screen shots.

8 APRIL 2016
ENSIM CONFIDENTIAL
395
Publishing P2R Offers of Bundled Services

There is no difference in the mechanism of publishing P2R Offers to Reseller Type 2. The process of P2O
Offer management and Ordering is same as regular Offers.
Offer Import and Export for Bundled Service

The Offer export-import feature has been enhanced to automatically export and import all child services,
resources and other elements of an Offer of a bundled service.
Notification Enhancement for Bundling

1.
2.
Access Information (credentials) for each of the automated child services will be emailed by EAS to
the TC and BC of the Order. Each Service may require a different credential if they have a different
identity management system.
However each of the cloud vendors may directly send notifications to the Organizations as well.
A new conditional macro isBundled is available in the Notification templates which can be used to
compose the email body differently from that of child services.
Provisioning System ID
The provisioning system ID is the ID assigned by the service vendor (SDP) to fulfill the order. For cloud
based services, the cloud vendor typically assigns a unique ID to represent the Order. This ID is propagated
back to EAS by the connector and is available for searching the orders in EAS. For a parent service, as there
could be more than one Services, all the vendor IDs need to be captured and be available for searching
against them.
Billing
Pay-per-use billing for Items of bundled services is allowed only if the usage data is manually imported into
EAS. EAS does not support automatic usage collection for Items that involves multiple automated child
services. All other billing functionalities of regular Services are supported for bundled services seamlessly.
It is recommended that Offers of automated bundled services are sold in reservation only along with Payper-use value added manual items.

8 APRIL 2016
ENSIM CONFIDENTIAL
396
CHAPTER 8
Finance Module
Introduction
Finance Module covers the entire billing system of EAS right from Usage collection, rating to Invoicing after
an order gets provisioned. First the usage report is generated and then it is dumped in the database from
where it is taken into account for rating and then the rated data is exported and invoiced accordingly.
Usage collection
After the service is provisioned in ESOM the usage reports are generated for the services in CSV format.
These CSV reports are getting stored in specified shared location. With these CSV report files some text files
are also getting report generated containing the report status info. These text files contain the name of the
CSV files for services which has to be downloaded from the shared location to the local server through ftp.
When you run the .jar file called UsageCollection.jar is executed, the following actions will be performed1.
It will identify the shared location in the ftp server.
2.
CSV files will be downloaded through ftp transfer.
3.
These files will be dumped in the local server.
During the process of dumping CSV data into the database the .jar file refers to a config.xml file where
database configuration setting and ftp setting has been made.
With this config.xml file we also have to configure another log4j.xml file where you can set name of the log
file and specify the location where the log file will be generated.
Binaries
This background provisioning module contains one jar file and two xml files1.
2.
3.
UsageCollection.jar
config.xml
log4j.xml

8 APRIL 2016
ENSIM CONFIDENTIAL
397
FINANCE MODULE CHAPTER 8
Run the UsageCollection.jar

After making all the configuration changes in the config.xml file and log4j.xml file run the
UsageCollection.jar file with the following commandjava -Dlog4j.configuration=file://<location of the log4j.xml file>/log4j.xml -jar <location of the jar file>/<jar file name> .jar <dd mm
yyyy>
For examplejava -Dlog4j.configuration=file://home/order/usage/log4j.xml -jar /usr/share/usage_collection/UsageCollection.jar 01 06 2015
Check version of the executable jar file:

To check the version of the executable UsageCollection.jar file put the following commandjava jar <location of the jar file>/<name of the jar>.jar v
For example:
java jar /usr/share/usage_collection/UsageCollection.jar v
In EAS, the Usage collection jar and Usage Import tool supports BPA specific usage collection as described
below:
Changes in usage collection jars config.xml file in FTP properties.

<ftpproperties> 
<property name="host" value="<FTP host IP>" />
<property name="user" value="<FTP user naem>"/>
<property name="password" value="<FTP user password>"/>
<property name="sourcedirectory" value="<source directory location>" />
<property name="storagedirectory" value="<storage directory location>" />
<property name="initial_date" value="<initial start date>" />
<property name="external_usage_files" value="<extrenal usage file location>" />
<property name="manual_usage_files" value="<BPA usage file loaction>"/>
</ftpproperties>
Two fields are added in Usage CSV to support fiscal billing period: billingstartdate and
billingenddate.

8 APRIL 2016
ENSIM CONFIDENTIAL
398
Tax
In EAS, the Tax feature allows billing of orders (placed by Organizations) with the applicable taxes per item
along with discounts and promos. Tax is applicable for orders that have the Tax feature enabled in EAS. The
following options are available:
Turn ON for Service Provider and all Resellers
Turn ON for Service Provider only
If EAS is not used for Invoicing (that is, final Taxing), the Tax module is either not used at all or used only
for quoting or ordering the estimated tax. Therefore, there are two options:
Quoting
Invoicing
Configure Tax
The Service Provider user can configure Tax settings only if the Enable Tax Management privilege is
provided. To configure tax, complete the following steps.
1. Click Configuration.
2. In the left pane, click Tax Management.
3.
On the Configuration tab, set the following fields as required and click Save Changes.
Enable Tax: Select this option to use the Tax feature. At the item level, a text box appears for
entering the tax code.
Enable Tax for All Resellers: Select this option to make the Tax feature available to all resellers.
Apply Tax: Select this option to display the tax deducted value on the order page.

8 APRIL 2016
ENSIM CONFIDENTIAL
399
All tax codes, which are updated in the system, must be attached to the items. While creating an
item under general properties, the option to attach tax codes is available. The user must provide
the tax code manually (all tax codes applicable to the item are displayed).
Note: As prior to 4.3 release, tax was not supported by EAS, for existing orders, tax 0 code
is attached to the corresponding items by default. The order total is displayed with the total
tax as 0.
Purpose: Select the option(s) for which you want the tax to be calculated.
Orders
Invoices
Tax Management System: Select the Tax Management System you want to use. Tax Connectors
may be internal (that is, Ensim Tax Management system) or external. Currently, no external tax
connector is used to calculate tax.
Note: For an internal or local tax connector, the Tax rates are stored in the internal tax
tables in the EAS database.
Import or Export Tax Codes

After the tax feature is configured, you must import the tax codes to the database. You can view the
imported tax codes in a database using the tax code export functionality.
To import the tax codes, on the Import/Export Data tab, select the Tax Management System and
upload the CSV file containing tax codes, and then, click Upload.

8 APRIL 2016
ENSIM CONFIDENTIAL
400
Note: To download a sample CSV file, click Download Sample CSV.
To export the tax codes, on the Import/Export Data tab, select the Tax Management System and
click Export Tax Data.

8 APRIL 2016
ENSIM CONFIDENTIAL
401
Provide External Connector-Specific Authentication Data

If an external tax connector is used to calculate tax, the tax connector specific input XML data (for example,
SURETAX) must be stored for authentication.
On the System Credential Data tab, select the Tax Management system, provide the connector specific
input, and then, click Save Changes.

8 APRIL 2016
ENSIM CONFIDENTIAL
402
Rating calculates the tax applicable per item per order and exports the same in the exported files.
The exported files contain the following additional columns for tax calculation.
ORDER_TOTAL_TAX_AMOUNT_ARREARS
ORDER_TOTAL_TAX_AMOUNT_ADVANCE
ORDER_TOTAL_TAX_ON_TAX_AMOUNT_ARREARS
ORDER_TOTAL_TAX_ON_TAX_AMOUNT_ADVANCE
ITEM_TOTAL_TAX_AMOUNT_ARREAR
ITEM_TOTAL_TAX_AMOUNT_ADVANCE
ITEM_TOTAL_TAX_ON_TAX_AMOUNT_ARREARS
ITEM_TOTAL_TAX_ON_TAX_AMOUNT_ADVANCE
ITEM_TAX_CODE
The tax information is displayed on the Summary page. EAS does not display the tax information when the
item quantities are chosen.

8 APRIL 2016
ENSIM CONFIDENTIAL
403
Once the order is placed, tax is shown on the Order Summary page.
Rating
On purchasing an offer, organizations need to pay the invoice based on the pricing specified for each items
within that offer. There may be one-time charges, monthly charges, charges based on the usages of various
items of the offer, etc. This charge applicable on individual items is termed as Rating.
Rating concept is completely based on business point of view. Service Provider will provide services to
organizations and charge accordingly. Rating calculation is executed on a monthly basis on every running
order that is provisioned for the organization. Rating job will run on a daily basis instead of monthly. It is be
possible to rate all subscribed orders for a specific customer, specific offer, specific service.
BCD (Bill Cycle Day)

Bill Cycle Day (BCD) signifies the bill cycle of an order (that is, the day of each month on which invoice will
be generated against that order). Suppose the BCD of an order is set as 5 th of a month, then Rating will
generate invoice against that order from 5th of the previous month to 4th of the current month.
You can set the BCD for new orders or modify the BCD of existing orders at three levels.
Service level:
To set or modify the BCD at the service level, select one of the following options as applicable.

8 APRIL 2016
ENSIM CONFIDENTIAL
404
As in account: If you select this option, the BCD is set according to the BCD value selected at the
account (under which the order is provisioned) level.
Order fulfillment day: If you select this option, the BCD is set according to the date on which the Order
is fulfilled in EAS (provisioned). For example, if the order is provisioned on 10th of the month, then the
bill cycle day of that order will be 10. BCD can be set from 1-28 of any month. If for any order is
provisioned from 29th to 31st of any month the BCD of the corresponding order will be considered as 28
and calculated accordingly.
Updated by connector: If you select this option, the BCD is set according to the date on which the
service is activated at the service platform. For example, if an order is provisioned on the 14th of a
month and activated on the 18th at the service platform, then the BCD of the Order will be set as 18. If
the order activation at the service platform is done between 29 and 31 of any month the BCD of the
corresponding order will be considered as 28 and the calculations will be done accordingly.
Specific day: Select this option to fix a day (Between 1 to 28) of the month on which all the orders of
that service will be billed irrespective of the Account level BCD or Order fulfillment date (in EAS or on
the service platform).

8 APRIL 2016
ENSIM CONFIDENTIAL
405
Account level:
You can set the BCD in the billable account details of an organization. By default, it is set to 1, that is, 1st day
of a month. You can change it to set any day from 1st to 28th.
The account level BCD is effective only if the As in account option is selected at the service level.
You can set the account level BCD of the master account while creating the Organization.
You can also set the account level BCD for additional billable accounts while adding an account of an
Organization.

8 APRIL 2016
ENSIM CONFIDENTIAL
406
Order Level:
You can set the BCD per order according to the order provision date in EAS or order activation date in the
service platform, irrespective of the BCD of the account under which it is ordered. This date is effective only
if the Order fulfillment day or Updated by Connector option is selected at the service level.
Changing BCD
You can change the BCD for a service, account, or an order. This affects the BCD of the existing orders and
the subsequent orders. You can change the BCD of an existing subscribed order; however, it does not affect
the subscription renewal.
If you change the BCD set on a specific day at the service level, all existing orders of that service are
updated with the new BCD.
If you change the BCD at the account level, all existing orders of that account having the As in account
rule set at the service level BCD are updated.
BCD is changed from account or service level using the action log. However, as an asynchronous operation
is necessary to update the BCD of a huge number of order records, it is displayed in the Activity Log as
shown in the following figure.
To change the BCD for an existing order at the order level, on the Order Details page, click Edit.

8 APRIL 2016
ENSIM CONFIDENTIAL
407
While changing BCD from service, account or order level, EAS provides two options:
Bill from next invoice
Bill prorated
The following use cases explain each scenario.
Use case 1: Rating calculation for changing the BCD with Bill from next invoice option selected
Example 1: If on 18th January 2016 the provider changes the BCD to 22 from 14, then the next bill will be
generated on 22nd January 2016 and that will have all the charges from 22 nd December 2015 to 21st January
2016.
Before changing the BCD, the last bill of the order was done on 14 th January 2016 (as the BCD was 14 at that
time) and it was charged for 14th December to 13th January 2016. So, In this case the effect of the change BCD
will charge the order twice for the period 22nd December 15 to 13th December 16.
generated on 22nd January 2016 and that will have all the charges from 22 nd December 2015 to 21st January
2016.
Before changing the BCD the last bill of the order was done on 14 th December 2016 (as the BCD was 14 at
that time) and it charged for 14th November to 13th December 2016. So, In this case the effect of the change
BCD will not charge the order for the period 14th December 15 to 21st December 16.
As this rule is designed not to consider prior BCD of the order hence the over or under charge, it is advised
that if provider selects the change BCD option as Bill from next invoice then the bill settlement with
respect to last bill should be done via back office systems.
Use case 2: Rating calculation for changing the BCD with Bill pro-rated option selected

8 APRIL 2016
ENSIM CONFIDENTIAL
408
generated on 22nd January 2016 and that will have all the charges the account in pro rata basis and from 14 th
January 2015 to 21st January 2016.
generated on 10th January 2016 and that will have all the charges from 14 th December 2015 to 10th January
2016. There is no over or under charge.
Suspend or Resume Billing

Provider can suspend billing and resume billing without cancelling the Order. This can be useful when an
Organization wants to suspend a subscription for some time period without changing the order state. Note:
In case of order cancellation, resume cannot take place if the retention period in either EAS or the target
service has been passed.
The provider user who has the Mark Order as Billable permission, can suspend or resume billing.
On the Order Details page, to suspend the billing of an order, click Suspend Billing from the order action
pane.
Select one of the following options as applicable.
Current date time: In this case, the billing of the order will be suspended at the current moment. For
example, if the current date is 5th April, 2016 and the current time is 12:52:54 pm and while suspending
billing of a specific order, you have selected the current date and time option, then the billing gets
suspended on 5th April, 2016 at 12:52:54 pm.
On a specific date: In this case, EAS allows you to select a future date and the billing of the order gets
suspended from that specific date. For example, if the current date is 5th April, 2016 and while
suspending billing of a specific order, you have selected the date as 10 th April 2016, then the billing of
the Order gets suspended on 10th April, 2016 at 11:59:59 pm.

8 APRIL 2016
ENSIM CONFIDENTIAL
409
Note: For an active installment item in an order, first stop the Installment item and then perform the
Stop Billing action.
When the billing of an order is in the suspended mode, then only cancellation and configuration (order
self-service) of the order is possible.
Subscription auto renewal of an order is not possible if the bill is suspended on the anniversary;
however, if the renewal option is auto cancel, then the order gets cancelled on the anniversary.
Once a billing of the order is suspended, then instead of Stop Billing button Resume Billing button is
available. To resume the billing of an order, click Resume billing.
The use cases for this feature is similar to Billing order cancellation use cases.

8 APRIL 2016
ENSIM CONFIDENTIAL
410
Use case 1:
If the bill suspension and the resubmission occurs within a billing cycle, then the order is billed for the
whole month. For example, if the BCD of the Order is 1 and the billing is suspended on 7th April and
Billing is resumed on 20th April, then the bill generated for the period 1st April to 30th April does not
consider the bill suspension period (7th to 19th) at all.
Use case 2:
If the bill suspension occurs during a bill cycle (Say A) and resubmission occurs in the next bill cycle
(Say B), then the billing for the bill cycle A (during which billing suspension took place) is prorated and
billing for the following bill cycle B (during which billing resubmission took place) is charged from the
first day of the bill cycle. If the provider wishes to charge bill cycle A in full, then he must perform a
historical run for bill cycle A.
Modify Billing
The provider user who has the Adjust Billing Date permission, can adjust the invoice start date of an
order from the Order UI.
On the Order Details page, to modify the invoice start date of an order, click Modify Billing from the order
action pane.
Select one of the following options as applicable.
Current date time: In this case, the invoice start date of the order will be the current date.
On a specific date: In this case, EAS allows you to select a future invoice start date. For example, if the
current date is 5th April, 2016 and while suspending billing of a specific order, you have selected the
date as 10th April 2016, then the billing of the Order gets started on 10 th April, 2016.

8 APRIL 2016
ENSIM CONFIDENTIAL
411
Killing a Process
The Process Kill feature enables users (provided the user have the corresponding permission) to kill a
rating process while execution i.e. when a schedule job or ad hoc run is running in the UI beside the status
bar a button will appear, clicking which will terminate the ongoing process.

8 APRIL 2016
ENSIM CONFIDENTIAL
412
Mid-Month Billing Rule

An order may be rated for the whole month if the Order request is fulfilled on or before the 15th day of the
billing cycle, or rated as zero for the month if the Order is fulfilled after the 15th day of the billing cycle.
During offer creation, under Billing Rules, to set the day (in this case, 15), select the Full month billing
with latest order action that has happened on or before <number> day from the bill cycle day option.
Note: You may set any day between 1 to 28, if you do not want it to be mid month.
Skip Billing
During offer creation, in the Billing Rules section, for Cancel order action, you can specify the number of
days. No billing will be done for the order for the month (fiscal or calendar) of cancellation, if the
cancellation happened on or before the number of days (as specified in the text box) from the last bill date.

8 APRIL 2016
ENSIM CONFIDENTIAL
413
Usage Buffer Day

Rating will be supporting usage buffer days to include the usage data of the previous billing period as
many services do not provide usage data information instantly when the date/period is completed. For an
example, if someone sets usage buffer day as 5 days, then during rating run on 13th of month it will
consider those orders whose bill cycle day is (13 -5) = 8th of each month and will calculate for the period 8 th
of previous month to 7th of the current month.
Pro Rata Calculation

Earlier pro rata calculation was applicable to reserved type of items only. EAS includes pro rata calculation
on PPU items too. In Pro rata calculation rating is calculated on the resources based on the days of usage of
this resource within a month. Pro rata calculation is done based on the following formulae
Order quantity of the item*(number of days of usage of the resource within a month/total number of days in
that month)*base price (this price will differ for each tier).
The following example will clear the idea a bit
Say, an offer has been provisioned on 5th January, 2015 contains one reserved type of item. Order quantity of
this item is 50 and base price for the suitable tier is 25 dollars. If this offer is getting upgraded on 17th
January, 2015 then the rating calculation for that particular tier on that reserved item will be as follow50*(12/31)*25=483.870 dollars
Upsize
Increasing the number of quantity of individual items within an offer is termed as upsizing the offer.
Upsizing of an offer depends upon the following factors1.
Increment in number of quantity of items
2.
Weight of the items. Default weight for each item is -1.

If quantity of any of the item within an offer gets increased, then the offer will be considered as
upsized, in this scenario, weight of the items do not come into play.
But, if the quantity of the items remains the same or gets decreased and the weight of that items is
set to a positive integer value, then also the offer will be considered as upsized.
Weight against the individual items within an offer can be set at the offer level in EAS by the
following way
a.
Log in to the EAS portal.
b.
Click the Offers tab.
c.
Select the desired service and its list of the offers appears.
d. Click the Configure button in the Item weight column against any of the listed offers.
e.
The Item weight configuration page appears where weight may be set against each item within
an offer.

8 APRIL 2016
ENSIM CONFIDENTIAL
414

8 APRIL 2016
ENSIM CONFIDENTIAL
415
3.
Upsize calculations can also be done in full month mode along with prorated, which is if the
upsize occurs in the middle of the month then the calculation will be done on the highest quantity
for full month. This option will be in the offer level settings as billing rule.
Downsize
Decreasing quantity of the items within an offer is termed as downsizing the offer. Downsizing also
depends upon the following two factors1.
Decrement in number of quantity of items
2.
Weight of the items

If quantity of any of the item within an offer gets decreased then the offer will be considered as
downsized.
And in downsizing of the offer item weight must be set to -1 because any positive integer value in
the weight will lead the offer to the upsizing mode.
Note: Downsize calculations with full month mode is not considered in rating. Downsize calculation is
always prorated.

8 APRIL 2016
ENSIM CONFIDENTIAL
416
Upgrade
Altering from one offer to another offer having higher pricing value. This is termed as upgrading. Upgrade
weight for each offer is set while creation of an offer based on the offer value. If we want to upgrade from
one offer to another one then the weight of the new offer has to be greater than the weight of the existing
offer.
There may be multiple offers available during offer up-gradation. (For up-gradation, offers having higher
offer weight than the current one from the Upgradable to list-box on the offer creation page. For setting
the offer weight of the current offer and to set multiple offers in the upgraded to drop-down list.)
Downgrade
Switch from one offer to another offer having lower pricing value is termed as downgrading. If offer is to be
downgrade from one to another then the weight of the new offer has to be less than the weight of the
existing offer.
There may be multiple offers available to be downgraded while attempting for downgrading the offer. For
that offers having lower offer weight than the current one has to be selected from the upgradable to dropdown list on the offer creation page.
Advance Billing
Advance calculation is done on the reserved type of items only. In EAS whenever rating is calculated on the
reserved type of items for a particular month, an advance is also getting added to the account for the next
month for that particular item.

8 APRIL 2016
ENSIM CONFIDENTIAL
417
For example, an offer containing a reserved item gets provisioned on 10 th March, 2015. If rating is calculated
on this offer for the month of March of the year 2015, rating will be done on this reserved item for March,
2015 and with this an advance rating will be done for the month of April on this reserved item as well.
Reimbursements
Reimbursement comes into act at the time of upgrading of the offer which contains at least one reserved
type of item within it. At the time of upgrade in the middle of the month (excluding the month on which the
offer was provisioned), the surplus amount needs to be refunded to the organization which was taken from
the organization in form of advance rating amount. This pay-back process is termed as Reimbursement.
Reimbursement is calculated only on Reserved items and this reimbursement process is tightly bound
with the advance rating calculation.
Following example will help to view the picture from a better angle
An offer contains one reserved type item. This offer was provisioned on 7 th February, 2015. This offer gets
upgraded on 19th March, 2015.
Rating for the month of February, 2015 will calculate the rating amount on the reserved item within the
previous offer from 7th February to 28th February. Also advance rating will be done from 1 st March, 2015 to
31st March, 2015 on the reserved item of the previous offer.
When rating is executed for the month of March, 2015 then rating will calculate the amount on the reserved
item of the previous offer from 1st March to 18th March, 2015. And reimbursement amount will be calculated
from 19th March, 2015 to 28th March, 2015 as the amount for this period of time is already taken in form of
advance.
Suspend
In EAS, Suspend action can be performed on a provisioned order. On performing this action the
organization will not be able to use the service until the state is turned into the resumed state. Order
suspension can be done in certain situation where the organization failed to pay the invoice or so. The order
for those organizations will be activated by turn off the suspend state when they will clear the invoice.
When a provisioned order gets entered into this state, then rating is not getting affected, rating process
continues for the suspension period.
Resume
After suspension period is over the provisioned order can be resumed. Resuming an order means the
order will be in active state for the organizations and they will be able to use the services and charges will
be applied accordingly by rating process.
Cancel
Cancel operation stops the current service which was provisioned to the organization. Cancel request for a
particular offer cannot be provisioned at the middle of the month. The request is taken under consideration
but is getting activated from the last day of that month.
EAS application also supports force cancellation in the middle of the month.

8 APRIL 2016
ENSIM CONFIDENTIAL
418
Like reimbursement if offer gets cancelled in the middle of the month (excluding the month in which the
offer was provisioned), then a cancellation amount is calculated by the rating process, which was taken in
form of advance. This cancellation amount is also related to the advance amount taken on the reserved type
of items.
See the example belowAn offer contains one reserved type item. This offer was provisioned on 10 th February, 2015. This offer gets
cancelled on 20th March, 2015.
Rating for the month of February, 2015 will calculate the rating amount on the reserved item within the
previous offer from 10th February to 28th February. Also advance rating will be done from 1 st March, 2015 to
31st March, 2015 on the reserved item of the previous offer.
When rating is executed for the month of March, 2015 then rating will calculate the amount on the reserved
item of the previous offer from 1st March to 20th March, 2015. And cancellation amount will be calculated
from 21th March, 2015 to 31th march, 2015. Whether this amount will be refunded back to the organization or
not will be decided by the Service provider.
Forced Cancellation
Forced cancellation is the process of cancelling an Order anytime during the month. Normal cancellation
process is executed only at the end of the month. In EAS, Organizations can submit cancellation requests
anytime during the month but the execution is deferred till the end of the month. However the users of
Service Provider, Resellers and Agents are given right (if turned on) to execute cancellation anytime of the
month if the customers persist. Earlier whenever a force cancellation used to happen, Rating Engine used to
take the Invoice stop date as the date in which the order used to be in the suspended for cancellation state
and bill accordingly.

8 APRIL 2016
ENSIM CONFIDENTIAL
419
Annual Billing
EAS rates an item on yearly basis, depending upon the billing frequency set in the item configuration
section of the Offer. Yearly billing item will only be set for a subscribed offer.
For the yearly calculation the Rating Engine will charge the reserved advance amount for the whole year.
Currently, rating calculation for multi annum billable item is out of scope.
1.
2.
For n year subscribed offers the billing frequency will always less than n, and the billing frequency
will always the factorial integral of the subscription period (i.e. if the subscription period is 1 year
then the billing frequency should be less than 12months and 1,2,3,4.6 months.)
If an upgrade takes place in between the subscription period then the reimbursement calculation
will be done and the rating will be calculated on the new offer.
If the yearly item is getting upsized or downsized during subscription period. Then the
reimbursement will happen for the old quality. Rating will charge the yearly item depending upon
the current quantity of the upsized or down charge order for the remaining bill period.
If provider or organization user cancels an order during the subscription period then rating will
calculate the reimbursement of the yearly billing item for the remaining period of subscription.
Billing Hole
Items having monthly billing frequency: If an order is cancelled and resumed within the same month, then
the rating process rates the order for whole month i.e. the cancellation period is not included in rating
calculation.
For examplean active Order (provisioned in the month of September) is cancelled on 10th October 2015 and
is resumed on 20th October 2015. Billing calculation for the month of October 2015 will rate the Order for the
full month irrespective of the cancellation.
Items having yearly billing frequency: For Annual items/(monthly items having termed subscription
period more than 1 month), if cancellation takes place (not in the month of provision) then User will not be
allowed to resume the cancelled order, and in the next bill run Rating will calculate the reimbursement
amount for the rest of the subscription period from the day of cancelation and will reimburse accordingly.
This restriction will impact all the offers that have at least 1 annual item, or monthly items having termed
subscription period more than 1 month.
Change of Offer during Subscription period

In EAS, TERM_SUBSCRIPTION_CODE field has been introduced on the offer creation page under
Subscription details accordion. Users upgrading or downgrading a subscribed order will be billed as per the
following rules:
a.
If the value of TERM_SUBSCRIPTION_CODE is identical in both the offers (upgrade/downgrade

FROM and upgrade/downgrade TO) then subscription period will not be changed. The user
i. Will be billed as per the existing proration rule of upgrade/downgrade TO offer.
ii. Will get the reimbursement as per the existing prorated rule of Upgrade/downgrade FROM
offer.
b.
If the TERM_SUBSCRIPTION_CODE is different or blank in both the offers then subscription

period will be reset as per the upgrade/downgrade TO offer. The user

8 APRIL 2016
ENSIM CONFIDENTIAL
420
i. Will be billed as per upgrade/downgrade TO offer for the Full tenure with the new
subscription period.
ii. Will get the reimbursement as per the existing prorated rule of Upgrade/downgrade FROM
offer.
Differential Billing Mode

Pricing or reservation or Usage quantity adjustment is required if the bill contains wrong data for the order
placed by the Customer. With the help of this feature Service provider should be able to rectify the data and
a new bill will be issued with the correct data. To support these feature presently EAS has one new option
called Diff Billing. If SP selected this option at the time of billing run then the rating jar should pick up
only those order which orders are adjusted. For the normal billing SP should select Full Run option.
Future Billing
In the Billing Rule section of the Offer, EAS has an option to initiate billing on start of the next month for
provision only. Provisioning engine will stamp the INVOICE_START_DATE as the start of the next month
and billing for those orders will be started from the first day of next month. For such orders, users will not
be charged for the first month.

8 APRIL 2016
ENSIM CONFIDENTIAL
421
Rating Configuration and Scheduling

Rating Configuration Tab states the configuration details made from the UI in order to generate specific
results for rating for a particular organization or reseller.
The respective fields that are need to be configured are as follows:
Floor Order quantity - If checked, the ordered quantities of the items will be rounded off to the (lower)
integer values. For e.g.; 5.4 and 4.3 will be rounded of as 5 and 4 respectively.
Bill Reseller for trial order - It specifies whether the respective reseller will be billed if their customers
subscribe to trial offer. By default it is set to true.
If an Order is cancelled, still invoice the customer for the day of cancellation: -It specifies that whether the
day in which the order is cancelled should be included or not. By default it is false. E.g.: If an order is
cancelled on 10th March, invoice the customer till 10th March when the option is selected.
Split the output files after including <no of order each file> orders: It determines how many order will be
included in each output file. For e.g.: if there are 25000 orders and the split limit is set to 10000 then three
files will be created containing 10000, 10000, 5000 orders respectively. Avoid a very large value as large files
are difficult to manage.
Output Location:
> In a shared Directory- It is used to specify the shared path where the output file will be stored.
> In a local directory of application node- It is used to specify the Path in the local directory format. Ensure
that the location must be writable by Tomcat User.
Shared directory location* - It specifies the path of the shared folder on a file server
Username* - We need to specify this only if we are using shared directory for storing the output.
Password* - We need to specify this only if we are using shared directory for storing the output.
Buffer days for System Downtime: If the system was down for a day, the scheduled rating run for the day
will be skipped. To let the system automatically verify missed jobs specify a positive value. E.g., if 2 is
specified, the rating job will look backward up to 2 days in search of missed rating runs.
OS Command To kill a process: The command will be used to kill a running process, where {0} will be
replaced by actual process ID at runtime.

8 APRIL 2016
ENSIM CONFIDENTIAL
422
General Settings
The option is used to configure various tools which includes application server name, schedule time, retry
count etc. Specifically for Rating jobs the operator has to select the right application server and then save, it
automatically creates Default Rating job
Schedule Day This date states the day of the month; for Usage Collector and Rating, Schedule Day is
Daily and cannot be changed.
Scheduled Time Time need to set in hourly format(24 hrs. format).
Retry Count The number of times the scheduler will try if something goes wrong while running
scheduler. Each module has its own retry count.
Application Server The server where all the modules are placed. Select from the list of registered servers
in registered application server.
Required Any module can be stopped even after scheduling. Uncheck if the module is not required.
Scheduled Rating Jobs

Scheduled Rating Jobs tab is used to configure the Rating jobs and to view the already configured rating
jobs:
The following sreenshot depicts various parameters of Rating Jobs:
Job ID: Can be Auto generated or can be entered manually but it should be unique.
Name: Job name will be given in this field
Created by: Name of the creator who is adding the job.
Scheduled time: The particular time when the jobs are scheduled to run.
Active: The current status of the Job

8 APRIL 2016
ENSIM CONFIDENTIAL
423
For adding new jobs operator has to click the button Add New Job and then it will be redirected into the
following window:
Different input criteria can be set while creating a job. All orders will be the default selection whereas user
can choose a particular service and its corresponding offer or a set of order ids to create a Rating job.
In the output criteria user can specify what are the item types to be included in the rating output, what will
be the output content (rated/unrated) and what will be the output file format (CSV/XML or both).

8 APRIL 2016
ENSIM CONFIDENTIAL
424
Note: XML output file is currently supported only for Rated Export.
Limitation :- Ensim has a promotion model to support discounts on order total (only fixed amount) as well
as item total (either % of item total or fixed amount). If splitting of invoices based upon the item type is
supported (reserved, one time, pay per use etc.), promo discount on order total will not work.
Default Rating Job: the deafut job can be autometically created, for that operator has to click General
Setting tab, then click Edit Details and save. Default job will be created internally by the system. The job is
required to perform various internal operation for Rating run.
Status
Status tab states the history of all the previous run by this scheduler along with last running status.
Following screen\shot shows status of different modules.
Viewing status of EAS Tools

8 APRIL 2016
ENSIM CONFIDENTIAL
425
The status tab shows the status of all the latest tasks in EAS. If operator wants the the status of previous
runs, Click history link and a list will appear showing all the previous instances of rating run along with
other details. EAS also provides search option for different jobs and its status. The operator can search job
by specifying its name or id. In case of Rating job status operator can search the job status by multiple
searching option.
Following screenshot shows the history of Rating jobs.
Historical Run
In Historical Run tab, output data of any day of previous month can be generated. To get historical data,
select the tool from Task Name dropdown list, provide Date, month and year whatever is applicable in
numeric format and get the data.
To be mention, Date field is applicable only for Usage Collector and Rating module and for other
modules keep this field empty.
E.g. To run Usage Collector module for 13th August 2015, provide data as follows-
Fig: Historical Run for Usage Collector.

8 APRIL 2016
ENSIM CONFIDENTIAL
426
Fig: Historical Run for Rating.
User Permissions, Schedule Jobs and Ad-Hoc Run

EAS has two new rights to operate jobs
Configure Scheduled Jobs: assigning this right allows a user to create and edit jobs.
Execute Scheduled Jobs: assigning this right allows a user to execute and stop different jobs and also
allows download of generated output files.
Only those users who have these permissions can do the job configuration and execution.
A new job (Rating job) can be added on the basis of specific service, specific offer, set of order ids, set of
organization ids. Multiple Rating Jobs can also be created. It is possible to run them from the UI (ad-hoc)
and/or is possible to schedule them at a particular time. The schedulers (Rating jobs) will execute every day
and will consider a subset of the orders on a given calendar day which are having the BCD on that
applicable day (i.e. after taking into consideration of usage buffer day which is already described above).
Keep in mind , rating run for adjustments (i.e. Differential Run) will run for a calendar month range to get
the applicable orders from database, but those orders will be rated according to their BCDs.
Execution of a Job the jobs will automatically run on scheduled time however, they can be executed
manually from UI on ad-hoc basis.
Apart from scheduling EAS also provides option for Ad-hoc run of different jobs. Allowed user can execute
job at any point in time by clicking Run Now button from the job listing page. Once it is clicked it will
show some of the filters with which the job was created. The user can alter those filters if required before
executing the ad hoc run.

8 APRIL 2016
ENSIM CONFIDENTIAL
427
The following section depicts different filter criteria:

Service Name : it is possible to choose specific service to rate.
Offer Name: it is possible to choose the Offer of the selected service for which the rating is to be executed.
Organization IDs: It is possible to rate all orders for a specific customer or a set of customer.
Order IDs: User is able to create rating job for a specific order or a set of orders.
Item: User will be is able to create rating run for single or combinations of different types of items i.e.
Reserved, PPU, One-time, Installment.
Example:
1. Rate all Orders of customer with ID = ENSIM001, only include Usage based Items, between 10th Jan
and 9th Feb for Azure service.
2. Rate all Orders of Google Apps that were to be billed between 5th Feb and 4th March
3. Rate the Order Id ENSIM12345
Scheduled jobs can be deactivated from the UI. If so then those set of jobs will be excluded from the daily
scheduled run whereas EAS provides ad-hoc run option to execute the jobs on demand.
Downloading Output Output files can be downloaded after complete execution of any job. The output is
split into multiple files, each file containing up to 10000 orders (configurable). If there are 15000 files, there
will be three output files
a. One for first 10000 orders
b. One for remaining 5000
c. One zip file containing both of the above.
Above files will be stored at the location configured in Rating Configuration. The zip file that contains all
the generated output files will be available for download.

8 APRIL 2016
ENSIM CONFIDENTIAL
428

8 APRIL 2016
ENSIM CONFIDENTIAL
429
Expected Output File Format

Exported File
CSV
XML
Unrated Exporter
Rated Exporter (P2O)
Rated Exporter (P2R)
In EAS, rating is calculated on each tier of every item within an offer. One tier specifies the pricing on a certain
quantity range of different items.
Behavior of rating on different types of tiers1. In case of flat rate, there will be one single rating line in the database.
2. In case of tier-absolute, rating line will also be one because in this case the absolute tier range is chosen
depending on the given item quantity. See the example belowi. 0 to 100 : 2500 dollars (base price)
ii. 100 to Unlimited : 1500 dollars (base price)
If the given order quantity is 120 then rating line will be one and that will be for tier range (ii) as
shown above.
But if the order quantity for this item is 100, then question will arise which tier range will be
chosen? To resolve this issue EAS supports two feature- Starts With and Ends With
In case of starts with the rule is
a.
b.
Item quantity <=99 will fall under tier range (i) and
Item quantity >=100 will fall under tier range (ii) For integer value
In case of ends with the rule is

a. Item quantity<=100 will fall under tier range (i) and
b. Item quantity >=101 will fall under tier range (ii)
Consider the following tier rangesi. 0 to 100.00 : 1234.8765 (base price)
ii. 100.00 to 1000.00 : 675.4532 (base price)
iii. 1000.00 to Unlimited : 549.6382 (base price)

8 APRIL 2016
ENSIM CONFIDENTIAL
430
In case of Starts-With the rule isa. Item quantity<=99.99 will fall under tier range (i)
b. Item quantity>=100.00 will fall under tier range (ii)
In case of Ends-With the rule isa. Item quantity<=100.00 will fall under tier (i) and For real value
b. Item quantity>=100.01 will fall under tier (ii)
3.
In case of tier-relative, rating lines can be multiple. See the examplei. 0 to 1000 : 5000 dollars (base price)
ii. 1000 to 2000 : 3000 dollars (base price)
iii. 2000 to Unlimited : 1500 dollars (base price)
If the given item quantity is 1500 then rating line will be twoOne for 999 quantities and the next for the rest 501 quantities (when starts-with rule is applied).
One for 1000 quantities and another for next 500 quantities (when ends-with rule is applied).
To know more about these tiers and pricing of items please refer to the product model section in this
document.
EAS has its own rating system as well as the facility of invoice generation. Invoice generating system works on the
following Rating output
Previous month calculation
Late fees (calculated in percentage (%)) and Actual Payment or Payment reconciliation.
All the above factors are the part of Financial Settlement System.
Presently, payment reconciliation is being done; that is payment entries are corresponded to external
entries.
Note: Payment Gateway plugins are to be implemented shortly in future.

8 APRIL 2016
ENSIM CONFIDENTIAL
431
Here three possible situations may arise on basis of those EAS will behave accordingly. The possible cases
are as followCase 1: In case of large Telco company where it is expected that they will have their own rating system as
well as financial settlement system. For such kind of clients EAS will only provide the unrated order data
and usage data and they will feed these data into their financial system to do the rating and invoice.
Case 2: Sometimes client may have only the financial settlement system but they do not have the rating
system, in this case EAS provide only the rated data on which the client will generate the invoice through
their own system.
Case 3: In case of smaller business clients, they neither have their rating system nor the financial settlement
system. Such kinds of clients are fully dependent on EAS and they expect EAS to do all the financial
operations (rating calculation and invoice generation).
This guide will cover all the use cases related to rating and invoice (financial settlement) system. Based on
the above mentioned cases organizations may skip certain sections that are not applicable to them.
Firstly, this document focuses on the Rating related use cases and later it has covered the Invoice part.
Rating is calculated on four types of items. They are:
1.
Reserved Items
2.
Pay-per-use Items and
3.
Other Items (mainly One-time Item).
4.
Installment items

8 APRIL 2016
ENSIM CONFIDENTIAL
432
Different use cases of Rating of different types of Items

Rating calculation for One-time Item
One-time items are those items that are charged only once at the time of purchase such as; installation
charge or setup fee. Rating for such type of items is calculated only once in the month in which they are
billable.
Use case 1: Rating calculation for one-time Items after the Order is provisioned
Full month rating calculation is done on the onetime items if the rating process is executed on the month in
which the offer gets provisioned. From the next month rating, there will be no rating calculation for that
one-time item again. It is calculated only once. No Pro rata calculation is done on the one-time items.
Lets consider an offer having a one-time item and has been provisioned on 3rd January, 2015. Order
quantity of the item is 1 and the base price is set to 500 dollars.
Rating for this item will be calculated from 3rd January to 31st January, 2015 and the rating amount will be
(Quantity of the item*base price)
Here 1*500=500 dollars.
Use case 2: Rating calculation for one-time Items after the Order is upgraded/downgraded in the middle
of the month
Offer having one-time item can be upgraded or downgraded to another offer. Rating calculation process in
this scenario is explained with the following exampleAn offer containing one one-time item was provisioned on 5th January, 2015. If this offer gets upgraded or
downgraded on 15th February, 2015 then rating will be as belowa. Rating from 5th January, 2015 to 31st January, 2015 on the one-time item and
b. Rating will be done from 15th February, 2015 to 28th February, 2015 on the new offer.
If the current offer is upgraded to another offer containing the same one-time item within it, in that case
how rating will be calculated for the one-time item within the new offer will be decided on the following
three factors a.
Full Charge- In this scenario rating will be calculated on the one-time item within the new offer
based on the price value of it within the new offer.
For example if the base price of the one-time item within the previous offer was 500 dollars and it
becomes 1000 dollars within the new offer then in this mode (full charge) the rating will be done for
this one-time item based on the base price 1000 dollars.
b.
Charge Difference- In this condition the rating will be calculated for the one-time item based on the
base price difference between the one-time item in the previous offer and in the new offer.
Say base price of the one-time item within the previous offer was 700 dollars and within new offer it
becomes 1200 dollars then according to this scenario rating will be calculated on this one-time item
based on the base price difference of this item which is (1200-700)=500 dollars in this case.
c.
No Charge- In this case no rating will be done on the one-time item within the new offer while the
current offer is getting upgraded to a new one.

8 APRIL 2016
ENSIM CONFIDENTIAL
433
Use case 3: Rating calculation for one-time Items after the Order is downgraded at the end of the month
Offer having one-time item can be downgraded either in the middle of the month or a request for
downgrade can be sent to Service Provider, which will be provisioned on the first day of the next month.
Lets see the rating calculation process in this scenario with the following exampleAn offer containing one one-time item was provisioned on 5th January, 2015. Request for downgrade was
sent on 15th January, 2015 and gets provisioned on 1 st February, 2015. Then rating will be calculated as
discussed belowa. Rating from 5th January, 2015 to 31st January, 2015 on the one-time item and
b. Rating from 1st February, 2015 to 28th February, 2015 on the new offer.
Use case 4: Rating calculation for one-time Items after the Order is cancelled in the middle of the month
Offer having one-time item is getting cancelled in the middle of the month. Rating will be calculated until
the status of the offer changes to Suspended for Cancellation or Cancelled. Lets see the rating calculation
process in this scenario with the following exampleAn offer containing one one-time item was provisioned on 5th January, 2015. If this offer gets cancelled on
15th February, 2015 then rating will be calculated as mentioned belowa. Rating from 5th January, 2015 to 31st January, 2015 on the one-time item and
Use case 5: Rating calculation for one-time Items after the Order is cancelled at the end of the month
Cancellation request for offer having one-time item can be sent to Service Provider. But this request will be
provisioned only at the end of the month. Rating will be calculated until the status of the offer changes to
Suspended for Cancellation or Cancelled.
Lets see the rating calculation process in this scenario with the following exampleAn offer containing one one-time item was provisioned on 5th January, 2015. If a cancellation request has
been sent for this offer on 15th February, 2015, which will be provisioned only at the end of the month, then
rating will be calculated as mentioned belowa. Rating from 5th January, 2015 to 31st January, 2015 on the one-time item and
Hence no rating will be calculated on this offer from 1 st March, 2015.

8 APRIL 2016
ENSIM CONFIDENTIAL
434
Rating calculation for Reserved Items

Reserved items are committed by the buyer and they are invoiced regardless of their actual consumption.
Use case 1: Rating calculation for reserved Items after the Order is provisioned
If an offer containing reserved items gets provisioned in a certain month then rating engine will calculate
for those items as well as an advance calculations will also done for every item for the next month of the
provisioning of the offer.
Lets consider an offer having a reserved item and has been provisioned on 3 rd January, 2015. Order
quantity of the item is 80 and the base price against the tier where 80 is fitted is set to 50 dollars.
(Quantity of the item*base price*no. of days for which the item has been used in the month/total no. of days)
Here 80*50*29/31=3741.9355 dollars
Also an advance amount will be charged for this reserved item based on the invoice. The advance amount
will be (Quantity of the item * base price) dollars.
Here 80*50=400 dollars
Use case 2: Rating calculation for reserved Items after the Order is upsized/downsized in the middle of
the month
Offer having reserved item can be upsized or downsized in the middle of the month.
Lets see the rating calculation process in this scenario with the following exampleAn offer containing one reserved item was provisioned on 5th January, 2015. If this offer gets upsized or
downsized on 15th February, 2015 then rating will be calculated as discussed belowa. Rating from 5th January, 2015 to 31st January, 2015 on the reserved item
b. Advance amount from 1st February, 2015 to 28th February, 2015.
c. Rating from 1st February, 2015 to 14th February, 2015 on the reserved item with the old quantity
d. Rating will be done from 15th February, 2015 to 28th February, 2015 on the new item quantity and
e. Rating from 1st March, 2015 to 31st March, 2015 for advanced amount on reserved item based on the
new quantity after upsizing or downsizing the offer.
Use case 3: Rating calculation for reserved Items after the Order is downsized at the end of the month
Downsize request on offer having reserved item may arrive in the middle of the month but this will be
provisioned on the start of the next billing month. Lets see the rating calculation process in this scenario
with the following exampleAn offer containing one reserved item was provisioned on 5th January, 2015. Request for downsize was sent
on 15th January, 2015 and gets provisioned on 1 st February, 2015. Then rating will be calculated as discussed
belowa. Rating from 5th January, 2015 to 31st January, 2015 on the reserved item
b. Rating from 1st February, 2015 to 28th February, 2015 for advanced amount on reserved item based
on the new quantity (decreased quantity) after the offer gets downsized.
Use case 4: Rating calculation for reserved Items after the Order is upgraded/downgraded in the middle
of the month

8 APRIL 2016
ENSIM CONFIDENTIAL
435
Offer having reserved item can be upgraded or downgraded to another offer. Lets see the rating calculation
process in this scenario with the following exampleAn offer containing one reserved item was provisioned on 5 th January, 2015. Consider that this offer has
been upgraded or downgraded on 15th February, 2015.
Rating for the month of January will be as followa. Rating from 5th January, 2015 to 31st January, 2015 on the reserved item
b. Rating from 1st February, 2015 to 28th February, 2015 for advanced amount on reserved item
And rating for the month of February will be as followa. Rating from 1st February, 2015 to 14th February, 2015 on the reserved item with the old offer
b. Rating from 15th February, 2015 to 28th February, 2015 for reimbursed amount on reserved item
c. Rating will be done from 15th February, 2015 to 28th February, 2015 on the new offer and
d. An advance amount will be calculated from 1st March, 2015 to 31st March, 2015.
Use case 5: Rating calculation for reserved Items after the Order is downgraded at the end of the month
Downgrade request can be done on the offer having reserved item in the middle of the month but this will
be provisioned on the start of the next billing month. Lets see the rating calculation process in this scenario
with the following exampleAn offer containing one reserved item was provisioned on 5 th January, 2015. Request for downgrade was
sent on 15th January, 2015 and gets provisioned on 1 st February, 2015. Then rating will be calculated as
discussed belowa. Rating from 5th January, 2015 to 31st January, 2015 on the reserved item of the old offer
b. Rating from 1st February, 2015 to 28th February, 2015 for advanced amount on reserved item of the
new offer and
c. Rating from 1st February, 2015 to 28th February, 2015 on the new offer.
Use case 6: Rating calculation for reserved Items after the Order is cancelled in the middle of the month
Offer having reserved item can be cancelled in the middle of the month. Rating will be calculated until the
status of the offer changes to Cancelled. Lets see the rating calculation process in this scenario with the
following exampleAn offer containing one reserved item was provisioned on 5 th January, 2015. If this offer gets cancelled on
15th February, 2015 then rating will be calculated as mentioned belowb. Rating from 5th January, 2015 to 31st January, 2015 on the reserved item
c. Rating from 1st February, 2015 to 28th February, 2015 for advanced amount on reserved item
d. Rating from 1st February, 2015 to 15th February, 2015 on the reserved item and
e. Rating from 16th February, 2015 to 28th February, 2015 for cancelled amount on reserved item.

8 APRIL 2016
ENSIM CONFIDENTIAL
436
Use case 7: Rating calculation for reserved Items after the Order is cancelled at the end of the month
Cancellation request for Orders having reserved item can be sent to Service Provider. But this request will
be provisioned only at the end of the month. Rating will be calculated until the status of the offer changes to
Suspended for Cancellation or Cancelled.
Lets see the rating calculation process in this scenario with the following exampleAn offer containing one reserved item was provisioned on 5 th January, 2015. If a cancellation request has
been sent for this offer on 15th January, 2015, and gets provisioned on 1st February, 2015. Then rating will be
calculated as mentioned belowa. Rating from 5th January, 2015 to 31st January, 2015 on the reserved item
Hence no rating will be calculated on this offer from 1 st February, 2015.

8 APRIL 2016
ENSIM CONFIDENTIAL
437
Rating calculation for Annual Reserved Items

If an offer containing annual reserved items gets provisioned in a certain month then rating engine will
calculate all the annual items in advance. No arrear charges are applicable for annual items.
Lets consider an offer having an annual reserved item and has been provisioned on 3rd January, 2015. Order
quantity of the item is 80 and the base price against the tier where 80 is fitted is set to 50 dollars.
Rating for this item will be calculated from 3rd January 2015 to 2nd January, 2016 and the rating amount for
the month of January 2015 will be
(Quantity of the item*base price*no. of days for which the item has been used in the month/total no. of days)
Here 80*50*365/365=4000 dollars.
Use Case 1: Rating calculation for annual Items if the Order is upsized in between the billing period
If an order containing annual item gets upsized in between the billing period, then the previous advance
amount will be reimbursed for that item and the rating engine will calculate according to the new quantity
from the day of upsize.
Lets consider an offer having an annual reserved item and has been provisioned on 3 rd January, 2015. Order
quantity of the item is 80 and the base price against the tier where 80 is fitted is set to 50 dollars. The order
gets upsized on 3rd February on quantity 90, then in the February Rating run the amount will be :
1: 3rd February 2015 to 2nd January 2016 Reimbursement amount 80*50*334/365= 3660.2739
2: 3rd February 2015 to 2nd January 2016- Rating on upsized amount =90*50*334/365=4117.8082
Use Case 2: Rating calculation for annual Items if the Order is upgraded in between the billing period
If an order containing annual item gets upgraded in between the billing period, then the previous advance
amount will be reimbursed for that item and the rating engine will calculate on the new upgraded offer.
Here two cases can be happen:
a.
Same subscription code:

If the previous offer and the new offer have the same subscription code , then the billing period will
be same as previous .
Lets consider an offer having an annual reserved item and has been provisioned on 3 rd January,
2015. Order quantity of the item is 80 and the base price against the tier where 80 is fitted is set to 50
dollars. The order gets upgraded on 3rd February . The new offer contains an annual item having
quantity 40 and base price 75:
1: 3rd February 2015 to 2nd January 2016 Reimbursement amount of previous offer= 80*50*334/365=
3660.2739
2: 3rd February 2015 to 2nd January 2016- Rating on upgraded offer =40*75*334/365=2745.2054
b. Different subscription code:

If the previous offer and the new offer have the different subscription code , then the Rating engine
will charge for a full billing period from the day of upgrade.
Lets consider an offer having an annual reserved item and has been provisioned on 3rd January,
2015. Order quantity of the item is 80 and the base price against the tier where 80 is fitted is set to 50
dollars. The order gets upgraded on 3rd February . The new offer contains an annual item having
quantity 40 and base price 75:
8 APRIL 2016
ENSIM CONFIDENTIAL
438
1: 3rd February 2015 to 2nd January 2016 Reimbursement amount of previous offer =80*50*334/365=
3660.2739
2: 3rd February 2015 to 2nd February 2016- Rating on upsized amount =40*75=3000
Use Case 3: Rating calculation for annual Items if the Order is canceled in between the billing period
If an order containing annual item gets canceled in between the billing period, then the previous advance
amount will be reimbursed for that item .
Lets consider an offer having an annual reserved item and has been provisioned on 3 rd January, 2015. Order
quantity of the item is 80 and the base price against the tier where 80 is fitted is set to 50 dollars. The order
gets canceled on 3rd February , then in the February Rating run the amount will be :
1: 3rd February 2015 to 2nd January 2016 Reimbursement amount 80*50*334/365= 3660.2739.
Use Case 4: Rating calculation for the Offers having both monthly and yearly billing frequency
If an offer having both monthly and yearly items the Rating engine will recurrently calculate the monthly
items per month basis and annual items yearly basis . If any upgrade/downgrade, upsize/downsize and
cancellation happens in between the annual billing period the annual item will be charged and reimbursed
accordingly.
Lets consider an offer having an annual reserved item and one monthly reserve item has been provisioned
on 3rd January, 2015. Order quantity of the annual item is 80 and the base price against the tier where 80 is
fitted is set to 50 dollars and the quantity and base price of the monthly item is 50 and 100 respectively.
Then in the February Rating run the amount will be :
1: 3rd January 2015 to 2nd January 2016 Charge for annual item 80*50=4000.
2: 3rd January 2015 to 31st January 2015 Charge for monthly item 50*100*29/31=4677.4193
Rating calculation for Pay-per-use Items

Pay-per-use items are offered to organization in a way where buyer pays the amount based on the actual
consumption of the resources. Rating calculation for PPU Items is influenced by the metering rules of the
Resources in Service definition as described below-

8 APRIL 2016
ENSIM CONFIDENTIAL
439
1.
2.
3.
4.
Click the Service tab.

Click
button against any of the services.
Edit Service and Resource Details page appears.
Click the Add Resource button to select the Metering rule.

8 APRIL 2016
ENSIM CONFIDENTIAL
440
The consumed amount is stored in database on daily basis and this metering rule is applied on the
consumed quantity. Each rule has its own specifications.
No metering- in this case, metering rule would not be applied on consumed quantity.
Sum of daily usage- the summation of the daily consumed quantity is considered as the consumed
amount for the month.
Average of daily usage- the average of the daily consumed quantity is considered as the consumed
amount for the month.
Maximum of daily usage- the maximum of the daily consumed quantity is considered as the
consumed amount for the month.
Minimum of daily usage- the minimum of the daily consumed quantity is considered as the
consumed amount for the month.
Pro rata- Pro rata calculation will be applicable on PPU items.

User based rating for PPU
1. On 11th Apr, a reservation of 5 seats was made. Assume no further change was performed in
Jan. The price per user is $2.00 for both reserved and PPU items
2.
On 16 Apr, two more were created = 7 users total.
3.
On 21 Apr, three more = 10 users total
4.
On 26 Apr, 1 user deleted = 9 total
The invoice generated for January, at the beginning of Feb will have
1. 5 reservations = 5 * 2.0, pro-rated for 20 days (11-30) = 10.00 * 20/30
2.
2 PPU users between 16th and 20th = 2 * 2.00 for 5 days (16-20) = 4.00 * 5/30
3.
5 PPU users between 21st and 25th = 5 * 2.00 for 5 days (21-25) = 10.00 * 5/30
4.
4 PPU users between 26th 30th = 4 * 2.00 for 5 days (26-30) = 8.00 * 5/30
It is important to note that we need to store each of these incremental PPU amount in the DB, while
we sum them up in the invoice. In future it would be needed to export these details along with
total.

8 APRIL 2016
ENSIM CONFIDENTIAL
441
The PPU reporting mechanism also needs to be set by the Service Provider in the following ways:
1.
2.
3.
4.
Click the Service tab.

Click the
button against any of the services.
Edit Service and Resource Details page appears.
Click the Add Resource button to select the PPU reporting mechanism.
The actual mechanism of rating calculation for PPU items follows a series of steps. Firstly, the Usage
Collection Jar file dumps the data into the database. After that calculation for rating may be done in three
different ways based on the PPU reporting mechanism.

8 APRIL 2016
ENSIM CONFIDENTIAL
442
They area. OSS Reports PPU

b. EAS calculates PPU and
c. No PPU.
OSS reports PPU: If the Service platform measures the PPU amount of Items (such as in case of IaaS hourly
usage), EAS will use the reported usage as is for rating.
EAS calculates PPU: EAS derives the usage amount from the following formula for hybrid resources
(having reservation and PPU Items of the same resources in the same Offer):
PPU amount = (Consumed Amount on the resource) (Max Reserved Amount on the resource for that
month until up/downgrade occurs).
Lets see how to obtain the individual values for Reserved, Consumed and PPU amounts.
In calculating reserve amount on the particular resource consider the following case-
Say there are two reserved items of same resource named YYY within a single offer called Flex VPS Offer.
Consider the quantity of these two items are changed from 20 to 10 and 50 to 70 respectively, in reserved
amount first consider the summation of the reserved quantity and also take the maximum quantity in
account. In the above case previous reserved quantity was (20+50) = 70 and after changing it becomes
(10+70) = 80. Here 80 is the maximum reserved quantity hence we consider this as the reserved amount.
In calculating consumed amount on the particular resource consider the following case-
Consumed quantity is saved in database on daily basis. The required consumed amounts are obtained from
the database as per the metering rule set by the Service Provider. Say for example the Metering Rule has
been set as Maximum of daily usage. Accordingly the maximum consumed quantity will be considered as
the required value. Lets consider the maximum consumed amount to be 100.
In calculating PPU amount on the particular resource consider the following case-
Subtract the reserved amount from the consumed amount to obtain the PPU amount. Hence from the above
cases, the reserved amount is 80 and consumed amount is 100. Thus, the PPU amount is (100-80) = 20. Hence
20 is the PPU amount calculated by EAS.
No PPU: No calculation for rating on PPU is done.
Allowing discount percentage on PPU amount calculation by Rating
Usage data reported by OSS system in case of PPU calculation is not always correct and sometimes it might
report extra quantity than the original one. So to prevent this mainly for the organization benefit EAS
applies percentile on reported PPU.
If the applicable percentile on the reported PPU quantity is set as 100%, then rating will take the original net
amount on that PPU item. Also no floor operation will be applicable on the reported PPU quantity.
But if any other percentage value less than 100% is set, then the given percentage will be multiplied with the
reported PPU quantity and the floor operation will always be applied on the multiplied value to generate
the amount which organization has to pay (PPU quantity upon which amount will be calculated).
Floor operation will be applicable on the PPU amount when applicable percentile on reported PPU will be
set to less than 100%. And no floor will be applied on PPU amount when applicable percentile on reported
PPU is 100%.

8 APRIL 2016
ENSIM CONFIDENTIAL
443
For example if the reported PPU quantity is 85.78 GB and the base price is 5 dollars where applicable
percentile on reported PPU is 100%, then organization has to pay 428.9 dollars.
Consider applicable percentile on reported PPU to be 95% on 85.78 GB of reported PPU quantity with base
price of 5 dollars. Here the amount that the organization has to pay is(85.78*95%) = 81.491 GB
In this case floor will be applied and the PPU quantity will become 81 GB.
Use case 1: Rating calculation on PPU Items after the Order is provisioned
Generally full month rating calculation is done on Pay-per-use items if the rating process is executed on the
month in which the offer gets provisioned. If there is no value in database for daily usage on a particular
resource on which a PPU item is made, then rating amount for this PPU item will be Zero (0). No advance
amount and reimbursement is calculated for PPU items. Pro rata calculation is also not done on PPU items.
Lets consider an offer having a PPU item and has been provisioned on 3rd January, 2015. Let the PPU
quantity be 80 and the base price is set to 50 dollars.
(Quantity of the item*base price)
Here 80*50=4,000 dollars
Use case 2: Rating calculation on PPU Items after the Order is upgraded/downgraded in the middle of
the month
Offer having PPU item can be upgraded or downgraded to another offer. Lets see the rating calculation
process in this scenario with the following exampleAn offer containing one PPU item was provisioned on 5 th January, 2015. If this offer gets upgraded or
downgraded on 15th February, 2015 then rating will be calculated as mentioned belowa. Rating from 5th January, 2015 to 31st January, 2015 on the PPU item
b. Rating from 1st February, 2015 to 14th February, 2015 on the PPU item with the old offer and
c. Rating will be done from 15th February, 2015 to 28th February, 2015 on the new offer.
Use case 3: Rating calculation on PPU Items after the Order is downgraded at the end of the month
Offer having PPU item can be downgraded either in the middle of the month or a request for downgrade
can be sent to Service Provider, which will be provisioned on the first day of the next month. Lets see the
rating calculation process in this scenario with the following exampleAn offer containing one PPU item was provisioned on 5 th January, 2015. Request for downgrade was sent on
15th January, 2015 and gets provisioned on 1 st February, 2015. Then rating will be calculated as discussed
belowa. Rating from 5th January, 2015 to 31st January, 2015 on the PPU item and
b. Rating from 1st February, 2015 to 28th February, 2015 on the new offer.

8 APRIL 2016
ENSIM CONFIDENTIAL
444
Use case 4: Rating calculation on PPU Items after the Order is cancelled in the middle of the month
Offer having PPU item is getting cancelled in the middle of the month. Rating will be calculated until the
status of the offer changes to Suspended for Cancellation or Cancelled. Lets see the rating calculation
process in this scenario with the following exampleAn offer containing one PPU item was provisioned on 5 th January, 2015. If this offer gets cancelled on 15th
February, 2015 then rating will be calculated as mentioned belowa. Rating from 5th January, 2015 to 31st January, 2015 on the PPU item and
b. Rating from 1st February, 2015 to 15th February, 2015 on the PPU item.
Use case 5: Rating calculation on PPU Items after the Order is cancelled at the end of the month
Cancellation request for offer having PPU item can be sent to Service Provider. But this request will be
provisioned only at the end of the month. Rating will be calculated until the status of the offer changes to
Cancelled.
Lets see the rating calculation process in this scenario with the following exampleAn offer containing one PPU item was provisioned on 5 th January, 2015. If a cancellation request has been
sent for this offer on 15th February, 2015, which will be provisioned only at the end of the month, then rating
will be calculated as mentioned belowa. Rating from 5th January, 2015 to 31st January, 2015 on the PPU item and
b. Rating from 1st February, 2015 to 28th February, 2015 on the PPU item.
Hence no rating will be calculated on this offer from 1 st March, 2015.
Rating calculation for Offers having Organization global discount

At the time of offer creation we can set an Organization global discount amount which may have various
types of items within it. Rating reflects this discount percentage of the organization and calculates the
amount after applying the discount on individual items.
Lets consider the following example
An offer may contain three types of items one one-time item, one reserved item and one pay-per-use item.
Quantity of these items 1, 30 and 50 respectively. Base prices for the suitable tier are 2000, 5000, 3000 dollars
respectively.
A Organization global discount of 10% is set to this offer. This offer gets provisioned on 7 th January, 2015.
Rating for the month of January, 2015 will be calculated as follows7th January, 2015 to 31st January, 2015: 2000*(31/31)*1= 2000 dollars (original rating amount for one-time
item)
7th January, 2015 to 31st January, 2015: (2000*10%) = 200 dollars (discounted amount)
7th January, 2015 to 31st January, 2015: 5000*(25/31)*30=120967.7420 dollars (original rating amount for
reserved item)
7th January, 2015 to 31st January, 2015: (120967.7420*10%) = 12096.7742 dollars (discounted amount)
7th January, 2015 to 31st January, 2015: 3000*(31/31)*50 = 150000 dollars (original rating amount for PPU item)
7th January, 2015 to 31st January, 2015: (150000*10%) = 15000 dollars (discounted rating amount)
8 APRIL 2016
ENSIM CONFIDENTIAL
445
Rating calculation of Installment Items

Installment items are offered in a way that the organization has to commit to the amount he purchased for
invoicing purposes but the payment can be done in a periodic manner for some finite no of defined time
intervals (e.g. 5 months). Rating module will stop calculating the amount of these type of items when their
payment period counter as defined in the offer itself is over (e.g. A smartphone is sold under the agreement
that the owner should be paying 100$ per month for the first 5 months instead of making One-time 500$
payment right away during buying. After 5 months are over there should not be any payment regarding the
phone).These items can only be made by non-provisionable type of resource.
In case of the installment type of items rating amount is calculated by the installment amount defined at the
time of creating the price plan elements of the item. One can also prepay the installment amount and choose
to stop getting the installment amount in the next invoices. If the amount is Invoice in Advance then rating
will not report the items calculation after the month on which the pre-payment is done.
i.e. If one decides to give right away 500$ instead of making 5 payments of 100$ each for the next 5 months
then rating will not report the installment items calculation as it is already settled.
Use case 1: Rating calculation for installment Items after the Order is provisioned
Offer containing installment items gets provisioned in a certain month then rating will be calculated for that
month on those installment items.
Lets consider an offer having an installment item and has been provisioned on 3 rd January, 2015. Order
quantity of the item is 10 and the monthly installment amount is set to 50 $ per quantity and the period over
which the item is to be rated is 3 months.
(Quantity of the item*predefined installment price)
Here 10*50=500 $
And these 500$ will be repeated in the next 2 billing cycles i.e. for the month of march and April and there
will be no more calculation for that item.
Use case 2: Rating calculation for Installment Items after the Order is upsized/downsized
Installment items can only be upsized in the middle of the month.
Lets see the rating calculation process in this scenario with continuation of previous exampleThis offer gets upsized on 15th February, 2015 with additional quantity of 5 more with the same installment
repay period of 3 months, rating will be calculated as discussed belowa. Rating from 3rd January, 2015 to 31st January, 2015 on the quantity 10. Rating amount would be 500 $
b. Rating from 1st February, 2015 to 28th February, 2015 on the on the quantity 10. Rating amount
would be 500 $
c. Rating from 15th February, 2015 to 28th February, 2015 on the new quantity 5.Rating amount would
be 250 $.
Note: The installment payment of previous 10 quantities will stop after March2015 rating run and that
of new 5 quantities will be stopped after April2015 rating run.

8 APRIL 2016
ENSIM CONFIDENTIAL
446
Use case 3: Rating calculation for installment Items after the Oder is upgraded/downgraded in the
middle of the month
Offer having installments item cant be upgraded or downgraded to another offer until the total installment
amount is received for that item. Considering the example in use case 1 the offer cannot be upgraded or
downgraded until 500 $ * 3 = 1500 $ is received from the organization. Either he can pay in 3 monthly
installments or can pre pay the outstanding (if 1 installment is already given then outstanding amount is
1500 500 = 1000 $) amount at once.
Use case 4: Rating calculation for installment Items after the Order is cancelled
Likewise offer having installment item cant be cancelled until the total installment amount is received for
that item. Considering the example in use case 1 the offer cannot be cancelled 500 $ * 3 = 1500 $ is received
from the organization. Either he can pay in 3 monthly installments or can pre pay the outstanding (if 2
installment is already given then outstanding amount is 1500 1000 = 500 $) amount at once.
Rating calculation on more complex use cases

Here are few more examples of complex use cases that may occur and accordingly its impact on rating.
Example 1:
Consider an offer having three types of items; one one-time item, two reserved items (R1 and R2) and one
PPU item was provisioned on 5th January, 2015.
The reserved item R1 was upsized on 15th January, 2015.
And again on 25th January, 2015 the offer was upgraded to an offer having one one-time item, one reserved
item and one PPU item.
The rating calculation for the month of January is as followsi.
ii.
iii.
iv.
v.
vi.
vii.
viii.
ix.
Rating from 5th January, 2015 to 24th January, 2015 on the one-time item
Rating from 5th January, 2015 to 24th January, 2015 on the reserved item (R2)
Rating from 5th January, 2015 to 24th January, 2015 on the PPU item
Rating from 25th January, 2015 to 31st January, 2015 on the one-time item of the upgraded offer
Rating from 25th January, 2015 to 31st January, 2015 on the reserved item of the upgraded offer
Rating from 25th January, 2015 to 31st January, 2015 on the PPU item of the upgraded offer
Rating from 1st February, 2015 to 28th February, 2015 for the advance amount based on the upgraded
offer

8 APRIL 2016
ENSIM CONFIDENTIAL
447
Example 2:
Consider an offer having three types of items; one one-time item, one reserved item and one PPU item was
provisioned on 5th January, 2015.
The offer was suspended on 15th January, 2015. For January Rating run there will be following lines:
i.
ii.
iii.
Rating from 5th January, 2015 to 15st January, 2015 on the one-time item
Rating from 5th January, 2015 to 15st January, 2015 on the reserved item
Rating from 5th January, 2015 to 15st January, 2015 on the PPU item
Then again the offer was resumed on 7th February, 2015. The rating calculation will be continued as
discussed below or the month of January and February, 2015 iv.
v.
vi.
vii.
viii.
ix.
x.
xi.
Rating from 1st February, 2015 to 28th February, 2015 for the advance amount
Rating from 1st February, 2015 to 28th February, 2015 on the one-time item
Rating from 1st February, 2015 to 28th February, 2015 on the reserved item
Rating from 1st February, 2015 to 28th February, 2015 on the PPU item
Rating from 1st March, 2015 to 31st March, 2015 for the advance amount
Example 3:
provisioned on 5th January, 2015. A suspension for cancellation request was sent on 31 st January, 2015 for the
offer.
The rating calculation for the month of January is discussed belowi.
ii.
iii.
The suspension for cancel request will be provisioned on the first day of the next month; that is from 1 st
February charges will not be applicable on the offer. Hence rating will not be calculated for the month of
February and no advance amount will be charged.
Example 4:
Consider an offer having three types of items; one one-time item, two reserved items (R1 and R2) and one
PPU item was provisioned on 1st January, 2015.
A cancellation request for the offer was sent on 1st February, 2015.
The rating calculation for the month of January is discussed below-

8 APRIL 2016
ENSIM CONFIDENTIAL
448
i.
ii.
iii.
iv.
v.
vi.
Rating from 1st January, 2015 to 31st January, 2015 on the one-time item
Rating from 1st January, 2015 to 31st January, 2015 on the reserved item R1
Rating from 1st January, 2015 to 31st January, 2015 on the reserved item R2
Rating from 1st January, 2015 to 31st January, 2015 on the PPU item
Rating from 1st February, 2015 to 28th February, 2015 for the advance amount based on the reserved
item R1
Rating from 1st February, 2015 to 28th February, 2015 for the advance amount based on the reserved
item R2
The rating calculation for the month of February is discussed belowi.

ii.
iii.
iv.
v.
Rating from 01-FEB-13 12.00.00.000000000 AM to 01-FEB-13 03.00.38.049000000 PM for reserved

item R1
item R2
item PPU
Rating from 2nd February, 2015 to 29th February, 2015 for cancellation of reserved item R1
Rating from 2nd February, 2015 to 29th February, 2015 for cancellation of reserved item R2
The request for cancel will be provisioned at the end of the day of 1 st February, 2015 on the offer. Hence
rating will be calculated for 1st February, 2015 and from 2nd February, 2015 onwards rating will not be
calculated.
Example 5:
provisioned on 1st January, 2015.
The offer was upsized twice in a day; first on 17-JAN-13 11.00.00.000000000 AM, the reserved item was
upsized from R1 to R2.
And again on 17-JAN-13 12.00.00.000000000 PM, the reserved item was upsized from R2 to R3.
The rating calculation for the month of January is discussed belowi.
ii.
iii.
iv.
v.
Rating from 1st January, 2015 to 31st January, 2015 for one-time item
Rating from 1st January, 2015 to 16th January, 2015 for reserved item R1
Rating from 17-JAN-13 11.00.00.000000000 AM to 17-JAN-13 12.00.00.000000000 PM for the upsized
reserved item R2
Rating from 17th January, 2015 to 31st January, 2015 for reserved item R3
Rating from 1st January, 2015 to 31st January, 2015 for PPU item
Trials
Trial is an effective strategy of marketing where a service is offered for free within a limited time period
(referred to as the trial period) hoping to convert trial users into paying users after the threshold. Trial can
be assigned to multiple offers and there is a time period for each and every individual trial.
8 APRIL 2016
ENSIM CONFIDENTIAL
449
No charges are applied for the trial order other than the Pay-per-Use items within the order. Rating for onetime and reserved items is not calculated. Only rating amount for PPU item is charged.
This section will describe how to assign trial offer on an item. Trial on offers can be configured in the
following way1. Click Offer tab.
2. Select one of the categories for which an offer is to be created.
3. Click the Add Offer button.
4. After configuring the basic details as well as after configuring the item details, click the Trial
Configuration section.
Offer Type: There are four options available under trial configuration.
a. Purchase Only- this option allows only the purchase option for the offer.
b. Trial Only- this option allows only the trial option for the offer.
c. Trial Purchase Both- this option allows both the trial and purchase option for the offer at the
same time. In case of Trial Only and Trial Purchase Both options the trial configuration page
will appear.
d. Available Through Trial- this option allows the purchase option for the offer only after going
through the trial.
Trial may be configured in two modesOpt In trial mode does not allow auto purchase of offer after the expiry of the trial period. Organization has
to explicitly buy the item after the trial period gets over. Service Provider can select multiple offers under
Trial upgrade option for its organization. After the trial period gets over, the trial offer will be cancelled
and the organization has to explicitly buy an offer amongst these chosen offers from its Service Provider.
8 APRIL 2016
ENSIM CONFIDENTIAL
450
Opt Out trial mode allows auto purchase option of offer after the expiry of the trial offer. In this case Service
Provider can select only one offer under Trial upgrade to for its organization. After the trial period gets
over organization will be automatically upgraded to the selected offer and charges will be applied
accordingly.
Whenever a trial offer gets purchased then rating will consider this action as an offer upgrade. No upsize or
downsize is allowed with trial offer. The trial period also needs to be specified by the Service Provider
either in days or weeks or months or years. Rating will be calculated based on this time span.
This section will mainly focus on the trial amount calculation by rating as general rating calculation on
different types of items have already been discussed in the earlier sections.
Use case 1: Rating calculation for trial Offers after the Order is provisioned
Consider that an offer has been configured for trial for a period of 30 days and this offer contains three types
of items; one one-time item, one reserved item and one pay-per-use (PPU) item.
Assume this offer gets provisioned on 11th January, 2015. Rating on this offer for the month of January, 2015
will be calculated as followsRating will be calculated on the PPU items only and it will be from 11 th January, 2015 to 31st January, 2015
and the rating amount will be calculated based on the quantity of this PPU item and the base price.
Rating line will be there in the database for the other types of items as well but rating amount will be 0
which denotes that in trial offer only PPU items are calculated.
Use case 2: Rating calculation for trial Offer after the Order is purchased
Purchasing a trial offer is nothing but upgrading the trial offer to the purchased one. So in this scenario
rating will behave same as whenever an offer gets upgraded to another one.
Lets consider the following exampleA trial offer containing one one-time item, one reserved item and one PPU item gets provisioned on 15th
January, 2015 and this trial offer gets upgraded on 10 th February, 2015 to a purchased offer containing the
same type of items and quantity with one more reserved item.
Rating for the month of January, 2015 will be calculated as followsRating will be calculated on the PPU item only within the trial offer and it will be from 15 th January, 2015 to
31st January, 2015. There will be no advance rating amount as advance is not taken on PPU types of item.
For other two types of items rating amount will be 0.

8 APRIL 2016
ENSIM CONFIDENTIAL
451
After the trial offer gets purchased on 10th February the rating for the month of February will be as follow
Rating amount will be calculated for PPU item within the trial offer from 1 st February, 2015 to 9th February,
2015. For other types of items there will be no rating amount.
Rating amount will be calculated on each and every item within the new purchased offer which will be
from 10th February, 2015 to 28th February, 2015.
Also two advance amounts will be calculated by rating for two reserved items and this will be from 1st
March, 2015 to 31st March, 2015.
Note: When an offer is in trial mode, upsize or downsize of items is not possible.
Use case 3: Rating calculation for trial Offer after the Order is cancelled
Trial offer can be cancelled within the trial period or any time or it gets automatically cancelled if the offer is
in Opt in mode and trial period gets expired.
Lets consider the following example
A trial offer containing two items one reserved item and one PPU item gets provisioned on 19th March,
2015 and gets cancelled on 6th April, 2015.
Rating calculation for the month of March, 2015 will be as followsRating calculation will be done on the PPU item from 19th March, 2015 to 31st March, 2015.
And rating for the month of April will be as follow
Rating will be calculated from 1st April, 2015 to 6th April, 2015 on the PPU item only. No further rating
calculation will be done for rest of that month as the offer gets cancelled.
Note: In trial, upsize or downsize of items is not possible. Promotion cannot be applied on trial offer.

8 APRIL 2016
ENSIM CONFIDENTIAL
452
Promotions
Promotion is communicating with the organization that helps motivate demands for the offer and involves
enduring advertisement and publicity to influence organizations toward purchasing items or services.
Promotions can be assigned to multiple offers and there is a time period for each and every individual
promo. If the offer is bought within this promo period then only assigned promo will be applicable with the
offer.
Promotional discount can be given on an offer (which is nothing but a collection of different items) as well
as the promo discount can also be given on each and every individual items within an offer.
Rating does take care of all these cases and calculates the promo amount on individual items and also
determine the promo amount applied on the total offer as well.
This section will describe how to assign promotion with offers and how promotional discount is given on
the offers and on each items.
Association of Promotion
Here are the steps to associate a promo to an offer1.
Select the desired category and its corresponding offer.
2.
Click the Associate Promo button against the desired offer.
3.
Promo can be configured in two modes, either opt-in or promo code.
Opt-in is a mode of promotion is automatically applied to new orders and can be applied to an
offer at a time.
Promotion Code is a mode of promotion which allows a promo code to be entered for new
orders.
4.
The Continue promo even if upgrade/downgrade field allows organization to continue relishing
the promo without any interruption of upgrade or downgrade.
5.
Promotion can be associated to both offer and item.

8 APRIL 2016
ENSIM CONFIDENTIAL
453
Promotion association to offer

To assign promotion to an offer1. Click Offer Discount tab.
2.
3.
Fill the required details in the description section and select the mode of discount.
In case of offer only a flat amount can be assigned as promotion.
Promotion association to items

To assign promotion to each items1. Click Item Discount tab.

8 APRIL 2016
ENSIM CONFIDENTIAL
454
2.
Fill the required details with description and mode of discount for each items.
3.
In case of items, discount percentage or a flat amount may be assigned as promotion.
This section will mainly focus on the promotional amount calculation by rating as general rating calculation
on different types of items have already been discussed in the earlier sections.
Rating calculation after associating promotional discount to the Offer
After assigning a promo to an offer, rating will be calculated on that offer with the discounted
amount.
In EAS on offer level promo discount can be given only in amount, no percentage is allowed.
The promo validation depends on the Mode of discount. There are three modes of discounta.
b.
c.
One-time
Recurring
Till offer termination.
One-time promotion on an offer:

If mode of discount is set as one-time, that means the promotional amount will be calculated only Onetime on the selected offer. From the next month onwards promo rating will not be applicable on this offer.
If the mode of discount is set as one-time while applying promo at the offer level then the rating will be
calculated as followsLets consider an offer having a discount amount of 200 dollars and has been provisioned on 3 rd January,
2015.

8 APRIL 2016
ENSIM CONFIDENTIAL
455
The rating for such an offer will be calculated from 3rd January to 31st January, 2015 and the rating amount
will be(Promo amount*no. of days of promo/total no. of days in the month)
(200*29/31) = -187 dollars
Recurring promotion on an offer:
If the mode of promo discount is set as recurring that means promo rating amount will be applicable on
the offer for each month till the given time period.
For Recurring type promo discount applied at the offer level; the unit for time period needs to be
mentioned. The time period may be in days or months for which the rating will be calculated in the
following waysCase I:
Lets consider an offer having a discount amount of 200 dollars for 1 month has been provisioned on 3 rd
January, 2015. Hence rating will be calculated from 3 rd January, 2015 to 31st January, 2015 and the rating
amount will be(Promo amount*no. of days of promo/total no. of days in the month)
(200*29/31) = -187 dollars
Case II:
Say for example, an offer having a discount amount of 200 dollars for 35 days has been provisioned on 3 rd
January, 2015. Hence rating will be calculated from 3 rd January, 2015 to 31st January, 2015 and again from 1st
February, 2015 to 6th February, 2015. Thus the rating amount calculation will be done in following ways(Promo amount*no. of days of promo/total no. of days in the month)
(200*29/31) = 187.096 dollars for the month of January and
(200*6/28) = 42.85 dollars for the month of February
Till offer termination promotion on an offer:

If the mode of discount is set as Till offer termination then promo rating will be applicable on the offer for
each month till that offer gets terminated.
For Till offer termination type promo discount applied at the offer level, then the rating will be calculated
as followsLets consider an offer having a discount amount of 200 dollars and has been provisioned on 3 rd January,
2015.
Considering the above example; the rating for such an offer will be calculated on every month till the
termination of the offer since the day of provision that is, 3 rd January, 2015 and the rating amount will be(Promo amount*no. of days of promo/total no. of days in the month)
(200*29/31) = -187 dollars

8 APRIL 2016
ENSIM CONFIDENTIAL
456
Rating calculation after associating promotional discount on individual Items

After assigning a promo to an individual item, rating will be calculated on that item with the
discounted amount.
In EAS on item level promo discount can be given both in amount as well as percentage.
The promo validation depends on the Mode of discount and Discount type as well.
The three modes of discount area. One-time.

b. Recurring.
c. Till offer termination.

8 APRIL 2016
ENSIM CONFIDENTIAL
457
One-time promotion on items:

For one-time mode of discount, the promotional rating amount will be calculated only once on the selected
item. From the next month onwards promo rating will not be applicable on this item. The rating will be
calculated as followsLets consider an offer having three types of items; one one-time item, one reserved item and one PPU item.
The offer has been provisioned on 3rd January, 2015. Say the one-time item has been assigned a fixed promo
amount of 100 dollars; the reserved item has been assigned a promo percentage of 5% and the PPU item has
also been assigned a fixed promo amount of 50 dollars. Hence the rating calculation will be as follows(Promo amount*no. of days of promo/total no. of days in the month)
Rating amount for one-time item from 3rd January, 2015 to 31st January, 2015= (100*29/31) = -187 dollars
Rating amount for reserved item from 3rd January, 2015 to 31st January, 2015= (rated amount for this
item)*5% dollars
Rating amount for PPU item from 3rd January, 2015 to 31st January, 2015= (50*29/31) = -47 dollars
For fixed promo amount on a particular item user needs to check whether pro-rated amount is greater than
the rated amount. The amount which is less will be set as promo amount.
Recurring promotion on items:

For recurring mode of promo discount, the promotional rating amount will be calculated on each item for
each month till the given time period. For Recurring type promo discount; the unit for time period must be
mentioned that is either in days or months.
The rating will be calculated in the following waysLets consider an offer having three types of items; one one-time item, one reserved item and one PPU item.
amount of 100 dollars for 1 month; the reserved item has been assigned a promo percentage of 5% for 40
days and the PPU item has also been assigned a fixed promo amount of 50 dollars for 20 days. Hence the
rating calculation will be as follows(Promo amount*no. of days of promo/total no. of days in the month)
Rating amount for reserved item from 3rd January, 2015 to 31st January, 2015= (base price*29/31)*5% = (-)
rated amount after discount dollars
Rating amount for reserved item from 1st February, 2015 to 11th February, 2015= (Rated amount on this
reserved item) *5% dollars
Rating amount for PPU item from 3rd January, 2015 to 22nd January, 2015= (50*20/31) = -32 dollars

8 APRIL 2016
ENSIM CONFIDENTIAL
458
Till offer termination promotion on items:

For Till offer termination mode of discount, the promo rating will be calculated on each item for each
month till that item/offer gets terminated. The rating will be calculated as followsLets consider an offer having three types of items; one one-time item, one reserved item and one PPU item.
amount of 100 dollars; the reserved item has been assigned a promo percentage of 5% and the PPU item has
also been assigned a fixed promo amount of 50 dollars. Hence the rating calculation will be as follows(Promo amount*no. of days of promo/total no. of days in the month)
From next month onward there will be no rating calculation for the one-time item.
Rating amount for reserved item from 3rd January, 2015 to 31st January, 2015= (rated amount on this
item)*5% = -0.05 dollars
Rating amount will be calculated on each month for the promo associated till the reserved item gets
terminated.
Rating amount for PPU item from 3rd January, 2015 to 31st January, 2015= (50*29/31) = -47 dollars
Rating amount will also be calculated on each month for the promo associated till the PPU item gets
terminated.
Note: In the database promotional rating amount is getting stored with a (-ve) sign which indicates this
amount will be deducted from the original rating amount on that particular items.

8 APRIL 2016
ENSIM CONFIDENTIAL
459
Example of Rating on Offers with promo association

Consider an offer having three types of items; one one-time item, one reserved item and one PPU
item. The offer has been provisioned on 5th January, 2015.
Here is the offer along with its different items and their respective criteriai.
The mode of discount for the offer is set as till offer termination and has been assigned a
fixed amount of 80 dollars.
ii.
The mode of discount for one-time item is set as One-time and has been assigned a fixed
discount amount of 100 dollars where the base price is 200 dollars.
iii.
The mode of discount for reserved item is set as recurring for 35 days and has been
assigned a discount percentage of 5% where the base price is 150 dollars.
iv.
The mode of discount for PPU item is set as till offer termination and has been assigned a
fixed discount amount of 50 dollars where the base price is 220 dollars.
This offer has been upsized on 15th January, 2015.
If promotion is associated with individual items within the offer then rating will calculate the
original rating amount on each and individual items along with the promotional rating calculated
on these items.
Hence the rating calculation for each individual item along with their associated promo is discussed
belowi.
ii.
iii.
iv.
v.
vi.
vii.
viii.
ix.
x.
xi.
xii.
xiii.
xiv.
xv.
Rating for one-time item from 5th January, 2015 to 31st January, 2015 (original amount)=
(200*27/31) = 174 dollars
Rating for one-time item from 5th January, 2015 to 31st January, 2015 (promo amount) =
(100*27/31) = -87 dollars
Rating for reserved item from 5th January, 2015 to 14th January, 2015 (original amount) =
(150*10/31) = 48 dollars.
Rating for reserved item from 5th January, 2015 to 14th January, 2015 (promo amount)= (base
price*10/31)*5% = (-) rated amount dollars
Rating for reserved item from 15th January, 2015 to 31st January, 2015 (original amount)=
(150*17/31) = 82 dollars
Rating for reserved item from 15th January, 2015 to 31st January, 2015 (promo amount)=
(base price*17/31)*5% = (-) rated amount dollars
Rating for PPU item from 5th January, 2015 to 31st January, 2015 (original amount) =
(220*27/31) = 192 dollars
Rating for PPU item from 5th January, 2015 to 31st January, 2015 (promo amount) =
(50*27/31) = -44 dollars
Rating for promo amount on offer from 5th January, 2015 to 31st January, 2015 = (80*27/31) =
70 dollars
Rating for advance amount from 1st February, 2015 to 28th February, 2015 (original amount)
= (150*28/28) = 150 dollars
Rating for advance amount from 1st February, 2015 to 28th February, 2015 (promo amount)
= (5/100*28/28) = -0.05 dollars
Rating for reserved item 1st February, 2015 to 28th February, 2015 (original amount) =
(150*28/28) = 150 dollars
Rating for reserved item from 1st February, 2015 to 8th February, 2015 (promo amount)=
(base price*8/28) = (-) rated amount dollars
Rating for PPU item from 1st February, 2015 to 28th February, 2015 (original amount) =
(220*28/28) = 220 dollars
Rating for PPU item from 1st February, 2015 to 28th February, 2015 (promo amount) =
(50*28/28) = -50 dollars

8 APRIL 2016
ENSIM CONFIDENTIAL
460
xvi.
xvii.
Rating for promo amount on offer from 1st February, 2015 to 28th February, 2015 = (80*28/28)
=80 dollars
Rating for advance amount from 1st March, 2015 to 31st March, 2015 (original amount) =
(150*31/31) = 150 dollars.
Payment and Invoice

Payment and invoices are solely dependent on the rated data. Because based on the usage data and the
rated data invoices are getting generated. And from the generated invoices organization gets an idea about
the payment procedure and the actual payable amount etc.
Rating calculates the amount on each and individual item based on the usage of the resource on which the
item was created. But on the rating amount certain factors like Late fine etc. can be applied and with the
addition of these factors to the rating amount the actual amount is getting invoiced. Organization pays this
actual amount instead of the rating amount.
The Payment and Invoice module will come into play only when the Payment and Invoice Module Mode
is set to Required, otherwise payment and invoice module will not be effective at all.
This mode select option can be found under Configuration>Payments and Invoice within EAS.
See below

8 APRIL 2016
ENSIM CONFIDENTIAL
461
Useful terms related to Invoice and Payment

Before getting into the invoice system certain factors needs to be considered, such as VAT, Late Fine
percentage, Payment due day, Payment date, Invoice Generating Frequency, Payment Frequency etc.
Payment Date: The Date on which organization has paid the amount. This date cannot be after current date.
Payment Due Day: This is the day limit within which organization has to pay the amount as per the
invoice. Due day is the number of days allowed for an organization to pay the amount to avoid the late fee
after exceeding the date on which he/she is supposed to do the payment.
Late Fine Percentage: This is the amount which organization has to pay if he/she fails to fulfill the payment
within the payment due day. This late fees are calculated in certain percentage on the actual payable
amount.
Late Fine Minimum: Minimum amount set for the late fees. The amount has to be set in percentage.
Payment Agreement: A written agreement, commonly called a promissory note, is a contract between 2
parties. The promisor is the party paying a specific amount of money to another party known as the payee.
Invoice Frequency: Invoice frequency determines the time interval between generating two invoices.
Generally this is set as monthly.
Payment Frequency: Payment frequency is the time interval after which the payment has to be made by the
organization. Payment frequency can be set to monthly, quarterly, half-yearly and yearly.
Payment Mode: Mode of payment can be either INVOICE IN ADVANCE or POST- PAID. If the
payment mode is set to Invoice in Advance then advance amount will be included in the organization
payable amount. But if the payment mode is set to Invoice in Arrears then advance amount will not be
added with the payable amount.
Payments and Invoice Setting

The payment and invoice default settings can be done from the Configuration tab.
1.
Click Payments and Invoice link at the left side menu bar.
2.
The payments and invoice page appears.
3.
The four different sections for the setting of Payments and Invoice are
General.
Payment Agreements.
Financial Institution.
Card Type.

8 APRIL 2016
ENSIM CONFIDENTIAL
462
In General Settings:
a.
Invoice and Payment Module Mode: Select the mode from the drop down list. Three types of mode
exist. They are
Not Required- This Invoice and Payment mode will not be reflected at the time of organization
payment. This attempts to deactivate the Payment and Invoice module. This will stop the Payment
Reconciliation and Invoice creation of Organizations and Resellers.
Required- This Invoice and Payment mode will be available during organization payment. This
attempts to activate the Payment and Invoice module. This will initiate the Payment Reconciliation
of Organizations and Resellers. But a new invoice cannot be added. The invoice will be generated
by the jar invoked.
View only- This option is for third party users. These organizations may have their own invoice
generator system and do not want to use our jar to generate the invoice. They will generate the
invoice in other system and input the details manually in EAS application.
Click Save Changes button to set the mode.
b. Edit Default Settings: Set the desired values in the editable fields. These values will be shown during
the organization payment and invoice generation.
VAT Rate- Set the VAT percentage.

8 APRIL 2016
ENSIM CONFIDENTIAL
463
Invoice Generation Day- Select the duration for the generation of Invoice.
Payment Due Day- Select the payment due day.
Late Fine Percentage- Set the percentage amount for late fine.
Late Fine Minimum- Set the minimum amount for late fine.
Late Fine Percentage For Reseller-
Late Fine Minimum For Reseller-
Financial Year Starting At- Select the month for the starting of Financial year.
Required Agent- If this Boolean field is checked then Agent tab will appear on EAS UI.
Price Discount Allowed- This Boolean field decides whether the discount fields like Organization
global discount will be shown at the offer creation page or not.
Use Promo Model-This field decides whether the promo model will come into play or not when
invoices are getting generated.
Order Cancellation Reimbursement Allowed- This Boolean field allows reimbursement on order
cancellation.
Click Save Changes button to save the Default Settings.

In Payment Agreements Settings:
a.
Add Payment Agreement: Set the agreement for payment.
Enter Payment Agreement Name- Enter the agreement type. To enter the Payment Agreement
Name in multiple languages, click the
icon on the right side of the screen.
Invoice Frequency- Invoice will be generated every month, so it is fixed to monthly basis.
Select Payment Frequency- Select the frequency of payment which can be either monthly or
quarterly or half-yearly or yearly.

8 APRIL 2016
ENSIM CONFIDENTIAL
464
Select Payment Mode- Select the mode of payment; that is Invoice in Advance or Invoice in
Arrears.
Remarks- This is an optional field. Service Provider may enter the remarks regarding the payment
agreement.
Click Add New button to save the payment agreement.

Once the new setting is saved, the Payment Agreement Name will appear in the Default Payment
Agreement as shown below.
As the Default Payment Agreement Name is changed, the default settings for that agreement appear in
a section as shown below.
After the Default Payment Agreement is set, click the Save Changes button.
Note: At least one payment agreement must be created in order to create Organization or Reseller
successfully.

8 APRIL 2016
ENSIM CONFIDENTIAL
465
In Financial Institution Settings:
a.
Add Financial Institution: Enter the name of the financial institution.

Click the Add New button to save the financial institution.
Once the financial institution is added, the name will appear in the default section as shown in the
figure below.
After the Default Financial Institution is set, click the Save Changes button.
In Card Type Settings:

8 APRIL 2016
ENSIM CONFIDENTIAL
466
a.
Add Card Type: Enter the name of card type that will be acceptable during payment.
Click the Add New button to save the card type.
Once the Card Type Name is added, the name will appear in the default section as shown in the figure
below.
After the Default Card Type Name is set, click the Save Changes button.
Save organization payment

Follow the steps below to save organization payment info through EAS1.
2.
Click the Payments tab. If the Payments tab is not visible then go to the
Configuration>Payments and Invoice and set the Payment and Invoice Module Mode as
Required. Then click the Save Changes button.
3.
After click the Payments tab the following form will open up

8 APRIL 2016
ENSIM CONFIDENTIAL
467
4.
Organization ID/Account ID: Put the organization id or account id. If the organization id
or account id is already present in the database then organization details will be shown at
the right side of the screen.
Payment Date: Put the date of payment by the organization.
Amount Paid: Amount paid by the organization and also set the currency type from the
drop down. Exchange rate will be shown on each currency type.
Mode of Payment: Mode of payment can be Cash, Cheque, Debit Card, Credit Card,
Other etc.
Fill the other required details if any and click the Save Payment button to save the payment.
A. In Organization Payments:
i.
Select payment received.
ii.
Provide an existing organization id. The basic details of the user will be displayed.
iii.
Fill the required details such as Payment date, Amount, etc.
iv.
Select the currency, payment mode and financial institution.
v.
Click the Save Payment button.
vi.
The payment will be saved.

8 APRIL 2016
ENSIM CONFIDENTIAL
468
Adjustment for Organization:

1. Select adjustment from organization payment.
2. Fill the details for payment adjustment.
3. Select adjustment type either Credit Note or Debit Note.
4. Click save payment.
i.
For bulk payment entry CSV file may be uploaded by clicking the Upload CSV button.
The CSV format will be displayed.

8 APRIL 2016
ENSIM CONFIDENTIAL
469
vii.
viii.
Click the Choose File button to upload the file and click Save Payment button.
As the Organization Id is provided,
tab; Organization Invoice section.
icon appears which redirects user to the Invoice
B. In Reseller Payments:
i.
Select payment received.
ii.
Provide an existing reseller id. The basic details of the user will be displayed.
iii.
Fill the required details such as Payment date, Amount, etc.
iv.
Select the currency, payment mode and financial institution.
v.
Click the Save Payment button.

8 APRIL 2016
ENSIM CONFIDENTIAL
470
vi.
The payment will be saved.
Adjustment for reseller:

1.
Select adjustment from reseller payment.
2.
Fill up the details.
3.
Select adjustment type which is either Credit Note or Debit Note.
4.
Click save payment.

vi.
For bulk payment entry CSV file may be uploaded by clicking the Upload CSV button.
The CSV format will be displayed.

8 APRIL 2016
ENSIM CONFIDENTIAL
471
vii.
Click the Choose File button to upload the file and click Save Payment button.
Add Invoice
In this section the payment details can be viewed and new invoices can be added.
To view the invoice details for an organization, follow the steps below1.
Change Payment and Invoice configuration to View Only.
2.
Click the Invoice tab.
3.
Search for the desired invoice details through the Search Invoice section. Provide the required
details and click the Search button.
4.
A list of Invoice appears.
5.
Click a particular invoice, and the details will be displayed. This payment details appears on the
basis of payment made from the Payments tab.

8 APRIL 2016
ENSIM CONFIDENTIAL
472
6.
New invoice may be added by clicking the Add Invoice Details button.
A. In Organization Invoice:
i.
Provide the Organization Id and the organization details will be displayed.
ii.
Fill the other required details.
iii.
Click Add Invoice button.
B. In Reseller Invoice:

8 APRIL 2016
ENSIM CONFIDENTIAL
473
The above invoice window will appear under the Reseller Invoice tab as well where required details
can be filled for adding a new reseller invoice.
Payment and Invoice module mode can be set to three conditions as discussed previously.
The Not Required mode depicts that the organization has its own rating and invoicing system and wants
EAS to provide only the usage data and unrated order information. The organization will produce its own
rating and financial settlement data. In this case both the payment and invoice tab will not appear.
The View Only mode depicts that the organization wants EAS to do the rating and then transfer the rated
information and the organization will do the financial settlement for themselves. In this case a third party is
allowed to generate the financial settlement. Firstly the Rating.jar calculates the rating on behalf of the
organization. Then the InvoiceExporter.jar file is used to generate xml files containing the rated data. The
third party generates these xml files are transferred to an organization based on this invoice. EAS can just
reconcile the generated invoice details by the third party into their own database.
The Required mode depicts that the organization wants EAS to do both the rating as well as the financial
settlement for their organization. EAS will do the rating with the Rating.jar and then the invoice through the
InvoiceGenerator.jar and then generate the invoice PDF for organization through InvoicePDFGenerator.jar.
Invoice is account specific as well as provider specific. Hence, multiple invoices can be sent to organization
in a single month for different accounts (official address or billing address). Organizations can have
multiple accounts separated either geographically or departmentally. Hence, in a single month an
organization may receive multiple invoices in their accounts. Multiple invoices may be sent to a single
account if the organization has multiple providers.
Billing Adjustment
Billing Adjustment feature is implemented to rectify and reduce the risk of error occurrence in three billing
sub modules:
1. Pricing
2.
Reservation Quantity
3.
Usage
Pricing adjustment is required if an order without one off discount is placed by the user and the provider
wants to allow that user a discount percentage. For the above mentioned case some adjustments are
required in pricing which can be done in 2 ways Suppose, item IT1 has tiered pricing with discount-

8 APRIL 2016
ENSIM CONFIDENTIAL
474
Range
0-100
100-500
500-Unlimited
Price in $
5
4.50
4
Discount (%)
20
22
23
In this case, user will be able to adjust the discount percentage for each tier, effectively adjusting the price
for that item and order-line. But the adjusted price should be within the discount range.
If no discount is available, i.e. "Use discount" has been turned off or discount range is not specified in item
pricing, then the user can modify the actual price for the change scope.
A new role "Adjust One-Off Price for Invoice correction" is implemented for pricing adjustment for Provider.
Reservation Adjustment is required if an order which is already placed by the provider needs to have any
adjustments in the reserve quantity.
For example: suppose an order is placed with a reserved item with quantity 10 and after some time customer
raise a concern that the reserved quantity ordered was 8 instead of the billed quantity which is 10. Hence
Reservation adjustment is required for the mentioned order which is not allowed in the current order line.
Reservation Quantity Adjustment also depends on the purchase option validation.
Only if purchase option is selected as "Custom" then reservation quantity can be adjusted in between the
minimum and maximum range.
A new role is implemented namely Adjust Reservation Quantity for Invoice correction for Reservation
Quantity Adjustment for provider.
EAS receives or calculates usage data for a given order. Rating and billing are done based on that. If this data
has errors, there is no way to rectify them as of now and they result in recursive billing errors. The following
scenarios are foreseen regarding adjustments as of now1) Adjustment of value of a particular usage line. E.g., user has ordered Storage in PPU and on 21st January he
used 8GB. But the usage data has 10 GB for the same date. This needs to be adjusted on demand through EAS
UI.
2) Inserting new usage for a given date. E.g., user has used 8 GB on 21st of January, but there is no record of it in
EAS. This needs to insert in EAS DB through UI.
A new role is implemented namely Adjust Usage Data for Invoice correction for Usage Adjustment for
provider.

8 APRIL 2016
ENSIM CONFIDENTIAL
475
Impact on Rating
Rating will run on 2 modes:
1.
Full Month Billing Mode Where rating will run as it is.
2.
Differential Billing Mode Where Rating will run only for the orders for which billing adjustment is
done.
Billing Codes
OTC (One-time Charge) +VE and debit to the customer.
-VE and debit to the customer if a discount (One/Off Discount, Global Discount and Item Level Promo) is
applicable.
This element is present in the following circumstances 1. In FIRST invoice if there is an one-time item
2. In upgrades and downgrades if the new Offer has a chargeable one-time element.
Note that at the time of Upgrade and downgrade for One-time item EAS has 3 options No charge, Charge
Differentiate and Full Charge. A line is coming after upgrade and downgrade if the option is selected as
Charge differentiate and Full charge. For no charge option no line is coming.
PRC (Previous Reservation Charge) +VE and debit to customer.
-VE and debit to customer if organization global discount or item promo or One/off discount applied.
If billing in advance is used then in first instance PRC need to charged but ignore for all other instances.
If billing in arrears is used then PRC need to charge for every instance.
ARC (Advance Reservation Charge)+VE and debit to customer.

-VE and debit to customer if organization global discount or promo discount applied.
For the first instance of the billing run of an Order, PRC and ARC both must be charged to the customer if
billing in advance is used.
If billing in arrears is used then ARC need to ignored for every instance.
Note that for the last instance (cancelled orders), if advance billing was used, then a pro-rated
reimbursement amount will be present in a separate billable Item node as CRR.
BRC (Breakage Reservation Charges) +VE and debit to the customer.
-VE and debit to the customer if org global discount is applicable.
If any upsize, downsize, upgrade, downgrade takes place within the month then this BRC line is coming for
reservation item.

8 APRIL 2016
ENSIM CONFIDENTIAL
476
PUC (Previous Usage Charge) +VE and debit to customer.

-VE and debit to customer if promo or global discount is applied.
Usage amounts are always billing in arrears.
PRR (Previous Reservation Reimbursement) +VE and credit to customer for Reservation charges
-VE and credit to customer for Promotional and Organization discounts
If billing in advance is used then PRR need to reimburse to the customer.
If billing in arrears is used then PRR need to ignore as there is no advance so no reimbursement also.
Note that Reimbursement is happening when doing upsize, downsize, upgrade, downgrade in steady state
and billing in advance mode is selected
CRR (Cancellation Reservation Reimbursement)Always +VE and credit to customer
This represents reimbursement of the advance reservation charges when the Order was cancelled.
If billing in advance is used then CRR need to reimburse to the customer.
If billing in arrears is used then CRR need to ignore as there is no advance so no reimbursement also.
DOT (Discount on Order Total) -VE and debit to customer if the offer level promo discount is present
IRC (Installment Reservation Charge)
Always +VE and debit to customer
For installment item this billing code is coming and this code will be continued for the time period set in the
offer level (Installment Times).
Table of Billing Code

Billing
Code
OTC
Billing Instance
Billing Mode
FIRST
OTC
STEADY, LAST
DOT
IRC
FIRST, STEADY,
LAST,
RESUMED
FIRST,STEADY
PRC
FIRST
PRC
STEADY
PRC
STEADY
Invoice in
Advance/Invoi
ce in Arrear
Invoice in
Advance/Invoi
ce in Arrear
Invoice in
Advance/Invoi
ce in Arrear
Invoice in
Advance/Invoi
ce in Arrear
Invoice in
Advance/
Invoice in
Arrear
Invoice in
Arrear
Invoice in
Advance

8 APRIL 2016
Chargeable/NonChargeable
Chargeable
Condition
Chargeable
Upgrade/Downgrade
Chargeable
Offer Level Promo
Chargeable
Chargeable
Chargeable
Non-Chargeable
ENSIM CONFIDENTIAL
477
PRC
RESUMED
PRR
STEADY
CRR
LAST
ARC
FIRST, STEADY,
RESUMED
STEADY,LAST
BRC
Invoice in
Advance/Invoi
ce in Arrear
Invoice in
Advance
Invoice in
Advance
Invoice in
Advance
Invoice in
Arrear/Invoice
in Advance
Chargeable
Reimbursement
Reimbursement
Upsize/Downsize/Upgrade/
Downgrade
Cancel
Chargeable
Chargeable
Upsize/Downsize/Upgrade/
Downgrade
Billing Instance
There are 3 instances as explained below:
FIRST: This is the first invoice to the organization for an order
For billing in advance, the first invoice will have two lines for every reservation
1. Previous months charges
2. Next month advance
For billing in advance, the first invoice will have both lines and both must be charged.
For billing in arrears, the first invoice will have both lines but advance line need to ignore.
LAST: This is the last invoice to the organization for an order because that order has been cancelled due to
some reason
STEADY: This is the steady invoice to the organization for an order (previously invoiced for that order at
least once)
Special cases: If an order was placed and cancelled in the same month, the invoice will be reported once as
'first' instance.
If the Order was placed in a month and cancelled in the very next month, there will not be any invoice for
'steady' instance.
In other words, the 'first' instance is mandatory.
RESUMED: This is the Resumed invoice to the organization for an order which has been cancelled before.
After the Resumed invoice organization will start getting steady invoice for this order.
Billing Type
The type will be either credit/debit. The value should be debit in all cases except reimbursements and
discounts.
Debit and positive (+ve) values imply that the customer is liable to pay.
Debit and negative (-ve) means a discount on the amount to be paid by the customer.
Credit and positive (+ve) means the merchant will reimburse this amount against a previous invoice.
Credit and negative (-ve) means that the customer is liable to pay against a discount he received earlier.
8 APRIL 2016
ENSIM CONFIDENTIAL
478
Payment Mode
The billing mode will be either Invoice in Advance/Invoice in Arrear based on the payment mode set in
offer.
If Invoice in Advance then billing should be in advance
If Invoice in Arrear then billing should be in arrears and there is no advance no reimbursement
Custom Fields
There are 12 custom fields of each type in EAS at different levels of product :
Organization custom fields
Item custom fields
Offer custom fields
Order custom fields
The Custom fields can be configured from Configuration-> Custom Fields
Name: These are the default names given to the custom fields.
Rank: It determines the order in which the custom field would show everywhere.
Enabled: If checked the custom field is a activated. You can enable 12 custom fields of each type.
Mandatory: If checked the user will have to put some values in the field, in order to proceed.
8 APRIL 2016
ENSIM CONFIDENTIAL
479
Export: Unless checked the custom field will not be exported in Rated Export and Order Export.
Export Id: The input here will appear as headers in all the exported CSV and xml files
PIFs
Provisioning information will be exported if while creating an offer under the item configuration tab if
Export value set to true.
Please refer to the sample CSV in the folder SAMPLE EXPORTED FILES AND XSD
Headers in Rated/Unrated Execution Mode

Apart from the headers present in the Order Exporter, the following headers are present in the
Rated/Unrated export file.

8 APRIL 2016
ENSIM CONFIDENTIAL
480
Headers
Descriptions
PROVIDER_ID
This represents the ID of the provider.
PROVIDER_NAME
This represents the providers name.
RESELLER_TYPE
ORGANIZATION_ID
ORGANIZATION_NAME
ORGANIZATION_UPN_SUFFIX
MASTER_ACCOUNT_ID
SERVICE_ACCOUNT_ID
SERVICE_ACCOUNT_NAME
BILLING_ACCOUNT_ID
BILLABLE_ACCOUNT_NAME
EXTERNAL_BILLING_ID
PAYMENT_AGREEMENT_NAME
This represents the type of reseller, that is, type-1, type2,

and so on.
This is the unique organization ID for which the order
was created.
It represents the name of the organization for which the
order was created.
It represents the UPN Suffix of the organization for
which the order was created.
This represents the name of the master account to which
this Order was placed.
This represents the unique ID for a service account of an
organization under which the Order was placed.
This represents the name of a service account of an
organization under which the Order was placed.
This represents the unique ID of a billable account to
which this Order must be billed.
This may or may not be same as the service account of
the Order.
This represents the unique ID of a billable account to
which this Order must be billed.
This may or may not be same as the service Account of
the Order.
This represents the unique ID that indicates the external
account ID of the customer.
The name of the payment agreement applicable for this
order.
TECHNICAL_CONTACT
Login name of the technical contact of the Order.
TECHNICAL_CONTACT_PRIMARY_EMAIL
Primary email of the technical contact of the Order.
TECHNICAL_CONTACT_PHONE_NUMBER
Phone number of the technical contact of the Order.
BUSINESS_CONTACT
Login name of the business contact of the Order.
BUSINESS_CONTACT_PRIMARY_EMAIL
Primary email of the business contact of the Order.
BUSINESS_CONTACT_PHONE_NUMBER
Phone number of the business contact of the Order.
ORDER_ID
Order number is the unique ID of that Order.
SUBORDER_NUMBER
Every Order has a co-orderNumber, along with the

orderNumber. The subOrderNumber changes with each
action performed on a particular order.
ORDER_CREATION_DATE
The date on which the order was created.
CREATED_BY
The username of the user who created the order.
CREATOR_ORG_TYPE
Organization type of the user who created the order.
BILL_CYCLE_DAY
It represents the day on which the particular is to be

billed, subject to other conditions.

8 APRIL 2016
ENSIM CONFIDENTIAL
481
PREV_BILL_CYCLE_DAY
It represents the previous bill cycle day, if the bill cycle

day value is changed within a billing period.
LAST_EDIT_DATE
The last date on which the order was edited.
PURCHASE_ORDER_NUMBER
MIGRATION_STATUS
APPROVED_BY
APPROVED_BY_ORG_TYPE
PROVISIONED_BY
This field is required to map the internal EAS order

number with the external order numbers during the
time of importing external orders.
This indicates whether the order is migrated from other
system and its current state of migration.
It represents the username of the user who approved the
order.
It represents the organization type of the user who
approved the order.
It represents the username of the user who provisioned
the order.
PROVISIONING_SYSTEM_ID
It represents the ID generated by provisioning system.
PROVISIONING_ID_DETAILS
It represents the provisioning details generated by the

provisioning system.
IS_TRIAL
This indicates whether the order is in trial.
TRIAL_TO_PURCHASE_DATE
The date on which the trial order was purchased.
NET_ORDER_TOTAL_ARREARS
NET_ORDER_TOTAL_ADVANCE
ORDER_TOTAL_TAX_AMOUNT_ARREARS
ORDER_TOTAL_TAX_AMOUNT_ADVANCE
ORDER_TOTAL_TAX_ON_TAX_AMOUNT_ARRE
ARS
ORDER_TOTAL_TAX_ON_TAX_AMOUNT_ADV
ANCE
INVOICE_START_DATE
INVOICE_END_DATE
SUBSCRIPTION_ID
SUBSCRIPTION_PERIOD_LENGTH

8 APRIL 2016
It represents the net Order total without tax that an

organization has to pay if the invoicing mode is
Postpaid.
It represents the net Order total without tax that an
organization has to pay if the invoicing mode is Prepaid.
It represents the net Order tax total that an organization
has to pay if the invoicing mode is Postpaid.
It represents the net Order tax total that an organization
has to pay if the invoicing mode is Prepaid.
It represents the net Order tax on tax total that an
organization has to pay if the invoicing mode is
Postpaid.
It represents the net Order tax on tax total that an
organization has to pay if the invoicing mode is Prepaid.
It represents the date from which the item is billable for
this billing run.
It represents the date till which the item is billed for this
billing run.
SSID is a unique ID generated by EAS for the Order. The
ID changes when the Order is upgraded or downgraded
to another Offer.
It represents the length of the subscription period for the
corresponding offer. For example, 1,2,3............n.
ENSIM CONFIDENTIAL
482
SUBSCRIPTION_PERIOD_UNIT
It represents the unit of the subscription period for the

corresponding offer. For example, year, month, day, or
hour.
Note: the Subscription period is present for information
only.
SUBSCRIPTION_START_DATE
It represents the date on which the subscription started.
SUBSCRIPTION_END_DATE
It represents the date on which the subscription ended.
SUBSCRIPTION_RENEWAL_DECISION
This indicates how the subscription plan will behave

after the subscription period. It contains the following
constant values according to the subscription renewal
decision:
RENEW_TO_SAME_PLAN
CANCEL_PLAN
RENEW_WITH_UPSIZE_QUOTA
RENEW_WITH_DOWNSIZE_QUOTA
RENEW_WITH_CHANGE_PLAN
ITEM_ID
Item ID is the unique ID of the corresponding Item.
ITEM_CODE
ITEM_NAME
ITEM_DESCRIPTION
ITEM_UNIT
UNIT_NAME
PROMO_CODE
PROMO_APPLY_DATE
DIFFERENTIAL_QUANTITY
NET_QUANTITY
NET_PRICE
DATE
8 APRIL 2016
It represents the Item Code of an item of corresponding

Order
Depending upon the Billing language of the
Organization the corresponding name of the Item will
printed.
If the language specific name is not registered in EAS,
the English name will be printed.
This field contains the description of the item of
corresponding order.
It represents the code for the unit of the item as
registered in EAS. For example, Nr for Number, GB for
Gigabytes, and so on.
Unit Name represents the unit for the item, such as
Number, Gigabytes.
It represents the promo code used to apply promo to an
order.
It represents the date on which the promo has been
applied to an item.
This represents the change in quantity of an item if an
item is either upsized or downsized. For example, if an
item quantity has been upsized from 10 to 15
'differential quantity' will be 5.
It represents the total quantity after summing up all the
tiered quantities of an item.
It represents the cost of the tier after considering one-off
discount as approved for this Order.
Note: Organization Global Discounts, Promo discounts
are not included in the price.
It represents the date on which the job has been
executed.
ENSIM CONFIDENTIAL
483
PROVISIONED_DATE
The date on which the order was provisioned. This date

varies for each order action. (For example, Provision,
Up-Down size, Up-Down grade)
FIRST_PROVISIONED_DATE
The date on which the order was first provisioned.
BILLING_FREQUENCY_LENGTH
BILLING_FREQUENCY_UNIT
It represent the length of the billing frequency for the

corresponding item. For example, 1,2,3............n.
It represents the unit of the billing frequency for the
corresponding item.
The possible values are month and year.
For example, if an item is priced for 2 years, the unit will
be year while the length will be 2.
There are 3 instances as follows:
FIRST: This is the first invoice to the organization for an
order.
For billing in advance, the first invoice will have two
lines for every reservation, that is
previous months charges
next month advance
For billing in advance, the first invoice will have both
lines and both must be charged.
For billing in arrears, the first invoice will have both
lines but advance line need to ignore.
LAST: This is the last invoice to the organization for an
order because that order has been cancelled due to some
reason.
BILLING_INSTANCE
STEADY: This is the steady invoice to the organization

for an order (previously invoiced for that order atleast
once)
Special cases: If an order was placed and cancelled in the
same month, the invoice will be reported once as 'first'
instance.
If the Order was placed in a month and cancelled in the
very next month, there will not be any invoice for
'steady' instance.
In other words, the 'first' instance is mandatory.
RESUMED: This is the Resumed invoice to the
organization for an order which has been cancelled
before. After the Resumed invoice, organization starts
getting steady invoice for this order.

8 APRIL 2016
ENSIM CONFIDENTIAL
484
There are 9 codes as follows:

OTC (One Time Charge):
+ve and debit to the Organization.
-ve and debit to the Organization if a discount is
applicable.
This element is present in the following circumstances
In the first invoice if there is an one-time item
In upgrades and downgrades if the new Offer
has a chargeable one-time element.
PRC (Previous Reservation Charge):
+ve and debit to Organization.
-ve and debit to Organization if organization global
discount or promo discount applied.
If billing in advance is used then in first instance PRC
need to charged but ignore for all other instances.
If billing in arrears is used then PRC need to charged for
every instance.
ARC (Advance Reservation Charge):
discount or promo discount applied.
BILLING_CODE
For the first instance of the billing run of an Order, PRC

and ARC both must be charged to the Organization if
billing in advance is used.
If billing in arrears is used then ARC need to ignored for
every instance.
For the last instance (cancelled orders), if advance billing
was used, then a pro-rated reimbursement amount will
be present in a separate billableItem node as CRR.
BRC (Breakage Reservation Charges):
+ve and debit to the Organization.
-ve and debit to the Organization if org global discount
is applicable.
PUC (Previous Usage Charge):
discount is applied.
Usage amounts are always billing in arrears.
PRR (Previous Reservation Reimbursement):
+ve and credit to Organization for Reservation charges
-ve and credit to Organization for Promotional and
Organization discounts.

8 APRIL 2016
ENSIM CONFIDENTIAL
485
If billing in advance is used then PRR need to

reimbursed to the Organization.
If billing in arrears is used then PRR need to ignore as
there is no advance so no reimbursement also.
CRR (Cancellation Reservation Reimbursement):
Always +ve and credit to Organization.
This represents reimbursement of the advance
reservation charges when the Order was cancelled. See
notes on ARC.
If billing in advance is used then PRR need to reimburse
to the Organization.
If billing in arrears is used then PRR need to ignore as
there is no advance so no reimbursement also.
DOT (Discount on Order Total):
-ve and debit to Organization if the discount is on Order
total.
IRC (Installment Reservation Charge):
Always +ve and debit to Organization.
BILLING_TYPE
NET_ITEM_TOTAL_ARREARS
NET_ITEM_TOTAL_ADVANCE
ITEM_TOTAL_TAX_AMOUNT_ARREARS
ITEM_TOTAL_TAX_AMOUNT_ADVANCE

8 APRIL 2016
The type will be either credit or debit. The value should

be debit in all cases except reimbursements and
discounts.
Debit and +ve values imply that the customer is liable to
pay.
Debit and -ve means a discount on the amount to be
paid by the Organization.Credit and +ve means the
merchant will reimburse this amount against a previous
invoice
Credit and -ve means that the Organization is liable to
pay against a discount he received earlier.
It represents the net item total without tax that an
organization has to pay for the corresponding item if the
invoicing mode is Postpaid.
It represents the net item total without tax that an
invoicing mode is Prepaid.
It represents the net tax amount that an organization has
to pay for the corresponding item if the invoicing mode
is Postpaid.
It represents the net tax amount that an organization has
to pay for the corresponding item if the invoicing mode
ENSIM CONFIDENTIAL
486
is Prepaid.
ITEM_TOTAL_TAX_ON_TAX_AMOUNT_ARREA
RS
ITEM_TOTAL_TAX_ON_TAX_AMOUNT_ADVAN
CE
It represents the net tax on tax amount that an

invoicing mode is Postpaid.
It represents the net tax on tax amount that an
invoicing mode is Prepaid.
ITEM_TAX_CODE
It represents the tax code attached to the item in EAS.
TIER_QUANTITY
Quantity determines the amount of items per tier/price

plan. For reservation items it signifies the purchased
quantity. For usage based items it represents the
collected quantity from the service platform.
Specific rating rules such as AVERAGE, SUM, MAX,
MIN, PRO-RATA would have already been applied
according to configuration.
TIER_MIN_VALUE
Min Value is the minimum value of a tier range.
TIER_MAX_VALUE
Max Value is the maximum value of a tier range.
TIER_TOTAL
Tier total represents the calculated rated data for a single

tier of an item within the specific period of time.
The element may represent one of the following
A +ve amount for charges that the customer has to
pay, or its adjustment
A -ve amount for discounts offered to the customer
(against a chargeable element) or its adjustment
To identify how this quantity is to be incorporated into
the final payable amount of the invoice, one must
take the following attributes into consideration Billing_Type: Debit or credit
Billing_Code: 8 possible codes, look into the
documentation of the same.
Exported Rated CSV File (Renamed Headers)

Old column name (4.2)
Renamed column name (4.3)
NET_ORDER_TOTAL_WITHOUT_ADVANCE
NET_ORDER_TOTAL_WITH_ADVANCE
NET_ITEM_TOTAL_WITHOUT_ADVANCE
NET_ITEM_TOTAL_ARREARS
NET_ITEM_TOTAL_WITH_ADVANCE
NET_ITEM_TOTAL_ADVANCE

8 APRIL 2016
ENSIM CONFIDENTIAL
487
Exported Rated XML File (Renamed Tags)

Old Tags (4.2)
Renamed Tags (4.3)
netOrderTotalWithoutAdvance
netOrderTotalArrears
netOrderTotalWithAdvance
netOrderTotalAdvance
netItemTotalWithoutAdvance
netItemTotalArrears
netItemTotalWithAdvance
netItemTotalAdvance
The header set of Unrated Export is the subset of Rated export where the following headers are not present:
BILLING_TYPE
BILLING_CODE
BILLING_INSTANCE
Output File Naming Convention

The CSV/XML file generated will contain the above mentioned columns for P2R as well as P2O.
The corresponding CSV and XML file will have same names with different extensions.
The regular expression for file names are:B2C File:
<Provider Id>_<File Use>_<job Id>YYYY_mm_dd_<Instance Id> (eg.
1_RatedExport_DemoJOb_2016_04_01_I328.csv)
After every 1000 orders(default, configurable from UI) a new file will be created appending _i where i
will increment after every 1000 orders. (eg. 1_RatedExport_2015_06_28_I303_1)
For differential run _diff will be appended at the end (eg. 1_RatedExport_2015_06_28_I303_1_diff)
B2B File:
SP_<Reseller Id>_<job Id>YYYY_mm_dd_<Instance Id> (eg. SP_17RTx6_DemoJob_2015_06_28_I657)
Zip File:
<File Use>_<job id>YYYY_mm_dd_<Instance Id> (eg. RatedExport_DemoJOb_2016_04_01_I328.zip)
Invoice Generator Jar

InvoiceGenerator.jar mainly generates invoices based on the rated data on various items. The information
stored by Rating.jar file are gathered and dumped in database by this InvoiceGenerator.jar file. Such as; the
organization specific details (organization id, organization name, account id, address, organization type,
etc.) are stored in table customer invoice details. Whereas the rated order information (individual charges
for one-time, reserved and PPU items, advance amount, value with respect to each tier, etc.) are stored in
table invoice order monthly.

8 APRIL 2016
ENSIM CONFIDENTIAL
488
Invoice Generator jar takes as input the month and year in the format MM YYYY and collects the invoice
data of each account for that particular month.
The data includes the account-wise details of the orders, the net amount payable, the late fees and the
payment received. The data also includes the order-wise Reserve, One-time, Pay-per-use and Advance
amounts payable for each account. This data collected is then used for the InvoicePDFGenarator jar for
systematic invoices PDF generation.
Note: It is mandatory to run the Rating jar before the InvoiceGenerator jar for the particular monthyear.
Application Settings
Tool used for Invoicing
An executable .jar(named as InvoiceGenerator.jar) file along with two xml files(log4j.xml and
configuration.xml) is responsible for performing the financial settlement on the rated order data and usage
data for a certain interval of time. Generally it is executed on 2nd day of every billing month.
Java Version
To execute the .jar file successfully make sure the installed jdk version is jdk 1.7 or more
Binaries
The application module contains following files
i.
One .jar file named InvoiceGenerator.jar
ii.
One config.xml file and
iii.
One log4j.xml file
Where log4j.xml file contains the path and name of the log file correspond to the InvoiceGenerator jar.

8 APRIL 2016
ENSIM CONFIDENTIAL
489
To change the name and the path of the log file open the log4j.xml file and edit the following portion-
config.xml file contains the following three properties along with the database connection settinga. blocksize: This block size determines the number of orders which will be fetched from the database
at a time.
b. frequency_of_prorata_calculation: This property determines the Pro rata calculation frequency. It
can be either daily or hourly.
c. floor_order_quantity: If this field is set to true then the order quantity will be taken after applying
the floor operation on the given order quantity.
For example if the order quantity is given as 50.67 then the order quantity will be taken as 50 when
this field is set to true.
See below-

8 APRIL 2016
ENSIM CONFIDENTIAL
490
Executing the jar

InvoiceGenerator.jar file with the following commandjava -Dlog4j.configuration=file:/<location of the log4j.xml file>/log4j.xml jar <location of the jar file>/<name of the jar>.jar
For exampleusr/bin/java -Dlog4j.configuration=file:usr/home/InvoiceGenerator/log4j.xml -jar /usr/home/InvoiceGenerator/InvoiceGenerator.jar
Invoice generator can also be run from Tool Scheduler Menu page in configuration tab.
Check version of the executable jar

To check the version of the executable jar of this module the following command has been usedjava Dlog4j.configuration=file:<location of the log4j.xml>/log4j.xml jar <name of the jar file>.jar v
For example:
usr/bin/java Dlog4j.configuration=file:/usr/home/InvoiceGenerator/log4j.xml
jar/usr/home/InvoiceGenerator/InvoiceGenerator.jar -v
Historical Invoice Calculation

Invoice may be calculated for any of the month (any previous month of the current month) by specifying
the month and the year in the command of executing the .jar file.
The generalized command structure is mentioned belowjava Dlog4j.configuration=file:<location of the log4j.xml file>/log4j.xml jar <location of the jar file>/<name
of the jar>.jar <month> <year>
For example, to generate the rating of June month of the Year 2013 then put the commandusr/bin/java Dlog4j.configuration=file:/usr/home/InvoiceGenerator/log4j.xml jar
/usr/home/InvoiceGenerator/InvoiceGenerator.jar 06 2013
Historical run of Invoice Generator can also be run from Tool Scheduler Menu page in configuration tab.
Note: The year should contain 4 digits as shown above (2013) and month field will take only integer
value containing 2 digits. January will take 01; February will take 02 and so on.

8 APRIL 2016
ENSIM CONFIDENTIAL
491
Invoice PDF Generator Jar

A printed copy of invoice details helps both the Service Provider and their organizations to keep track of the
payable amount, previous month invoice, late fees, fines etc. Hence the invoice details are structured in a
PDF format and sent to respective organizations. The Invoice PDF gives a detailed organized view along
with the price distribution for each item. The InvoicePDFGenarator.jar helps in collecting the data from the
database and generates the invoice in PDF format. The InvoicePDFGenerator jar generates the invoices for a
particular month and year for every organization and saves it in the shared location set by the Service
Provider is discussed belowi.
In the General Properties section under the Configuration tab of the EAS portal, the value is set
as smb://[hostname/IP address]/[share name] for property name Application wide Shared
Folder path.
ii.
Then the path invoices/yyyy/mm/[organization_id/reseller]_id/.pdf will get appended with the

above value. Here the invoice PDF files are generated and stored when the InvoicePDFGenerator.jar
file is executed.
iii.
The logo that needs to be applied on the invoice varies on the provider of that organization. Hence
for branding, the path branding/[service provider/ reseller_id]/.png will get appended to the
above mentioned value. In this location the logo of the provider is stored. While generation of the
invoice PDF, the InvoicePDFGenerator.jar will match the organization details and find the provider
and then applies the logo accordingly.
iv.
The currency that has been activated and set as default currency by the Service Provider in the EAS
portal will be considered as the Invoice currency and Invoice PDF will be generated accordingly.
The invoice will be generated in the billing language set during creation of the organization user.
If the language of the provider and organization is different, then two invoice PDFs will be
generated. One PDF will be generated in the language of the Service Provider and other in the
language of the Organization.
v.
Note: It is mandatory to run the Invoice Generator jar before the InvoicePDFGenerator jar for the
particular month-year.
The structure of the invoice PDF is discussed belowOn the Invoice PDF, the details of the Service Provider are set as the header such as the company name,
address and the logo. Then comes the organization specific details section which includes the organization
related basic details; such as Organization Id, name, Account Name, Account Id, Address, Invoice Number,
Invoice Date, etc.

8 APRIL 2016
ENSIM CONFIDENTIAL
492
The account summary section includes the following details:

Previous Invoice Amount: The previous month invoice amount is displayed. If the invoice PDF is
generated for the month of January, 2015 then this field will show the invoice amount of the month
of December, 2013.
Payment Received: The payment received from last month till date is displayed in this column. If
the invoice PDF is generated for the month of January, 2015 then this field will show the payments
received since December, 2013 till January, 2015.
Balance Amount: The amount difference between the previous month invoice amount and
payment received is displayed here.
Adjustments: The compensated amount (if any) is displayed in this column. If payment is received
in advance and the service has been cancelled within the middle of the month, then the surplus
amount needs to be returned to the organization. This column displays the adjustment amount.
Current Invoice Amount: The present month invoice details are displayed in this column. If the
invoice PDF is generated for the month of January, 2015 then this field will display the invoice
amount for January.
Late Fees: Late fees (if any) are displayed in this column.
Amount Payable: The total amount paid (Balance amount + Current Invoice Amount + Taxes and
Late Fees) is displayed in this field.
The Pie-chart displays the ratio of the usage charges of different types of items such as the reserved item,
PPU item and one-time item.

8 APRIL 2016
ENSIM CONFIDENTIAL
493
Invoice Summary includes the details of the charges applied on each item along with the promotional
discount. The summary also includes the Organization global discount, late fees, previous invoice amount
and payment received till date. The total payable amount is displayed for organization ease.

8 APRIL 2016
ENSIM CONFIDENTIAL
494
Counter foil
If the organization makes payment at the counter, this foil acts as the receipt of the payment.
The receipt may be generated at the counter based on the payment date, amount and mode.
Order Details
The order information including each item details is displayed in this section such as the reserved charge,
the PPU charge, the one-time charge, the advance amount and the total payable amount.
If the invoice PDF is generated for the month of January, 2015 then the order details section will include the
reserved charges for January, one-time charges for January, PPU charges for January, Advance amount for
the month of February and at the end the Gross payable amount is displayed.
Rest of the details includes the pricing of each item tier wise. The invoice PDF may include multiple orders
and their respective pricing details.
Note: Tax amount is set to 0 as EAS does not support tax rating.

8 APRIL 2016
ENSIM CONFIDENTIAL
495
Application Settings
Tool used for Invoice PDF
An executable .jar(named as InvoicePDFGenerator.jar) file along with two xml files(log4j.xml and
config.xml) and supporting jrxml and jasper files are responsible for the generation of the invoice PDF for a
certain interval of time. Generally it is executed on 2nd day of every billing month.
Java Version
Binaries
i.
One .jar file named InvoicePDFGenerator.jar
ii.
One config.xml file
iii.
One log4j.xml file
iv.
jrxml and
v.
jasper
The jrxml contains the structure for the invoice PDF along with pointers.
The jasper file fills the tables accordingly and generates the invoice PDF.
Where log4j.xml file contains the path and name of the log file correspond to the InvoicePDFGenerator jar.
To change the name and the path of the log file open the log4j.xml file and edit the following portion-
config.xml file contains the database connection properties along with the Email properties connection
setting-

8 APRIL 2016
ENSIM CONFIDENTIAL
496
1.
The Database properties in the config.xml file can be edited to set the connection setting with the
corresponding database.
User needs to set the database name, username and password accordingly within the desired
database property.
2.
The Email properties in the config.xml file can be edited to set the recipients email address.
See below-
Executing the jar

InvoicePDFGenerator.jar file with the following commandFor example the generalized command structure is mentioned belowjava Dlog4j.configuration=file:/<location of the log4j.xml>/log4j.xml cp <location of jar file>/<name of the jar>.jar:
reportgenerator.MainClass
Command for Linux/usr/java/jdk1.7.0_10/bin/java -Dlog4j.configuration=file:log4j.xml -cp

/home/seap/Downloads/InvoicePDFGenerator/*:/home/seap/Downloads/InvoicePDFGenerator/InvoicePDFGenerator.jar:
reportgenerator.MainClass
Invoice PDF Generator can also be run from Tool Scheduler Menu page in configuration tab.
Command for Windowsjava -Dlog4j.configuration=file:log4j.xml -cp C:\User\resellerPDF1stJar\*;InvoicePDFGenerator.jar; reportgenerator.MainClass

To check the version of the executable jar of this module the following command has been usedEAS 4.2 SERVICE PROVIDER MANUAL
8 APRIL 2016
ENSIM CONFIDENTIAL
497

java Dlog4j.configuration=file:<location of the log4j.xml>/log4j.xml cp <name of the jar file>.jar; reportgenerator.MainClass v
For example:
usr/bin/java Dlog4j.configuration=file:/usr/home/InvoicePDFGenerator/log4j.xml
cp/usr/home/InvoicePDFGenerator/InvoicePDFGenerator.jar; reportgenerator.MainClass -v
Historical Invoice PDF Generation

Invoice PDF may be generated for any of the month (any previous month of the current month) by
specifying the month and the year in the command of executing the .jar file.
The generalized command structure is mentioned belowjava Dlog4j.configuration=file:<location of the log4j.xml file>/log4j.xml cp <location of the jar file>/<name
of the jar>.jar; reportgenerator.MainClass <month> <year>
For example, the Linux command to generate the rating of the June month of the Year 2013 is as follows/usr/java/jdk1.7.0_10/bin/java -Dlog4j.configuration=file:log4j.xml -cp
/home/seap/Downloads/InvoicePDFGenerator/*:/home/seap/Downloads/InvoicePDFGenerator/InvoiceP
DFGenerator.jar: reportgenerator.MainClass 06 2013
The Windows command to generate the rating for the month of June of Year 2013 is as followsjava -Dlog4j.configuration=file:log4j.xml -cp C:\User\resellerPDF1stJar\*;InvoicePDFGenerator.jar;
reportgenerator.MainClass 06 2013
Historical run of Invoice PDF Generator can also be run from Tool Scheduler Menu page in configuration
tab.
Note: The year should contain 4 digits as shown above (2013) and month field will take only integer
value containing 2 digits. January will take 01; February will take 02 and so on.
Invoice PDF generation for organization

The InvoicePDFGenerator.jar generates the invoices in the PDF format for a particular month and year for
every organization and saves it in the shared location set by the Service Provider in the General Properties
under the Configuration tab of the EAS. To proceed, follow the steps below:
1.
Edit the Database properties in the config.xml file to set the connection setting with the
corresponding database.
2.
At the command line, enter any of the following commands that help to run the jar.
-h or H or ?

8 APRIL 2016
ENSIM CONFIDENTIAL
498
This command shows the syntax to run the jar. It also shows the input parameters and their
respective formats and meanings along with the description of the exit codes.
3.
Run the jar with the month and year in the correct format to generate the Invoices in PDF format.
4.
The Invoices of the organizations for that month will be stored inside the folder for that particular
month and year in the shared location.
Note: It is mandatory to run the Invoice Generator jar before the InvoicePDFGenerator jar for the
particular month-year.
The format of Invoice is customizable. The Service Provider can customize the format of invoices for
Organization and Reseller by following the Invoice PDF Customization section available inside the
InvoicePDFGenerator Tool.
Java Version:
Binaries
i.
One .jar file named InvoicePDFGenerator.jar
ii.
One config.xml file
iii.
One log4j.xml file and
iv.
Set of iReport files(.jrxml and corresponding .jasper)
When this .jar file will execute it will read some configurable parameter from the config.xml file.
Executing the jar
InvoicePDFGenerator.jar file with the following commandjava -Dlog4j.configuration=file:/<location of the log4j.xml file>/log4j.xml jar <location of the jar file>/<name of the jar>.jar
For exampleusr/bin/java -Dlog4j.configuration=file:usr/home/InvoicePDFGenerator/log4j.xml -jar /usr/home/ InvoicePDFGenerator

/InvoicePDFGenerator.jar

To check the version of the executable jar of this module you have to put the following command
java Dlog4j.configuration=file:<location of the log4j.xml>/log4j.xml jar <name of the jar file>.jar v
For example:
usr/bin/java Dlog4j.configuration=file:/usr/home/ InvoicePDFGenerator /log4j.xml jar /usr/home/ InvoicePDFGenerator /
InvoicePDFGenerator.jar -v

8 APRIL 2016
ENSIM CONFIDENTIAL
499
Reseller Rating and Invoicing

A reseller acts as an intermediate between Service Provider and organization and help organizations to get
their items through marketing, pricing and organization service. In case of organizations, pricing is set on
each items whereas in case of resellers, pricing is set for each service called reseller price plan.
Reseller Price Plan (RPP) is a collection of resource specific pricing, set by a service provider for its reseller.
Pricing for Resellers is done on provisioning and non-provisioning (setup fee) attributes of different
services. The Service Provider assigns a copy of Offer to the Reseller with this Reseller Price Plan. Hence bill
for Reseller will be generated on the basis of service provided and its RPP. This reseller pricing, set by the
Service Provider will be common for all the resellers under that Service Provider but the difference will be
created by the discount amount which will vary from reseller to reseller.
Reseller Rating
When offer is created with these services then based on the reseller pricing set by the Service Provider,
Service Provider to Reseller rating is done. Reseller can sell these offers to their own organizations and
charges will be solely depended on the reseller.
All the use cases of rating from Service Provider to reseller are same as the Service Provider to organization
rating. Use cases of Service Provider to Organization rating have already been discussed in earlier section of
this document. Please follow the same for Reseller rating as well.
Reseller Payment and Invoice

Reseller Payment and invoices are solely dependent on the Service Provider to Reseller rating and its rated
data.
Rating amount is calculated on resource consumed by reseller from its Service Provider. But on the rating
amount certain factors like Late fine etc. can be applied and with the addition of these factors to the rating
amount the actual amount is getting invoiced. Reseller pays this actual amount instead of the rating amount
to their Service Provider.
The Payment and Invoice module will come into play only when the Payment and Invoice Module Mode
is set to Required, otherwise payment and invoice module will not be effective at all.

8 APRIL 2016
ENSIM CONFIDENTIAL
500
CHAPTER 9
Ticketing
Introduction
Ticket system (also known as Issue tracking system, Trouble ticket system, Support ticket system or Incident ticket
system) is a piece of software that manages and maintains lists of issues. The goal is to streamline all communication
within a ticket that has a highly organized workflow towards resolution of the Organization issue. An issue tracking
system often also contains a knowledge base containing information on each Organization, resolutions to common
problems, and other such data.
Overview of Ensim Ticket System

In order to streamline and better serve our clients, Ensim is introducing Ensim Ticket System to track Organization
requests and issues inside EAS platform. The Ensim Ticket System is an integrated, Web-based Customer
Relationship and Project Management Solution. Tickets will be created in have a few detailed characteristics:
Tickets will have unique reference numbers (e.g. Ticket Number).
Tickets will have a priority and workflow-related status (e.g. new, pending and closed).
Tickets will have a Subject, Description.
Tickets will have a Requester, Requested date, Category and Status etc.
With the system, Organization can:

Enter requests for ticket and report issues
Attach documentation supporting the ticket
Receive e-mail notifications when the ticket changes
Receive and answer questions about request by Organization
Track the progress of the ticket online

8 APRIL 2016
ENSIM CONFIDENTIAL
501
TICKETING CHAPTER 9
This section describes the product features of the EAS Ticket System.
Organization Support
An elegant system for dealing with inbound ticket requests. Organization service is vital for any company. You
need to ensure you respond to all questions and issues in a timely manner. Ensim Ticket System assists you
with doing that.
Organization Self Service

An easy way for users to help themselves, quickly describe what they need, and minimize their frustration.
Organization Engagement
This platform lets you gather data and use the insights to build Organization relationships that are more
meaningful, personal, and productive.
Automatic Notification
Have tickets automatically notified based on the category and it will send the notifications to the group of
support engineers who are associated with the selected category.
Adding Attachment
Tickets and replies allow a file (i.e. images, logs, etc) to be uploaded along with them to support your request.
Virus Scanner
In EAS system, you can attach a file for a ticket. The attachments are directly stored into the database as binary
format. To prevent the system from being infected by virus with these attachments, there is a virus scanner for
detecting trojans, viruses, malware & other malicious threats.
Proposed Solution
The attachment file will be checked before it being saved into the database. If the file is infected with virus,
the system will throw an error message. As we are not sure which antivirus, our client will prefer, we have
decided that EAS will use a free antivirus named ClamAV. ClamAV is an open source antivirus toolkit,
which provides a number of utilities including a flexible and scalable multi-threaded daemon, a command
line scanner and advanced tool for automatic database updates.
EAS will build a java library (.jar) based on ClamAV to check the virus infected file. The library will have
a function named checkForVirus (filename), which will accept filename as an argument. This antivirus
location and the command line arguments required to execute it, both will be configured in EAS.
The question comes if client does not want to use ClamAV what they need to do.
The solution is that, they need to change the code for checkForVirus () function as required and replace the
.jar file. They need this as every antivirus have different command line arguments.
Note: If the antivirus is not installed in the system, still they can use the EAS Ticketing System with
attachment facility but without the antivirus support. So it is up to the customer whether they want to
implement this or not.

8 APRIL 2016
ENSIM CONFIDENTIAL
502
TICKETING CHAPTER 9
Antivirus Configuration
To use the virus scanner in EAS you need to configure the location and the command line arguments
required to execute the antivirus in the synergy-config.groovy file. By default the virus scanner will be
disabled. To make it enabled you need to change the virus.scanner.enabled to TRUE.
The screenshot shows above are the commands needed to run the antivirus (i.e.: the above commands are
for clam AV running in windows) for a particular file, only you need to provide the installed antivirus path
in place of AV path. You can use any other antivirus of your choice, provided that antivirus should support
command line arguments as shown above.
Note: Please write the commands within double quote. The below table describes the use-cases of this
scanning process.

8 APRIL 2016
ENSIM CONFIDENTIAL
503
TICKETING CHAPTER 9
Common Terms for Tickets

Tickets/Issues
Tickets/Issues can have several aspects to them. Each Tickets in the system may have an urgency value
assigned to it, based on the overall importance of those Tickets. Low or zero urgency Tickets are minor and
should be resolved as time permits. Other details of Tickets include the Organization experiencing the
Tickets, date of submission, detailed descriptions of the problem being experienced, attempted solutions or
workarounds, and other relevant information. Each Tickets maintains a history of each change.
Ticket Category
Classify various business units into categories and efficiently organize incoming requests based on type.
Requests to a category can be submitted according to your help desk requirements. For greater
productivity, help desk staff can be given access to single or multiple categories, ensuring that the relevant
staff are able to view, manage and respond to requests. The category will be like General, Users, Orders,
Billing and Catalog. For example, tickets created for orders should select the category as order. Depending
upon the category the notification mails will be sent to the support engineers assigned for the specific
category. For example, if the ticket is created under Orders category, support engineers those falls under
orders category will be notified.

8 APRIL 2016
ENSIM CONFIDENTIAL
504
TICKETING CHAPTER 9
Order category will not be visible in the category drop down list when raising a ticket from Organization
page. It is automatically selected when tickets are raised from the order page.
Support Engineer
Support Engineers will be the actual person for giving the support or resolving the issues. Before using the
Ticket system Reseller should add some support engineers for the Ticket system category wise. The support
engineers can be created for multiple category or single category. When a new ticket has been submitted,
depending upon the category of the ticket the corresponding support engineers will be notified.
Note: For each category, at least one Support Engineer should be added to get the notification email. If
not then the ticket will be accessible to any Reseller who has the permission to Manage Ticket.
Questions and Comments

After the submission of request, Support Engineer may have questions to clarify request or may have
additional comments to add. To do so, select any ticket from the list that takes you to a new window, enter
the task and click Add Comment. If Support Engineer adds a comment, you will receive a notification that
the ticket has a change. Review the Comment Thread in the email or view the information by logging into
EAS. To respond, go to your ticket and Add Comment.
State of Tickets
8 APRIL 2016
ENSIM CONFIDENTIAL
505
TICKETING CHAPTER 9
A ticket can have different states like New, Pending and Closed. When a new ticket is added by default, the
state will be New. After resolving the issue, the ticket state can be changed as Closed. Intermediate state
can be used as Pending. Once the ticket has been closed you can re-open the same.
Workflow
An example scenario is presented to demonstrate how this tracking system would work:
1. As soon as a ticket is filed depending upon the category, selected Support Engineers or Ticket agents
receives the updates via email.
2.
Ticket agent verifies that the problem is real, and not just perceived.
3.
Ticket agent can view the details of the ticket from EAS UI as well, other than mail.
4.
The Ticket agent will also ensure that enough information about the problem is obtained from the
Organization. This information generally includes the environment of the Organization, when and how the
issue occurs, and all other relevant circumstances.
5.
As work is done on that issue, the support engineer updates the system with new data. Any attempt at
fixing the problem should be noted in the issue system. Ticket status most likely will be changed from new
to pending.
6.
After the issue has been fully addressed, it is marked as closed in the issue tracking system.
7.
If the problem is not fully resolved, the ticket will be reopened once the Support Engineer receives new
information from the Organization.
What happens if an Organization user logged in EAS and files a ticket?
If the organization comes under reseller, notification will be sent to support engineers of Reseller
depending on the selected category and to the ticket creator via email.

8 APRIL 2016
ENSIM CONFIDENTIAL
506
TICKETING CHAPTER 9
Note: Service Provider users only can enable and disable Ticket system from General Configuration
setting in EAS.
Roles and Rights

There will be two rights available in each of the role scope (like Reseller) in EAS for doing the operations related
to the ticket:
Manage Tickets: This will be added in each of the Role scope (like Reseller). Who does have this
permission can do all kinds of operations in this Ticket system.
View Tickets: This will be added in each of the Role scope (like Reseller). Who are having this
permission they can only view the tickets.
There will be another right available in the role scope of Reseller in EAS for doing all kind of administrative
operations (i.e. Add Support Engineer):
General Administration: This will be added in the Role scope Reseller. Who are having this permission
they can do all kind of administrative operations (i.e.: add Support Engineer).
To change the rights, follow the steps below:
1. Go to ConfigurationRoles.
2.
Select required role from the list and click Edit button to view and update required rights.

8 APRIL 2016
ENSIM CONFIDENTIAL
507
TICKETING CHAPTER 9
Ticket Notifications
Create your own notifications to be sent out on various actions taking place in your help desk. Template based
notifications allows to have specially customized content for various categories. Add any of the available tags in
each notification to tailor them to your requirement.
Templates of notification
There will be three templates used for ticket notification:
1.
New Ticket Added: This e-mail will be sent when a new ticket has been created or added.
2.
Ticket Updated: This e-mail will be sent to the list of users when a ticket has been updated.
3.
Ticket Closed: This e-mail will be sent to the list of users when a ticket has been closed.
The notification Subject line contains the following macros:

(ticketId) : It will expand the id of the ticket in notification.
(ticketsubject): It will expand the subject of the ticket in notification.
(updatedby): It will expand the user's first name and last name in notification.
The notification body contains the following macros:
(ticketId): It will expand the ticket id in notification.
(ticketsubject) ): It will expand the ticket subject in notification.
(updatedby) : It will expand the user first name and last name in notification.
(creatorname): : It will expand the ticket owner name in notification.
(description): : It will expand the ticket description in notification.
Working mechanism of notification

For all above template To and Cc will be populated as the algorithm below:
In case of ticket creation by any user (like Reseller), To field includes all the support engineers under
the selected category, the user himself if he belong to Reseller and the assignee of that ticket (created by
Reseller) while ticket creation and CC field includes the Organization user.
If the ticket is commented by organization user, To field includes all the support engineers under the
selected category under Reseller. It will also add the entire user who are ever associated with the ticket
on behalf of the Reseller (i.e.: who have ever commented on the ticket) and Agent user if the ticket is
filed by that Agent. CC field includes the requester and all other people who have ever commented on
the ticket on behalf of the Organization.
In case of ticket is commented by support engineer, exactly reverse mechanism of the above will be
applied.

8 APRIL 2016
ENSIM CONFIDENTIAL
508
TICKETING CHAPTER 9
To change the default template, follow the steps below:

1. Click SettingsConfigurationNotification Templates.
2.
Select the category named 'Support tickets'.
3.
To modify the template click
4.
User can add/edit/delete macros in the subject line and ticket details.

8 APRIL 2016
button or
button.
ENSIM CONFIDENTIAL
509
TICKETING CHAPTER 9
Note: For more details refer to the chapter called 'Notification' in the document called 'EAS 4.0 Service
Provider Manual'.
Add Support Engineer

For each ticket category, at least one Support Engineer should be added. More than one Support Engineer can be
added to a category and vice versa. There is a right available in the role scope of Reseller in EAS for doing the
operations related to the Support Engineers association called General Administration. Make sure the user should
have this right in his role scope. To add Support Engineer follow the steps below:
1. Login as Reseller. Click Ticket menu.
2.
Click Add Support Engineer button.
3.
Provide login id of Resellers user to whom you want to add as Support Engineer.
4.
Select the Category. You can select more than one category by pressing the Ctrl button.
5.
Click Add Support Engineer.

8 APRIL 2016
ENSIM CONFIDENTIAL
510
TICKETING CHAPTER 9
Note: Reseller user can add only those users that belongs to his own Organization.
List Support Engineer

List Support Engineer button lists all user that are add as Support Engineer for each category that are
belongs to his own Organization.
To
change category of any Support Engineer follow the steps below:
1. From the list click any Support Engineer to change assigned category.
2.
It will open a new tab. You can select or de-select the category as required.

8 APRIL 2016
ENSIM CONFIDENTIAL
511
TICKETING CHAPTER 9
3.
Click the Save Changes button.
Add Ticket
Adding ticket can differ for different users. Please refer to the table below to get clear idea about adding ticket
for each users:
Options
Users
Add Ticket from

Order page
Add Ticket from

Header menu
Reseller
Add Ticket from

Organization
page
Yes
Yes
Organization
Not Available
Yes
Redirect to
Organization
page
Add ticket page
will open.
Options with steps to add tickets:
Add Ticket from Organization page

Reseller can file a ticket from Organization page. To add Ticket from Organization page, follow the steps
below:
1.
Click EntityOrganization.
2.
From the list of menu, search for a particular Organization.

8 APRIL 2016
ENSIM CONFIDENTIAL
512
TICKETING CHAPTER 9
3.
Click the New Ticket button, which will redirect to the new ticket page.
Description of the fields:
Category: The category will be like General, Users, Orders, Billing and Catalog. For example, tickets
created for Billing issue should select the category as Billing. Depending upon the category the
notification mails will be sent to the support engineers assigned for the specific category.
Organization name: shows the <organization name>(<organization id>) of selected Organization.
Subject: contains the subject of the issue/ticket.
Description: Contains the details of the ticket.
Priority: shows the importance of the ticket.

8 APRIL 2016
ENSIM CONFIDENTIAL
513
TICKETING CHAPTER 9
Assigned to: user can choose other Support Engineer from the drop down list to assign the ticket. This
field is available for Reseller only.
Attach file: user can choose and attach any file, page etc. to show error if required.
A provider can assign an end user request to a particular support engineer, denoted by Assigned to field.
Reseller also can submit a ticket on behalf of an Organization. In this case, all the support engineers under the
selected category, the user himself, the assignee of that ticket while ticket creation, Organization user will be
notified via mail. The selection of this organization user will may vary as per the below rule:
If a Reseller files a ticket (except Orders category) on behalf of an Organization then the system will
automatically select the default BC of the organization as ticket owner.
If default BC does not exist then it will select the default TC.
If both are not available then the system will suggest up to 10 Organization user randomly in a drop-down
list called Issuer login name to select as a ticket owner.

8 APRIL 2016
ENSIM CONFIDENTIAL
514
TICKETING CHAPTER 9
The system does not allow filing a ticket against Organisation, which do not have a user.
Add Ticket from Order page

Reseller/Organization can file a ticket from order page. At least one order must be required in order list to
file a ticket from order page. To do so follow the steps below:
1.
Click list order from the list of Order menu item

8 APRIL 2016
ENSIM CONFIDENTIAL
515
TICKETING CHAPTER 9
2.
Select a particular Order.
3.
Click New Ticket button, it will redirect you to the new ticket page.

8 APRIL 2016
ENSIM CONFIDENTIAL
516
TICKETING CHAPTER 9
Description of the fields:
Order Number: shows the selected Order number.
Organization name: shows the <Organization name>(<Organization id>) of selected Organization.
Subject: contains the subject of the issue/ticket.
Description: Contains the details of the ticket.
Priority: shows the importance of the ticket.
Assigned to: user can choose other support Engineer from the drop down list to assign the ticket.
Attach file: user can choose and attach any file, page etc. to show error if required.
A Reseller can assign an end user request to a particular support engineer, denoted by Assigned to
field.
Reseller can submit a ticket on behalf of an Organization for an order. In this case, all the support
engineers under the selected category, the user himself, the assignee of that ticket while ticket creation,
Organization user will be notified via mail. The selection of this organization user will may vary as per
the below rule:
If a Reseller file a ticket on an order then the system will automatically select the TC of the order as
ticket owner.
If TC does not exist then it will select BC of the order as the ticket owner.

8 APRIL 2016
ENSIM CONFIDENTIAL
517
TICKETING CHAPTER 9
If both are not available then the system will suggest up to 10 Organization user randomly in a
drop-down list called Issuer login name to select as a ticket owner.
The system does not allow filing a ticket against Organization, which do not have a user.
View tickets from List Order page

Click list order from the list of Order menu item ->click View All Tickets button, it will redirect you to
the list ticket page and list all the tickets of the corresponding organization.
Tickets created for a particular organization:
Add Ticket from Header Menu
For Reseller: File a ticket from header menu, clicking New Ticket button will redirect to
Organization page.

8 APRIL 2016
ENSIM CONFIDENTIAL
518
TICKETING CHAPTER 9
Search Tickets
There are some search options available for all users (Reseller/Organization) having view ticket or manage ticket
permission in his role scope.
Every users can search ticket by Ticket ID, Creator, Subject, Order number, Organization ID for Reseller, and
Commented by, Assigned to search keywords. Here only subject search key follows 'starts with' search and for
other we have to provide full keywords. The tickers visibility for different user as follows1.
Reseller can only view those tickets that exists under his own organizations. Reseller can view closed tickets
as well by clicking in the checkbox called Include Closed.

8 APRIL 2016
ENSIM CONFIDENTIAL
519
TICKETING CHAPTER 9
2.
Organization user can view those tickets that are filed under his own organization. Organization user can
view all the closed tickets as well by clicking in the checkbox called Include Closed.
Update ticket
To update a Ticket follow the steps below:
1. Go to Ticket menu and select any ticket that needs to be updated.
2.
The selected ticket opens up in new tab with the 'Ticket-<Ticket ID>' as header, where you can put
comments, change the status, change the assigned user('Assign to' field is only available for Reseller user)
and attach a file.

8 APRIL 2016
ENSIM CONFIDENTIAL
520
TICKETING CHAPTER 9
3.
Once done click Add Comments button to save the changes and update the ticket.
Closing a Ticket
The user must have 'Manage Ticket' right enabled in his role scope who want to close the ticket. Follow the use
cases below:
1.
If an end user of an organization comes under Reseller want to close a ticket, it is mandatory to add a
comment on it. After operation the status of the ticket move to 'closed' state and the 'Ticket Closed'
notification will sent to all Resellers associate to the ticket(in TO) and all the organization users associate to
the ticket(in CC).
2.
If Reseller want to close a ticket, on behalf of their organization users, it is necessary to add a comment on
it. After operation status of the ticket move to 'closed' state and the 'Ticket Closed' notification will be sent
to all corresponding Reseller associate to the ticket(in CC) and the all Organization users associate to the
ticket(in To) via email.

8 APRIL 2016
ENSIM CONFIDENTIAL
521
EMAIL NOTIFICATION
CHAPTER 10
Email Notification
Introduction
This document will guide the Service Provider and Enterprise user on how to configure the
notification templates and also properly notifying their organizations about their orders, invoice,
users etc.
Definition
Template - Notification templates provide a means of sending customized messages to users about
events in the system.
Macros - A single instruction that expands automatically into a set of instructions. Macros are available
for each and every notification templates.
Conditional parameter - The Conditional Parameters are used to include customized fields in the body
of the mail

8 APRIL 2016
ENSIM CONFIDENTIAL
522
EMAIL NOTIFICATION CHAPTER 10
Overview of Notification
Notification capability of EAS product
Notification module is used to send notification emails to the Entities or service provider/enterprise
after completion of certain action regarding orders, users etc.
Email notifications allow administrators to specify
When to send the notification

Who receives the notification
What content needs to be sent in the notification
Identifying the Notification

EAS different notification are divided into categories, and each category contains a group of templates
related to that category, which are as follows:1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
Orders
Trials
Users
Order Alerts
Invoice Details
Entities
Manual Provisioning
Payments
Offers
Support Tickets
On selecting any of the notification categories, related notification templates will be listed as shown below

8 APRIL 2016
ENSIM CONFIDENTIAL
523
Note:
symbol indicates the template is inactive, implying that the notification will not be sent;
symbol indicates that the template is active.

8 APRIL 2016
ENSIM CONFIDENTIAL
524
Category: Entities
Notification templates regarding new organization creation and new account creation are under
organization category.
Organization (org) --> Email address of the newly created organization
SL No.
Template Name
1.
New Organization
Creation
2.
New Account Creation
3.
New Agent Entity

Creation
4.
New Reseller Entity

Creation
To
org
Recipients
Cc
Bcc
Optional Optional
org
Optional
Optional
Agent
Optional
Optional
Reseller
Optional
Optional
Description
This e-mail will be sent to the e-mail
address of the newly created
organization.
address of the organization for which
the account has been created.
address of the newly created agent
entity.
address of the newly created Reseller.
New organization creation template
When the notification is received, the macros would have been replaced by the actual values.

8 APRIL 2016
ENSIM CONFIDENTIAL
525
Category: Users
This category consists of templates, which are used to notify the user upon their Generate password and
Reset Password actions.
Activation email for the user created by the Service Provider/Enterprise
Activation email for the self-registered users
SL No.
Template
1.
Regenerate User
Password
Reset User
Password
User Activation
Email
2.
3.
4.
5.
New User Sign

Up Notification Provider
New User Sign
Up Welcome
Notification

8 APRIL 2016
To
user
Recipient
Cc
Optional
Description
user
Optional
user
Optional
Service
Provider
Optional
Optiona
l
user
Optional
Optiona
l
Bcc
Optiona
l
Optiona
l
Optiona
l
This notification will be sent to the user for

which the password has been re-generated.
This notification will be sent to the email ID
of the user whose password has been reset.
This email is sent to the newly created user.
This email should contain a link to activate
his account.
This notification is sent to the email address
of the service provider to notify him that a
new user has sign in to the portal.
This is the welcome notification which is
sent to the email address of the new
organization user when the user sign in to
the portal.
ENSIM CONFIDENTIAL
526
New User creation template

8 APRIL 2016
ENSIM CONFIDENTIAL
527
Category: Orders
This category consists of the templates related to the automatic order provisioning.
Here, an order goes through different states, an email notification is sent to the business contact/technical
contact/agent (if assigned) which notifies the user that the particular operation has been performed on that
order.
BC:- Business Contact
TC:- Technical Contact
AG:- Agent
SR:- Sales Representative (If assigned while placing an order)
SL
No.
Template
To
Recipient
Cc
Bcc
1.
Full details of new

order for
Organization
TC
Optional
Optional
2.
Full Details of New

Order for Agent
AG
Optional
Optional
3.
Overview of new
order for
Organization
BC
SR
Optional
4.
Full details of
Provisioned Order
for Agent
Full details of
Provisioned Order
for Organization
AG
Optional
Optional
TC
Optional
Optional
6.
Order Provisioned
Email
BC
SR
Optional
7.
Order Approval Email
BC
Optional
Optional
8.
Full details of order
AG
Optional
Optional
5.

8 APRIL 2016
Description
This email notification is sent to the technical
contact of an organization upon approval of a
new order. This mail should ideally contain all
the details including technical information like
order summary.
This email notification is sent to the email
address of assigned agent upon approval of a
new order. This mail should ideally contain all
the details including technical information like
order summary.
This email notification is sent to the business
contact of the order upon approval of a new
order. This mail should ideally contain primary
details of the new order excluding technical
information like order summary.
This e-mail notification is sent to the agent of the
organization when an order has been
provisioned.
This e-mail notification is sent to the technical
contact of the organization when an order has
been provisioned.
contact of an organization when an order is
being provisioned.
This email is sent to a user of the organization
having authority to approve an order. The mail
should ideally contain primary details of the
draft order.
This email is sent to the agent email address
ENSIM CONFIDENTIAL
528
upsize Agent
9.

upsize Organization
TC
Optional
Optional
10.
Overview of order
upsize Organization
BC
SR
Optional
11.

downsize Agent
AG
Optional
Optional
12.

downsize Organization
TC
Optional
Optional
13.
Overview of order
downsize Organization
BC
SR
Optional
14.
Full details of
upgrade request for
Organization
TC
Optional
Optional
15.
Full details of
upgrade request for
Agent
AG
Optional
Optional
16.
Overview of order
upgrade request for
Organization
BC
SR
Optional
17.
Full details of
downgrade request
for Agent
AG
Optional
Optional
18.
Full details of
downgrade request
for Organization
TC
Optional
Optional

8 APRIL 2016
upon approval of upsize request for an order.

This email should contain all the details of an
order including order summary.
This email is sent to the technical contact of the
organization upon approval of upsize request for
an order. This email should contain all the details
of an order including order summary.
This email is sent to the business contact of the
organization upon approval of upsize request for
an order. This email should contain primary
details regarding the order.
This email is sent to the email address of
assigned agent upon approval of downsize
request for an order. This email should contain
all the details of an order including order
summary.
This email is sent to the technical contact of the
organization upon approval of downsize request
for an order. This email should contain all the
details of an order including order summary.
This email is sent to the business contact of the
organization upon approval of downsize request
for an order. This email should contain primary
details regarding the order.
contact of an organization upon receiving a
upgrade request on an existing order. This mail
should ideally contain all the details regarding
the order including order summary.
This email notification is sent to the email
address of assigned agent upon receiving an
upgrade request on an existing order. This mail
should ideally contain all the details regarding
the order including order summary.
contact of an organization upon upgrading an
This email notification is sent to the agent email
address upon receiving a downgrade request on
an existing order. This mail should ideally
contain all the details regarding the order
including order summary.
This email notification is sent to the Technical
contact of an organization upon receiving a
downgrade request on an existing order. This
mail should ideally contain all the details
ENSIM CONFIDENTIAL
529
19.
Overview of order
downgrade request
for Organization
BC
SR
Optional
20.
Full details of Order

cancel request
TC
Optional
Optional
21.
Overview of Order
cancel request
BC
SR
Optional
22.
Cancel request for

Agent
AG
Optional
Optional
23.
Order Abort
Notification
Organization
SR
Optional
24.
Order Abort
Notification - Agent
AG
Optional
Optional
25.
Discount reject
notification
Optional
Optional
26.
Discount seek
approval
notificationProvider
Optional
Optional
27.
Order
Acknowledgement
Notification
User
seeking
discount
approval
Discount
approver
distribut
ion list
as set in
offer
BC & TC
Optional
Optional

8 APRIL 2016
BC & TC
regarding the order including order summary.

contact of an organization upon downgrading an
This e-mail notification is sent to the technical
contact of the organization when a cancel request
for a given order is received.
This e-mail notification is sent to the business
contact of the organization when a cancel request
for a given order is received.
This e-mail notification is sent to the agent email
address when a cancel request for a given order
is received.
This notification is sent to the business contact
and technical contact when an order is aborted
from approved state. This notification contains
all the primary details of the order.
This notification is sent to the assigned agent
email address when an order is aborted from
approved state. This notification contains all the
primary details of the order.
This notification will be sent to the seek approver
who notified the DL for approval of an order
with higher level of discount applied to it than
he has right to approve.
This notification will be sent to the designated
DL seeking approval for an order with higher
level of discount applied than the creator has
right to approve.
This notification will be sent to the BC and TC as

an acknowledgement.
ENSIM CONFIDENTIAL
530
The order notification category contains the Organization custom field macro.
All notifications under order category contains the Sub Order Number macro to display the Sub Order Number.
New order creation template
When the notification is received, the macros are replaced by the actual values.

8 APRIL 2016
ENSIM CONFIDENTIAL
531
Order provisioned template

8 APRIL 2016
ENSIM CONFIDENTIAL
532
Service access information

When orders are provisioned, the technical contact needs to be notified of the credentials and access
information of the service. To enable the same, the following configuration steps are to be taken -
1. Enable at 'Service' level

8 APRIL 2016
ENSIM CONFIDENTIAL
533
2. Edit the corresponding template

8 APRIL 2016
ENSIM CONFIDENTIAL
534
Category: Trials
This category consists of the templates related to the trial orders.
Here trial provisioned, trail Wipe, trail expiry etc. email notification is sent to the business contact/technical
contact / agent (if assigned) which notifies the user that the particular operation has been performed on that
trial order
SL
No.
1.
2.
3.
4.
BC :- Business Contact
TC :- Technical Contact
AG :- Agent
SR :- Sales Representative (If assigned while placing an order)
Template
To
Trial
Provisioned
Email
Full details of
trial
provisioned Agent
Full details of
trial
provisioned Organization
Full details of
trial wipe Agent
5.
Full details of
trial wipe Organization
6.
Overview of
trial wipe Organization
7.
Trial period
expiry - First
notification
Recipient
Cc
Description
Bcc
Optiona
l
Optional
This notification is sent to the business contact of the

organization when a trial is provisioned. This mail
should ideally contain primary details regarding the
provisioning details and also technical details like
order summary.
This e-mail notification is sent to the agent of the
organization when a trial has been provisioned.
Optiona
l
Optional
This e-mail notification is sent to the technical contact

of the organization when a trial has been provisioned.
Optiona
l
Optional
Optiona
l
Optional
BC
SR
Optional
BC,TC
& AG
SR
Optional
BC
SR
Optional
AG
TC
AG
TC

8 APRIL 2016
This email notification is sent to the agent upon

receiving a trial data wipe request on an existing trial.
This mail should ideally contain all the details
regarding the trail including order summary.
This email notification is sent to the technical contact
of an organization upon receiving a trial data wipe
request on an existing trial. This mail should ideally
contain all the details regarding the trail including
order summary.
This email notification is sent to the business contact of
an organization upon receiving a trial data wipe
request on an existing trial. This mail should ideally
contain primary details of the trail excluding technical
This notification is sent to all the parties regarding a
trial order based on the time set for first notification in
the trial definition.
ENSIM CONFIDENTIAL
535
Trial period
expiry Second
notification
Trial period
expiry - Third
notification
BC,TC
& AG
SR
Optional

trial order based on the time set for second notification
in the trial definition.
BC &
TC
SR
Optional

trial order based on the time set for third notification
in the trial definition.
10.
Expiry of trial
offer Organization
BC &
TC
SR
Optional
This notification is sent to the business contact and

technical contact of the organization upon expiry of
trial.
11.
Expiry of trial
offer - Agent
Upgrade from
Trial - Full
details for
Agent
Upgrade from
Trial - Full
details for
Organization
Upgrade from
Trial - Full
details for
Organization
AG
Optiona
l
Optiona
l
Optional
TC
Optiona
l
Optional
BC
SR
Optional
This notification is sent to the agent email address

upon expiry of trial.
This notification is sent to the agent upon upgrading
from trial to a premium subscription. This mail should
ideally contain all the details regarding the upgrade
including order summary.
This notification is sent to the technical contact of the
organization upon approval of a new trial order. This
mail should ideally contain all the details regarding
the upgrade including order summary.
This notification is sent to the business contact of the
organization upon upgrading from trial to a premium
subscription. This mail should ideally contain primary
details regarding the upgrade excluding technical
8.
9.
12.
13.
14.
AG

8 APRIL 2016
Optional
ENSIM CONFIDENTIAL
536
Screenshot of Trial provisioned template

8 APRIL 2016
ENSIM CONFIDENTIAL
537
Category: Order alerts

This category consists of templates which are sent as an alert to the organization/operations team when an
order is Suspended, Resumed, Failed, Delayed, or Wiped.
AG :-Agent
OP :- Operations team
SR :- Sales Representative (If assigned while placing an order)

8 APRIL 2016
ENSIM CONFIDENTIAL
538
SL
No.
1.
Template
To
AG
Recipient
Cc
Bcc
Optional Optional
2.
Full details of
order data wipe Organization
TC
Optional
Optional
3.
Overview of
order data wipe Organization
BC
SR
Optional
4.
Order Delayed
OP
Optional
Optional
5.
Order Failed
OP
Optional
Optional
6.
Order Resumed
BC &
TC
OP
Optional
7.
Order Suspended
BC &
TC
OP
Optional
8.
Cancellation
Reconsideration 1
BC
Optional
Optional
9.
Cancellation
Reconsideration 2
BC
Optional
Optional
10.
Cancellation
Reconsideration 3
BC
Optional
Optional
11.
SSID Generation
BC
SR
Optional
Full details of
order data wipe Agent

8 APRIL 2016
Description
This email notification is sent to the agent upon
receiving an order data wipe request on an
existing order. This mail should ideally contain all
the details regarding the order including order
summary.
contact of an organization upon receiving a order
data wipe request on an existing order. This mail
should ideally contain all the details regarding the
order including order summary.
contact of an organization upon receiving a order
data wipe request on an existing order. This mail
should ideally contain primary details of the order
excluding technical information like order
summary.
This email is sent if the provisioning is getting
delayed for a given order. The receiver is specified
in the TO field of the template.
This email is sent in case of failure to provision an
order. The receiver is specified in the TO field of
the template.
This notification is sent to business contact,
technical contact and operations team when an
order is resumed. The email address of operations
team is specified in CC field of the template.
This notification is sent to business contact,
technical contact and operations team when an
order is suspended. The email address of
operations team is specified in CC field of the
template.
This notification is sent to the business contact of
the order/trial based on the time set for first
reconsideration notification after an order/trial has
been cancelled.
the order/trial based on the time set for second
been cancelled.
the order/trial based on the time set for third
been cancelled.
This notification is sent to the business contact and
assigned agent of a manual order whenever a new
'Service Subscription Id'(SSID) is generated for that
ENSIM CONFIDENTIAL
539
order. It contains the SSID and the primary details

regarding a particular order.
the order when an order is closed.
This notification is sent to business contact when
an order is kept in draft state.
This notification is sent to BC, TC and assigned
Agent for the orders having Deferred-billing when
billing for this order starts.
This notification will be sent to the operation team
of the service provider only when deferred billing
is required for an order.
This notification will be sent to the operation team
of the service provider only when some premanual configurations is required for an order.
This notification will be sent to BC, TC of the
subscribed order, when the order is cancelled.
Order Closed
Notification
Cart Notification
reminder
Start Billing
Notification
BC
Optional
Optional
BC
Optional
Optional
BC
SR
Optional
15.
Post-Provisioning
notification
OP
Optional
Optional
16.
Pre-Provisioning
notification
OP
Optional
Optional
17.
Subscription
cancellation
notification
Subscription
renewal
notification
Subscription
ending reminder
notification
BC &
TC
Optional
Optional
BC &
TC
Optional
Optional
This notification is sent to BC, TC of the subscribed

order, when the order is renewed.
BC &
TC
Optional
Optional
20.
Price Change
Notification
Optional
Optional
21.
Subscription
renewal settings
email
Rejection of
Order Request
BC,TC
&
Agent
BC &
TC
Optional
Optional
Order
draft
initiat
or
operat
ions
team
Optional
Optional
This notification will be sent to BC and TC as

reminders for ending of subscription period for
their order before specific number of days
mentioned in that offer.
The notification is sent to the business contact,
technical contact and agent of the order when price
of the order is changed.
This notification is sent to BC,TC of the subscribed
order, when the renewal settings for the order is
changed.
The e-mail is sent to the draft initiator of the Order
when the Order is rejected.
Optional
Optional
12.
13.
14.
18.
19.
22.
23.
Post Order
Fulfilment
Notification

8 APRIL 2016
This notification will be sent to the operations

team of the Service Provider only when additional
task is required after provisioning but billing has
started.
ENSIM CONFIDENTIAL
540
Screenshot of order failed template

8 APRIL 2016
ENSIM CONFIDENTIAL
541
Category: Manual Provisioning

This category consists of templates which are sent to the operations team when any provisioning action is
performed on an order. The email address of the operations team is set at the offer level under the tab
'Provisioning Workflow'.
OP --> Operations team

8 APRIL 2016
ENSIM CONFIDENTIAL
542
SL
No.
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
Template
To
Details for Manual
Termination
OP
Details for Manual

Resume
OP
Details for Manual

Suspend
OP
Details for Manual

Downgrade
OP
Details for Manual

Upgrade
OP
Details for Manual

Downsizing
OP
Details for Manual

Upsizing
OP
Details for Manual

Provisioning
OP
Details for Manual

Termination of
Suspended Order
OP
Details for Manual

Renewal
E-mail
addresses
specified
at offer
level

8 APRIL 2016
Recipient
Cc
Optional
Description
Bcc
Option
al
Optional
Option
al
Optional
Option
al
Optional
Option
al
Optional
Option
al
Optional
Option
al
Optional
Option
al
Optional
Option
al
Optional
Option
al
Optional
Option
al
This notification will be sent only in case of

manual termination. This will contain all the
details to configure the service in another
manual resume. This will contain all the details
to configure the service in another provisioning
system.
manual suspension. This will contain all the
manual down gradation. This will contain all the
manual up gradation. This will contain all the
manual downsizing. This will contain all the
manual upsizing. This will contain all the details
system.
manual provisioning. This will contain all the
manual termination of suspended order after
retention period. This will contain all the details
system.
manual renewing. This will contain all the details
system.
ENSIM CONFIDENTIAL
543
Screenshot of Manual provisioning template

8 APRIL 2016
ENSIM CONFIDENTIAL
544
Category: Invoice details

This category consists of the templates which are sent with a link of the invoice PDF to the
organization/reseller.
RS -- > Reseller email address.
AC Account email address of the organization.
SL No.
Template
1.
Invoice detail of
reseller
2.
Invoice detail of
Organization

8 APRIL 2016
To
RS
AC
Recipient
Cc
Bcc
Optional Optional
Optional
Optional
Description
This email will be sent to the email address of
the reseller. The body should contain primary
details of the invoice. There will be a link which
will allow organization to view his invoice.
This email will be sent to the account email
address of the organization. The body should
contain primary details of the invoice. There will
be a link which will allow reseller to view his
invoice.
ENSIM CONFIDENTIAL
545
Screenshot of Invoice details for organization template

8 APRIL 2016
ENSIM CONFIDENTIAL
546
Category: Payment
This category consists of the templates which are sent regarding the payment Organization users, Merchant
and Business contact.
Org user :- Organization users
Mer :- Merchant
BC :- Business contact
SL No.
Template
To
Org
user
Recipient
Cc
Bcc
BC
Optional
1.
Successful payment Organization
2.
Failure payment Organization
Org
user
BC
Optional
3.
Failure payment Merchant
Mer
Optional
Optional

8 APRIL 2016
Description
This notification is sent to the organization user
who did the payment and organization's default
business contact upon successful completion of
the payment.
This notification is sent to the organization user
who did the payment and organization's default
business contact when payment was unsuccessful.
This notification is sent to the merchant when
payment made by organization was unsuccessful.
ENSIM CONFIDENTIAL
547
Screenshot of Payment details for organization template
Note: Recurring payment reminder, Recurring payment cancel consent, Recurring payment given consent
templates will be implemented in next release.

8 APRIL 2016
ENSIM CONFIDENTIAL
548
Category: Offers
This category consists of the templates which are sent regarding the Offer versioning to Technical and Business
contact.
SL No.
Template
1.
Version
Announcement
2.
Version Alignment

8 APRIL 2016
To
TC &
BC
TC &
BC
Recipient
Cc
Bcc
optional
optional
optional
optional
Description
This template is used to announce a new version
of a specific Offer that will be published in future.
This notification will be sent to all technical and
business contacts who has an active subscription
of that Offer's previous version.
This template is sent to business and technical
contact for announcing successful synchronization
with a new version.
ENSIM CONFIDENTIAL
549
Screenshot of Version Announcement details of offer

8 APRIL 2016
ENSIM CONFIDENTIAL
550
Support Tickets
Virus Scanner
In EAS system you can attach a file for a ticket. The attachments are directly stored into the database as
binary format. To prevent the system from being infected by virus with these attachments, there is a
virus scanner for detecting trojans, viruses, malware & other malicious threats.
Antivirus Configuration
To use the virus scanner in EAS you need to configure the location and the command line arguments
required to execute the antivirus in the synergy-config.groovy file. By default the virus scanner will be
disabled. To make it enabled you need to change the virus.scanner.enabled to TRUE.
The screenshot shows above are the commands needed to run the antivirus (i.e.: the above commands
are for clam AV running in windows) for a particular file, only you need to provide the installed
antivirus path in place of AV path. You can use any other antivirus of your choice, provided that
antivirus should support command line arguments as shown above. Write the commands within double
quote.

8 APRIL 2016
ENSIM CONFIDENTIAL
551
View tickets from List Order for each order

Click list order from the list of Order menu item ->click View All Tickets button, it will redirect you to
the list ticket page and list all the tickets of the corresponding organization.
Tickets created for a particular organization:
Category: Support Tickets

This category consists of the templates which are sent regarding the Ticket to support engineers,
Service Provider/Agent/organization user.
Org user :- Organization users
SE :- Support Engineers
AG :- Agent
SP :- Service provider

8 APRIL 2016
ENSIM CONFIDENTIAL
552
SL No.
Template
To
SE/SP/
AG
Recipient
Cc
Bcc
Optional Optional
1.
Ticket New
2.
Ticket Updated
SE/SP
Org
user
Optional
Optional
3.
Ticket Closed
SE/SP
Org
user
Optional
Optional
Description
This notification is sent to Support Engineer/End
user when a new ticket is submitted.

user when an existing ticket is updated.
user when a ticket is closed.
Screenshot of Version Announcement details of ticket

8 APRIL 2016
ENSIM CONFIDENTIAL
553

8 APRIL 2016
ENSIM CONFIDENTIAL
554
Other Features of Notification

Other capability of the EAS notification
Scheduling a specific notification
Specifying who receives the notification

For organization category email notification sent to email address of the organization
For users category, email notification sent to email address of the organization user and Service
Provider
For orders and trials categories email notification sent to Business Contact, Technical Contact and Agent
(if assigned).
For Manual Provisioning category email notification sent TO field address, which has been set at the
Offer level.
For Invoice Details category email notification sent to email address of reseller and organization
Content of the Notification

There are more than one functions of an email notification, we can specify the following content options in email
notifications.
Format the email body
Set up the conditional parameter
Place the macros
Select the Multiple Language
Adding the email addresses under TO, CC,BCC field
Edit Notification:
To edit notification templates following are the steps
1.
Select category from the Category drop down list
2.
Select a template from the list

8 APRIL 2016
ENSIM CONFIDENTIAL
555
5.
3.
Click the Edit button
4.
Edit Notification page will open, where the content of the template can be edited.
Change some of the template details like :

a) The Subject Line Parameters, these are used to append variable parameters into the subject line.
b) Conditional Parameters, these are used to include customized fields in the body of the mail. The
email is sent as HTML in the email body.

8 APRIL 2016
ENSIM CONFIDENTIAL
556
6.
Click Save button

Other button available on the Edit notification page are:
The Reset button on the right side of the page enables to reset all the notification email
settings from the beginning.
The Save button enables to save the notification for this language.
Leave This Page button enables to exit the edit notification page without saving the
changes for this language.
Send demo e-mail button allows sending a demo email for testing purpose.
Import & Export of templates

We can Import bulk amount of templates in xml format for a particular category, following are the steps
to Import template:1) Click the Import icon
2) Click the Browse button and select a valid XML file
3) Click Import button

We can download all the templates of the selected category, following are the steps to Download template:1)
Click the
(download) icon.
2) To download a particular template click the

8 APRIL 2016
icon placed at the right side of each template.

ENSIM CONFIDENTIAL
557
Set Default Body

In case if any Subject and Body is not added for the template in a category we can set a default body
1) Click the 'Set Default Body' button.
2) Confirmation message window will open
3) Click 'OK' button to continue.
SMTP Mail Configuration

Email notification is nothing but sending emails to the concerned person after completion of certain action in
regarding users, orders etc.
The steps to configure Email notifications are as follows1.
Log in to the EAS as an admin user.
2.
Go to the Configuration tab.
3.
Click the Notification link. See below-

8 APRIL 2016
ENSIM CONFIDENTIAL
558
SMTP Settings

8 APRIL 2016
ENSIM CONFIDENTIAL
559
To send notification from the EAS application portal, we need to set the SMTP configuration with
proper set of values by the following steps1.
2.
3.
4.
5.
Click the Message icon, A pop up window will open up where user have to set the SMTP host
name, SMTP port number, username, password etc. and some other fields with proper set of values.
Click the SMTP Settings' link.
Provide Host name
Provide SMTP port number
Set Default Senders address
Set Default Senders Host name of the SMTP server: Provide the Host name of the SMTP server.
SMTP port number: Provide the SMTP port number.
Default sender's address: Default email id from where the email notification will be sent to the
concerned person's email id after completion of certain action under a notification category like
orders.
Default sender's name: Provide the default name of the sender.
To send an authenticated mail, check the Authentication required check-box and provide the
user name and password for the host. This will provide privacy to the mail and only the
authenticated user can access it.

8 APRIL 2016
ENSIM CONFIDENTIAL
560
Note: Other fields like Username for host authentication and Password for host authentication' are
optional as these fields are required only when the SMTP connection is secure and trusted. When you need
to provide the values for SMTP username and password, you have to checked in the field called
Authentication required shown in the above figure.
Reseller customization
Notification module is also used to send notification emails to the Reseller or users after completion of certain
action regarding orders, users etc.
Reseller can perform all the activities related to notification which a Service Provider can perform, like
Import & export templates
Set default body
Address setting
Enable/Disable templates
Conditional parameters
Note: Major Difference between Service Provider and Reseller is agents templates are included in the
Service Provider module but agents templates are not included in the reseller module.
Set Email Signature

This field is used to define the email signature.
The macro 'Signature' used in the body of notification will be replaced by this text.
You can use hyperlinks or any other content here

8 APRIL 2016
ENSIM CONFIDENTIAL
561

8 APRIL 2016
ENSIM CONFIDENTIAL
562
Send demo email
This mail is for testing whether SMTP settings are correct and whether the mail body is going out as
HTML
Macro expansion cannot be tested through this.

8 APRIL 2016
ENSIM CONFIDENTIAL
563
Cart reminder setting

This notification is sent to business contact when an order is kept in draft state.
Cart reminder will be sent for the orders which are in the initial draft, Upsize draft, Upgrade draft,
Downsize draft and Downgrade draft.

8 APRIL 2016
ENSIM CONFIDENTIAL
564
REPORTING
CHAPTER 11
Reporting
EAS provides a robust reporting capability based on fully integrated Jasper Report Server as a binary plug-in
module. By default, the Manage Report right is checked for the Service Provider super admin. Reports are
scheduled by the system. Generated Reports are saved in a shared file system at any server. Users can download
reports from UI and can send or receive via email as attachments.
1. Download from UI: The download option is available based on rights of the user.
2.
The right to access reports is provided in role, and the report is tagged to one or more roles to have
access to that report. This combination categorizes the users with the authority to view different reports.
Receive in Email: This depends on Distributed List membership. Distributed Lists help to reduce email
traffic out of EAS.
Note: Anyone can be on a Distributed List (entity user or non-system user/external list).

8 APRIL 2016
ENSIM CONFIDENTIAL
565
REPORTING CHAPTER 11
By default, all reports remain deactivated. To activate a report, select the check box
and click
Activate. After sometime (that is set by Service Provider), go to Ensim Dashboard that contains the list
of available reports in EAS.
To edit any selected Report, provide the following details:
Report Name: A human readable name
Recipients DL: The Distributed List (contains a list of users to send reports through email) is
maintained outside of Ensim. When the Distributed List (DL) is empty for Service Provider (SP), the
system triggers no email.
Role: Service Provider can select more than one role (if required). Users with the selected roles can
access the generated reports

8 APRIL 2016
ENSIM CONFIDENTIAL
566
Frequency: This defines the execution frequency. In EAS, frequency is set to Monthly.
To keep reports in a shared drive, provide following details:
Share Folder Path for Reports: Keep reports in a shared folder at any location and provide the
complete path here.
Shared User Name for Reports: Provide the username to access the Reports
Shared Password for Reports: Provide the password to access the Reports.
The Ensim dashboard contains the list of available reports in EAS.

8 APRIL 2016
ENSIM CONFIDENTIAL
567
JasperServer Reports
JasperReports Server (JRS) builds on the JasperReports Library to provide a fully functional reporting
server. It is an independent Reporting Engine. To know more about JRS, refer to their website
http://community.jaspersoft.com/project/jasperreports-server/releases
EAS database schema has been extended to simplify building reports using third-party visual reporting
tools such as JRS, Microsoft Reporting Services, and others. While any of these tools can be used with
EAS, Ensim has pre-built few useful reports for JRS out of the box. These reports can be executed in any
edition of JRS including the community edition.
Integration with EAS

JasperReports Server (JRS) is functionally independent of EAS. The JRS is configured to the layer-2
database of EAS which contains the data required to generate reports. JRS IDM and EAS IDM are
functionally independent of each other, therefore, the userId and password for both of the IDM's can be
different. The users need to Import a file in the JRS to generate reports.
The Schedule Report Data Replication Jobbatch job calls the generate report data store procedure
at the scheduled time as configured and the corresponding data is populated in the database. By default,
the batch job is scheduled at 6 a.m. When the batch job runs on the 1st day of a month, the data is
populated in a table for the previous month. When the batch job runs on the other day, except 1st day of
a month, the data is populated from the 1st day to the previous day of the same month for which it has
been executed.
For example, if the batch job runs on 1st of February 2016, the procedure populates data from 1st to 31st
January 2016. If the report runs on 6th of March 2016, the data is populated for the period from 1st
March to 5th March 2016. Jasper Reports Server generates the reports in schedule time utilizing the
populated data and then sends the notification. The replication job can be run or rerun by the Service
Provider user with the Manage Data Replication Jobs privilege from EAS. By default, this right is
enabled for the Service Provider Super Admin user and Service Provider Operation user.
In EAS, the Report Configuration page displays two tabs:
Built-in Reports: Ensim provides all the robust reporting modules that Ensim supports.
Replication Jobs: On the Replication Jobs tab, you can run the Reporting schedule job by providing the
corresponding month to generate the report. After the job executes successfully, the layer-2 database is
populated for generating reports in the JRS server.
To run or rerun the report replication job, complete the following steps:
a) Click Settings > Configuration > Reports.
b) On the Report Configuration page, click Replication Jobs.
c) In the Run for Month of text box, specify the period (in month) and click Run Now for a fresh run.
The Next Fire Time field displays the next run time for the job.
NOTE: The user can perform fresh run only for previous months or years.

8 APRIL 2016
ENSIM CONFIDENTIAL
568
Install JRS
For installing JRS community edition, refer to the following URL:
http://community.jaspersoft.com/project/jasperreports-server/releases
To install the JasperReports server, click the JasperReports Server Community Edition 6.1.0 link and
follow the installation guide (JasperReports-Server-CP-Install-Guide.pdf).
After the successful installation of JRS, click Start JRS Service and then, browse the intended JRS URL to access
the JRS; provide the correct user ID and password.
Configure JRS
Ensim provides a pre-configured .zip folder which contains pre-configured reports. To configure JRS, you must
import the .zip folder in JRS to generate the reports. The .zip folder contains the following files:
Configuration of the Database (For Data Source Connectivity)
Input Control Configuration (Report Parameters)
Published JRXML files
SQL Query to populate the Report
Scheduling and other Configuration related files: The Published JRXML and SQL Query to populate the
Report files can be modified based on the customization required. To change the structure of any report, modify
the JRXML file and the SQL query accordingly to populate the data in the report
To import the file in the JRS server, complete the following steps.
1.
After logging in, click Manage > Server settings and click Import.

8 APRIL 2016
ENSIM CONFIDENTIAL
569
2.
3.
4.
Select the file you want to import.

After importing the particular file, you must configure the database accordingly. Navigate to 'home' from
the main menu and then to 'Data Sources' and click the intended database name.
Provide field values (such as Type, Jdbc drivers, url, username, password) and then, click Test
Connection to test if the connection is established.
According to the database vendor (Oracle/SQL Server/PostgreSQL), you must place the driver
software under <jasper-report-server-install-directory>\apache-tomcat\lib.
For Oracle :
Copy /ISO/DatabaseDrivers/Oracle/ojdbc6.jar to <jasper-report-server-installdirectory>\apache-tomcat\lib.
For SQL Server:

Download the respective jar: jtds-1.3.1.jar, sourced from
http://sourceforge.net/projects/jtds/files/ and place in the location: < jasper-report-serverinstall-directory>\apache-tomcat\lib.
For PostgreSQL:
Download the respective jar: postgresql-8.4-702.jdbc4, sourced from
http://mvnrepository.com/artifact/postgresql/postgresql/8.4-702.jdbc4 and place in the
location: <jasper-report-server-install-directory>\apache-tomcat\lib.
Report Types
Call Order Meeting Agenda Report
Add Item Categorization: Administrator provides a category name while creating an item to produce the
sum of certain category of items in report.
Add Offer Type Identifier: The offer type field must be added in offer.

8 APRIL 2016
ENSIM CONFIDENTIAL
570
SLA Performance Requirements Report

SLA per Organization per Order Action: This EAS feature allows user to configure SLAs for a defined set of
order actions on a per customer basis. On global configuration page turn on the SLA feature in EAS. When the
feature is turned ON, the global configuration page allows the administrator to define the following SLA
settings globally:
Define weekly off (that is the days of the week the EAS must exclude while calculating SLA days and
other exceptional days).
Holiday lists that can be set using a calendar UI control, to define the holidays (yearly basis) that must be
excluded in SLA calculations.
SLAs is defined and maintained at the organization level when the global configuration is turned ON.
Organization level SLA is enabled for the following order actions:
New Orders (Recurring Orders)
New Orders (One Time Orders)
Upsize (Type A)
Upsize (Type B)
Downsize
An administrator is authorized to view the SLA Performance Requirements Report on the order form.
To produce the SLA report along with the difference, add the following two fields in the EAS DB:
Expected SLA in Days

Actual Number of Days Taken
Order History is updated to show these fields for each base and sub order.
Asset Report
This report is used to review and look up the quantity of items against a serial number. It includes base and sub
orders specific to a customer. All orders in stable state (such as provisioned, upsized, downsized) is included,
Billing Report
This report provides the billing information of a customer for a configurable date range.
Procedures to Generate Reports

After importing the file and configuring the database successfully, you can generate reports according to your
requirements by clicking the Reports and ScheduleReport folders from JasperServer UI.
To generate a report, complete any of the following procedures as required.
Manual Run: To perform a manual run, click the Report folder icon and then select the report you want to
generate. As an input criteria for generating the reports the user must provide the mandatory values:
FromDate, ToDate and Organization

8 APRIL 2016
ENSIM CONFIDENTIAL
571
Adhoc Run (Run Now): To perform an adhoc run, click the Scheduled Report folder icon and select the
report, which gives an instant report only by providing the input control 'Organization ID of the respective
organization. The generated report contains the data of the previous month.
Schedule Run: To perform a schedule run, click the ScheduledReport folder icon, select the report you want
to generate, and then right-click and select Schedule. This action redirects to a page where you can create the
schedule according to your requirement by selecting the Create Schedule option. The parameters on which the
run can be scheduled are Schedule, Parameter, Output Options, and Notifications.
To send notification, ensure the SMTP configuration in the Jasper Server is complete. To configure SMTP in the
Jasper Server, refer to the following URL: http://community.jaspersoft.com/wiki/howconfigure-jasperreportsserver-send-e-mailsEAS 4.2 SERVICE PROVIDER MANUAL
8 APRIL 2016
ENSIM CONFIDENTIAL
572

8 APRIL 2016
ENSIM CONFIDENTIAL
573
Some specific points:
Reports can be generated for a month.

Reports will be customer specific. Therefore, user must use 'Organization ID' as an input criteria or control.
Configurable date range can be provided while generating reports.
Schedule Run jobs will be different for each specific type of report.
For example: For 1 user to generate 4 different reports, we need to run 4 separate schedule job.
All reports will be generated by the user who have the required rights from the JRS UI.
To share the reports for Manual and Adhoc run the user must save the reports in a location and then share the
location to make the reports available to other user.
Reports generated by ScheduleRun can be saved in FTP server location which is provided by the user during
configuration.
All the reports will be pulled out from JRS server by the user having rights. The reports can also be configured
to send through email notifications to other users from the JRS settings. For schedule run, the email
notification can be sent which will contain the report as an attachment.
All the reports are specific to a single customer.

8 APRIL 2016
ENSIM CONFIDENTIAL
574
PIF Mapping
PIF Column Name
PIF1
PIF2
PIF3
PIF4
PIF5
PIF6

8 APRIL 2016
Report Header
Project name
Environment
Type
RP
Serial number
New Business
Tech refresh
Type
Free text
Free text
Free text
Free text
Free text
PIF SL No.
1
2
3
4
5
List of values
ENSIM CONFIDENTIAL
575
To modify the PIF in a report, complete the following steps.

1.
2.
3.
4.
5.
Open the jrxml file in the Jaspersoft Studio.

Double-click the table.
Double-click the column heading that must be modified.
Modify the heading and click outside.
Click Save.
To include a new PIF in the report, update the jrxml file and reporting query. To do so, complete the following
steps.
1.
2.
3.
4.
5.
6.
7.
Add the required PIF in EAS portal and set PIF identifier.
Open jrxml file in the Jaspersoft Studio. Double-click the table.
To add a new field, right-click the field name under the Column Header node under the Table node in the
Outline view and select Create Column After/Before option. (You may need to modify page size by select
report name in the outline view and click Edit Page Format in the Report tab present on Properties view).
Drag and drop the Static Text element from Elements palette to Column Header section and set the column
heading as required.
Expand the dataset from Outline view and expand the Fields.
Drag and drop the required field (PIF) from Outline view to Detail section in the table.
Save the report.
In the list of PIF (PIF6) values, if you want to add a new value under a new column, complete the following steps.
1.
2.
Open jrxml file in the Jaspersoft Studio. Double-click the table.

To add a new field, right-click the field name under the Column Header Node under the Table node in the
Outline view and select Create Column After/Before option. (To modify the page size, select report name in
the outline view and click Edit Page Format in the Report tab on Properties view).
3. Drag and drop the Static Text element from Elements palette to Column Header section and set the column
4. Expand the dataset from Outline pane.
5. Right-click the Fields and select Create Field option. A new field Field_1 is added.
6. Modify the name and data type (Class) of the field from Properties section.
7. Drag and drop the field from Outline view to Detail section in the table.
8. Go to the main report by clicking Main Report tab.
9. Select the dataset and click Edit query, filter and sort options.
10. Dataset and Query Dialog window open. Modify the report query and click OK.
11. Save the report.

8 APRIL 2016
ENSIM CONFIDENTIAL
576
Item Category Mapping

Item category can be set in the Product Management sub menu under Configuration menu. In the Item Unit
Configuration page under Item Tags tab you can add, edit, or delete item tags. If any item tags is to be included
in the report, you must enabled item tags.
After configuring the Item Tags, the value is displayed in the Item Tag drop-down list on the item creation page.
By default, the report supports maximum of 20 item tags. Beyond this limit, you must modify the jrxml
and database script. To do so, complete the following steps.
1.
2.
3.
4.
5.
6.
Add the new field in report_orderline table in database as required.

Modify the procedure generate_report_orderline in the database to populate the newly added fields.
Open jrxml file in the Jaspersoft Studio and double-click the table.
To add a new field, right-click the field name under the Column Header Node under the Table node in the
Outline view and select Create Column After/Before option. (To modify the page size, select report name in
the outline view and click Edit Page Format in the Report tab on Properties view.)
Drag and drop the Static Text element from Elements palette to Column Header section and set the column
Expand the dataset from Outline pane.

8 APRIL 2016
ENSIM CONFIDENTIAL
577
7.
8.
9.
10.
11.
Right-click Fields and select Create Field option. A new field is added.
Modify the name and data type (Class) of the field from Properties section.
Drag and drop the field from Outline view to Detail section in the table.
Go to the main report by clicking Main Report tab.
Select the dataset and click Edit query, filter and sort options. Dataset and Query Dialog window open.
Modify the report query and click OK.
12. Save the report.
Offer Type Identifier for Reporting

This feature has been introduced to mark an offer for reporting purposes. For example, based on the Offer Group
Code of the offer the total number of item quantity will be calculated.
By default two group codes; Infrastructure and Storage are added.
To enable the offer group code, execute the following commands for different database vendors: :
POSTGRES: update offer_group_tag set is_enabled=true;
Oracle:
update offer_group_tag set is_enabled=1;
SQL Server: update offer_group_tag set is_enabled=1;
Impacted Modules in EAS
Configuration Module: The Configure SLA right is added for Service Provider and Reseller (by default this
right is ON for Service Provider and Service Provider or Reseller Operation). If a logged in user has the right then
a global configuration page opens. From the global configuration page the user can turn on the SLA feature in
EAS. When the SLA feature is enabled, the global configuration page also allows the logged in user to provide
the holiday lists.
Organization Module: If the SLA is turned ON in global configuration and logged in user has the right, then a
new section is available in General tab of Organization list page. User can modify the following SLA details from
this section:
New Orders (Recurring Orders)
New Orders (One Time Orders)
Up size (Type A)
Up size (Type B)
Downsize

8 APRIL 2016
ENSIM CONFIDENTIAL
578
Product Module: The Offer Type field must be added while creating a product offer.
Service Module: A new field PIF Identifier must be added while adding a PIF. This field is used to map the PIF.
Order Module:
While Service Provider or Reseller is placing an order, Organization level SLA information must be
displayed in order summery page if SLA is enabled in configuration.
While Service Provider or Reseller is upsizing an order, he must select the upsize type but organization user
cannot able to do it.
When an order is provisioned, org_level_sla_trigger is triggered to save the actual.
Order history must show the fields (Expected SLA in Days and Actual Number of Days Taken) for each
base and sub order.
In Order exporter, the exported file contains the Expected SLA in Days and Actual Number of Days
Taken fields for each base and sub order.
In the billing reports or order reports, user can choose either Tech Refresh or New Business for the PIF with
list values. The internal value of the corresponding list of values must be Tech Refresh and New Business.
Notification: A new notification macro for Expected SLA in days is included in notification templates of the
emails that go to service providers.

8 APRIL 2016
ENSIM CONFIDENTIAL
579
SECURITY
CHAPTER 12
Security
The measures taken for creating a secure Web application is extensive. EAS, being an e-commerce application, is
exposed resellers, agents and organization users need to access the same over internet. Some of the security
measures are inherent in the application code of EAS, while the rest are dependent on how the application is
deployed in the network. In this article, we will delve into both of these aspects in details.
Deploying securely
1.
Tomcat, DMZ and SSL

Apache Tomcat boasts an impressive record of accomplishment when it comes to security. Most
vulnerabilities, both major and minor, are discovered by the Tomcat community itself or security
researchers, and quickly patched. Thus, the default installation of Tomcat can be said to be "fairly
secure". For additional information, refer to http://www.mulesoft.com/tcat/tomcat-security
It is always recommended that the Tomcat application nodes are deployed in DMZ behind a firewall.
The firewalls should terminate SSL and communicate with tomcat on http only. Although it is possible
to deploy SSL certificates on Tomcat application servers, it is never recommended to do so. Deploying
SSL certificates on Tomcat server slows down performance of Tomcat. Specialized Firewall appliances
are better equipped to process SSL certificates.
2.
DB security
Access to the databases of EAS is required for installing or upgrading the schema and for the application
to run. While installation and upgrade process required DDL and DML statements to be executed, the
application only needs to execute DML statements. Out of the box, EAS is configured to use two distinct
users
a. ESCM_SCHEMA: strictly to be used by Install and Upgrade process; has DML and DDL rights.
b.
ESCM_ONLINE: for the application to use; can perform only DDL operations.
All the DB passwords in the configuration files must be encrypted. EAS provides a tool to encrypt
DB passwords.
3.
API Security
If EAS is API integrated with other applications dedicated EAS nodes should be deployed to receive API
calls. Deploying Portal UI and APIs from the same application nodes are not recommended for
production deployment for security and performance reasons. These dedicated nodes should be
exposed to the consumer application only by appropriate firewall configuration such as allowing only
known IP Addresses to access the APIs. If these APIs are consumed by in-house applications of the
Service Provider then consider restricting access

8 APRIL 2016
ENSIM CONFIDENTIAL
580
SECURITY CHAPTER 12
from internal network only.

EAS APIs are password protected. To execute an API call, user credentials are mandatory. These users
must exist in the EAS with appropriate Roles and Permissions to execute APIs and perform necessary
actions.
Built-in features
1.
User Passwords: One of the most important aspect of a secure application is to protect users passwords.
It is to be noted that an application is written assuming the worst situations which may include the
scenario where the encrypted passwords of the users are leaked to hackers. The following features of
EAS describes how passwords are managed securely:
a.
Encryption, Hashing and Salting: ECM hashes passwords. Hashing is a one way encryption
method from which decryption is not possible. Additionally EAS uses password specific salt (32
characters generated by Secure-Random sequence). This makes rainbow tables almost
ineffective.
b.
No recovery of password, token based reset: Since passwords are not decryptable, there is no
way to recover passwords. EAS provides password reset option via token based URLs sent in
email notification to the user.
2.
Security against attacks: Security against attacks is vast topic. In the following sections we will explain
how EAS is secured against four most well-known attacks.
a.
SQL injection: EAS is built using Grails framework. Grails uses Hibernate as the ORM library.
Hibernate, which is the technology underlying GORM domain classes, automatically escapes
data when committing to database so this is not an issue. However, there are many instances in
the application where SQL queries are formed by collating user inputs. Grails provides
parameterised HQL constructs that are used in such circumstances. Parameterized HQL
automatically escapes user data and thus the SQL queries are injection proof.
b.
HTML/URL injection: This is where crafted data is supplied such that when it is later used to
create a link in a page, clicking it will not cause the expected behavior, and may redirect to
another site or alter request parameters. HTML/URL injection is easily handled by EAS with the
codecs supplied by Grails, and the tag libraries supplied by Grails all use encodeAsURL where
appropriate.
c.
CSRF: CSRF involves unauthorized commands being transmitted from a user that a website
trusts. A typical example would be another website embedding a link to perform an action on a

8 APRIL 2016
ENSIM CONFIDENTIAL
581
SECURITY CHAPTER 12
website if the user is still authenticated. EAS prevents this type of attacks by useToken attribute
in all HTML forms.
d. XSS: EAS verifies as much as possible that incoming requests were originated from the same
application and not from another site. It is also important to ensure that all data values rendered
into views are escaped correctly. For example when rendering to HTML or XHTML EAS
ensures that people cannot maliciously inject JavaScript or other HTML into data or tags viewed
by others.

8 APRIL 2016
ENSIM CONFIDENTIAL
582
BRANDING
CHAPTER 13
Branding
Introduction
EAS provides flexibility to the Service Provider (SP) and Resellers to change the look and feel (LnF) of the EAS
UI (EAS Portal) and brand it the way SP/Resellers wants its users to view EAS Portal. The same LnF will be
applicable to Org, Reseller and Agent users under the said Provider (SP/Reseller).
This document describes the high level scope regarding EAS Portal branding, and additionally, branding
customization retention for EAS upgrades.
Scope of branding for Service Provider

1.
UI Texts & Language packs: Ensim packages US English language pack file by default that contains all
the UI labels, help texts and error messages. SP can make changes to this file as required. SP can also
add non-English language pack(s) if required. Ensim can provide non-English language pack on
demand or SP can create one by translating the US English language pack.
a.
Only SP have access to language pack configuration. The language pack configuration is global SP language pack configuration and settings are applied to all Resellers and Organizations.
b.
2.
For detailed language pack configuration instructions, refer to EAS Service Provider Manual.
CSS files: Ensim packages the CSS of the portal in two separate
i. For SP (and Resellers, Agents) user interface which is named as merchant .css
ii. For Orgs user interface which is named as organization.css
3.
SP can make changes in both the files and change the LnF for both Provider and Org users.
For detailed branding configuration instructions, refer to EAS Service Provider Manual.
Image files: SP can make changes in image files but must retain the same image size and file names.
These images are used by EAS for logo and icons embedded in the UI.
4.
HTML/GSP files: EAS is built on Grails framework in which static HTML and dynamic code are
presented together in .gsp files to serve Web pages like any other Web framework. The .gsp files are
editable in a text editor however, Ensim do not recommend making any HTML change in .gsp files as it
will directly impact backend behaviour. The only .gsp file a SP can change is _external.gsp by which
EAS allows extension of the menus in the UI.. If SP makes changes in other GSP files, Ensim will not be
responsible for issues created due to the changes. Moreover, Ensim will not be responsible for retaining
the changes during EAS upgrades. SP will have to redo or re-apply the changes after Ensim handovers
the setup after completing any upgrade task.

8 APRIL 2016
ENSIM CONFIDENTIAL
583
BRANDING CHAPTER 13
Scope of branding for Resellers

SP can allow Resellers to brand EAS UI in one of the following 2 ways:
1. Basic Branding: Resellers are allowed to change the logo images used in Portal, Quotes and
Invoices, and edit CSS classes as required to change the LnF in its EAS Portal. Resellers have to
download CSS files (merchant and organization) via EAS UI and edit as required. To apply the
changes, Reseller has to upload the Logo and CSS files via its EAS Portal. Multi-Reseller
branding is supported as each Reseller branding files are stored under different folders. Reseller
users and Orgs owned by the Reseller (i.e. Orgs under the Reseller) will view the custom LnF
implemented by the Reseller. Limitation to Basic Branding: Resellers cannot make any changes
to icons or other images (except for logo images).
2.
Advanced Branding: Ensim packages all the CSS and Images in a zip file named as
defaultTheme.zip for Resellers to download, unzip and make changes on CSS and images
(must retain image size and filename) files. After the Reseller make necessary changes to these
files, zip the files and folders again and upload and apply it in EAS Portal to configure
branding. Multi-Reseller branding is supported as each Reseller branding files are stored under
different folders. Reseller users and Orgs owned by the Reseller (i.e. Orgs under the Reseller)
will view the custom LnF implemented by the Reseller.
Note: Detailed information for SP and Reseller branding is in EAS Service Provider Manual and
EAS Reseller Manual respectively.
Process to retain branding during EAS upgrade

EAS is packaged and deployed in a fashion that retains customizations made by the SP and Resellers.
The additions and changes introduced by Ensim are packaged with clear demarcation which helps
Ensim apply them onto the existing customized files. The SP and the Resellers will have to customize
only the additional elements introduced by the upgrade process otherwise Ensims default LnF will be
visible in the portal.
The detailed information to retain branding by SP and Resellers during upgrade process is described in
EAS Installation Guide. High level description of the process is as follows:
1. Language packs: Ensim introduces new messages at the end of the message file with every
release of EAS. These messages are needed for additional features introduced in the release.
During the upgrade process Ensim appends these new messages to the existing messages of the
deployment thus retaining all previous customizations.
However, at times Ensim may need to modify old existing messages of previous releases. If so,
Ensim packages these messages in a separate file with the old and the new texts for ease of
comparison. Such changes are typically done for better clarity of language or spelling,
grammatical corrections and changes to nomenclature. Ensim evaluates the impact of these
corrections in the existing customized message files and consults with the SP before applying.
2.
CSS files:
a.
For SP branding: Ensim doesnt change existing CSS classes. New CSS classes (delta for the
new EAS features) are added at the end of the file with clear demarcation, similar to the
way new texts are added to the message files. By adding new CSS classes, existing

8 APRIL 2016
ENSIM CONFIDENTIAL
584
BRANDING CHAPTER 13
customized CSS are retained. SP is responsible for modifying the appended section to
incorporate the custom LnF.
b.
For Reseller branding: For EAS upgrades, new CSS classes (delta for the new EAS version)
will be appended at the end of the file by an automated back-end job. By adding new CSS
classes, existing customized Reseller CSS are retained but the newly added CSS will have
Ensim default LnF. This will be done automatically for every Reseller however, Resellers
will have to change the newly added CSS classes to customize the LnF.
3.
LESS files: The merchant.less and organization.less files contain pre-defined color codes and
font styles, which you can modify to change the branding. After you modify the files, compile
the merchant.less file with merchant.css and the organization.less file with organization.css.
Replace the existing CSS files with the compiled CSS files and then, upload to EAS.
For information on how to compile LESS files with CSS files, refer to the available URLs, such
as http://lesscss.org/less-preview/
Note: The LESS files are packaged within the ESCM-DataFiles folder.
The merchant.less file is placed in the ESCM-DataFiles\css folder.
The organization.less file is placed in the ESCM-DataFiles\css\modern_ui folder.
4.
Image files:
a.
For SP branding: Ensim provides a separate folder which has newly added images in each
EAS release. Ensim will copy the newly added images to desired location but will not
override the existing images. After the upgrade, SP may replace these images as necessary.
b.
For Reseller branding: The newly added images are automatically added to the respective
folders of each Reseller (with advanced branding). The Reseller may choose to replace these
images as necessary.
5.
HTML/JSP files: Except for _external.gsp file, Ensim does not recommend making any changes
to HTML/JSP file. Hence Ensim will not take any action to retain the changes made by SP. SP is
responsible to re-apply all HTML/JSP customization after the upgrade. Ensim will retain
customization made to the _external.gsp.
Note: For branding, it is not required to restart tomcat for updating the CSS files.
Summary
1.
Ensim allows customizations of texts and labels in UI, CSS and Images.
2.
Ensim introduces new elements in each release as the features are enhanced.
3.
Ensim upgrade process ensures that existing customizations are retained while the newly added
elements continue to work with Ensims LnF.
Configuring EAS for branding

Please make sure these system configurations are made to make branding work.
8 APRIL 2016
ENSIM CONFIDENTIAL
585
BRANDING CHAPTER 13
1.
Log in to EAS as Service Provider Administrator and go to the General Properties section
under the Configuration tab.
2.
Then set the following properties :

c.
Application Share Folder Path -: The path to a SMB share which is used as an application
wide share to store and distribute reseller themes among load balanced application servers
with EAS deployed.
d. NTLM Username -: The username for access to the SMB share pointed by Application
Share Folder Path with read/write permission on that share.
e.
NTLM Password -: The password corresponding to the username put in NTLM

Username
f.
Domain -: Domain for the authentication/authorization of the credentials stored in NTLM

Username and NTLM Password.
g.
Local Branding Theme Folder Path -: It is the path to the branding folder under the folder
where the EAS is deployed.
3.
Service Provider can alter the branding theme of their UI as per requirement. Branding theme
can be customized by adding or replacing the images or modifying the CSS file.
If Service Provider needs to change certain images in order to apply new branding for the portal
of EAS, he/she needs to change the images under the given locationa) Go to the location /<location of the tomcat folder>/webapps/<application folder
name>/images
b) The image within the <images folder location> can be changed by following either of the
two steps
Delete the previous picture and paste the new one at that location having same name as
the earlier one or,
Rename the previous picture and paste the new one having same name as the earlier
one.
If Service Provider needs to alter the CSS in order to apply new look and feel for the portal of EAS,
he/she needs to make some alterations in the CSS file under the given locationa) Go to the location /<location of the tomcat folder>/webapps/<application folder name>/css
b) Alter the all.css file within the <CSS folder location> to modify the branding as per
requirement.
Note: EAS supports Modern UI theme for all types of entities (Service Provider, Reseller, Agent and
Organizations).

8 APRIL 2016
ENSIM CONFIDENTIAL
586
BRANDING CHAPTER 13
Configuring SMB share

SMB will be used for various reasons like Branding, Generation of Invoice for organization.
To enable branding for resellers, EAS needs to have access to a file share were the Resellers can upload
the branding files. Generation of Invoice for organization also needs to have access to the file share to
save the invoice PDF files for organizations. The Share must be a samba compatible share on any OS. You
can use the Database server file system or any of the application servers file system to host the share.
1. Install samba package if not already installed. In RPM based Linux box, configure yum and run the
following command as root-:
2.
yum install samba

Configure a samba share by editing the samba configuration file smb.conf usually available under
/etc/samba directory. For example, to create a share called applicationShare under
home/sambauser,
i.
add the following to smb.conf file -: [applicationShare] comment = Application Share path
= /home/ sambauser /applicationShare browseable = yes writable = yes public = yes read
only = no valid users = sambauser
ii.
iii.
Add someuser to the samba user database using the command smbpasswd a sambauser
The above command will prompt for the samba access password for the user sambauser.
These information will be used later to configure the Share location on EAS.

8 APRIL 2016
ENSIM CONFIDENTIAL
587
BRANDING CHAPTER 13
Customizing the Login page

This section describes how to customize the different blocks and images of the EAS login screen.
Browse the EAS portal with the URL: http://<ip address or hostname> :< port>/<application folder
name>
For example- http://localhost:8080/order
Change the EAS log-in page image

In the above figure section 1 indicates the log-in page image of the EAS log-in page. To change this
image, follow the path \webapps\<order>\images. There is an image named loginEnsimfinal.png.
Replace with your desired image with same name and size (approx. width=287 height=214), so that
there is no distortion in the UI.
Note: Make sure image background should be transparent for better look and feel of the UI.
Change the dynamic content of the right box on the EAS log-in page
In the above figure, section 2 indicates the dynamic content part of the EAS log-in page. The display for
the dynamic content for Service Provider webpage can be customized in two ways. You may provide
your desired URL or text.
In case if you want to provide a URL, update the label login.dynamic.content.url with the URL within
message.properties file in the path \webapps\<order>\WEB-INF\grails-app\i18n.
Note: The default application folder name that has been used is order. This will be replaced
accordingly if different application folder name was used during installation.
For exampleEAS 4.2 SERVICE PROVIDER MANUAL
8 APRIL 2016
ENSIM CONFIDENTIAL
588
BRANDING CHAPTER 13
login.dynamic.content.url = http://example.html
After making the changes, default contents of the right side box will be replaced by the content of the
provided URL.
If login.dynamic.content.url is kept blank, then two parts can be seen at section 2. These parts are1-text: it displays the text from the label login.dynamic.content.label in the messages.properties file.
2- image: it displays the rightimg.png image from the <application folder name>/images location.
Change the text of the right box on the EAS log-in page
If login.dynamic.content.url is, kept blank then a default text and image will be shown at the right box
of the log-in page as shown in the figure above. In the above figure, section 3 indicates the text within
the right side box of the EAS log-in page. To alter this text, change the value of the label
login.dynamic.content.label in the messages.properties file.
Change the image of the right box on the EAS log-in page
Section 4 indicates the image part on the right side box of the EAS log-in page. To change this image,
follow the path \webapps\<order>\images. There is an image named rightimg.png. Replace with
your desired image.
Change the title text of the EAS log-in page

In the above figure section 5 indicates the header title of the EAS log-in page. To change this title text,
you need to modify the message.properties file at the location-\webapps\<order>\WEB-INF\grailsapp\i18n.
Open this page and change the value for the property called application.title.
EAS log-in page for the resellers

In EAS, every resellers can have their individual login page with different branding applied in it.
At the time of reseller creation by the Service Provider, Service Provider put one unique identifier for
that particular reseller.
In the Customized login URL field, Service Provider needs to provide the unique identifier for the
reseller.

8 APRIL 2016
ENSIM CONFIDENTIAL
589
BRANDING CHAPTER 13
Here, res002 is the unique identifier. When this reseller wants to have its own login screen, it has to
browse the following URLhttp://<hostname>:<port>/<application folder name>/res002
After browsing the above URL, reseller will have its own branded log-in page for EAS-
This dynamic content URL can also be changed by the resellers. Reseller can do the change on the edit
organization page with reseller user login.

8 APRIL 2016
ENSIM CONFIDENTIAL
590
BRANDING CHAPTER 13
Customizing CSS
To change the look and feel of the portal Reseller needs to change the CSS code in the related files. To
know the CSS basics, refer to Appendix A.
Changing the default look and feel of EAS UI to a green colored UI

To alter the default look and feel of the EAS UI you need to modify the CSS class and IDs in
merchant.css and organization.css
Identify the CSS classes to customize the look and feel of the EAS UI
Before applying the changes to the CSS classes within the CSS files, you need to identify the correct CSS
class, which is responsible to provide the look and feel of the selected section of the EAS UI.
Different web browser support different techniques to identify the CSS class against each block of EAS
UI. Here are the detailsA. Mozilla Firefox: This browser supports one add-on called Firebug, which allows you to
identify the classes within the CSS files when you select any particular area of EAS portal using
this add-on.
In case the add-on called Firebug is not available, go to Tools>Web Developer Tools link of
the browser menu or press F10 key on the keyboard. It will give you the option to find the
proper CSS class or ID of the selected CSS element.
How to open developer tools in Mozilla Firefox
In order to inspect different CSS element of the EAS UI, you need to open the developer tools in
Mozilla Firefox browser.
1. To do that click the Tools>Web Developer>Developer Toolbar on the Mozilla Firefox
browser.

8 APRIL 2016
ENSIM CONFIDENTIAL
591
BRANDING CHAPTER 13
2.
Developer Tools window appears. Click the icon
3.
Click the tab Inspector and then on an icon
4.
Click the arrow shown in the above figure in order to inspect various elements of the EAS
portal.

8 APRIL 2016
ENSIM CONFIDENTIAL
592
BRANDING CHAPTER 13
5.
Select any of the section from the EAS UI. Corresponding CSS class will be displayed within
the developer tools window.
6.
Make the required changes within the selected class. Class details will be shown at the right
panel of the developer tools window.
Changes will be reflected in the EAS UI. Changes stay until you reload the page.
B. Google Chrome: While EAS is browsed through this browser, right click the portal it will give
option called inspect element, which enables you to find the CSS classes against the selected
area of the EAS UI.
C. IE: Go to Tools>Developer Tools link of the browser menu or press F12 key on the keyboard.
It will give you the option to find the proper CSS class or ID of the selected CSS element.
Working process of the fire bug add-on is discussed in details.
How to open developer tools in IE
In order to inspect different CSS element of the EAS UI, you need to open the developer tools in
Internet Explorer (IE) browser.
1. To do that click the Tools>Developer Tools on the IE browser.

8 APRIL 2016
ENSIM CONFIDENTIAL
593
BRANDING CHAPTER 13
2.
Developer Tools window appears.
3.
Click the arrow shown in the above figure in order to inspect various elements of the EAS
portal.
4.
Select any of the section from the EAS UI. Corresponding CSS class will be displayed within
the developer tools window.

8 APRIL 2016
ENSIM CONFIDENTIAL
594
BRANDING CHAPTER 13
5.
D. Safari: This browser supports one preference called develop menu, which allows you to get the
option Inspect element, which enables you to find the CSS classes against the selected area of
the EAS UI.
How to open developer tools in Safari
In order to inspect different CSS element of the EAS UI, you need to open the Inspect
Elementin Safari.
1.
To do that click the icon
2.
Select the option Show Develop menu in menu bar and close the pop-up window.

8 APRIL 2016
. Select Preferences.
ENSIM CONFIDENTIAL
595
BRANDING CHAPTER 13
3.
Again click the icon
. Select Customize Toolbar. Drag the Web Inspector to the
toolbar. Then click Done.
4.
Select any of the section from the code. Corresponding EAS UI will be displayed.
5.

8 APRIL 2016
ENSIM CONFIDENTIAL
596
BRANDING CHAPTER 13
1) Changing the CSS style of the Header

To change the CSS style of the header of the EAS portal, heading_bottom_grey, .heading,
.header_content_dashboard:hover, .header_content_left_border_logout:hover,
.header_content:hover, .inherited, #nav ul, #menu ul id needs to be modified within merchant.css
and organization.css files.
#heading_bottom_grey {
background: -moz-linear-gradient(left center , #3E6400 20%, #3E6400 80%) repeat scroll 0 0 rgba(0, 0,
0, 0) ;
background-repeat: repeat-x;
height: 35px;
margin-top: 70px;
min-width: 1300px;
position: fixed;
width: auto;
z-index: 40;
}
.heading {
background: none repeat scroll 0 0 #3E6400;
border: 1px solid #000000;
height: 30px;
padding: 0 9px 0 10px;
}
.header_content_dashboard:hover {
}
.header_content_left_border_logout:hover {
}
.header_content:hover {
}
.inherited {
background: -moz-linear-gradient(center top , #3E6400 0%, #619C03 100%) repeat scroll 0 0 rgba(0, 0,
0, 0);
}
#nav ul {
list-style: none outside none;
}
#menu ul {
list-style: none outside none;
}

8 APRIL 2016
ENSIM CONFIDENTIAL
597
BRANDING CHAPTER 13
Header section is static for all the pages, contents gets altered when click different tabs.
2) Changing the CSS style of the navigation bars and buttons on the dashboard
To change the CSS style of the header of the EAS portal, heading_bottom_grey id needs to be modified
within merchant.css and organization.css files.
height: 35px;
margin-top: 70px;
min-width: 1300px;
position: fixed;
width: auto;
z-index: 40;
}
To change the CSS style of the heading of the Account Information screen, heading class needs to be
modified within merchant.css and organization.css files.
.heading {
height: 30px;
}
To change the font and background color of the buttons on dashboard page, .ui-state-default, .uiwidget-content .ui-state-default, .ui-widget-header .ui-state-default class need to be modified within
jquery-ui-1.8.17.custom.css file.

8 APRIL 2016
ENSIM CONFIDENTIAL
598
BRANDING CHAPTER 13
.ui-state-default, .ui-widget-content .ui-state-default, .ui-widget-header .ui-state-default{

background: none repeat scroll 0 0 #E6E6E6;
color: #000000;
font-weight: normal;
}
3) Changing the CSS style of the navigation bars and buttons in the Organization
page
To change the CSS style of the heading of the Organization screen, heading class needs to be modified
.heading {
height: 30px;
}
8 APRIL 2016
ENSIM CONFIDENTIAL
599
BRANDING CHAPTER 13
To change the CSS style of the Filter By page on the Organization screen, two classes (user_grey_light
class and user_grey_dark class) needs to be modified within merchant.css and organization.css files.
user_grey_light
.user_grey_light {
}
user_grey_dark
.user_grey_dark {
background: none repeat scroll 0 0 #D2CBCB;
}
body {
color: #000000;
font-family: 'SegoeUINormal',Arial,Helvetica,sans-serif;
font-size: 12px;
}
To change the background of the Search button on the Organization screen, submit search class
needs to be modified within merchant.css and organization.css files.
.submit2, .submit {
background: none repeat scroll 0 0 #2A61CA;
color: #FFFFFF;
cursor: pointer;
float: left;
font-weight: bold;
line-height: 22px;
margin-bottom: 3px;
margin-top: 0;
position: relative;
text-align: center;
width: 135px;
}

8 APRIL 2016
ENSIM CONFIDENTIAL
600
BRANDING CHAPTER 13
4) Changing the CSS style of the navigation bars and buttons in the Catalog
To change the CSS style of the header of the EAS portal, heading_bottom_grey id needs to be modified
height: 35px;
margin-top: 70px;
min-width: 1300px;
position: fixed;
width: auto;
z-index: 40;
}
To change the CSS style of the heading of the Catalog screen, heading class needs to be modified
.heading {
height: 30px;
}
To change the background of the buttons on the Category list screen, ui-button ui-widget ui-statedefault ui-corner-all ui-button-text-icon-primary class needs to be modified within jquery-ui1.8.17.custom.css file.
.ui-state-default {
color: #000000;
}
5) Changing the CSS style of the navigation bars, screens and buttons in the Order
page
To change the CSS style of the heading on the List Order screen, heading class needs to be modified

8 APRIL 2016
ENSIM CONFIDENTIAL
601
BRANDING CHAPTER 13
.heading {
height: 30px;
}
To change the CSS of the search window in the List Order screen, blue_simple class needs to be
modified within the merchant.css and organization.css files.
.blue_simple {
background-color: #454545;
}
To change the background of the Advanced Search button perform the following changes-

8 APRIL 2016
ENSIM CONFIDENTIAL
602
BRANDING CHAPTER 13
element.style {
background-color: #333333;
color: #FFFFFF;
cursor: pointer;
margin-left: auto;
margin-right: auto;
padding: 3px;
text-align: center;
text-decoration: none;
}
To change the CSS style of the Search button on the List Order screen, item2 blue_simple class needs
to be modified within merchant.css and organization.css files.
To change the background of Search button perform the following changes-
.item2 table {
background-color: #2A61CA;
border: 1px solid #007FFF;
color: #000000;
margin-left: 2px;
margin-right: 2px;
width: 98%;
}
To change the text color of Search button perform the following changes-
element.style {
8 APRIL 2016
ENSIM CONFIDENTIAL
603
BRANDING CHAPTER 13
color: #000000;
font-size: small;
}
To change the background of Reset button perform the following changes-
.item2 table {
background-color: #2A61CA;
border: 1px solid #007FFF;
color: #FFFFFF;
margin-left: 2px;
margin-right: 2px;
width: 98%;
}

8 APRIL 2016
ENSIM CONFIDENTIAL
604
BRANDING CHAPTER 13
To change the text color of Reset button perform the following changes-
element.style {
color: #FFFFFF;
font-size: small;
}
6) Changing the LnF of the Order details page

If you want to change the blue shade of order details block and the other blocks as well then you have to
make the following changes in the blue_shade class within the merchant.css file.blue_shade {
background: -moz-linear-gradient(left center , #81F781 20%, #04B404 80%) repeat scroll 0 0 rgba(0, 0, 0,
0);
}
Before change, the output was -

8 APRIL 2016
ENSIM CONFIDENTIAL
605
BRANDING CHAPTER 13
.blue_shade {
background: -moz-linear-gradient(center top , #A9F5BC 0%, #A9F5BC 6%, #04B431 66%, #A9F5A9 99%)
repeat scroll 0 0 transparent; /* FF3.6+ */
background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#A9F5BC 0%,),colorstop(100%,#04B431));/* Chrome,Safari4+ */
background: -webkit-linear-gradient(top, #A9F5BC 0%,#04B431 100%); /* Chrome10+,Safari5.1+ */
background: -o-linear-gradient(top, #A9F5BC) 0%,#04B431 100%); /* Opera 11.10+ */
background: -ms-linear-gradient(top, #A9F5BC 0%,#04B431 100%);/* IE10+ */
background: linear-gradient(top, #A9F5BC 0%,#04B431 100%);/* W3C */
filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#A9F5BC,endColorstr='#04B431
',GradientType=0 ); /* IE6-9 */
}
Note: To apply background color with gradient effect in different web browser, you need to
provide browser specific CSS code as shown in the above lines of CSS code.
8 APRIL 2016
ENSIM CONFIDENTIAL
606
BRANDING CHAPTER 13
For e.g /*FF3.6+*/ the gradient will be visible in firefox browser with version above 3.6
But if you want to add background color without any gradient effect then no need to write browser
specific CSS code. Only use the property background-color of CSS following with the color code.
After making changes in the blue_shade, output will be as below-

8 APRIL 2016
ENSIM CONFIDENTIAL
607
BRANDING CHAPTER 13
7) Changing the LnF of the top navigation menu on mouse hover event
If you want to change the color of the main tabs of EAS UI on mouse hover operation then do the
following changes in the navigation id within the merchant.css and organization.css filesBefore making the changes default output was-
.header_content:hover {
}
.inherited {
background: -moz-linear-gradient(center top , #3E6400 0%, #619C03 100%) repeat scroll 0 0 rgba(0, 0,
0, 0);
}
.table-row-style-selected {
background: -moz-linear-gradient(center top , #A9F5BC 0%, #01DF01 100%) repeat scroll 0 0 rgba(0, 0,
0, 0);
After making the changes the output is as follow-

8 APRIL 2016
ENSIM CONFIDENTIAL
608
BRANDING CHAPTER 13
After changing different sections of the EAS UI the overall changes will be reflected-
To change the CSS style of the heading of the Promotion screen, heading class needs to be modified
within
.heading {
height: 30px;
}
To change the background of the buttons on the Promotion screen, ui-button ui-widget ui-statedefault ui-corner-all ui-button-text-icon-primary class needs to be modified within jquery-ui1.8.17.custom.css file.
.ui-state-default {
color: #000000;
}
The above change can be done by using Fire bug add-ons in Firefox browser. To use of Firebug you
need to follow the steps below1. Install the add-ons (fire bug) in your Mozilla Firefox browser.
2. After successful installation of the add-ons you will have the Firebug shortcut at the top of the
right corner of the browser.
3.
Open your web portal and Just click the icon shown in the above figure and it will get activate.
Firebug UI will open up.

8 APRIL 2016
ENSIM CONFIDENTIAL
609
BRANDING CHAPTER 13
4.
Click the inspect element icon shown above. Move the mouse pointer and point on the
particular section of the web portal. Corresponding code will be shown on the Firebug UI
location
5.
Style code (CSS code) of the selected class can be seen at the right side of the Firebug window.
You can modify the code there and the live preview can be seen. When you close the Fire bug
the changes will be lost and the UI will be reverted back to the original one.
To implement the temporary look and feel which you have painted through Firebug please contact
Ensim Support Team. To contact Ensim support team follow the link
http://www.ensim.com/services/support.
Customizing Organization UI
We can modify the existing theme to generate a new theme for EAS UI which will have complete new
look and feel. Here we are going to change the modern-ui theme to a classic green theme.
To do the changes in the modern-ui theme (default theme) you need to do the following
Download the zip file and extract the same, will get two folders. Namely:
CSS:
Under this folder you will get modern ui folder and merchant.css file. In order to change the look
and feel of the modern ui theme, modify organization.css file under modern ui folder.
Images:

8 APRIL 2016
ENSIM CONFIDENTIAL
610
BRANDING CHAPTER 13
This folder contains all the images of logo as well as the icons.
All the related images to modern UI theme can be found under css/modern_ui/images folder.
Here are the classes within the organization.css file under the modern_ui folder where you have to
make the changes to make the modern theme to the green theme.
Changing the account page look and feel for organization
To change the search navigation bar at left panel do the changes in the following CSS classDefault look and feel:
Branded look and feel:
.heading3 {
background: -moz-linear-gradient(center top , #3E6400 0%, #1B2B0C 100%) repeat scroll 0 0 rgba(0, 0,
0, 0);
border: 1px solid #FFFFFF;
color: #FFFFFF;
font-size: 17px;
height: 40px;
padding: 5px 9px 0 16px;
width: 240px;
}
To change the look and feel of the header modify the following CSS idDefault look and feel:
Branded look and feel:
0, 0);
height: 35px;
margin-top: 70px;
min-width: 1300px;
position: fixed;
width: auto;
z-index: 2;
}

8 APRIL 2016
ENSIM CONFIDENTIAL
611
BRANDING CHAPTER 13
To change the background color of the header icon image, modify the following CSS classesBranded look and feel:
.inherited {
0, 0);
}
.header_content_left_border {
0, 0);
border-left: 1px dotted #808080;
height: 65px;
padding: 5px 0 0 10px;
width: 70px;
}
After altering the look and feel of the organization account page, the branded UI will be-

8 APRIL 2016
ENSIM CONFIDENTIAL
612
BRANDING CHAPTER 13
blue_shade2
ui-list-item
.blue_shade2
{
background-color: #3399FF !important;
}

8 APRIL 2016
ENSIM CONFIDENTIAL
613
BRANDING CHAPTER 13
Before the changes, the look was -
.blue_shade2
{
background: -moz-linear-gradient(center top , #3E6400 0%, #3E6400 100%) repeat scroll 0 0 rgba(0, 0,
0, 0);
}
.ui-list-item
{
background: -moz-linear-gradient(center top , #3E6400 0%, #3E6400 50%, #64FE2E 100%) repeat scroll
0 0 rgba(0, 0, 0, 0);
border-radius: 5px 5px 5px 5px;
color: #FFFFFF;
font-weight: bold;
margin-bottom: 10px;
margin-right: 20px;
padding: 10px 15px 15px 10px;
}
After the changes, the look is:

8 APRIL 2016
ENSIM CONFIDENTIAL
614
BRANDING CHAPTER 13

8 APRIL 2016
ENSIM CONFIDENTIAL
615
BRANDING CHAPTER 13
Branding for Invoice

Branding can be applied for generating invoice pdf files for the Reseller and Organization of the Service
Provider. Invoice portal logo can be altered in the generated pdf files by replacing the invoice logo
image file called invoiceLogoImage.png. Service Provider needs to go to the
/branding/serviceprovider location within samba shared folder. Then Service Provider has to replcae
the existing logo with new invoice logo, but name of the new invoice logo file has to be same as the
existing logo.
Following is the header of the Invoice PDF with InvoiceLogo of Service Provider
Note: For further details on CSS and Class refer to Appendix C.
Customizing UI labels
Labels can be customized by updating the values of keys in the messages.properties file. In the below section,
we have used the example of modifying the term Resellers in EAS UI to Contracts. The steps are:
Step 1: Log in to the EAS Application Server as an Administrator.
Step 2: In order to take a backup of existing message.properties file create a folder called Backup on C:
drive.
Step 3: Go to the location C:\tomcat8\ESCM-DataFiles\i18n as shown below.

8 APRIL 2016
ENSIM CONFIDENTIAL
616
BRANDING CHAPTER 13
Step 4: Copy messages.properties file from this location an paste it in C:\Backup.

8 APRIL 2016
ENSIM CONFIDENTIAL
617
BRANDING CHAPTER 13
Step 5: Right click messages.properties file and open it in any editor (we have used Notepad++ in this
example.) See image below.
Step 6: The message.properties file opens up in the editor window as shown below.
Step 7: In order to rename Resellers to say, Contracts we need to perform the below steps:
a. Press CTRL+F or, click Search->Find to search for the string Reseller.
b. Select the two checkboxes Match whole word only and Match case.
c. Then click the Find All in Current Document.

8 APRIL 2016
ENSIM CONFIDENTIAL
618
BRANDING CHAPTER 13
The above steps are reflected in the below screenshot.
d. Next click the Replace tab in the Find dialog box. Type Contract on the Replace with
field and click the Replace All button to replace all occurrences in the message.properties file.

8 APRIL 2016
ENSIM CONFIDENTIAL
619
BRANDING CHAPTER 13
e.
Repeat the above steps again using Resellers as search string and replace all occurrences of
this string with Contracts.
Step 8: Next log in to the EAS portal using Service Provider credentials.
The dashboard page opens up as shown below.

8 APRIL 2016
ENSIM CONFIDENTIAL
620
BRANDING CHAPTER 13
Step 9: Click Entities tab to notice the effect of the above message.properties file change on the EAS
UI. Resellers will get renamed to Contracts throughout the entire UI level of EAS just like the one
displayed in below screenshot.

8 APRIL 2016
ENSIM CONFIDENTIAL
621
BRANDING CHAPTER 13
Customizing Invoices
The Service Provider can apply branding to the invoice by changing the invoice logo. To change the
invoice logo, the Service Provider should manually replace the desired logo with the name,
invoiceLogoImage.png, in <ApplicationwideSharedFolderPath>/branding/serviceprovider/
location. The <ApplicationwideSharedFolderPath> is configurable through EAS (Configuration
General Properties).
Following is the header of the Invoice PDF file with the Invoice Logo chosen by the Service Provider

8 APRIL 2016
ENSIM CONFIDENTIAL
622
BRANDING CHAPTER 13
Optional operations
Service Provider can apply branding to change the look and feel of the EAS portal. Service Provider
needs to make changes in the CSS files and he can alter the images too.
In order to change the look and feel of the EAS UI, Service Provider needs to access the server location
where the CSS files and images are stored.
To customize the look and feel of the portal, Service Provider needs to modify the CSS file and images.
The below table describes the location of the files, along with the user which will be impacted by the
changes made in the files.
SL
No.
1
Location of the CSS files
File name
<tomcat installation
folder>/ESCMDataFiles/css/modern_ui
organization.css
<tomcat installation
Merchant.css
folder>/ESCM-DataFiles/css/
Location of the
images' folder
<tomcat
installation
folder>/ESCMDataFiles/
css/modern_ui/i
mages
<tomcat
installation
folder>/ESCMDataFiles/image
s
Impacted Users
Organization users
Service Provider users,

Reseller users and Agent
users
Enabling Reseller Branding

In EAS, Service Provider can assign different types of branding capabilities to different reseller. There
are two types of branding (basic and advanced) available, which Service Provider can assign at the time
of creating reseller.
Go to Entities>Resellers link. Then go under Business Model tab. Assign available brandings to the
reseller.
To know the details about these branding, please go through the following section:
Note: If None option is selected from the branding drop-down list, then branding will not be
applicable for the reseller
8 APRIL 2016
ENSIM CONFIDENTIAL
623
BRANDING CHAPTER 13
Service Provider can set branding for the reseller at the time of creation of that reseller. There are two
types of branding available of resellersa.
Basic Branding -: In case of basic branding, the reseller is given the option to upload three files,
which are all are compulsory to upload. They are namely a CSS file (which contains all the classes
being used in the application and is essentially a copy of the all.css file under the css folder under
the EAS deployment directory), an invoice logo image, and an image to be shown as the banner
image.
b.
Advanced Branding -: In case of advanced branding, the reseller user is given the option to
download a file called defaultTheme.zip containing all the necessary images and CSS from the
Service Providers default theme. The reseller can choose to alter the CSS and change any image,
repack the defaultTheme.zip and upload it to EAS.
Resellers can apply their desired look and feel based on the type of branding set by Service Provider.
The modifications allowed based on Basic Branding are as follows1.
Log in to EAS with reseller login credential.
2.
Select Branding section under the Configuration tab.
3.
Here the portal logo as well as the invoice logo may be altered by uploading an image in .png
format.
4.
Similarly for changes in the CSS, the CSS file needs to be downloaded and after making the
required changes within the file it has to be uploaded back to the same location.
The modifications allowed based on the Advanced Branding are as follows1.
Log in to EAS with reseller login credential.
2.
Select Branding section under the Configuration tab.
3.
Resellers authorized to do advanced branding can always perform basic branding (alteration of
portal logo, invoice logo and modification in CSS) along with changes in icon images and
further alterations in CSS file.
4.
Reseller having advanced branding can download the defaultTheme.zip file which contains
the images and css folder within it. Through the CSS folder, reseller can make changes on the
assigned default branding. In addition, with that from the image folder reseller can change the
icon too. To do so reseller can just select the desired icon and save the same in the image folder
by changing the name. The name of the image must be same as the previous one.
Note: To stop the branding theme synchronizer module, set the Local Branding Theme Folder
Path under the general properties to blank. This will disable the branding synchronization process
among the application servers.

8 APRIL 2016
ENSIM CONFIDENTIAL
624
CHAPTER 14
License Management
Ensim Software License

A software license comprises the permissions, rights and restrictions imposed on software. Licensing is the
practice of leasing a legally protected property. Based on a contractual agreement between the owner of the
property known as the licensor; the user of the property, the licensee, it grants the licensee permission to use
the property.
Ensim also has predefined terms and conditions to manage the lifecycle management and asset
management of EAS (hence Ensim automation suite) which is done by Ensim licensing management policy.
Ensim license management policy include specific terms and conditions which include the purpose of use,
a defined territory, and for a defined time.
Ensim Software License Management Paradigm

There are two types of license key supported by Ensim.
Default License Key : When the EAS is installed for the first time the 'Default License Key' will be applied
automatically. The validity of this license is 90days.
Registered License Key : To use the product beyond 90days the service provider or enterprise need to
apply 'Registered License Key' issued by Ensim.
.
The validity of this registered license key has two characteristic.
Time based validation: Ensim will maintain the following parameters of the applied license to enforce the
time based validation :
Date of license generation
Date of application of the current license
Number of days for which the license key will be valid as issued by Ensim
Uniqueness based validation : Ensim will maintain a unique key for each license key deployed for its
Organizations individually.
At the time of each log in to the EAS application, above two types of validations will be checked.

8 APRIL 2016
ENSIM CONFIDENTIAL
625
LICENSE MANAGEMENT CHAPTER 14
When the license key expiration is nearing its end, notification e-mail is sent to the licensee's registered
primary support contact as well as to the Ensim support team. The notification frequency is gradually
increased from the initial notice until the final notice. If the license key is valid for 365 days (this is
definable by Ensim), the first email may be sent when 60 days are left. The next when 30 days are left, and
the next when 15 days are left, and then 10, 5, 4, 3, 2, 1 days left until the expiration of the license.
Note: This uses same notification and SMTP as normal EAS notifications.

8 APRIL 2016
ENSIM CONFIDENTIAL
626
When the license validity remains 30 days or less, the service provider user can see messages in EAS portal
informing that the license period is coming to an end and also inform about the necessary actions to be
taken.
To renew or apply the license, service provider user having 'Manage License Agreement' right need to go to
License management page.
To renew a license 'Request for License Renewal' button. This will send an email to Ensim Support team.
Ensim will analyze and if appropriate, create a new license key for the licensee with a new specific validity
period as decided by Ensim.
After getting the new license key from Ensim, the service provider having 'Manage License Agreement'
right can apply the license by clicking the 'Apply License' button from License Management Page.

8 APRIL 2016
ENSIM CONFIDENTIAL
627
Note: EAS will provide a license management page under configuration section for service provider to
view the current Ensim license information with renew and apply license options.
If the service provider does not renew and apply a new the license with in the validity period the license
will automatically get expired. In this expiry period, service provider user who does not have 'Manage
License Agreement' right cannot log in to EAS portal and is prompted for contact to support team.
A service provider user who has 'Manage License Agreement' right can only be asked to apply the new
license key obtained from Ensim or request for one. The rest of the system will be inaccessible.

8 APRIL 2016
ENSIM CONFIDENTIAL
628
In license expiry period, log in to the portal will be blocked for all the Resellers, Agents and Organization
users. On login attempt, these users get a message 'License key has expired. Please contact your service
provider'.

8 APRIL 2016
ENSIM CONFIDENTIAL
629
SYSTEM CONFIGURATION
CHAPTER 15
System Configuration
Configuration
About
Configuration-> About tab helps to know the current version of the application and the time zone used in
EAS.
In the Locale, the default language code and the time zone are displayed.

8 APRIL 2016
ENSIM CONFIDENTIAL
630
SYSTEM CONFIGURATION CHAPTER 15
Activities
The Configuration > Activities section in EAS lists the recent activities performed in EAS, such as bulk
organization import, bulk service import, and so on.
The organization name, description, and the logged in user who have set the activity are listed here.
The start time and the end time (when the task is completed) are displayed. The icons depict the
activity status.
The icon
symbolizes that the activity is still running.
The icon symbolizes that the activity has been completed successfully.
The icon symbolizes that the activity has failed.
The search option is also available for the list of activities. User may search by the ID, User, or
Description. User may also search by the status or creation date.

8 APRIL 2016
ENSIM CONFIDENTIAL
631
Address Property Configuration

Address properties (or Address Fields) are used to store address information of Organizations and
Accounts. EAS is capable of making specific address fields mandatory or optional.
By default, these address fields are Optional. The Service Provider can configure the address fields from the
configuration section to make them mandatory. Service Provider user who has Configure address format
permission can configure the address fields.
To configure the Organization and Account address fields, complete the following steps.
1.
Under Configuration, in the left pane, click Address Configuration.

The Address Line Format drop-down list appears, which has the following values.
LINE: It accepts Address as address line 1, Address line 2, City name, City code, State province, Zip
code, and Country.

8 APRIL 2016
ENSIM CONFIDENTIAL
632
FIELD: It accepts address as a specific fields like Apartment number. Floor number, and so on.
2.
To set the mandatory properties for an address field, select the check box under Mandatory.
3.
Click Save to save your settings.
For the address fields, which are set as mandatory in address configuration, the required information must
be provided as follows:
In organization address while creating an organization from Service Provider or Agent.
In master account address while creating an organization from Service Provider or Agent.
In account address while adding an account from Service Provider or Agent.
In organization address while editing an organization from Service Provider or Agent.
In master account address while editing an organization from Service Provider or Agent.
In account address while editing an account from Service Provider or Agent.
While Self-registering an organization.

8 APRIL 2016
ENSIM CONFIDENTIAL
633
Approval Workflow
Approval Workflow allows Service Provider to create approval workflows/templates. Approval
workflows created by Service Provider can only be edited by Service Provider itself. SP created workflows
are globally available to use, unless it is marked as private.
To create a new workflow, follow the steps below1. Click the Add Workflow button and the create or update workflow page appears.
2. Provide the workflow name and description.
3. Private to provider field if enabled, the approval workflow will not be available to Resellers for
use
4. Reject Order field if enabled, then the Service Provider can reject the order associated with this
workflow.
5. A workflow could not be saved without an approval steps in it. Add approval steps to the
workflow as follows:
a. Click Add Step button.
b. Provide the display name and approver type (either Service Provider or Organization). Provide
the user group code, added while creating the user group. Rank needs to be specified which
step to be executed first.
c. If Send email to organization for acknowledgement field is enabled, then mail will be sent to
the BC/TC on execution of that step.
d. The status of approval step is activated if Active field is enabled.
e. Allow approval by agent if the agent is associated with the Order if enabled, agent can
approve the Order.
f. Allow approval by agent if associated with order if enabled, agent can approve that particular
step.
g. Keeps BC and TC into the CC list of the notification field is enable then email will be sent to
BC and TC of the Order.
h. Click +Add button to add the approval step and then click the Save button.
Approval Workflow and the approval steps once added can be edited or deleted later.

8 APRIL 2016
ENSIM CONFIDENTIAL
634
Company
Configuration-> Company tab helps to view as well as edit the details regarding the organization.
Provide value for the mandatory fields such as Organization name, Address, etc. These fields appear on the
Invoice generated for the organizations. The Country, Default Currency, Language and Date Time Format,
etc. mandatory fields must be set.
If the Use reseller model field remains unchecked, the Reseller tab and its related modules would not
appear such as the Reseller pricing, reseller discount, etc. All these features related to reseller would appear
only when this field is checked.
If the Use agent model field were unchecked, the Agent tab and its related modules would not appear
such as the Agent commission, assignment of agent during order, etc. All these features related to agent
would appear only when this field is checked.
After the necessary changes have been made, click the Save Changes button.
Note: Although default currency is being set, it is possible to add other languages and currencies.
Please refer to these respective areas within this chapter for further details.
8 APRIL 2016
ENSIM CONFIDENTIAL
635
Countries
EAS provides a list of country names for flexible use of the application globally.
Country names are enlisted in disabled form and user may enable the required countrys name from this
list. Only the list of activated country names will be displayed in the UI at the time of selecting a country.
To activate the country names, follow the steps below1.
Click the Configuration-> Countries tab.
2.
The list of disabled country names appears at the bottom.
1.
Click the Enable button to activate a particular country name or click the Enable All button to
activate all the country names altogether. Only the enabled country names will be displayed to
users.
2.
Click the Disable button to deactivate a particular country name or click the Disable All button
to deactivate all the country names altogether.
3.
The 2-Letter Code and 3-Letter Code is also displayed. The

symbol denotes that the country
name is in active mode and symbol denotes that it is inactive.
4.
Select for the desired country by selecting the initial at the top of the screen.

8 APRIL 2016
ENSIM CONFIDENTIAL
636
CRM Settings
EAS allows configuring of the application mode from Configuration-> CRM Settings section. Currently
EAS supports three modes of applicationa.
EAS is being used as master CRM with organization self-registration
b.
EAS is being used as master CRM without organization self-registration
c.
EAS is being used as slave CRM without organization creation
EAS is being used as master CRM with organization self-registration- Selecting this mode a Signup button will be displayed to the organization in the Login page.
This sign up button will redirect the user to a signup page where the user can feed their
information. Accordingly, an organization will be created along with a default user. The email
address will be the login name, the password and the activation link for the account will be sent in
the mail.
The Boolean fields under this option allow organization to view the fields in an order as per the
rank. The enabled fields appear to be mandatory in the self-registration form. The disabled fields
will not appear in the form. Service Provider may specify a format or value for Phone number and
Link for Terms & Conditions. There is a URL for terms & conditions on the self-registration page
for services made available to Organization users from EAS.
EAS is being used as master CRM without organizations self-registration- Selecting this mode
allows the Service Provider to create organizations and their users and provide the credentials to
the organizations. Based on the permissions, organizations can also add users under that
organization.
EAS is being used as slave CRM without organization creation- On selecting this mode user
cannot create new organization/reseller/agent through EAS application.

8 APRIL 2016
ENSIM CONFIDENTIAL
637
Bulk Organization and Account Import

Overview
To import existing Organizations and Accounts (under those organizations) of other system in the EAS,
this Bulk Organization and Account Import procedure is used. This procedure is carried out using a
CSV file. This CSV file contains all the detail informations about importable organizations and
accounts. Irrespective of the hierarchy followed in the other system, when those organizations and
accounts are imported in the EAS, then those organizations and accounts are fitted in the EAS
hierarchy.
Bulk Organization and Account Import procedure is performed by browsing a CSV file and also able to
provide a specific path of the CSV file location. This file contains number of fields. We can schedule the
job of import operation on a particular date and time, so on that particular scheduled date and time
import job will be carried out. Also this procedure allows to cancel import jobs in between its execution
procedure i.e., if an import job starts execution and in between if a cancel call appears then the
procedure will stop execution at that point. After completion of import procedure, if the external system
still running in its own way, then in the next time, if any kind of change made in an already imported
Organization or Accounts then, the procedure will read the CSV file and update the details of the
Organization or Accounts with new entries. Update process only carried on Organization/Account
name or on address fields.
Pre-requisite for CSV file creation
To create a CSV file to import Organizations and Accounts we need to follow the given below points:
1. To create a CSV file we have to use the specific field name mentioned in this document as the
header name in our CSV file no matter how you arrange the fields. All the fields in the CSV file will
be separated by a comma operator; in case you do not want to give any value for a field then you
must have to put a space between two comma operators otherwise import operation will not be
processed for that particular row and also for its effected row(s) if any present.
2.
To import an Organization need to provide organizationName and organizationId, and to import

an Account need to provide accountName and accountId in the CSV file.
3.
DNS import procedure:

a.
If the external CRM system follow a flat organizational structure like Org1 (DNS:
org1.com), Org2 (DNS: org2.com), Org3 (DNS: org3.com) then when these organizations are
imported in EAS then all Organizations are created under service provider with respective
DNS.
b.
If the external CRM system follow a flat organizational structure like Org1 (DNS :
org1.com) parent of Account1 (DNS : account1.com) and Account2 (DNS : account2.com)
then when these Organization and Accounts are imported in EAS then Org1 will be created
with three DNS org1.com, acconut1.com, account2.com, under this organization Account1
and Account2 will be created.
c.
If the external CRM system follow a flat organizational structure like Org1 parent of
Account1 (DNS : account1.com) and Account2 (DNS : account2.com) then when these
Organization and Accounts are imported in EAS then Org1 will be created with two DNS
acconut1.com, account2.com, under this organization Account1 and Account2 will be
created.

8 APRIL 2016
ENSIM CONFIDENTIAL
638
d. If the external CRM system follow a flat organizational structure like Org1 (DNS :
org1.com) parent of Account1 (DNS : account1.com) and Org2 (DNS : org2.com) parent of
Account2 (DNS : account1.com) then when these Organizations and Accounts are imported
in EAS then Org1 will be created with two DNS org1.com, acconut1.com and Account1 will
be created under this Org1 and also Org2 will be created with one DNS org2.com and
Account2 will be created under this Org2, but DNS account1.com of Account2 will not be
added in Org2 because that DNS already registered under Org1.
4.
AD entry procedure:
a.
If UPN Suffix for AD is provided in the CSV file then with that UPN Suffix an AD entry
will be created.
b.
If the external CRM system follow a flat organizational structure like Org1 (DNS :
org1.com) parent of Account1 (DNS : account1.com) and Account2 (DNS : account2.com)
then when these Organization and Accounts are imported in EAS then Org1 will be created
with three DNS org1.com, acconut1.com, account2.com, under this organization Account1
and Account2 will be created, but in Active Directory (AD) only one entry will be created
with DNS org1.com and other two DNS will be ignored because EAS system supports only
one AD entry.
c.
If the external CRM system follow a flat organizational structure like Org1 parent of
Account1 (DNS : account1.com) and Account2 (DNS : account2.com) then when these
Organization and Accounts are imported in EAS then Org1 will be created with two DNS
acconut1.com, account2.com, under this organization Account1 and Account2 will be
created, but in Active Directory (AD), at the time of Org1 creation, a system generated AD
entry will be created i.e., a fake entry and after that when Account1 will be created, under
this Org1, at that time this fake entry will be replaced with DNS account1.com.
5.
First time we need to create a payment agreement as default for Service Provider. Now at the time
of importing all Organizations and Accounts comes under Service Provider should use this default
payment agreement.
6.
At the time of Reseller creation we add a payment agreement that payment agreement use as
default payment agreement for imported Organizations and Accounts under Reseller.
7.
At the time of importing an organization need to provide masterAccountName and

masterAccountId if that organization have different master account ID else leave this column in
CSV file blank. If masterAccountName and masterAccountId is provided then with that ID a new
account will be created else a master account will be created with organization ID.
8.
At the time of importing an organization need to keep parentId filed in CSV file blank.
9.
To import an Account need to provide the organizationId, under which that account resides, in the
parentId filed in CSV file.
10. No need to provide any data in resellersId filed in CSV file if the Organization resides under ISP.
11. If the Organization comes under a reseller then need to provide specific reseller ID in resellersId
filed in CSV file.
12. At the time of importing an Account no need to provide any data, keep resellersId filed blank in
CSV file.

8 APRIL 2016
ENSIM CONFIDENTIAL
639
13. For importing an organization no need to provide any data, keep billableToAccountId filed blank in
CSV file.
14. For importing an Account no need to provide any data, keep billableToAccountId filed blank in
CSV file, if that account is a billable account.
15. For importing a Service Account need to provide ID of a billable account, under which this account
consider as service account, in billableToAccountId filed in CSV file.
Follow the steps below for bulk organization and account import:
1. Click Settings->Configuration tab.
2.
Click CRM Settings menu.
3.
Import procedure can be performed in two waysa.
Provide the CSV path, username and password and then click Update button.
b.
Click Import Orgs button and upload the CSV file through the Import
Organization wizard. Import job can be scheduled through this wizard on a
particular date and time.

8 APRIL 2016
ENSIM CONFIDENTIAL
640
4.
Click the List Jobs button in the import job status window to view the list of import job details.
a.
Click List button to get the action log details of a particular job.
b.
Click Stop button of a running job to suspend the import task.
c.
Click Resume button of a suspended job and provide date and time and click Update
button to resume.

8 APRIL 2016
ENSIM CONFIDENTIAL
641
Currencies
EAS supports multiple currencies for flexible use of the application globally.
Currencies can be added in EAS depending on the country where this application is currently being used.
To add a new currency in EAS, follow the steps below
1.
Log in to EAS as Service Provider.
2.
Click the Configuration-> Currencies tab.
3.
Click the Add New button to add a new currency.
a) Fill the required details such as name of the currency, code, symbol and exchange rate. The
Active Boolean filed reflects whether a currency is active or not. If the Display currency
code in pricing field is checked then at the time of setting price, the currency code gets
displayed.
b) In EAS, the currency symbol gets reflected in order page. If the currency symbol coincides
with some other country, then currency gets reflected along with the currency code.
For example- $ is used by two countries- United States and Australia. To differentiate
between the two currency symbols, the currency code is used along with it. Such as, for
United States the currency symbol will be USD$ and for Australia the currency symbol will
be AUD$.
8 APRIL 2016
ENSIM CONFIDENTIAL
642
c)
Click the Save Changes button to add the new currency to EAS application successfully.
d) Set any of the existing currency as default currency as per the requirement.
e) After setting the default currency, click the Save Changes button to save the changes.
To edit currency follow the steps below1.
2.
3.
Select one of the Boolean fields against each currency to make the currency available for editing.
After selecting a particular currency, click the Edit button.

Make the required changes and click the Save Changes button.
Custom Fields
Custom fields are used to store additional information. EAS supports custom fields only for Organizations,
Items, Offers and Orders.

8 APRIL 2016
ENSIM CONFIDENTIAL
643
By default, these custom fields are not visible in EAS UI. The Service Provider needs to enable and configure
the custom fields from the configuration section.
In the configuration page, on the left side menu panel, a menu called Custom Fields will get
displayed for global configuration of the custom field.
1. On the right side, a tab panel with four individual tabs appears(Organization, Item, offer and
Order). The second tab is named Item. Item tab is used to set the custom field feature for Item
creation form.
2. Item tab contains information about the Item custom field. These fields are:
a. Rank for setting the order of the custom field in Item entry form.
b. Enable: It enables the custom field for the item entry form.
c. Mandatory: This sets whether the custom field is mandatory or not.
d. Export to: This sets whether this custom field will be added on the exported files or not. Using
this field, Service Provider may also set which of the custom fields gets displayed in the
invoice.
3. Selected Item custom field will be appear in Item form under general tab under custom fields
heading. Note that only enabled checked field will be appear.
Service provider can change the rank of the appearance of the custom fields from configuration. The
Custom fields will be displayed as per the ranks on the Item form.
By default, the names are displayed as Custom Field 1, Custom Field 2, and so on. These names can be
modified from message.properties file. EAS provides twelve additional custom fields for items.

8 APRIL 2016
ENSIM CONFIDENTIAL
644
Dashboard properties
After logging in to EAS, the Support and News info gets displayed on the Dashboard. This section under
Configuration tab allows configuring the dashboard fields like News URL, Support URL and Dashboard
URL for each language.
In case URL is not provided, user can add their custom text. To add a text, user needs to follow the steps
belowi. Open the messages.properties file. The path is \webapps\<order>\WEB-INF\grails-app\i18n.
ii. To alter the text for Support, change the value of dashboard.display.support.content label.
iii. To alter the text for News, change the value of dashboard.display.news.content label.
iv. The dashboard will display information according to this content.
In case, a URL is provided for support and news in Configuration -> Dashboard Properties section, its
contents will be displayed accordingly. . See the figure below to add new URL for different language :-
After adding the said URL, it looks like-

8 APRIL 2016
ENSIM CONFIDENTIAL
645
DNS Settings
The DNS Settings menu appears only when Manage DNS Configuration right is assigned to the Service
Provider in the Super Admin role. Whether organization users will be allowed to add DNS by themselves
or not is decided by the Service Provider from the Configuration-> DNS Settings section.
If the Allow Organizations to add domain name field is checked then the organization users will be able
to add domain names for their own organizations. The Service Provider needs to provide at least one IP
address as DNS Query Resolver. It is recommended to provide two IP addresses, so that if one of the
resolvers fails to function, the other enables the DNS verification. To verify domain name entered by the
organization user, there must be an existing entry in the server (IP of DNS Query Resolver). If the domain
name matches with the existing entry in the server, only then the status changes to verified.
General properties
This link under 'Configuration' menu is used for modifying values of different properties of the EAS
application like Required field color, Browsing Window option etc.
Follow the steps below to changing different property values of the EAS application Click the 'Configuration-> General Properties tab.
General Properties form will open where property values can be changed.

8 APRIL 2016
ENSIM CONFIDENTIAL
646
Edit each property field value as per requirement. To edit a property value, click any of the
property names. An editable block will open up at the right side of the page.
The property name and its required descriptions are mentioned belowi. Application Mode: EAS supports two application modes, Synergy and SEAP mode.
Synergy is the generalized mode of application whereas SEAP is organization specific
mode of application. The default value will be Synergy, which is an editable field from
the synergy-Config.groovy file.
ii. ESOM Integration Mode: This field is used for synchronization between EAS and
ESOM. It can have three values: 0 (Not Integrated), 1 (Integrated without password sync),
2 (Integrated with password sync).
0 (Not Integrated) means EAS is not integrated to ESOM.
1 (Integrated without password sync) means after an user is provisioned in ESOM

from EAS, the user password will sync for the first time while provisioning in ESOM
if it matches the AD password policy, from next time onwards like reset or change
password it will not sync with AD. In this case if the EAS password does not match
the AD password policy, user will not get created in AD, hence will not be created in
ESOM.
2 (Integrated with password sync) means while provisioning an user from EAS to
ESOM, the user password will get synced with ESOM if it matches the AD password
policy, also when the password is reset or changed in EAS then the password will be
updated in ESOM end besides the AD password policy needs to match.

8 APRIL 2016
ENSIM CONFIDENTIAL
647
iii. Primary email ID uniqueness value: EAS supports uniqueness of primary email ID. If
the value for this field is set as 0, then the primary email ID can be duplicated. If the
value for this field is set as 1, then the primary email ID can be duplicated with a
warning. If the value of this field is set as 2, then the primary email ID cannot be
duplicated.
iv. Active directory upn-suffix for organization: To auto-generate the Active Directory upnsuffix name for organization.
v. Blackhole email address: For organizations created at ESOM, this email address should be
used as a black hole, i.e., these organizations will not receive any welcome notifications if
the black hole email is set as ESOM email..
vi. ESOM Access URL: This is the URL through which we can access the ESOM control
Panel.
vii. ESOM Provisioning API Username: This value should always be the ESOM Service
Provider Admin Username that is used to access the control panel.
viii. ESOM Provisioning API Password: This value should always be the ESOM Service
Provider Admin Password that is used to access the control panel.
ix. BSS Connector Subscription Management URL: The URL of Unify BSSConnector for
subscription management.
x. BSS Connector Organization Management URL: The URL of Unify BSSConnector for
organization management.
8 APRIL 2016
ENSIM CONFIDENTIAL
648
xi.
BSS Connector User Management URL: The URL of Unify BSSConnector for user
management.
xii.
Application Wide Shared Folder Path: The samba share folder location for branding is
provided in this section.
xiii.
Application Share Domain: If the share is hosted on Windows Server, specify the
Domain Name.
xiv.
Application Share Username: The username to access the SMB share specified in
Application Share Folder Path.
xv.
Application Share Password: The password to access the SMB share specified in
Application Share Folder Path.
xvi.
Online Help URL: EAS supports online helps for each type of user (Service Provider,
Reseller, Agent and Organization). To set the different online helps for the different users,
follow the stepsa) Go to the location /<location of the tomcat folder>/webapps/<application folder
name>
b) Create a new folder within this application folder named onlinehelp.
c)
Within this onlinehelp folder, create four new folders. Lets name them as-Service
Provider, Reseller, Agent and Organization.
d) All the html book files must be dumped within the corresponding folders.
e) After this, set the online help URLs for different type of users within the EAS
application, as mentioned below
Organization Online Help URL: Service Provider can set a help URL in this field.
f) Restart the tomcat server.

g)The corresponding help files can be viewed by clicking the help button displayed in the
application after successful login as Service Provider or Agent or Reseller or
Organization.

8 APRIL 2016
ENSIM CONFIDENTIAL
649
xvii.
Storage Location for Uploaded Usage File: The CSV file accepted by Usage importer tool
is browsed from client machine. The back-up of that CSV file is stored in this specified
path.
xviii.
Browsing window option: This option allows the external URL to open in a new browser
window by default.
xix.
Max Size of Zip File (KB): Value of this property field is the maximum size of the zip file
to be uploaded for advanced branding. If the size of the zip file exceeds the mentioned
value, then branding will not be applied. Here we have set the value as 15000 (kb).
xx.
Required field color: From the above figure see the value for this property field is 'red'. If
the value is changed from 'red' to 'blue' or 'green' or any different color then in the
required field the strings will be shown according to the value of this property.
xxi.
External Application URL: This represents external login URL of your portal. This is also
used in notification to users. Ensure that the URL is accessible externally. It is mandatory
that this URL must ends with /login/auth. The URL includes the Application Server IP
or Host name, Port and Application folder name.
For example: The URL must contain http://<IP address/host name>:<port
number>/<application folder name>/login/auth
While configuring the body of the notification mail, add the parameter Link to view the
Order from Order Parameters. This allows sending an order link through email to
Business Contact and Technical Contact.
The first part of the order link contains this Application Context URL and the rest is auto
generated by the system. After these fields are set, the order link will be sent through the
mail address against any action with order to the Business Contact and Technical
Contact. Clicking the order link redirects user to the edit order screen. User can modify or
perform their desired operations directly.
Note: Port number 80 must be omitted.
xxii.
Organization Address Format: This field used for Address Format. It can have two
values 1. LINE (It will accept address as address line 1, address line 2 format) 2.FIELD (It
will accept address as specific field).
xxiii.
SSO Generation Tool Path: A jar is executed for the generation of SSO Token and its
path is specified as the value of the property name SSO Generation Tool Path under the
Configuration -> General Properties section. By default, we have used the application
folder name as order.

8 APRIL 2016
ENSIM CONFIDENTIAL
650
In case the application folder name is changed, we need to specify the path accordingly.
xxiv.
Additional Menu Required: This field is used for adding an additional menu in the
menu bar (such as Resource menu). It can have two values: 0 (No additional menu
required) and 1 (Additional menu required).
xxv.
Link for dynamic content URL: Dynamic content URL used in log-in page.
xxvi.
Enable Ticketing System: This field is used for enabling Ticketing System. It can have
two values. 0 (Disable Ticketing System) and 1 (Enable Ticketing System).
xxvii.
ESOM Service Provider Admin Role: Role name that is created at ESOM end with
Service Provider admin rights. Make sure the name in ESOM and EAS are same.
xxviii.
xxix.
ESOM Organization Admin Role: Role name that is created at ESOM end with
Organization admin right. Make sure the name in ESOM and EAS are same.
Organization admin limited role: This type of admin have limited privilege in ESOM.
This role must exist in ESOM.

8 APRIL 2016
ENSIM CONFIDENTIAL
651
IDM Configurations
The Identity Management (IDM) Policy is a method of identifying the members of a community to access
the electronic data resources. This requires collecting and maintaining identifying attributes, ensuring that
electronic identities match the appropriate persons. This also includes the mechanisms to authenticate and
authorize the use of those identities.
This policy applies to everyone with an identity included in the identity registry, as well as individuals
authorized to perform identity management (IDM) functions.
The IDM policy can be implemented in either of the two possible options - Local and Non-Local.
In both the cases (local and non-local IDM policy), the user IDs are stored in the local database. However,
the password is supplied to the user remotely in case of non-local IDM policy, whereas the password is
available locally when a user uses the local IDM policy.
In case of the Local IDM Policy, if the auto-generate password field is enabled, by default a password is
provided to the users through the User Activation Email.
However, if the auto-generate password field is not checked, then the user must provide a password for the
account and hence, no activation mail is sent.
In case of the Non-local IDM Policy, the user cannot provide any password for the account and hence, a
User Activation Mail is sent to the user.
The IDM Configuration page contains the following tabs:
General: On this tab, the user can set the URLs for logout and Catalog advertisement. If no log-out URL
is specified in the Logout URL field, the URL set under the General tab is used as the default log-out
URL.

8 APRIL 2016
ENSIM CONFIDENTIAL
652
Hence, in the local IDM policy, a user can reset, regenerate, or change password if he/she has the
proper authorization to do so. When a user performs the change password action, he/she is
redirected to a separate window locally where he/she can change his/her current password.
However, if the Use local IDM policies field is unchecked, that is, when there is no local IDM
policy, the following actions cannot be performed by the user, as their passwords are managed
remotely:
The Change Password URL tab appears. In EAS, the global change password option has been
removed.
Notification mail is sent on performing reset and regenerate password actions to the users email
address.
It is recommended that you disable the corresponding notification templates (Reset User Password
template-for reset password and Regenerate User Password template-for regenerate password), so
that no unnecessary and confusing email is sent to the user. In non-local IDM policy, the change
password URLs must be provided to perform the change password action. In this case, the user is
redirected to the URLs provided in the change password fields and passwords are being changed.
The change password URL format is the same as the logout URL.
The Organization Landing Page field denotes that after logging in, the organization user is
redirected either to the Dashboard UI or to the Catalog UI as set in this field.
Local IDM Policy: This section allows setting and configuring local IDM policies.

8 APRIL 2016
ENSIM CONFIDENTIAL
653
The user can set the value of the following fields related to IDM:
Login username length: Here, the length of the username can be restricted by providing a
minimum and maximum range of the number of characters allowed in the given username.
Password Setting: Like username, set the length of the password as well in this section with the
following additional rules:
a. At least 1 special character: The password must contain at least one special character (! %, $
and so on).
b. At least 1 upper case: The password must contain at least one upper case letter.
c. At least 1 lower case: The password must contain at least one lower case letter.
d. At least 1 digit: The password must contain at least one digit.
Note: If ESOM integration mode is set to 2, the AD password policy set in ESOM must be
matched with the password policy setting done by the Service Provider at the EAS end.
Send email notification to the user when user password is reset: If this field is selected, an
email notification is sent to the user email ID after his/her password has been reset.
User account need activation by Email: If this field is checked, a user activation mail is sent
to the user with the credentials and activation token. Selecting this field allows the autogeneration of password during new user creation.
Auto-generate password during user creation: On selecting this field, password is auto
generated during user creation.
Prompt user to set security question and answer at every login, if not set: If no security
question is set during user creation, selecting this field prompts the user to set it every time
he/she tries to log in.
Force user to change password at first login, if user not set own password: On first log in,
the user is forced to change his/her password if he/she has not set his/her own password.
User login name format: User login name format can be configured with the following set
of rules:
Use regular expression with service domain as suffix in user login name: On selecting
this field, a section appears where the admin must set the regular expression for the login name (as shown in the above figure).
Use the primary email ID as the user login name: The user's primary email ID is used
as the user log-in name.
User activation mail is sent to the user, irrespective of the Local or Non-local IDM policy.
However, the Boolean fields in the local IDM policy tab can be edited only if use local IDM policy
is checked.
If both User account need activation by Email and Auto generate password during user creation
fields are checked, then the user is created in a deactivated state. Hence, the activation mail is sent
to the user with the username and password. The user has to click the link to activate his/her
account.
In the other cases, the user is created in activated state and the activation mail with username and
password is sent to the user.

8 APRIL 2016
ENSIM CONFIDENTIAL
654
Login URL: In this section, the login URL can be set for different user levels, such as Service Provider,
Agent, Organization, and Reseller.
The Log-In URL set in this field is sent to the user through the user activation link based on the priority.
For example, the Log-In URL for Service Provider is considered as high priority and the email is sent to
the Service Provider and their Organizations to access the portal.
For a Reseller and its Organizations, first priority is the Customized Login URL (if set) of the Reseller,
followed by the Log-In URL set for the Reseller. If the Log-In URL is not present, the Organization LogIn URL is sent in the user activation email.
Logout URL: Under this section, the logout URL can be set for different user levels, such as Service
Provider, Agent, Organization, and Reseller.

8 APRIL 2016
ENSIM CONFIDENTIAL
655
Note:
Internally versus Externally managed users: EAS now clearly distinguishes between users whose
credentials are managed internally in EAS versus users whose credentials are managed externally in
another IDM system and integrated with EAS as prescribed in the Back Office System Integration
Guide. If the user is tagged to be managed via an external IDM system, EAS UI functions like change
password will be hidden or greyd out. Note: This is on a per User not per Org basis. Admin users of
an Org may be managed via the external system, while end users of the Org may be managed
internally via EAS.
Overview of Identity Management in EAS

EAS has the most advance, granular, and comprehensive User Management of any BSS/OSS in the market.
Moreover, while it is easy to use from the web based portal, and preconfigured out of the box for almost
immediate use, the sheer number of options to support almost any User Management configuration will
need explanation for those wishing to take advantage of these advanced functions.
There are two basic modes of operation of EAS, Service Provider and Enterprise. These are served from the
same binary, and same message.properties file (naming file), but could be configured differently at
deployment based on the desired goals. Service Providers may sell direct, via commissioned Agents, via
Resellers or Distributors, or via all channels, while some Enterprises may act as a Service Provider from
their centralized IT department and resell to subsidiaries, business units, or operate as a single entity and
just want to track cost by departments and users.
EAS separates Users (identity), Role (scope of rights), and Entity (unit to which a user is a member) and
allows a great deal of flexibility in both breadth and depth of configuration. EAS employs complete
isolation of entities and is fully multi-tenant. However, it can be configure to allow limited rights across
entities if so desired by the Service Provider. This unique capability opens up many creative business and
management opportunities.

8 APRIL 2016
ENSIM CONFIDENTIAL
656
The following table defines some terms used throughout the document.
Entities
Service Provider mode
Enterprise mode
Service
Provider
A Service Provider is a company that

provides Organizations with hosted
applications on rent with technical support
and consultation. Service provider invoice
the organization for the services they buy.
Reseller
A Reseller is effectively a partner of

Service Provider who resells the services of
the Service Provider. A Reseller will have
the rights to define price of the products
and services but uses the IT infrastructure
of the Service Provider for Order
management. In EAS, conceptually
Resellers are of two types
1. Type1: Those who can create
Offers
2. Type2: Those who can only sell
Offers assigned to them.
In an Enterprise, the centralized IT

department provides services to the
employees. In general, there is no invoicing
but the IT department may need to
chargeback the consumers for budgeting
purposes.
In a very large Enterprise, a Reseller may
be the decentralized IT Departments
belonging to each business unit of the
Enterprise. For example, in case of a
University, each campus could be a
Reseller catering to the departments of that
campus. In a medium or small Enterprise,
the Reseller model may not fit well for
provisioning and budgeting.
Organization
An Organization buys the products and

consumes the services offered by the
Service Provider or Resellers and invoiced
for the same. A large organization may
hold multiple Accounts in the system, one
for each business unit.
Account
An Account is a logical unit under an

Organization and typically a
billable/chargeable entity. A default
Account is created for each organization.
The Account entity is used for logical
tracking of Orders.
Agent
Agents are external companies helping the

Service Provider sell the products to direct
organizations. Agents receive commission
based on rules set by the Service Provider.

8 APRIL 2016
In an Enterprise, the entire company may

be laid out as one or more Organizations.
While a large Enterprise with many
centralized branches or business units
could be implemented with as many
Organizations, it is also possible to
implement the model with one
Organization with many Accounts.
In an Enterprise, the entire company can be
implemented as
1. Each business unit as one
Organization with multiple
Accounts under them; suitable for
large Enterprises
2. Only one Organization and all
departments as Accounts; suitable
for medium or small enterprises
In an Enterprise scenario, an Agent could
be an external consulting company
employed by the IT Department to setup
and deploy the IT service infrastructure for
the employees of the enterprise.
ENSIM CONFIDENTIAL
657
Import Service Users

The tool under the tab Configuration-> Import Service Users can be used to import service attributes of
users that were provisioned outside of EAS. In order to use the tool, ensure that the following prerequisites
are met1.
The user identities exist in the platform. This tool cannot create user identities. Please use the tool
'Import Users' to create user identities in the platform irrespective of service means no service will
be assigned to the user using this tool.
2.
The relevant Service connector installed in the system has User migration feature implemented.
Depending on the implementation, the Connector against the live server (that hosts the application user)
may validate the CSV data before accepting the same.

8 APRIL 2016
ENSIM CONFIDENTIAL
658
Languages
Configuration-> Languages tab helps in setting different languages for the EAS application. By default,
registered language is 'English (US)'.
Before adding a new language to the EAS, the corresponding message property file must be placed in a
specific location under the top-level application folder.
The corresponding message property files for different languages are mentioned below for reference Language
Dutch
French
Message property file

messages_nl_NL.properties
messages_fr_FR.properties
Place the message property file of the language you want to read in the EAS application at the location:
\apache-tomcat-7.0\webapps\<top level application folder>\WEB-INF\grails-app\i18n
If user wants to register (add) additional languages other than 'English' then the below mentioned steps are
to be followed:1.
2.
3.
Click the Configuration-> Languages tab.

The list of languages get displayed.
Click 'Add New Language' button to register a new language.
4.
Add new language page opens, where the required details are to be filled..

8 APRIL 2016
ENSIM CONFIDENTIAL
659
Id: Auto generated language id.
ISO639 Code: It is a standardized nomenclature used to classify all known languages. Each
language is assigned a 2-letter (639-1) and 3-letter (639-2 and 639-3), lowercase abbreviation,
amended in later versions of the nomenclature.

8 APRIL 2016
ENSIM CONFIDENTIAL
660
ISO 639:2 letter codes

AA Afar
AB Abkhazian
AF Afrikaans
AM Amharic
AR Arabic
AS Assamese
AY Aymara
AZ Azerbaijani
BA Bashkir
BE Byelorussian
BG Bulgarian
BH Bihari
BI Bislama
BN Bengali Bangla
BO Tibetan
BR Breton"
CA "Catalan"
CO "Corsican"
CS "Czech"
CY "Welsh"
DA "Danish"
DE "German"
DZ "Bhutani"
EL "Greek"
EN "English" "American"
EO "Esperanto"
ES "Spanish"
ET "Estonian"
EU "Basque"
FA "Persian"
FI "Finnish"
FJ "Fiji"
FO "Faeroese"
FR "French"
FY "Frisian"
GA "Irish"
GD "Gaelic" "Scots Gaelic"
GL "Galician"
GN "Guarani"
GU "Gujarati"
HA "Hausa"
HI "Hindi"
HR "Croatian"

8 APRIL 2016
HU "Hungarian"
HY "Armenian"
IA "Interlingua"
IE "Interlingue"
IK "Inupiak"
IN "Indonesian"
IS "Icelandic"
IT "Italian"
IW "Hebrew"
JA "Japanese"
JI "Yiddish"
JW "Javanese"
KA "Georgian"
KK "Kazakh"
KL "Greenlandic"
KM "Cambodian"
KN "Kannada"
KO "Korean"
KS "Kashmiri"
KU "Kurdish"
KY "Kirghiz"
LA "Latin"
LN "Lingala"
LO "Laothian"
LT "Lithuanian"
LV "Latvian" "Lettish"
MG "Malagasy"
MI "Maori"
MK "Macedonian"
ML "Malayalam"
MN "Mongolian"
MO "Moldavian"
MR "Marathi"
MS "Malay"
MT "Maltese"
MY "Burmese"
NA "Nauru"
NE "Nepali"
NL "Dutch"
NO "Norwegian"
OC "Occitan"
OM "Oromo" "Afan"
OR "Oriya"
PA "Punjabi"
PL "Polish"
PS "Pashto" "Pushto"
PT "Portuguese"
QU "Quechua"
RM "Rhaeto-Romance"
RN "Kirundi"
RO "Romanian"
RU "Russian"
RW "Kinyarwanda"
SA "Sanskrit"
SD "Sindhi"
SG "Sangro"
SH "Serbo-Croatian"
SI "Singhalese"
SK "Slovak"
SL "Slovenian"
SM "Samoan"
SN "Shona"
SO "Somali"
SQ "Albanian"
SR "Serbian"
SS "Siswati"
ST "Sesotho"
SU "Sudanese"
SV "Swedish"
SW "Swahili"
TA "Tamil"
TE "Tegulu"
TG "Tajik"
TH "Thai"
TI "Tigrinya"
TK "Turkmen"
TL "Tagalog"
TN "Setswana"
TO "Tonga"
TR "Turkish"
TS "Tsonga"
TT "Tatar"
TW "Twi"
UK "Ukrainian"
UR "Urdu"
UZ "Uzbek"
VI "Vietnamese"
VO "Volapuk"
WO "Wolof"
XH "Xhosa"
YO "Yoruba"
ZH "Chinese"
ZU "Zulu"
ENSIM CONFIDENTIAL
661
Language Code: Language code contains two parts - language code (fr) and country code
(FR), as one language can be used by multiple countries.
Name: This is the name of the language that will be displayed on the UI.
Provisioning Language: These are the languages that are already registered in the ESOM.
UI Presentation: In this Boolean field if 'Allowed' option is selected then the language will
be used for UI presentation but if 'Not Allowed' option is selected it will not be available
for the UI presentation.
After putting all the required data, click the 'Save Changes' button to complete the language registration
process.
For further details on language setting, refer to language pack installation in EAS 4.2 Installation Guide.

8 APRIL 2016
ENSIM CONFIDENTIAL
662
License
A software license comprises of permissions, rights and restrictions imposed on software. Licensing is the
practice of leasing a legally protected property. The Configuration-> License tab allows the user to view
the license period and the validity date. Service Provider may apply for license renewal 15 days before
expiry, because once the license expires portal login will be blocked for all types of users.
To apply for license renewal, follow the steps below1.
Click the Configuration-> License tab and the license renewal page appears.
2.
Click the Request for License Renewal button and the request will be sent.
3.
The user will receive an Email from the support team with the license key.
4.
Click the Apply License button and provide the license key. Click the Apply Now button to
renew the license.

8 APRIL 2016
ENSIM CONFIDENTIAL
663
Marketplace Configuration
Ensim Cloud Marketplace (ECM) is a WECEEM Content Management System that creates separate
marketplace site for each provider to help increase business. Providers can manage content and style their
marketplace sites to attract users by providing them a better buying experience.
To activate the marketplace for the Service Provider following steps must be performed:
1.
2.
Click Configuration->Marketplace Configuration tab.

Check Use Marketplace (Weceem) to activate. By default, the configuration is unchecked.
3.
4.
After the checkbox is selected and saved, the Create Marketplace button appears.
On clicking the button, a new window appears. Put suitable name for marketplace and choose a
template.

8 APRIL 2016
ENSIM CONFIDENTIAL
664
5.
Click Save button to create the space.
Note: Once the button called Create Marketplace is clicked, space for marketplace will be created and
the button disappears. The button will reappear when the Marketplace is deleted.

8 APRIL 2016
ENSIM CONFIDENTIAL
665
Notifications Templates
Email notification is nothing but sending emails to the concerned person after completion of certain actions
such as order provisioning, user activation, new organization created, etc.
The steps to configure Email notifications are as follows4.
Log in to the EAS as an admin user.
5.
Go to the Configuration-> Notification tab.
To configure the notification settings click the

icon. This icon enables the configuration page for the
user. Here the SMTP Setting, Address setting, Set default body, Enable all, Disable all, Download
templates and Import templates buttons will be available.
SMTP Settings
To send these notification emails from the EAS application portal, set the SMTP configuration with
proper set of values by the following ways1.
2.
Click the 'SMTP settings' link.

A pop up window will open up where user have to set the SMTP host name, SMTP port
number, username, password etc. and some other fields with proper set of values.
Host name of the SMTP server: Provide the Host name of the SMTP server.
SMTP port number: Provide the SMTP port number.
Default sender's address: Default email id from where the email notification will be sent to
the concerned person's email id after completion of certain action under a notification
category like orders.

8 APRIL 2016
ENSIM CONFIDENTIAL
666
Default sender's name: Provide the name of the default sender.

To send an authenticated mail, check the Authentication required field and provide the
user name and password for the host. This will provide privacy to the mail and only the
authenticated user can access it.
TLS required: This field allows sending mail notification from different mail servers.
When this field is checked, make sure Authentication Required field is also checked as in
order to send mail notification from different mail servers, authentication is mandatory.
Note: Other fields like Username for host authentication and Password for host authentication
are optional as these fields are required only when the SMTP connection is secure and trusted.
When the values for Username for host authentication and Password for host authentication
are provided, the field Authentication required must be checked.

8 APRIL 2016
ENSIM CONFIDENTIAL
667
Email Signature
Another important feature supported by EAS is Email Signature. This feature is available under
Configuration-> Notification Templates link.
This feature allows all types of entities to set their respective signature to their corresponding notification
templates.
A newly added macro called signature is available which needs to be added with the template body in
order to add the signature with the email template. Actual signature value will be displayed in place of this
signature macro variable when the email notifications will be sent to the recipients email address.
Address Settings
This field is used to set the sender's address for all the templates of the selected category. If the value for
this field is set as blank then sender's address will be set to default value sender's address that is
configured in the SMTP settings.
Set Default Body

In case if any Subject and Body is not added for the template in a category, click the 'Set Default Body'
button. This button is used to set a default body and subject for all the templates within a category that
are not being set by the user.
8 APRIL 2016
ENSIM CONFIDENTIAL
668
Clicking the Set default body button, a confirmation message window opens up confirming whether a
default subject and body are to be set for all the templates. Click 'OK' button to continue.
Enable All or Disable All

The notification template generally remains in a disabled mode. A disabled template cannot be used for
sending notification email. To activate a particular template, follow the steps belowProcedure 1:
1. Click the 'Enable' button, on the right side of the template list section.
2. That particular template will be activated.
3. Similarly, to disable the template, click the 'Disable' button.
Procedure 2:
1. Select the category and click the template. The details of that template appears.
2. Click the 'Edit' button. User will be redirected to the 'Edit Notification' screen.
3. Check the 'Active' field on the top left of the page and click the 'Save' button.
4. A message window appears saying the notification have been saved successfully. Hence, the
template becomes active and this template can be used for notification emails.
5. Similarly, to deactivate, uncheck the 'Active' field and click 'Save' button.
Procedure 3:
1. In case user wants all the templates of a category to be activated, click the 'Enable All' button.
8 APRIL 2016
ENSIM CONFIDENTIAL
669
2. Similarly to de-activate all the templates of a category, click the 'Disable All' button.
Note: In this case, a template must be saved at least once to make its status active.
Import/Download notification templates

To import bulk amount of templates in xml format for a particular category, click the
(import) icon.
This action will lead to replacement of the existing templates and their respective details.
Choose the desired file for importing. Once done, click the import button.
To download all the templates of the selected category click the
will be stored in xml format.
To download a particular template click the
(download) icon. The templates
icon placed at the right side of each template.
There are eight notification categories available in this version (4.0) of EAS application. They are1.
Orders

8 APRIL 2016
ENSIM CONFIDENTIAL
670
2.
3.
4.
5.
6.
Trials
Users
Order Alerts
Invoice Details
Organization
7. Manual Provisioning
8. Payments
On selecting any of the notification categories, related notification templates get listed.
Under the User category, certain templates are to be configured such as the User activation email, New
organization sign up welcome notification, etc.
New organization sign up welcome notification template configuration

When a new user is created by self-registration, confirmation mail is sent to the users mail id. The New
organization sign up welcome notification template is invoked.
Service Provider has to configure the URL for self-registered users as mentioned below-

8 APRIL 2016
ENSIM CONFIDENTIAL
671
http://<host_name>: <port_number>/<war_name>/login/selfRegisteredUserActivation(user_activation_token)
User Activation Email template configuration

After a user is created, the User Activation Email template is invoked. The activation mail specifies the
username and password of the user account.
Service Provider needs to configure the URL for the user activation template as mentioned belowhttp://<host_name>:<port_number>/<war_name>/login/synergyUserActivation(user_activation_token)

8 APRIL 2016
ENSIM CONFIDENTIAL
672
Note:
symbol indicates the template is in inactive mode and
template is in active mode.
symbol indicates that the
Edit Notification Details:

To edit content of the notification templates
3.
Select any notification category from the list. All the notification templates under the selected
category will be listed.
4.
Choose any template from the list, template details will be displayed at the right side of the
screen.

8 APRIL 2016
ENSIM CONFIDENTIAL
673
5.
Click the Edit button at the bottom of the right side of the details page.
6.
Edit Notification page will open up; here the content of the template can be edited.

8 APRIL 2016
ENSIM CONFIDENTIAL
674
7.
Make the required changes in various fields like Language, Subject, Body etc. For the
content of the body the available Conditional Parameters like Service Provider, Created by
Agent etc. can be used as per requirement. These conditional parameters will be replaced with
the actual value in the body of the notification mail when these mails will be seen in the users
mailbox.
a.
The Subject Line Parameters are used to append variable parameters into the subject. These
subject line parameters will be replaced by the actual value in the subject of the notification
mail when this mail will be viewed in users mailbox.
b.
The Conditional Parameters are used to include customized fields in the body of the mail.
The email is sent as HTML content and hence HTML tags are used at suitable places in the
email body.

8 APRIL 2016
ENSIM CONFIDENTIAL
675
Conditional Parameters provide If-else conditions. In case the conditions satisfy,, IF is

displayed or else ELSE is displayed. These conditional HTML tags will be replaced with
the actual value in the body of the notification mail when these mails are sent to the users.
c.
There are four other parameters for the mail body. The Order Parameters, Order Creator
Details, Assigned Agent and Organization Details are used to append variable parameters
into the mail body.
The Order Creator Details, Assigned Agent and Organizations Details parameters perform similar
function as shown in the figure above.
8 APRIL 2016
ENSIM CONFIDENTIAL
676
d. This parameter is replaced by the actual signature configured using the Email signature link.
6.
The Reset button on the right side of the page allows resetting all the notification email settings
from the beginning.
7.
The Save button allows to save the notification for this language.
8.
Leave This Page button allows exiting the edit notification page without saving the changes for
this language.
9.
Send demo e-mail button allows sending a demo email for testing purpose.

8 APRIL 2016
ENSIM CONFIDENTIAL
677
Sending Sample Email to test SMTP and encoding

This section allows sending of demo emails to the recipients email address for testing the SMTP
configuration setting and to check whether the mail body is going out as HTML. Macro expansion
cannot be tested through this.
For sending the demo email click the Send demo email button on the Edit Notification page.
Put the recipient name in the TO field, put a subject and set a body message and then click the Ok
button to send the demo mail.

8 APRIL 2016
ENSIM CONFIDENTIAL
678
Order Management
Order management menu is used to configure order auto generated number as well as order status display.
Order number format can be configured in the order configuration setting by the following steps1.
2.
3.

Go to the Configuration-> Order Management tab.
The order related configuration is described below:

i.
Order number format: The order number format is eventually used to create the order number
in a certain format. The default format is as follows:
{3}-{2}-{1}-{0}. The significance of the numeric value defines below:
{3} Auto generated sequence number.
{2} Current day, example 21.
{1} Current month, example 01 for January
{0} Current year, example 2014
Service Provider can add text before or after the numeric sequence, as well as Service
Provider can change the numeric sequence. For example, if the order number format is in
the format cloud-{0}-{1}-{2}-{3} then the generated order number will be cloud-2014-03-21000235.
ii.
Reset order sequence: This configuration is used to reset the order numbers after a certain
period. It has the following options:
Year: If Service Provider selects this option, then the order number will be reset after every
year.
Month: If Service Provider selects this option, then the order number will be reset after
every month.
Never: If Service Provider selects this option, then the order number will never reset.

8 APRIL 2016
ENSIM CONFIDENTIAL
679
iii.
iv.
v.
vi.
vii.
viii.
ix.
x.
xi.
Length of order sequence: This configuration is used to set the length of the auto-generated
order number. By default it is set as 6 so that the auto-generated order number will be
generated with 6 digits. For example: 000235.
Show order status as: This configuration has two options, image and text. If Service Provider
chooses image, then the order status will be displayed as image icon. For example:
for
provisioned order. Else, status text will be displayed. For example: Draft.
Sales Representative ID format: User can enable sales representative by enabling this field and
specify the sales representative Id format.
Order Shared Folder Path: This field specifies the location where the PDF will be stored.
Order Share Username: Provide the username to access the shared folder.
Order Share Password: Provide the password of the shared username to access the shared
folder.
Display Sub-Order Number: If this field is enabled then for each order action, a sub-order
number will be generated.
Generate a sample Order number: From the above figure user can follow the sequence. Service
Provider can change the length of order sequence and clicking the Generate a sample Order
number button. It will generate order id by following the specific format described at the right
side on the figure.
If order number is being increased rapidly, user needs to change the length of the order
sequence so that it can generate more order id to accommodate with more number of orders.
Order Download Configuration: This button redirects the user to a new page where all the
order states are listed.
Against each order state, there is a checkbox enabling which allows the user to download
order PDF for that particular order states.
Message codes are displayed corresponding to each order state for PDF download button
text, download button tooltip and PDF header. The admin can only modify the message
text from the message.properties file.
If Enable for Trial field is checked, then Order PDF will be generated for trial orders only
for those orders states where downloadable checkbox is enabled.
If Save in Shared Location field is enabled, then the Order PDF will be stored in the
shared location, that is the path specified in Order Shared Folder Path field.

8 APRIL 2016
ENSIM CONFIDENTIAL
680
Payments gateways
This section will display the upcoming module Payment Gateways and its available features.
Payments and Invoice

The payment and invoice default settings can be done from the Configuration tab.
4.
Click Payments and Invoice link at the left side menu bar.
5.
The payments and invoice page appears.
6.
The four different sections for the setting of Payments and Invoice are
General
Payment Agreements
Financial Institution
Card Type
In General Settings:

8 APRIL 2016
ENSIM CONFIDENTIAL
681
b. Invoice and Payment Module Mode: Select the mode from the drop down list. Three types of mode
exist. They are
Not Required- This Invoice and Payment mode will not be reflected at the time of organization
payment. Hence, you attempt to de-activate the Payment and Invoice module. This will stop the
Payment Reconciliation and Invoice creation of Organizations and Resellers.
Required- This Invoice and Payment mode will be available during organization payment.
Hence, you attempt to activate the Payment and Invoice module. This will initiate the Payment
Reconciliation of Organizations and Resellers. However, you cannot add a new invoice. The
invoice will be generated by the jar invoked.
View only- This option is for third party users. These organizations may have their own invoice
generator system and do not want to use our jar to generate the invoice. They will generate the
invoice in other system and output the details manually in EAS application.
Click Save Changes button to set the mode.

c.
Edit Default Settings: You can set the desired values in the editable fields. These values will be
shown during the organization payment and invoice generation.
VAT Rate- Set the VAT percentage.
Invoice Generation Day- Select the duration for the generation of Invoice.
Payment Due Day- Select the payment due day.
Late Fine Percentage- Set the percentage amount for late fine.
Late Fine Minimum- Set the minimum amount for late fine.
Financial Year Starting At- Select the month for the starting of Financial year.

8 APRIL 2016
ENSIM CONFIDENTIAL
682
Order Cancellation Reimbursement Allowed- Checking this field allows reimbursement on

cancellation of order.
Click Save Changes button to save the Default Settings.

In Payment Agreements Settings:
b. Add Payment Agreement: You can set the agreement for payment.
Enter Payment Agreement Name- Enter the agreement type. To enter the Payment Agreement
Name in multiple languages, click the
icon on the right side of your screen.
Select Invoice Frequency- Select the frequency of Invoice.

Select Payment Frequency- Select the frequency of payment.
Select Payment Mode- Select the mode of payment; that is Always Invoice in Advance, Always
Invoice in Arrears or As in Offer Settings.
Always Invoice in Advance option restricts user to place order only in Invoice in Advanced mode.
Always Invoice in Arrears option restricts user to place order only in Invoice in Arrears mode.
Whereas implementation of the As in Offer Settings payment mode done mainly for the selfregistered organizations in EAS.
The additional payment mode redirects the organizations to the offer, which he wants to order to check
the payment mode set on the selected offer itself.
In offer level, there are also two payment modes present for both self-registered organization and
registered organization.
For the self-registered organizations by default payment mode is Invoice in Arrears. With this
payment mode, Self-registered organization can place the order but cannot approve the same.
In case of registered or verified organizations, they can place and approve the orders as well.

8 APRIL 2016
ENSIM CONFIDENTIAL
683
Remarks- This is an optional field. You may enter your remarks regarding the payment agreement.
Click Add New button to save your payment agreement.
Once you save your setting, the Payment Agreement Name will appear in the Default Payment
Agreement as shown below.
As you change the Default Payment Agreement Name, the default settings for that agreement appear in
a section.
After you set the Default Payment Agreement, click the Save Changes button.
Note: Service Provider must create at least one payment agreement in order to create Organization
or Reseller successfully.
In Financial Institution Settings:

8 APRIL 2016
ENSIM CONFIDENTIAL
684
b. Add Financial Institution: Enter the name of the financial institution.

Click the Add New button to save the financial institution.
Once you add the financial institution, the name will appear in the default section as shown in the
figure below.
After you set the Default Financial Institution, click the Save Changes button.
In Card Type Settings:

8 APRIL 2016
ENSIM CONFIDENTIAL
685
b. Add Card Type: Enter the name of card type that will be acceptable during payment.
Click the Add New button to save the card type.
Once you add the Card Type Name, the name will appear in the default section as shown in the figure
below.
After you set the Default Card Type Name, click the Save Changes button.

8 APRIL 2016
ENSIM CONFIDENTIAL
686
Phone Number Inventory

Phone Number Inventory is available to define a range along with phone numbers. Click Configuration->
Phone Number Inventory tab and the phone inventory page appears.
Setting:
In the Setting tab, phone inventory is available in two modes. They are Master Mode and Slave Mode.
a. Master Mode: The master mode allows the user to perform various actions such as adding of new
pool, range, range of phone numbers, etc.
b. Slave Mode: The slave mode allows user to perform limited actions such as viewing of pools,
ranges, etc. However, the current version of EAS does not support this feature.
Pools:
8 APRIL 2016
ENSIM CONFIDENTIAL
687
User can add a new pool by the following stepsClick Add a Pool link.
Set the pool name. User may set the Parent name from the list of existing pools.
Click the Create button to create a new pool.
User can add a range to the pool.
To add new ranges follow the steps belowSelect the pool and click the Add range button.
Set the values and click Add Range button.

To view the existing ranges of a pool follow the steps belowSelect a pool and click the View range button.
The range of numbers, quantity and the status of the numbers will be displayed.

8 APRIL 2016
ENSIM CONFIDENTIAL
688
Click the View Number link to view the list of available numbers.
Search Numbers:
User may search for the list of existing numbers from Search Numbers tab.
User may search for the list of numbers either by using the number or order id. Search option is also
available by selecting the pool name from the existing list of pools. Numbers can also be searched using the
status of the numbers.
Product management
Units
Units are used to define a proper standard of measurement of various resources of a service.
Before creating an item in EAS, configure the units of different resources of a service under
Configuration tab.
Follow the steps below to assign different units to different service resources1.
2.
Click the Configuration-> Product Management tab.

8 APRIL 2016
ENSIM CONFIDENTIAL
689
3.
Fill the required details as discussed belowi. Offer name format: The format of the offer name is specified here. The name for the new offer
created will appear in this format.
ii. Item name format: The format of the item name is specified here. The name for the new item
created will appear in this format.
iii. Maximum Allowable Commission: This is the maximum allowable commission percentage to
an agent.
iv. Use Promotions: The Promotion module will appear only when this field is checked.
v. Allow one-off discounts: The discount module on the offer level will appear only when this
field is checked.
4.
Click the Save Details button to save the assigned units to different resources.

8 APRIL 2016
ENSIM CONFIDENTIAL
690
Provisioning Workflow is available to fulfill orders with ESOM in an automated fashion. It is also possible
to manage life cycle of an order with sophisticated email notification that needs to be manually fulfilled
outside the system.
1.
Click Configuration-> Provisioning Workflow tab.
2.
The Provisioning Workflow page and the Properties Information open up.
3.
There are five types of Provisioning Workflow available. They are
Fully Automated Workflow: This implies that the Background Provisioning Task (BPT) jar
will pick up orders made by the services for Provisioning automatically.

8 APRIL 2016
ENSIM CONFIDENTIAL
691
Fully Manual Workflow: Implies that BPT jar will not process orders made by the services.
The services will be provisioned outside the system, based on info supplied within new
email notification for manual/semi-automated provisioning workflows. The email is sent
automatically with SSID, the provider needs to use the manual system to provision and
configure.
Semi-automated Workflow-1: This implies that the Provisioning APIs are available and the
technical provisioning is automated but, there are some additional manual tasks to be
performed in order for the service to be fully available to the organization. This use case is
for services that can be automatically provisioned for the first time but successive
operations can't be performed for lack of API integration. The provisioning action will not
be notified. The rest of the operations will be notified.
some manual configuration like DNS, Firewall, or even a training program to start
consuming the service and until then, billing should not be activated.

8 APRIL 2016
ENSIM CONFIDENTIAL
692
some manual configuration or even a training program to start consuming the service. But
billing will start as soon as the API call for provisioning is completed.

8 APRIL 2016
ENSIM CONFIDENTIAL
693
Registered servers
The Configuration -> Registered Servers section in EAS allows registering of application servers along
with their root folder location where the jar files are stored.
All the registered host name and host addresses are listed automatically in this page. Against each of these
listed registered servers, you can set the root folder location.
You can also delete the registered application server by clicking the delete icon against each registered
server.

8 APRIL 2016
ENSIM CONFIDENTIAL
694
Reports
EAS comes with automated reporting framework built with JasperReports. The following monthly reports
are prebuilt in EAS
o
For Service Providers:

1.
Revenue & Cost for Top 5 Organizations
2.
Revenue & Cost for All Organizations
3.
Revenue & Cost for Top 5 Resellers
4.
Revenue & Cost for All Resellers
5.
Revenue, Cost, & Seats by Services
For Organizations:
1.
List of Users in the Organizations
2.
Current Month Charges by Service
3.
Order and Charges Report
The reports are automatically sent as attachments in email to distribution list and can also be downloaded
from the EAS dashboard of the users (with appropriate viewing rights).
No prebuilt reports are available for Resellers or Agents in this release.
Details on reporting is discussed later in the document under the Reporting chapter.

8 APRIL 2016
ENSIM CONFIDENTIAL
695
Roles
This feature of EAS allows defining different roles and their authorities.
To access this section click Configuration-> Roles tab. The list of existing roles appears.
By default there are four roles available in EAS: Service Provider Super Admin, Reseller Super Admin,
Agent Super Admin and Organization Super Admin and their corresponding organization types are
Service Provider, Reseller, Agent and Organization as shown in the above figure. Additional roles
may be configured based on the existing organization types.
Super User can perform any task, as they have access to all areas.
Agent can perform operations like creating agent user; create order on behalf of an organization etc.
When an Agent will be created by the super admin at that time if Agent Super Admin role is
assigned to the agent then that agent can perform all the operations that are included in the role
'Agent Super Admin' in form of permissions.
Organizations are allowed to view the organization details, the services available to the user, place
order for themselves, etc.
For example, Service Provider does not want the organizations to have access to the system at all,
Service Provider needs to uncheck all fields and assign the role to the appropriate users.
Note: The user is recommended to copy and edit the default roles rather than directly editing default
roles above.
8 APRIL 2016
ENSIM CONFIDENTIAL
696
To create a new role, click the Add New button. User will be redirected to the New Role screen, where
there will be headers followed by a list of items with check boxes.
Role Name: Enter the name of the role here. For Example: Service Provider Super Admin.
Description: Enter a brief description detailing the function of the role.
Profile Identifier: Enter the identifier name of the current user profile.
Role Scope: There are four types of organizations available. They are Service Provider, Reseller,
Agent and Organization. Depending on the type of organization user will have to choose the
corresponding organization type from the drop down list.
Based on the organization type the rights change. Select the appropriate check boxes, which mean
the user will have access to that information and has the authority to manipulate it.

8 APRIL 2016
ENSIM CONFIDENTIAL
697
Service Provider may configure the configuration links in the following way1. Click the Roles tab.
2. Select the role Service Provider Super Admin and the edit role page appears.
3. Change the permission and it will be reflected in the UI.
For example- When Configure Notification Templates role is unchecked then Service Provider cannot
view the Notification menu in the Configuration tab.
Similarly, on unchecking the other configuration links respective menus will be disabled.
Various Types of Organization Roles:

To create new organization user and to assign roles, follow the stepsa. Click the Configuration-> Roles tab.
b. Click the Add New button and user will be redirected to the New Role screen.
c. Select the organization type as Organization.
There may be three types of organizations from roles and rights perspective. They area. Business Contact
b. Technical Contact
c. End User
Business Contact is an organization user who deals with orders as per the roles assigned by Service Provider
Super Admin. Business contact user is given the authority to approve an order. To set an organization user as
Business Contact, check the Business Contact field.

8 APRIL 2016
ENSIM CONFIDENTIAL
698
A business contact can also create or edit orders, resume suspended orders, etc.
Business contact roles can be classified into two types.
i.
Business Contact with approval rights- Organizations who have high credit limit and are eligible to place
orders for fulfillment all by themselves without the approval of the service provider. For this the Approve
Orders field needs to be checked.
These business contact users have maximum credentials and are allowed to perform the major roles without the
approval of the Service Provider.
Business contact user with approval rights can approve the orders themselves. Hence, the Approve button
appears in the Order details screen.

8 APRIL 2016
ENSIM CONFIDENTIAL
699
ii.
Business Contact without approval rights- Organizations who have low credit limit and are not eligible to
approve orders. Service Provider must approve all such orders of that organization. For this the Approve
Orders field remains unchecked.

8 APRIL 2016
ENSIM CONFIDENTIAL
700
These business contact users have limited credentials and are allowed to perform the roles except the order
approval. Organization can perform the roles and approve order only with the approval of the Service Provider
Business contact without approval rights cannot approve orders by themselves. Hence, the Seek Approval
button that appears in the Order details page allows organization to send an approval mail to the Service
Provider. The service provider will either approve or reject the order. The organization user will have to wait
for the service provider to approve.
Technical Contact is an organization user who deals with the technical impact of an order as per roles assigned
by Service Provider Super Admin. To set an organization user as Technical Contact, check the Technical
Contact check box. A technical contact organization can increase item quality, upgrade or downgrade offer or
upsize or downsize the order.

8 APRIL 2016
ENSIM CONFIDENTIAL
701
A Technical contact user deals with the technical aspects of an order such as improvement in the item quality,
upgrade or downgrade an offer, or upsizing or downsizing an item, etc. All these qualities are required for
enhancing the order and improve it technically.
When an organization user is created, contact details must be provided. This User email address can be used
both as Business contact as well as Technical contact at the time of order creation.
End User is an organization user who may be a business contact or a technical contact or neither of them or may
be both.
The Service Provider decides end users credentials at the time of assigning the roles.
Service Provider can set the maximum discount approval limit for individual seller (Service Provider, Reseller
or Agent) in the Approve Orders with discount up to field. The discount value must be provided in
percentage.
Select Service Provider Super Admin or Service Provider Operations and Support role and click Edit
button. Go to the Order section to get the right.

8 APRIL 2016
ENSIM CONFIDENTIAL
702
Note: To disable this right uncheck the Bulk Order Import right under the Order section.
For Reseller Super Admin or Reseller Operations and Support role, click Edit button and enable the
Bulk Order Import right.
Click Save Change button to save the role created. This newly created role will be available for selection in the
Role dropdown list on the New User screen.
Note: The above image does not include all items available. This is only a sample.
Custom roles can be created under Configuration -> Roles.

8 APRIL 2016
ENSIM CONFIDENTIAL
703
Click the Add New button and user will be redirected to the new role screen. Configure the desired custom
roles for an organization.

8 APRIL 2016
ENSIM CONFIDENTIAL
704
Role Scope of the Users

A user is always created in the system in the context of an Entity. That entity is typically the one to which
the user belongs natively. EAS allows, in certain cases, one user to be a member of multiple entities of
multiple types. For example, a native user of a Service Provider can be made a Technical Contact of an
Organization to configure the Services for the end users. While the user uses only one set of credentials
(Login ID and Password), separate Roles can be given to each of the memberships. The following table
describes the types of membership a user can play in each Entity.
For more information on users, follow Create organization user section.
Entity
Types
Service Provider mode
Enterprise mode
Service
Provider
The Service Provider Users are the

employees or technicians who can play
various roles in the system as
1. Administrators
2. Product Managers
3. Sales Executives
4. Operations Executives
Similarly, in an Enterprise, the typical

roles are
1. IT Administrators
2. Support Executives
3. Operations Executives
Reseller
Similar to Service Providers, all the roles

are applicable to Resellers as well.
Agent users are broadly classified into two
types
1. Administrators
2. Sales Executives
3. Support Executives
The users of an Organization are
associated to a specific Account. However,
their rights and scope are valid
Organization wide. Depending on Roles
assigned to the users they can be broadly
classified into four types
1. Business Contacts responsible for
Order management
2. Technical Contacts responsible for
technical matters
3. End Users they consume the services
4. Administrators maintain user
accounts and other operational jobs
Same as Service Provider but

decentralized business unit.
In an Enterprise, if Agents are deployed
they will typically play the same roles
as in case of Service Provider mode.
Agent
Organization

8 APRIL 2016
In an Enterprise, the use case does not

change. The respective heads or
managers of the departments could be
made the Business Contacts from
approval point of view, while the
experts from the IT departments could
play the role of Technical Contacts and
Administrators.
ENSIM CONFIDENTIAL
705
Memberships, Roles and Rights Management
Each user in EAS is made a member of one or more entities (even different types) and may have a Role
(scope of rights) or multiple roles associated with its membership in that entity.
Within each of these entities there is a predefined standard role with a scope of rights that can be set
globally for all users in that entity or within a specific role
New role scopes can be created and assigned to some or all users in the entity or a role scope may be
configured specifically for an individual user.
An entity may have rights to manage entities under it or associated with it (reseller to organization,
organization of Service Provider managed by an agent).
The entity level (Service Provider, Reseller, Agent and Organization) is generally used to determine the role
scope for a user that is a member.
A user may be a member of multiple entities such as a Service Provider, Reseller or Agent. Managing many
organizations and based on their role scope (definable at a specific right assigned to a specific user) they
may have both breadth and depth administration capabilities (i.e. specific functions in an entity or at a sub
level entity for which it have administration rights). Generally, each level will have some set of
administrating rights for sub levels associated with it. The situation is pictorially depicted below for a
Service Provider user who is a Technical Contact of multiple Organizations. The user has only one set of
credentials, can choose to work in the context of only one Entity only at the time of login. The user can
switch to another Entity in his login session, without logout or being asked for credentials again.

8 APRIL 2016
ENSIM CONFIDENTIAL
706
User can Switch to another entity without logging out from the current seeion :-
User can also switch to another entity by logging out from his current session and again logging with his
own credentails
Similarly, a Reseller or Agent user can be given memberships to multiple Organizations as Technical
Contact.

8 APRIL 2016
ENSIM CONFIDENTIAL
707
Roles and Rights of a Member

A Role is a set of rights in a given Entity type Service Provider, Reseller, Agent and Organization. A
member of an Entity has one Primary Role and none, one or more Secondary Roles. When the user logs in
the context of an Entity, the union of all the rights of all the Roles (primary and secondary in that Entity) are
assign to that user. The rights of a Role are meant for granting access (Permission) to specific task, not for
denial. If a particular right is added to a Role, all users assigned that role, will get the permission to do
specific action for the particular right. Similarly, if a right is removed from a Role definition, it will be
removed for all users assigned to that It is also possible to customize the rights of a user to deny specific
rights. The Administrator can revoke specific rights of a specific user. The denial rights can be synchronize
with the Master Role definition as required. Although the administrator cannot grant rights in addition to
what has already included in the roles assigned to the user. If a user is given multiple Roles in an Entity
scope, by default the user is given a set of rights that is equivalent of the union of all the Roles of the user in
that Entity. However, the user can choose to use only one of the many roles to work with by selecting a
specific Role from a drop down.
For more information on Roles and Rights, follow Roles section.
Assigning Bulk Order Operations Privilege

To assign the Bulk Order Operations permission to a role, complete the following steps.
1.
Click Configuration > Roles.
2.
Select the role to which you want to assign the permission and click Edit.
3.
Under the Orders section, select the Bulk Order Operations check box.

8 APRIL 2016
ENSIM CONFIDENTIAL
708
Service Provider Super Admin or Service Provider Operations and Support role permissions:
For Reseller Super Admin or Reseller Operations and Support role permissions:
4.
Click Save Change to save the created role. This newly created role is available for selection in the
Role drop-down list on the New User page.
Note: The figures above are samples. They do not include all available items.

8 APRIL 2016
ENSIM CONFIDENTIAL
709
Running batch jobs

The Configuration -> Running Batch Jobs section in EAS displays the different scheduled batch jobs
executed at the background of the portal. For example, emails are sent from the portal that is initiated by the
notification scheduled jobs.
Service connectors
The section will display the upcoming module Service Connectors and its available features.
Synchronization Tool
This tool helps the system to synchronize the user services with the underlying provisioning system.
8 APRIL 2016
ENSIM CONFIDENTIAL
710
If a user is assigned a service directly from the service portal (like Exchange from ESOM portal) then the
EAS application will not get the update. Hence, to align the user services in EAS and the service portal the
synchronization is done using this feature. This feature is only enabled if the user has the Register Service
Connector right enabled under Configuration-> Roles section. To synchronize the user services, follow
the steps below1. Click the Configuration-> Synchronization Tool tab.
2. Click the Setting button to set the synchronization process.
i.
Check the field Initialize synchronization for end user services to enable the process and
allow EAS to update the service status. If this field is unchecked, then the Synchronize
Now button will not be available.
ii.
User may the set the time interval of the process execution.
3.
Click the Add button to add the available services

i.
Select the desired service and select whether synchronization is required or not.
ii.
Click Save Changes button to add the service.

8 APRIL 2016
ENSIM CONFIDENTIAL
711
iii.
4.
The added service and its details will be displayed.
Click the Synchronize Now button to update the service status immediately.
Tool scheduler
The Configuration -> Schedule Tools section in EAS allows scheduling of jars or back end tasks. The
scheduling may be done by two ways. They areSchedule task through OS- this Boolean field if checked permits scheduling of executable (Jar) files through
the default scheduler of the operating system. Such as task scheduler for Windows and crontab for Linux.
Scheduling task through EAS portal- this Boolean field if checked permits scheduling of executable (Jar)
files through the EAS portal. Service Provider may set the Schedule date and time when the task will be
performed. The frequency, application server must be set accordingly. The Retry count resembles that the
task will be re-executed as mentioned after the execution as failed on the scheduled date and time.
The required check box allows user to control scheduling of individual jars. If user wants to stop scheduling
of a particular jar, then he/she should uncheck the Required field against the particular jar file. Service
Provider can schedule for the usage collection, rating, invoicing and other back end tasks on application
servers from the portal.
The Status tab displays the status of the executable files. The Historical Run allows execution of the jar on
desired date, month and year.
Note: The ESOM Usage Collector jar appears in the scheduling only when the value in the ESOM
Integration Mode under the General Properties-> Configuration is set to 1 or 2.

8 APRIL 2016
ENSIM CONFIDENTIAL
712
Usage Import
This is a substitute feature of existing Usage Collection tool (FTP). This allows the user to directly upload
the usage CSV file from their local machine to dump usage data in EAS DB. The data file format should be
CSV but the name and the extension of the file may vary. Click the Browse button to upload the file.
Once the CSV file is browsed, the Upload button gets enabled. Click the Upload button to import the
usage in database.

8 APRIL 2016
ENSIM CONFIDENTIAL
713
Appendixes
Appendix A: CSS
Introduction to CSS
A CSS (cascading style sheet) file allows you to separate your web sites (X) HTML content from its style. As
always you use your (X) HTML file to arrange the content, but all of the presentation (fonts, colors,
background, borders, text formatting, link effects & so on) are accomplished within a CSS.
At this point you have some choices of how to use the CSS, either internally or externally. In this section you
will learn how to use CSS to control the style and layout of multiple Web pages all at once.
What is CSS?
CSS stands for Cascading Style Sheets
Styles define how to display HTML elements
External Style Sheets can save a lot of work
External Style Sheets are stored in CSS files

8 APRIL 2016
ENSIM CONFIDENTIAL
714
APPENDIXES
CSS Syntax
A CSS rule has two main parts: a selector, and one or more declarations:
The selector is normally the HTML element you want to style.

Each declaration consists of a property and a value.
The property is the style attribute you want to change. Each property has a value.
A CSS declaration always ends with a semicolon, and curly brackets surround declaration groups:
p{
color:red;text-align:center;
}
CSS Comments
Comments are used to explain your code, and may help you when you edit the source code later.
Browsers ignore comments. A CSS comment begins with /*, and ends with */, like this:
/*This is a comment*/
p
{
text-align:center;
/*This is another comment*/
color:black;
font-family:arial;
}
CSS Id and Class
The id and class Selectors
In addition to setting a style for a HTML element, CSS allows you to specify your own selectors
called id and class.
The id Selector
The id selector is used to specify a style for a single, unique element.
The id selector uses the id attribute of the HTML element, and is defined with#.
The style rule below will be applied to the element with id=para1:
Example
#para1
{
text-align:center;
color:red;
}

8 APRIL 2016
ENSIM CONFIDENTIAL
715
APPENDIXES
The class Selector

The class selector is used to specify a style for a group of elements. Unlike the id selector, the
class selector is most often used on several elements.
This allows you to set a particular style for many HTML elements with the same class.
The class selector uses the HTML class attribute, and is defined with a .
In the example below, all HTML elements with class=center will be center-aligned:
Example
.center
{
text-align:center;
}
Appendix B: Plugins
Plugins
Plugins in EAS are optional modules to implement service provisioning (non-Active Directory based) and
order fulfillment of various 3rd party applications like BroadWorks VoIP, Symantec. Cloud Web and Email
security etc. To enhance EAS functionality with these modules please refer to installation and configuration
guides of the respective plugins.
Note: These Appendixes are optional fields.

If you have the financial system of your own which can generate Invoice and has PDF generator, you
may skip Appendix B.
If your financial system is also able to perform the rating, you can skip Appendix A.
If you have your own service provisioning system, you may skip Appendix C.
Melody Plugins
JavaMelody plugin is now packaged with EAS but disabled. The goal of JavaMelody is to monitor Java or
Java EE applications in QA and production environments. It is not a tool to simulate requests from users, it
is a tool to measure and calculate statistics on real operation of an application depending on the usage of the
application by users. To troubleshoot issues related to EAS performance, enable this as documented in the
Installation guide.

8 APRIL 2016
ENSIM CONFIDENTIAL
716
APPENDIXES
Appendix C: JasperReports
Jasper BI Integration
Executive Summary
EAS is integrated with Jaspersoft BI suite. Based on typical user scenarios and experience with
numerous real-world implementations, Jaspersoft has identified five levels of embedded BI
functionality:
Feature
Available in EAS 4.2
Embedding of Static Reporting.

Embedding of Managed Reports.
Embedding of Highly Interactive
Reports and Dashboards.
Yes
Yes
No. This requires API integration with
Reports Server.
Embedding of Self-Service
Reporting and Ad-hoc views.

Reports Server.
Embedding of Advanced
Analytics.

Reports Server.
Steps to add a report in EAS:

1. Need to connect to EAS DB from Jaspersoft Studio Report Designer (JSRD).
2. Write SQL query to fetch the dataset as required, requires knowledge of EAS data model which is
documented by Ensim in the product guides. The queries are to be written in native dialect of the
DB vendor. EAS is supported on SQL Server, Oracle and PostgreSQL.
3. Create template file (*,jrxml); optionally compile the template using JSRD and produce .jasper file.
The EAS framework is capable of compiling the template at runtime as well. So EAS support both
*.jrxml and *.jasper files. Run the report within JSRD and get a preview of the same.
4. These templates need to be stored in EAS application directory. Refer EAS product guides for the
same.
5. In future versions of EAS it will be possible to define more reports in the administrative UI.
EAS ships with 6 predefined reports. The look and feel of these reports can be customized by editing the
jrxml files in Jasper Studio.
Available Datasets
Being a combination of a BSS and an OSS, EAS offers the following datasets to produce reports
1. Revenue and Cost: granular information of revenue and cost per Item per Offer
2. Service Deployment: deployment of services per Organization and User
3. Organization, Accounts and Users: Details of Organization and User information

8 APRIL 2016
ENSIM CONFIDENTIAL
717
APPENDIXES
Components of Jaspersoft and their relation with EAS

JasperSoft comes with 5 components as described below:
1) JasperReports Reporting Library - The JasperReports Library is the world's most popular open source
reporting engine. It is entirely written in Java and it is able to use data coming from any kind of data source
and produce pixel-perfect documents that can be viewed, printed or exported in a variety of document
formats including HTML, PDF, Excel, OpenOffice and Word.
EAS is pre-integrated with JasperReports via a plugin of Grails framework. The desired reports are
registered in EAS with corresponding jrxml file and SQL query. At runtime, EAS executes the SQL queries
and feeds the resultant dataset to JasperReports library. The library is capable to rendering the data in
charts, graphs and other visual formats and is also equipped with various mathematical functions such as
sorting, averaging, standard deviation, conditional expression and the likes.
2) Jaspersoft Studio Report Designer - Jaspersoft Studio is the free, open source, eclipse-based report designer
for JasperReports and JasperReports Server. Create very sophisticated layouts containing charts, images,
subreports, crosstabs and much more. Access your data through JDBC, TableModels, JavaBeans, XML,
Hibernate, CSV, and custom sources. Then publish your reports as PDF, RTF, XML, XLS, CSV, HTML,
XHTML, text, DOCX, or OpenOffice.
For designing the templates (preparing JRXML files), the designer /developer needs to use this tool and
deploy the templates in EAS application nodes
3) JasperReports Server (JRS)- JasperReports Server builds on the JasperReports Library to provide a fully
functional report server. JasperReports Server provides important application features such as security, a
repository, and scheduling. To enable integration with other applications and the capability to easily
customize functionality, JasperReports Server exposes comprehensive public interfaces.
EAS doesnt have any integration with JRS.
4) Jaspersoft ETL- Jaspersoft ETL is a complete and ready-to-run ETL job designer with an extensive set of
data integration capabilities. It consistently and accurately extracts and transforms data from multiple
systems and loads it into data stores optimized for reporting and analysis"such as star or snowflake
schema data marts and warehouses. And it easily keeps pace with the performance of other leading ETL
tools.
Since this module is meant for transforming data from one system to another, EAS doesnt have any
integration with ETL. However, data can be extracted from EAS using standard ODBC connectors and
transformed by ETL and stored in a data warehouse system.
5) Jaspersoft OLAP- Jaspersoft's data analytics software is used to model, manipulate and visualize any flavor
of data using OLAP or in-memory analysis in order to identify issues, spot trends and make better decisions
quickly.

8 APRIL 2016
ENSIM CONFIDENTIAL
718
APPENDIXES
Embedded analytics solutions can help make your application more competitive; giving end users the
reporting and analytics they need to make better decisions.
As JasperSoft has its own UI for this, this can be used independently integrated with EAS db (as a loosely
coupled system via ODBC connectors). Although JasperSoft provides WebService APIs to embed OLAP in
other applications and for interactive dashboard, EAS doesnt have any integration with the same at this
point in time.
Appendix D: Order PDF

Steps for Order PDF Customization
The order PDF file is designed using an open source reporting tool named Jaspersoft Studio-5.6.1.final. The
files with the extension .jrxml and .jasper are the design templates of the PDF. To customization the PDF,
one has to alter these JasperReport files.
Note: Before starting the customization, keep a backup copy of all the JasperReport files (files with
extensions .jrxml and .jasper).
1.
Install jaspersoftstudio-5.6.1.final-windows-installer-x86_64
2.
Download and install jaspersoftstudio-5.6.1.final-windows-installer-x86_64 from

http://sourceforge.net/projects/jasperstudio/files/JaspersoftStudio-5.6.1/
This is the editor to be used for modifying the files.
Configure Report Datasources

8 APRIL 2016
ENSIM CONFIDENTIAL
719
APPENDIXES
Open Jaspersoft Studio 5.6.1.final. Right click the Data Adapters option on the
Repository Explorer view (Windows menu -> Show View -> Repository Explorer) present on the left
side of the Jaspersoft Studio. Click the Create Data Adapter option from the shortcut menu as
shown in the following page
After clicking the Create Data Adapter option the Data Adapter Wizard opens as shown in the
following page

8 APRIL 2016
ENSIM CONFIDENTIAL
720
APPENDIXES
Select Collection of JavaBeans option and click Next > button will display following page

8 APRIL 2016
ENSIM CONFIDENTIAL
721
APPENDIXES
Enter a name for the Data Adapter. It is cosmetic.

Enter reportgenerator.QuoteGeneratorBeanFactory value in the Factory class field.
Enter create as the static method name identical as in the above screen.
Click Add button and browse the OrderQuotePDFGenerator.jar file of the
OrderQuotePDFGenerator Tool. Click OK. This jar file can be obtained from the ISO of EAS that
you have received from Ensim.
Click Test button to test the connection. If the values are entered exactly as described above, the
successful message will be flashed.

8 APRIL 2016
ENSIM CONFIDENTIAL
722
APPENDIXES
3.
Remove all the jasper files

The folder jasper_designs contains following jasper files1) OrderQuote.jasper, 2) QuoteItemList_subReport.jasper, 3) QuotePriceTiers_subReport.jasper, 4)
QuoteItemBillingFrequency_subReport.jasper, 5) QuoteBillingSubtotal_subReport.jasper, 6)
QuotePIFs_subReport.jasper, 7) CustomField_subreport.jasper and 8)
OrgCustomField_subreport.jasper,
4.
Open all the JasperReport files

The folder jasper_designs contains 8 JasperReport files, out of those the OrderQuote.jrxml is the
main report and the remaining seven are sub-reports. The sub-reports can be embedded inside the
main report or the other sub-report.
Open all the .jrxml files in Jaspersoft Studio.
5.
Edit the defaultValueExpression of each .jrxml file

The following is the hierarchy for the arrangement of sub-reports under the main report
Click the Source tabof the OrderQuote.jrxml and QuoteItemList_subReport.jrxml report file and
set the defaultValueExpression as the location of the JasperReport files. Example
D:\\jasper_designs\\ (Assume that the JasperReport files location is D:\jasper_designs).
Note: The defaultValueExpresssion property will not exist for the remaining sub-reports
since there does not exist any sub-report.
8 APRIL 2016
ENSIM CONFIDENTIAL
723
APPENDIXES
6.
Make the desired modification

The JasperReport files have respective data sources. The data from these data sources can be viewed
in the Fields section in the Outline view (Windows menu -> Show View -> Outline).
To modify the existing element, click the element and alter the property from the property window.
To add new element, drag the element from the Palette (Windows menu -> Show View -> Palette)
and configure its properties from the properties window.
7.
Save and compile the file
8.
To save the modification click save button and then click compile
button to compile the
modified report file. If the report compiles successfully and Errors tab is empty, it indicates that
all the modifications are error free. If any error persists, read the error message carefully to identify
the error.
Preview the main report (OrderQuote.jrxml) file

8 APRIL 2016
ENSIM CONFIDENTIAL
724
APPENDIXES
Open the OrderQuote.jrxml file and click the Preview tab to preview the report. You can verify the
output of the report by previewing it.
Note: Select the Preview Format as Java (Settings option -> Preview Format -> Java)
The report customization is complete. This set of JasperReport files (.jrxml and .jasper) will generate
reports of this design.
Note: Do not alter any file name.
9.
Copy all the jrxml and jasper files into the EAS application server
Copy all the jrxml and jasper file (OrderQuote, QuoteItemList_subReport,
QuotePriceTiers_subReport, QuoteBillingSubtotal_subReport,
QuoteItemBillingFrequency_subReport, QuotePIFs_subReport, CustomField_subreport and
OrgCustomField_subreport) into the following location in Tomcat Server:
Catalina_home\ESCM-DataFiles\resources\jasper_designs.
Perform this replacement in all the EAS application servers.
10. Test
Generate the PDF to observe the new customized design.
Supported Fields for Order PDF

There are a number of fields which are used for Order PDF generation. The detail list of fields are
mentioned below with their corresponding value fields. In EAS 4.2 the following fields are made available
(in addition to the previously available set) in the PDF:
a. Organization custom fields
b. Sub order number
c. Differential quantity and amount
d. Base Order Originator

8 APRIL 2016
ENSIM CONFIDENTIAL
725
APPENDIXES
List of fields
Label Field
Message Id
Value Field
EntityLogo
NA
NA
ProviderName
NA
NA
order.quote.order.quote.hr
OrderQuoteHR
NA
order.pdf.hr
Description
The image file representing
the logo of the Service
Provider or Resellers.
Automatically branded.
The Name of the entity.
Automatically branded.
This refers to multiple
message IDs (configurable as
per order state, please refer
to order state table). For
example : for draft order we
are using the message id
order.quote.order.quote.hr
(refer to column
pdf_heading in
order_state table.
Order number assigned to

QuoteNumber
quoteNumberHR
order.quote.quote.number.hr
DateHR
order.quote.date.hr
QuoteDateString
Date of creation of the Order
CustOrgHR
order.quote.customer.organization.hr
CustOrg
ModeHr
order.quote.mode.hr
Mode
Organization name
New,
Upsize,Upgraded,Down
size,Downgraded
New subscription to
another Offer
Upgraded or Downgraded
offer name
Account name
Offer name
All the items of the Order
All the items code of the
Order
Price of items
AccountHR
OfferHR
ItemHR
order.quote.on.downgrade.hr
order.quote.on.upgrade.hr
order.quote.upgrade.offer.hr
order.quote.downgrade.offer.hr
order.quote.account.hr
order.quote.offer.hr
order.quote.item.item.name.hr
ItemCodeHR
order.pdf.item.code.hr
OnUDgradeHR
UDgradeOfferHR
PriceHR
order.quote.item.price.hr
QuantityHR
order.quote.item.quantity.hr

8 APRIL 2016
OnUDgrade
UDgradeOffer
Account
Offer
Item
ItemCode
TierRange
BasePriceString
UnitFrequency
Quantity
DiffQuantity
DiffOperator
this Order
Quantity of items
Differential quantity of items
Differential operator
ENSIM CONFIDENTIAL
726
APPENDIXES
NetQuantity
DiscountHR
order.quote.item..discount.hr
DiscountString
OrgDiscountHR
order.pdf.organization.global.discount.
hr
OrgDiscount
ItemSubTotalHR
order.quote.item.item.sub.total.hr
SubTotalString
DiffTotal
NetItemSubTotal
DiffSubTotalHR
order.pdf.decrease.differential.sub.total
.hr
order.pdf.increase.differential.sub.total.
hr
DiffSubTotal
OfferPromoDiscHR
order.quote.offer.promotion.discount
GrossTotalHR
order.quote.gross.total.hr
OfferPromoDiscStri
ng
GrossTotalString
BusinessContactHR
order.quote.business.contact.hr
BusinessContact
TechnicalContactHR
order.quote.technical.contact.hr
TechnicalContact
OrganizationIdHR
AccountIdHR
VatNoHR
order.quote.organization.id.hr
order.quote.account.id.hr
order.quote.vat.vo.hr
OrganizationId
AccountId
VatNo
SalesRepIdHR
order.quote.sales.rep.id.hr
SalesRepId
order.quote.sales.representative.name.
hr
order.quote.sales.representative.mobile
.hr
order.quote.sales.representative.email.
hr
SalesRepMobile
SubscriptionPeriodHR
order.quote.subscription.period.hr
SubscriptionPeriod
TariffCodeHR
CatalogIdHR
ItemBillingFreqHR
order.quote.tariff.code.hr
order.quote.catalog.id.hr
order.quote.item.billing.frequency
order.quote.item.billing.frequency.one.
time
order.quote.item.billing.frequency.mon
thly
order.quote.item.billing.frequency.year
ly
order.quote.every
order.frequency.2.multiple
order.quote.every
order.frequency.5.multiple
TarriffCode
CatalogId
ItemBillingFreq
SalesRepNameHR
SalesRepMobileHR
SalesRepEmailHR
BillingFreqLabel
NA

8 APRIL 2016
NA
SalesRepName
SalesRepEmail
Net quantity of items

Promotional discount of
items
Global discount of the
Organization or offer
Subtotal of items
Differential subtotal of items
Net subtotal of items
Differential Subtotal amount
of the order
Additional discount on
items
Gross total of items
Name of the Business
contact
Name of the Technical
contact
Organization id
Account id
VAT no of the Organization
ID of the Sales
Representative
Name of the Sales
Representative
Mobile number of the Sales
Representative
Email address of the Sales
Representative
Subscription period of the
order
Tariff code of offer
Catalog id of offer
Billing frequency of items
Subtotal of items according
to the billing frequency
BillingFreqValue
InstallmentPeriod
Installment period of the

items
ENSIM CONFIDENTIAL
727
APPENDIXES
ServiceCodeHR
PaymentAgreementH
R
order.quote.product.offer.service.code
ServiceCode
order.quote.payment.agreement.hr
PaymentAgreement
ProvisioningInfoFields
HR
order.quote.provisioning.info.fields.hr
ProvisioningInfoFie
lds
SubOrderNumberHR
order.pdf.sub.order.number.hr
SubOrderNumber
OrderStateHR
CustomerApproveDat
eHR
OrderOriginatorName
HR
OrderOriginatorEmail
HR
ContractualStatement
HR
order.pdf.state.hr
OrderState
CustomerApprove
Date
OrderOriginatorNa
me
OrderOriginatorEm
ail
ContractualStateme
nt
order.pdf.customer.approved.date.hr
order.pdf.order.originator.name.hr
order.pdf.order.originator.email.hr
order.pdf.contractual.info.hr
Service code of offer

Payment agreement of
customer
Provisioning information
fields of order; displayed if
visible to Organization.
Sub Order No of the order
will be displayed if enabled
in order configuration
Status of the Order
Date on which
Organizations approved
Base order originator first
and last name
Base order originator email
Contractual statement of the
Organization
PIFs visibility in Order PDF

The provisioning information fields (PIFs) may or may not be present in the order PDF based on the visibility
defined in Offer:
Hidden Field: Not visible to any user (SP/Reseller/Agent/Organization); will not be present in PDF.
Provider Only: Only visible to SP/Reseller/Agent user; will not be present in PDF.
Non-editable to Orgs: Visible to all user (SP/Reseller/Agent/Organization) but editable only by Service
Provider/Reseller/Agents; will be present in PDF.
Everyone: Visible to all user (SP/Reseller/Agent/Organization); will be present in PDF.
Visibility of Organization custom fields in Order PDF

The Organization custom fields may or may not be present in order PDF based on the visibility defined in
Custom Field Configuration page in Configuration menu. If an Organization custom field is enabled in
configuration and also show in order option is set ON then it is visible in Order PDF. By default custom field
value will be displayed till 95 characters. This can be changed by modifying OrgCustomField_subreport.jrxml
file as per following:
Open Jaspersoft Studio-5.6.1.final.
Open OrgCustomField_subreport.jrxml and double click the text field present on the right side.

8 APRIL 2016
ENSIM CONFIDENTIAL
728
APPENDIXES
Expression Editor window opens up. Modify the length as per requirement and click finish button.
To save the modification click save button and then click compile
report
file.
If
the
report
compiles
successfully copy
button to compile the modified
OrgCustomField_subreport.jrxml
and
OrgCustomField_subreport.jasper file into the EAS application server.

Visibility of Order custom fields in Order PDF
The Order custom fields may or may not be present in order PDF based on the visibility defined in Custom
Field Configuration page in Configuration menu. If an Order custom field is enabled in configuration then it
will visible in Order PDF for Service provider user and for Organization user both Enable and Visibility to
ORG option need to set ON in configuration. By default order custom field value will be displayed upto 95
8 APRIL 2016
ENSIM CONFIDENTIAL
729
APPENDIXES
character. This can be changed by modifying CustomField_subreport.jrxml file. The step will be same as
discussed in Organization custom field except that you need to open and modify CustomField_subreport.jrxml
in Jaspersoft Studio-5.6.1.final.
Branding for Order PDF

The Service Provider can brand the PDF for themselves as well as for the Resellers. The scope of branding is
limited to replacing the company logo (image) and company name. The resellers cannot define their own
PDF formats. All PDFs generated by the system will be based on the one and only Jasper design format.
The two Fields used for branding the PDF are described below:
1.
EntityLogo: service provider can alter the logo.
2.
ProviderName: The service provider name is added in the sign-up page itself. To modify the
provider name click Configuration-> Company tab.
Appendix E: Invoice PDF

Invoice PDF Customization
Overview
In Ensim Automation Suite (EAS), the invoice, in PDF format, is generated by the InvoicePDFGenerator
tool. This document intends to guide with the customization of EAS invoice PDF.
The organization places an order based on the Offers made available by his Service Provider/Reseller. The
Service Provider generates monthly invoice for the Organization accounts.
A brief understanding of Product Model will be helpful to understand the invoice.
The same tool generates the following invoices for a particular month year
Invoice for Organization account for orders placed to Service Provider
Invoice for Organization account for orders placed to Reseller
Invoice for Reseller by Service Provider for the resources utilized by the resellers organizations
The InvoicePDFGenerator tool generates different Invoice PDFs if the billing language of organization is
different from the language of organizations provider.

8 APRIL 2016
ENSIM CONFIDENTIAL
730
APPENDIXES
InvoicePDFGenerator
The InvoicePDFGenerator tool creates invoice PDF files for the organizations and resellers for a particular
month and year.
The InvoicePDFGenerator Tool contains the following
InvoicePDFGenerator.jar the tool is packaged as jar (Java Archive)
JasperReport files files with the extension .jrxml and .jasper
config.xml to configure the database, email and other general properties
Message property files with .properties extension to edit the headers used in the report. There can
be multiple files for different languages
Log4j.xml for the configurations of log

8 APRIL 2016
ENSIM CONFIDENTIAL
731
APPENDIXES
The invoice pdf files are designed using an open source reporting tool, Jaspersoft iReport-4.7.0. The files
with the extension .jrxml and .jasper are the design templates of the invoice PDF. The customization
indicates altering these JasperReport files.
Available EAS Invoice PDF formats
EAS presents two designs for the Invoice PDF, as follows
Basic format contains brief details on item data in the Offer ordered.
Following is the sample of simplified invoice-

8 APRIL 2016
ENSIM CONFIDENTIAL
732
APPENDIXES

8 APRIL 2016
ENSIM CONFIDENTIAL
733
APPENDIXES
The first page holds the summary of invoice details of all orders billable in the particular month. The second
page can holds the payment details if any payment has been made. The invoice data of individual orders
follow.
The term Invoice in Advance indicates that the advance amount for the next month has been charged for
the items of type Reserved, whereas, the Invoice in Arrears indicates that the advance amount for the
next month has not been charged.
Refer to the product model section in the EAS 4.2 Service Provider Manual for more details on the
product model of EAS.
If the Offer is ordered for Trial then the charges are applied only for the usage of Items of type PPU. The
label Trial indicates that the Offer is ordered for trial.
Detailed format - contains detailed tier wise pricing data of each item in the Offer ordered.
Following is the diagrammatic representation of the product model which is significant for the invoice data
of the order.

8 APRIL 2016
ENSIM CONFIDENTIAL
734
APPENDIXES
The invoice contains the list of orders for the particular account of the Organization. The order is placed
upon a single Offer. The Offer contains Items in a specified quantity. The pricing of item can be tiered or flat
rate.
Subscription Properties in Native Invoice

In EAS, Invoice PDF will contain the following subscribed offer properties:
i.
Subscription period for the order will be printed in Order Detail section.

8 APRIL 2016
ENSIM CONFIDENTIAL
735
APPENDIXES
ii.
Billing frequency will be printed in invoice PDF.
Multi-currency Support
In EAS a new feature called Multi-Currency is introduced. The Multi-Currency feature enables the
provider to assign a specific currency type to multiple profiles and accounts.
i.
Service Provider to Reseller Type 1 billing will be done on base currency of Service Provider.
a. Invoice PDF for Reseller Type1 will show the base currency Service Provider.
b. Rated Data Exported file to Reseller Type1 will show the base currency of Service Provider.
ii.
Service Provider to Reseller Type 2 billing will be done on base currency of Reseller Type2.
a. Invoice PDF for Reseller Type2 will show the base currency of Reseller Type2.
b. Rated Data Exported file to Reseller Type2 will show the base currency of reseller Type2.
iii.
Provider to end user billing will be done on the currency of the account under which the order is
created.
a. Invoice PDF from provider to customer will show the currency of the billable account
under which the order is created.
b. Rated Data Exporter File from Provider to its customer will contain the currency of the
billable account under which the order is created.
Steps for customization

Note: Before starting the customization, keep a backup copy of all the JasperReport files (files with
extentions .jrxml and .jasper).
Invoice for Organization

The Invoice for Organization is the invoice generated by the Service Provider to invoice the Organizations
of Service Provider as well as the Organizations of the Reseller.
11. Install Jaspersoft iReport-4.7.0
Download and install Jaspersoft iReport-4.7.0 from
http://sourceforge.net/projects/ireport/files/iReport/iReport-4.7.0/
12. Configure the classpath
Open Jaspersoft iReport Designer 4.7.0. Go to Tools -> Options. The Options window opens. Click
Classpath tab under iReport section.

8 APRIL 2016
ENSIM CONFIDENTIAL
736
APPENDIXES
Click Add JAR button and browse the InvoicePDFGenerator.jar file of the InvoivePDFGenerator
Tool. Click OK
13. Configure Report Datasources
Click the Report Datasources
button on the Designer toolbar, the following window opens.
Click the New button, a window opens to select the datasource type. Select JavaBeans set
datasource and click Next.
Enter a name for the datasource. It is cosmetic.
Enter reportgenerator.services.ReportGeneratorBeanFactory value in the Factory class field.
Enter create as the static method name identical as in the following page

8 APRIL 2016
ENSIM CONFIDENTIAL
737
APPENDIXES
Click Test button to test the connection. If the values are entered exactly as described above, the
message for successful connection will be flashed.
14. Open all the JasperReport files

The tool contains InvoicePDFGenerator folder with many JasperReport files. The
InvoiceDetailReport.jrxml is the main report and other .jrxml files are the sub-reports. The subreports can be embedded inside the main report or the other sub-report.
Open all the .jrxml files in iReport designer.
15. Edit the defaultValueExpression of each .jrxml file

8 APRIL 2016
ENSIM CONFIDENTIAL
738
APPENDIXES
The following is the hierarchy for the arrangement of sub-reports under the main report
The defaultValueExpression will locate the sub-report under that template when the files will be
compiled.
Click the XML button of the main report and change the defaultValueExpression. Enter the
location of the JasperFiles. Example F:\\InvoicePDFGenerator\\ (Assume that the tool location
is F:\InvoicePDFGenerator)
Note: The defaultValueExpresssion property will not exist for the sub-report at the leaf node
of the hierarchy since there does not exist any sub-report under the leaf node.
16. Make the desired modification

8 APRIL 2016
ENSIM CONFIDENTIAL
739
APPENDIXES
The JasperReport files have respective datasources. The data from these datasources can be viewed
in the Fields section in the Report Inspector (Windows menu -> Report Inspector).
To modify the existing element, click the element and alter the property from the property window.
To add new element, drag the element from the Palette and configure its properfies from the
properties window.
Refer the Datasources Fields chapter for brief description on the fields for each Datasource.
17. Preview each .jrxml file in correct order
Click the Preview button to preview the file. The preview will compile and generate the
corresponding .jasper file. Preview files starting from the leaf node of the template hierarchy.
Therefore, InvoiceProductReport must be previewed first and InvoiceDetailReport must be
previewed last.
Select the Internal Preview under the Preview menu.
If the preview is successfully generated and Report Problems Window is empty indicates that all
the modifications were error free. If any error persists, read the Report Problems Window carefully
to identify the error.
The report customization is complete. This set of JasperReport files (.jrxml and .jasper) will generate
reports of this design.
Note: Do not alter the file names.
18. Run the jar to observe the new customized design of Invoice PDF
Open command prompt, go inside the tool location where the InvoicePDFGenarator.jar file exists.
Enter the following command to run the tool.
For Windows:
java -Dlog4j.configuration=file:log4j.xml cp F:\InvoicePDFGenerator\*;InvoicePDFGenerator.jar;
reportgenerator.MainClass mm yyyy
For Linux:
/usr/java/jdk1.7.0_10/bin/java -Dlog4j.configuration=file:log4j.xml -cp
/home/seap/Downloads/InvoicePDFGenerator/*:/home/seap/Downloads/InvoicePDFGenerator/Inv
oicePDFGenerator.jar: reportgenerator.MainClass mm yyyy
Note: mm yyyy is optional argument for month and year. Providing month and year
explicitly will generate the Invoice PDF files for that month. Else, the InvoicePDFGenerator
tool implicitly generates the invoice for the previous month.
8 APRIL 2016
ENSIM CONFIDENTIAL
740
APPENDIXES
The invoice PDF files will be saved in the location configured in the config.xml file else will be
saved in the <ApplicationwideSharedPath > configured in EAS. The organization invoices will be
saved in the location \invoice\year\month\customer and the reseller invoices will be saved in the
location invoice\year\month\reseller.
Invoice for Reseller
The Invoice for Reseller is generated by the Service Provider to invoice the reseller based on the utilization
of resources by the resellers organizations orders.
The steps for customization of JasperReport files for reseller invoice PDF are same as above.
Configure Report Datasources
Use the following values to create Report Datasource for Reseller Invoice
Name: ResInvoiceData
Factory class: reportgenerator.services.ResReportGeneratorBeanFactory
Static method: create
The hierarchy of the report templates and Datasources of corresponding JasperReport files are as follows

8 APRIL 2016
ENSIM CONFIDENTIAL
741
APPENDIXES
The other steps for customization are same as described above.

Refer the Datasources Fields chapter for brief description on the fields for each Datasource.
Datasource Fields
The datasources of sub-reports are sub-sets of (or belongs to) the datasource of main report of
Organization/Reseller invoice report.
Datasources and fields for Organization invoice report
The datasorce of main-report (InvoiceDetailsReport) for Organization invoice report is
CustomerInvoiceDataContainer.
The following representation explains the datasources of sub-reports and the datasource to which they
belong

8 APRIL 2016
ENSIM CONFIDENTIAL
742
APPENDIXES
The following table provides description on the fields of customerInvoiceDataContainer datasource

Field name
Type
customerOrgName
customerId
customerType
accountId
accountName
address1
address2
distributor
invoiceNumber
invoiceDate
invoiceStartDate
invoiceStartDateString
invoiceEndDate
invoiceEndDateString
paymentDueDate
paymentDueDateString
String
String
String
String
String
String
String
String
String
Date
Date
String
Date
String
Date
String
prevInvoiceAmount
paymentReceived
balanceAmount
adjustment
curInvoiceAmount
amountPayable
Double
Double
Double
Double
Double
Double
reserveCharges
Double

8 APRIL 2016
Description
Name of Organization (end user)
Organization Id
Organization type
Id of Organization account
Name of Organization account
Address1 of Organization account
Address2 of Organization account
Invoice number for invoice naming
Date of invoice generation
Start date of invoice period
Formatted (Org date format) value for startDate
End date of invoice period
Formatted (Org date format) value for endDate
Payment due date for invoice
Formatted (Org date format) value for
paymentDueDate
Invoice amount of invoice for previous month
Received payment
Previous invoice amount minus payment received
Adjustment amount (if any)
Invoice amt of invoice period
Payable amt after considering the balance amt,
adjustments and taxes
Total reserve charges in this invoice
ENSIM CONFIDENTIAL
743
APPENDIXES
ppuCharges
onetimeCharges
advanceCharges
Double
Double
Double
Taxes
taxesAndLateFees
taxesAndLateFeesString
Double
Double
String
lateFine
providerName
providerAddress
lateFineRule
Double
String
String
String
providerId
providerLanguage
lateFineString
taxesString
advanceChargesString
Integer
Integer
String
String
String
onetimeChargesString
String
ppuChargesString
reserveChargesString
String
String
amountPayableString
String
curInvoiceAmountString
String
adjustmentString
balanceAmountString
String
String
paymentReceivedString
String
prevInvoiceAmountStrin
g
entityLogo
String
money_format
String
decimal_format
String
date_format
String
currency_code
reportLocale
String
String

8 APRIL 2016
Image
Total ppu charges in this invoice

Total reserve charges in this invoice
Total advance (for reserved items of next month)
charges in this invoice
Total tax amount
Total tax amt and late fees (if any)
Formatted value (money format) for
taxesAndLateFees
Late fees amount
Name of provider (Service Provider/Reseller)
Address of provider (Service Provider/Reseller)
Sentence describing the late fine rule (from
Message Properties file )
Id of provider (Service Provider/Reseller)
Language of provider(Service Provider/Reseller)
Formatted (money format) value for lateFine
Formatted (money format) value for taxes
Formatted (money format) value for
advanceCharges
onetimeCharges
Formatted (money format) value for ppuCharges
reserveCharges
amountPayable
curInvoiceAmount
Formatted (money format) value for adjustment
balanceAmount
paymentRecieved
prevInvoiceAmount
Invoice Logo of the provider (Service
Provider/Reseller) from branding
Format used for formatting money values, e.g.
gross_amount
Format used for formatting decimal values, e.g.
quantity
Format used for formatting date values, e.g.
invoiceDate
Currency code of the Service Provider
The locale, can be used to form formats for decimal
and money values
ENSIM CONFIDENTIAL
744
APPENDIXES
Alocale
Locale
invoiceDateString
decimalFormat
String
DecimalFormat
Discount
Double
distributorDiscountString
String
PromoDiscount
Double
PromoDiscountString
String
paymentAgreementMode
String
currencySymbol
orderContainerBean
String
List
<OrderContainerBe
an>
List<PaymentCont
ainerBean>
paymentContainerBean

8 APRIL 2016
The locale, can be used to form formats for decimal

and money values
Formatted (date format) value for invoiceDate
Format used for formatting decimal values, e.g.
quantity
Total Organization global discount acquired on
items of ordered Offers (if the Organization is a
distributor)
distributorDiscount
Total promotional discount acquired on items of
ordered Offers
PromoDiscount
Payment agreement mode. Can be Invoice in
Advance or Invoice in Arrears. Invoice in
Advance indicates advance charges for next month
for items of type reserved will be considered in this
invoice.
Currency symbol of Service Provider currency
Holds the list of orders in an invoice
Holds the list of payments made within a month
ENSIM CONFIDENTIAL
745
APPENDIXES
The following table provides description on the fields of OrderContainerBean datasource

Field name
Type
Description
orderNumber
reservedAmount
ppuAmount
onetimeAmount
advanceAmount
String
Double
Double
Double
Double
the number representing the order

The total amt of the items of type reserved
The total amt of the items of type ppu
The total amt of the items of type onetime
The total amt of the reserved items for next month
reservedAmountString
String
ppuAmountString
String
onetimeAmountString
String
advanceAmountString
String
money_format
String
decimal_format
String
date_format
String
currency_code
reportLocale
alocale
decimalFormat
gross_amount
grossAmountString
String
String
Locale
DecimalFormat
Double
String
promoOfferDiscountString
String
promoOfferDiscount
isPromoOffer
Double
Boolean
offerPaymentMode
currencySymbol
offername
startDate
endDate
startDateString
endDateString
productBeans
poNumberHR
String
String
String
Date
Date
String
String
List<ProductBean>
String

reservedAmount
Formatted (money format) value for ppuAmount

onetimeAmount
advanceAmount
String value for money format from Masseage
Properties file
String value for decimal format from Masseage
Properties file
String value for date format from Masseage
Properties file
The currency code of Service Provider currency
String value for locale used for formatting
locale used for formatting
Decimal format for formatting the decimal values
Billable amount without considering the discount
grossAmount
promoOfferDiscount
Promotional discount on Offer
Flag to decide whether promotional discount
exists
Payment mode at Offer level
The symbol for currency
Name of ordered Offer
Start date for monthly rated amount
end date for monthly rated amount
Formatted (date format) value for startDate
Formatted (date format) value for endDate
Holds list of items in the ordered Offer
Purchase order number

8 APRIL 2016
ENSIM CONFIDENTIAL
746
APPENDIXES
Note: The fields of headers are not included in the table. Change the value of headers by editing them
in the Messages_<locale>.properties file in the Tool.

8 APRIL 2016
ENSIM CONFIDENTIAL
747
APPENDIXES
The following table provides description on the fields of productbean datasource

Field name
Type
Description
itemName
quantity
itemtype
amount
itemUnit
productOfferId
productOfferDisplayNam
e
startDate
endDate
orderNumber
offerNameProviderLang
String
Double
String
Double
String
Integer
String
Name of Item
Quantity of Item
Type of Item
Billable amount of Item
Measuring unit of Item
Id of Offer
Name of Offer
Date
Date
String
String
itemNameProviderLang
String
quantityString
amountString
money_format
decimal_format
date_format
currency_code
reportLocale
alocale
decimalFormat
startDateString
endDateString
offerPromoName
offerPromoCode
String
String
String
String
String
String
String
Locale
DecimalFormat
String
String
String
String
offerPromoDiscount
offerPromoDiscountStrin
g
offerPromoStartDate
offerPromoEndDate
offerPromoStDateString
Double
String
offerPromoEdDateString
String
ValiidityStDate
ValidityEdDate
ValidityStDateString
ValidityEdDateString
Validity
Date
Date
String
String
String
Start date for monthly rated amount

End date for monthly rated amount
Number representing the order
Name of Offer in providers (Service
Provider/Reseller) language
Name of Item in providers (Service
Provider/Reseller) language
Formatted (decimal format) value for quantity
Formatted (money format) value for amount
Format for money values. E.g. gross_amount
Format for decimal values. E.g. quantity
Format for date values. E.g. startDate
Code of currency, E.g. USD
Locale for constructing formats
Locale for constructing formats
Format for decimal values. E.g. quantity
Formatted (date format) value for startDate
Formatted (date format) value for endDate
Name of Promotion applied to the Offer
Code to be provided when promo is of type Promo
code
Promotional discount on Offer
offerPromoDiscount
Start date of promotion
End date of promotion
Formatted (date format) value for
offerPromoStDate
offerPromoEdDate
Start date of Promo validity
End date of promo validity
Formatted (date format) value for ValidityStDate
Formatted (date format) value for ValidityEdDate
Formatted (date format) value with stant date and
end date of promo validity

8 APRIL 2016
Date
Date
String
ENSIM CONFIDENTIAL
748
APPENDIXES
promoAssociatedOn
Date
promoAssociatedString
String
promoProductDiscount
promoProductDiscountSt
ring
billedAmount
billedAmountString
isPromoProduct
Double
String
taxType
taxAmount
taxAmountString
currencySymbol
promoPlusDistriDiscItem
Str
String
Double
String
String
String
orderPpeElementBeanLis
t
listPrice
List<OrderPpeEle
mentBean>
Double
listPriceString
String

8 APRIL 2016
Double
String
Boolean
Double
Date at which the promotion was associated to the

Offer
promoAssociated
promoProductDiscount
Formatted (date format) value for billedAmount
Boolean to indicate whether promo discount is
available on the individual Item
Type of tax on the Item
Tax amount on the Item
Formatted (date format) value for taxAmount
The symbol of currency.
Billable amount of item for promo and
Organization global discount.
List amount of the the item if one of pricing given

in the Offer
List Amount as label
ENSIM CONFIDENTIAL
749
APPENDIXES
The following table provides description on the fields of Orderppeelembean datasource

Field name
Type
tierName
minValue
maxValue
basePrice
ppeQuantity
billedAmount
ItemName
minValueString
maxValueString
basePriceString
ppeQuantityString
billedAmountString
total_amountString
discount_amountString
Integer
Integer
Double
Double
Double
String
String
String
String
String
String
String
String
money_format
decimal_format
date_format
discount_amount
total_amount
currency_code
reportLocale
alocale
decimalFormat
tierNameProviderLang
currencySymbol
String
String
String
Double
Double
String
String
Locale
DecimalFormat
String
String
Description
The tier name.
Minimum value of the item.
Maximum value of item.
Base price of item.
The billable amount.
The name of the item.
Formatted (date format) value for minValue .
Formatted (date format) value for maxValue .
Formatted (date format) value for basePrice .
Formatted (date format) value for ppeQuantity .
Formatted (date format) value for billedAmount .
Formatted (date format) value for total_amount .
discount_amount .
Format for money values. E.g. gross_amount.
Format for decimal values. E.g. quantity.
Format for date values. E.g. startDate.
The discounted amount.
The total amount.
Code of currency, E.g. USD.
Locale for constructing formats.
The symbol for currency.
The following table provides description on the fields of PaymentContainerBean datasourceField name
Type
Description
paymentDate
Date
The date of payment.
amountPaid
Double
The paid amount.
amountPaidString
String
amountPaid .
description
String
money_format
String
decimal_format
String
date_format
String
Format for date values. E.g.
paymentDate.
currency_code
String
Code of currency, E.g. USD.
reportLocale
String
alocale
Locale
decimalFormat
DecimalFormat
paymentDateString
String
paymentDate .
8 APRIL 2016
ENSIM CONFIDENTIAL
750
APPENDIXES
Adjustment_no
String
Adjustment no for payment adjustment

entry
Datasources and fields for Reseller invoice report

The datasorce of main-report (ResInvoiceDetailsReport) for Reseller invoice report is
ResellerInvoiceDataContainer.
The following representation explains the datasources of sub-reports and the datasource to which they
belong
The following table provides description on the fields of resellerInvoiceDataContainer datasource

Field name
resellerId
resOrderBeans
paymentContainerBean
Type
String
List<ResOrderBean>
List
<PaymentContainerBean>
Description
Id of Reseller
Holds the list of orders in an invoice
Holds the list of payments made within a
month
The following table provides description on the fields of resOrderBean datasource
Field name
orderNumber
offerName
offerNameProviderLang
currency_code
String
String
String
String
resResourceBeans
List <ResResourceBean>

8 APRIL 2016
Type
Description
Order number of an order
Name of offer ordered
Name of offer in providers language
Currency code in which the amounts are
specified
ENSIM CONFIDENTIAL
751
APPENDIXES
The following table provides description on the fields of resResourcesBean datasource
Field name
itemName
itemType
Type
String
quantity
discount
grossAmount
Double
Double
Double
netAmount
Double
resourceProviderLang
String
quantityString
discountString
grossAmountString
netAmountString
String
String
String
String
Description
Name of resource(of item) in the ordered Offer
Type of resource (of item) in the ordered Offer.
type can be Reserved/PPU
Quantity of an item in the ordered Offer
Discount provided on the item
Billable amount of item without reseller
discount
Amount including discount (deducting
discount)
Name of resource (item) in providers
language
Formatted value of quantity
Formatted value of discount
Formatted value of grossAmount
Formatted value of netAmount
Appendix F: Custom Fields

EAS allows extension of various forms by enabling custom fields. These fields are available for Organizations,
Items, Offers and Orders. These fields are stored in DB as varchar columns and indexed for easy reporting. In
addition to these custom fields, PIFs can be used to extend the Order forms per Offer basis. Refer to the chapter on
Product Modeling for further details.
Organization Custom Fields
1.
2.
3.
In the configuration page, on the left side menu panel, a menu called Custom Fields will get
displayed for global configuration of the custom field.
On the right side, a tab panel with four individual tabs appears (Organization, Item, offer and
Order). The second tab is named Item. Item tab is used to set the custom field feature for Item
creation form.
Item tab contains information about the Item custom field. These fields are:
a. Rank for setting the order of the custom field in Item entry form.
b. Enabled: It enables the custom field for the item entry form.
c. Mandatory: This sets whether the custom field is mandatory or not.
d. Export: This sets whether this custom field will be added on the exported files or not. Using this
field, Service Provider may also set which of the custom fields are displayed in the invoice.
e. Show in Order: If enabled, then those respective custom fields will be displayed in the Order
screen.

8 APRIL 2016
ENSIM CONFIDENTIAL
752
APPENDIXES
Note: Fields that are enable will appear in the respective module.
Service provider can change the rank of the appearance of the custom fields from configuration.
By default, the names are displayed as Custom Field 1, Custom Field 2, and so on. These names can be
modified from message.properties file. EAS provides twelve additional custom fields for items.
Item Custom Fields

Item custom fields are used to store additional information of the items. With the current implementation at
most twelve additional fields (Custom fields) will be supported.
Apart from standard fields provided by EAS today, users may incorporate additional fields for item
creation to store item specific data like item creation date, external item code, item invoice id, etc.
By default these custom fields are not available. As per the requirement these fields can be
enabled/disabled/set mandatory by using the database script. By default, the names are displayed as
Custom Field 1, Custom Field 2, and so on. These names can be modified from message file. EAS
provides twelve additional custom fields. User may also set which of the custom fields will be displayed in
the invoice.

8 APRIL 2016
ENSIM CONFIDENTIAL
753
APPENDIXES
Offer Custom Fields

Apart from standard fields provided by EAS, users can add additional information for the Offers to store
Offer specific data. As per the requirement these fields will be included for the Offer. EAS will provide
twelve additional custom fields. These fields can be enabled or disabled or Service Provider user can set
mandatory of that field by using the configuration section. That enabled custom field will visible in offer
under General Properties tab.
Offer custom fields are used to store additional information of that Offer. With the current implementation,
at most twelve additional fields (Custom fields) will be supported. While creating or editing an Offer, under
General Properties tab a new option will available named as Custom Fields which contains all the
enabled offer custom fields. Only Service Provider can configure (enable, disable, set mandatory) the
custom fields from Custom fields option which is under Configuration menu. Service Provider, Reseller
type1 will able to insert value within the custom field section. All custom fields are free text only and it
supports maximum 1000 characters.
In the Offer forms (create offer/edit offer) custom fields (if enabled) will appear under the Custom Fields
heading in the General Properties section.
Order Custom Fields
1.
2.
3.
4.
In the configuration page on the left side menu panel a menu called Custom Fields will be display for
global configuration of the custom field.
On the right side, a tab panel with four individual tabs will be appeared (Organization, Order, order
and Order). The fourth tab is named Order. Order tab is use to setting the custom field feature for Order
creation form.
Order tab will contain the information about the Order custom field. The fields are
a. Rank for setting the order of the custom field in Order entry form.
b. Enable: It enabled the custom field for the order entry form.
c. Mandatory: It set the custom field is mandatory or not.
d. Export: It set whether this custom field will be added on export file or not. Service Provider
may also set which of the custom fields will be displayed in the invoice.
e. Visibility to ORG: It set the custom field will be visible to Organization or not. If this check box
checked the Organization would be visible, the custom field but not edit the custom field.
Selected Order custom field will be appear in Order page under Provisioning Information tab.

8 APRIL 2016
ENSIM CONFIDENTIAL
754
APPENDIXES
Note: Fields that are enable will appear in the respective module.
5.
Service Provider can change the rank of the appearance of the custom fields from configuration. The
Custom fields will be display as following the rank on the Order form.
Appendix G : Order Data removal

Delete Orders from UI
In EAS 4.2, orders can be deleted in two ways.
1. Hide Orders
2. Hide and Delete Permanently
To enable this, user role should have the Truncate and Hide order right enabled.
To delete the Order follow the steps below:

8 APRIL 2016
ENSIM CONFIDENTIAL
755
APPENDIXES
1. The Terminate and hide trashcan button appears in the Order details section of the orders in postprovisioning states and Abort state for Order delete/hide.
2. On clicking the button, the following dialog box appears:
3. Click Ok button to delete the service provisioning related data and hide the order from the portal.
The record of the Order still exists in EAS database as hidden.
4. To view the hidden Orders, click Advanced Search button and check the Show Hidden Orders.

8 APRIL 2016
ENSIM CONFIDENTIAL
756
APPENDIXES
5. The search result will include the hidden Orders. These orders remains in the database and there is
no action available through the UI to permanently delete these orders from the system.
6. The functionality of the Terminate and hide button will be extended to allow permanent order
delete. On clicking the Terminate and hide button, a dialog box will open with a checkbox that
saying Delete this order permanently.
7. If Delete this order permanently field is enabled, then the order will be deleted from EAS
database permanently.
Note: On permanent delete of the hidden order, the order still exists in the list of hidden Orders. Also,
the trashcan button will be seen in the details section of permanently deleted hidden order. If the user
clicks on the trashcan button of the already permanently deleted hidden order, an alert message will be
displayed saying that this order has been submitted for permanent deletion. This is because the
Provisioning Engine needs some time to erase related data before removing this record permanently
from the DB.
Appendix H: SPNEGO Authentication

Service Provider users can SSO into EAS from their devices that are connected to an Active Directory network
without login credentials. When Service Provider users log in to a client machine, under the AD domain and visit a
specially configured URL of EAS, they are logged into EAS without being prompted for login credentials. The
feature allows automatic on-boarding of these users based on their AD Security group membership and relies on
enablement of SPNEGO protocol. After on-boarding users will be prompted to change the account information.
Note: For SPNEGO configuration, refer to EAS Installation Guide.
Service Provider user having Super Admin role needs to configure the Role map for SPNEGO by executing the steps
below:1. Click Configuration-> IDM Configurations
2. Click Configure SPNEGO button.

8 APRIL 2016
ENSIM CONFIDENTIAL
757
APPENDIXES
3.
4.
Click Add New to create Security Group Role Map.

Fill in the required details, such asa. Provide the SID of the AD security group (refer to EAS 4.2 Installation Guide for finding the Security
Group SID).
b. Select the EAS role to map the respective security group. Only Service Provider roles will be displayed
in the list.
c. Enter the priority of the security group. If the user belongs to multiple security groups in AD, the one
with highest priority value will determine the primary role of the user in EAS.
If the priority of a security group is changed, the users primary role will be automatically updated to
the highest priority on next login
d. Provide a suitable name for the security group.
e. Once done, click Save Changes button.

8 APRIL 2016
ENSIM CONFIDENTIAL
758
APPENDIXES
Appendix I: Deleting Objects from EAS Database

Delete Order
Procedure name: delete_order(order_number)
This procedure is used to delete the order providing the corresponding order_number.
Execute the following commands for respective database vendors:
PostgreSQL: select delete_order(order_number);
Oracle: execute delete_order(order_number);
SQL Server: exec delete_order order_number;
Note: This script removes only the database entries from the EAS schema. If the order is already
provisioned in the native portal, delete or cancel the orders from EAS UI.
Delete Offer
Procedure Name: delete_offer(offer_GUID)
This procedure is used to delete the Offer providing the corresponding offer_GUID.
Conditions
Case-1
To verify whether the Offer has been ordered or not:
If the Offer has been ordered, first execute the delete order procedure and then, delete the Offer.
Case-2
To verify whether the Offer has been published or not:

8 APRIL 2016
ENSIM CONFIDENTIAL
759
APPENDIXES
If the Offer has been published to a Reseller, first delete the Offer from the Reseller and then, delete the
Offer.
PostgreSQL: select delete_offer(offer_GUID);
Oracle: execute delete_offer(offer_GUID);
SQL Server: exec delete_offer offer_GUID;
Delete User
Procedure name: delete_user(username, entity_ID)
This procedure is used to delete the Users providing the corresponding username and entity_ID (Specific ID
of the organization table for the corresponding entity which is being deleted).
Conditions
Case-1
To delete the user having single membership:
If the User belongs to a single Entity, then provide the username and entity_ID to delete the user.
Case-2
To delete the User having multiple memberships:
Deleting the User from a specific Entity

If the User belongs to multiple Entities, providing the corresponding username and entity_ID deletes
the user from that particular Entity.
Deleting the User from all the Entities

If the User belongs to multiple Entities, providing -1000 as a value in entity_ID field deletes the user
from all Entities.
If the user, which is associated (for example, TC, BC) with an order, is deleted, the user is replaced with
removed@localhost.local username.

8 APRIL 2016
ENSIM CONFIDENTIAL
760
APPENDIXES

PostgreSQL:
CREATE OR REPLACE FUNCTION get_test_read()
RETURNS VOID AS $$
DECLARE
status integer;
BEGIN
SELECT * FROM delete_user('<username>',<entity_ID>) INTO status;
RAISE INFO 'status: <%>', status;
END;
$$ LANGUAGE plpgsql;
select get_test_read();
Oracle:
DECLARE
VAR_LOGIN_ID VARCHAR2(200);
ENTITY_ID_PK NUMBER;
STATUS NUMBER;
BEGIN
VAR_LOGIN_ID := '<username>';
ENTITY_ID_PK := <entity_ID>;
DELETE_USER(
VAR_LOGIN_ID => VAR_LOGIN_ID,
ENTITY_ID_PK => ENTITY_ID_PK,
STATUS => STATUS
);
END;
SQL Server:
DECLARE @RC int
DECLARE @var_login_id nvarchar(1024)
DECLARE @entity_id_pk int
DECLARE @status int
set @var_login_id='<username>';
set @entity_id_pk=<entity_ID>;
EXECUTE @RC = [dbo].[delete_user]
@var_login_id
,@entity_id_pk
,@status OUTPUT
print @status
GO

8 APRIL 2016
ENSIM CONFIDENTIAL
761
APPENDIXES
Delete Organization
Procedure Name: delete_organization(organization_ID)
This procedure is used to delete an Organization providing the corresponding Organization ID (which is
visible in UI).
Impact
If Organization is deleted using this procedure, the following cases occur:
All Accounts of the corresponding Organization are deleted.
All Users of the Organization are deleted.
All Orders (if any) of the corresponding Organization are deleted.

PostgreSQL: select delete_organization(organization_ID);
Oracle: execute delete_organization(organization_ID);
SQL Server: exec delete_organization organization_ID;
Delete Reseller
Procedure name: delete_reseller(reseller_ID)
Execute this procedure to delete the Reseller providing the corresponding Reseller ID.
Impact
If Reseller is deleted using this procedure, the following cases occur:
The Orders placed from the corresponding reseller catalog are deleted.
All reseller users along with their memberships are deleted.
All Organizations and their Users along with their memberships are deleted.
The Offers or Items created or owned by the Reseller are deleted.
DNS names owned by the Reseller (type 3) are deleted.

PostgreSQL: select delete_reseller(reseller_ID);
Oracle: execute delete_reseller(reseller_ID);
SQL Server:
exec delete_reseller reseller_ID;

8 APRIL 2016
ENSIM CONFIDENTIAL
762

EAS 4.3 Service Provider Manual PDF

Diunggah oleh

Informasi Dokumen

Judul Asli

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

EAS 4.3 Service Provider Manual PDF

Diunggah oleh

Hak Cipta:

Format Tersedia

Ensim Automation Suite 4.

Service Provider Manual

Published: 8 April 2016

EAS 4.2 SERVICE PROVIDER MANUAL

About this guide

Getting started with EAS

Service Provider Signup ......................................................................................................................... 16

Service Provider entity and User Management ................................................................................... 20

Reset/regenerate Agent user password ..................................................................................... 63

Introduction ............................................................................................................................................ 106

EAS 4.2 SERVICE PROVIDER MANUAL

Map PIF Identifier ...................................................................................................................... 165

Introduction ............................................................................................................................................ 258

EAS 4.2 SERVICE PROVIDER MANUAL

Impact of Subscription............................................................................................................... 292

EAS Data Model

Identity Management ............................................................................................................................ 372

EAS 4.2 SERVICE PROVIDER MANUAL

Item quantity in an order .......................................................................................................... 385

Creating Bundled Service ..................................................................................................................... 391

Introduction ............................................................................................................................................ 397

EAS 4.2 SERVICE PROVIDER MANUAL

Change of Offer during Subscription period ......................................................................... 420

Introduction ............................................................................................................................................ 501

EAS 4.2 SERVICE PROVIDER MANUAL

Update ticket .......................................................................................................................................... 520

Introduction ............................................................................................................................................ 522

JasperServer Reports ............................................................................................................................. 568

EAS 4.2 SERVICE PROVIDER MANUAL

Deploying securely ................................................................................................................................ 580

Introduction ............................................................................................................................................ 583

Ensim Software License ........................................................................................................................ 625

Configuration ......................................................................................................................................... 630

Phone Number Inventory ......................................................................................................... 687

Appendix A: CSS ................................................................................................................................... 714

EAS 4.2 SERVICE PROVIDER MANUAL

About this guide

Intended audience and required skills

No description of these utilities will be available in EAS product guides.

Support and feedback

https://support.ensim.com to contact Ensim support.

EAS 4.2 SERVICE PROVIDER MANUAL

CHAPTER 1 ABOUT THIS GUIDE

Service Provider Entity

Services, Resources, Items and Offers

Promotions and Discounts

Upsizing and Upgrading

EAS 4.2 SERVICE PROVIDER MANUAL

Rating and exporting rated data

Invoicing and Payments

Getting started with EAS

Service Provider Signup

Click 'Save Changes' button to complete company signup process.

EAS 4.2 SERVICE PROVIDER MANUAL

GETTING STARTED WITH EAS

GETTING STARTED WITH EAS

Provide the Username and Password.

GETTING STARTED WITH EAS

The Dashboard page is divided into the following four sections

Content Management Placeholder

News and Announcements

Service Provider entity and User Management

Click the My Organization tab in the navigation bar.