0% found this document useful (0 votes)
50 views20 pages

CALM - Client User Guidance Notes (AP)

This document provides user guidance for AVEVA's Client Activated License Management (CALM) system. It begins with a quick start guide to the basic functions of creating a license. The full user guide then provides more details on: prerequisites for using CALM; how CALM works by allocating tokens to license durations; the process for logging in with a provided username and password; how to create a license by selecting options and adding license lines; viewing user logins and license servers; running reports on licenses; and getting help/support.

Uploaded by

An le
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
50 views20 pages

CALM - Client User Guidance Notes (AP)

This document provides user guidance for AVEVA's Client Activated License Management (CALM) system. It begins with a quick start guide to the basic functions of creating a license. The full user guide then provides more details on: prerequisites for using CALM; how CALM works by allocating tokens to license durations; the process for logging in with a provided username and password; how to create a license by selecting options and adding license lines; viewing user logins and license servers; running reports on licenses; and getting help/support.

Uploaded by

An le
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 20

USER GUIDANCE NOTES

FOR

CLIENT ACTIVATED LICENSE MANAGEMENT

Version 1.1 1st January 2013

AVEVA Asia Pacific


Level 39, Menara 3 Petronas
Persiaran KLCC
Kuala Lumpur City Centre
50088 Kuala Lumpur
Malaysia

Telephone : +603 2718 0888


Facsimile : +603 2718 0808

Version 1.0 Page 1 of 20


Index

Quick Start ................................................................................................................ 3


Full User Guide ......................................................................................................... 5
1 Introduction.......................................................................................................... 5
2 Prerequisites ....................................................................................................... 5
3 Client Activated License Management – How it works. ....................................... 6
4 Logging In............................................................................................................ 7
5 License creation .................................................................................................. 9
6 User Logins ....................................................................................................... 16
7 License Servers ................................................................................................. 18
8 Running Reports ............................................................................................... 19
9 Previous Orders ................................................................................................ 19
10 Getting Help / Support ....................................................................................... 20
11 Logging Off ........................................................................................................ 20

Version 1.0 Page 2 of 20


Quick Start
This section gives a brief guide to the basic operations for creating a license within
CALM.

1. With the username and password details emailed to you, enter CALM at
http://calm.aveva.com/calm

2. From the login screen you will


be taken to the contracts
screen also referred to as your
homepage. To call off a license
from one of the listed contracts
click the CALL-OFF button.

3. In the call off screen first select


the license server from the drop
down list. Your license servers
will already have been added
by AVEVA

4. Select the product you require


from the product drop down list
• Select the type of duration you
want (day, month or set dates –
not all may be available)
• For day or month state the
quantity you need and enter the
START date. The END date will
be completed for you. For SET

Version 1.0 Page 3 of 20


DATES enter both the START and END dates.
• Enter the number of USERS (seats) required.
• Click ADD to save the license line.
• For further license lines repeat the above two steps
• When you have called off the license you require click PREVIEW ORDER

5. Confirm your license


requirement by checking the
details. If you are unsure or
wish to make changes then
click the BACK button and
revise your license
requirements. When sure click
the SUBMIT BUTTON to
generate the license.

6. Finally the license fulfilment


screen will indicate the creation
of the license file which will be
emailed to you.

7. When finished log out of


CALM.

Version 1.0 Page 4 of 20


Full User Guide
1 Introduction
AVEVA’s Client Activated License Management system, CALM for short, is a web
based license publication system that AVEVA’s Clients will use to administer their
own license needs as their business requires. The design of CALM takes the best
concepts from other AVEVA web based licensing systems and the commercial
advantage and flexibility of ‘on demand’ type licensing.

The benefits of CALM are:-


• It will provide a wider scope of licensing solution that better meets Clients
requirements for flexibility and scalability
• It enables Clients to manage license call-off themselves with minimal
involvement from AVEVA through a 24 x 7 web portal solution thereby
expediting speed of publication and placing management control into the
hands of those that need it.
• Because the license model is flexible there is a much improved degree of
license utilisation, less waste and therefore a greater efficiency compared with
other purchasing models.
• It is a simple straightforward model and is easy to manage and readily
supports a wide variety of licensing need.

2 Prerequisites
To access the CALM system you must use a web browser. The web browsers
supported are Internet Explorer version 6 onwards and Firefox version 1 onwards.
CALM makes extensive use of cookies, so these must be enabled on your web
browser. The system will not allow you to log in without them.

Version 1.0 Page 5 of 20


3 Client Activated License Management – How it works.
Your Company will purchase or pre-commit from AVEVA a number of tokens which
will represent an agreed financial contract value. The CALM contract will detail the
products your Company is entitled to use, together with the contract period over
which licenses can be taken. These contract details will be added to the CALM
system under your Client account. Each product in the CALM agreement will be
assigned a numeric token value. For example:-
• The token amount for one user to use PDMS for one day will be 10 tokens
• The token amount for one user to use PDMS for one month will be 250
tokens.
Each token value assigned equates to the use of the product by one user for an
elapsed period of time. The elapsed period of time is called the License Access Unit
or LAU. There are two elapsed durations of LAU available, day and month. When
creating a license of a given period, CALM concatenates or ‘glues together’ LAU’s to
form the license period optimising the most efficient use of LAU’s. The token count or
cost for the product is then simply multiplied by the number of users and the number
of LAU’s used to construct the license.

Example: - A license is required for PDMS starting 11th October and ending 14th
December for 25 users.

PDMS - 25 user license -11 Oct–14 Dec

Month Month Day Day Day Day


=250 =250 =10 =10 =10 =10

10 Nov/11 Nov 10 Dec/11 Dec 12 13


11 Oct 14 Dec

250+250+10+10+10+10 = 540 x 25 users = 13500

As you have product license responsibility, you will be registered within CALM and
thereby authorised to spend from the token commitment as you order your license
files. When licenses are created by you for an AVEVA product for a particular period
of time and for a number of users, the token rate for the product will be multiplied
accordingly for the number of users and then deducted from the tokens purchased.

Depending on the type of contract agreed products may not have both types of LAU’s
assigned. For Clients wanting to purchase PDMS for monthly periods, then only
month LAU’s may be assigned in which case only license periods of months can be
selected. The same principle also applies to those products that have only daily
LAU’s assigned, i.e.: the license period selected will be made up of daily LAU’s only.

Version 1.0 Page 6 of 20


4 Logging In
To access CALM, each client user is registered in the system and assigned a
username and password. When your user details are registered your email details
are included. When the registration is completed, CALM will advise you by email
using this address.

Example: - Email Acknowledgement: -

Dear John

You have been registered to use AVEVA's Client Activated License Management Facility.
This email confirms the login details for your use only.

Your Username is: John.Smith3


Your Password is: xxxxxxxxxx

Please keep these details confidential and safe. You must not disclose or communicate these to
any other party. Please report to AVEVA by email or telephone of any suspected or unauthorised
disclosure or breach.
It is clearly very important that you keep your username and password details
confidential and that you do not disclose or communicate them to anyone else.
Should you suspect that your username or password have been compromised in any
way please advise AVEVA immediately.

To log into the CALM system access the web site by typing the URL
http://calm.aveva.com/calm and insert your username and password into the
requested fields on the login screen. Six attempts are allowed by CALM to give the
correct username and password combination, after which you will be locked out for
10 minutes. This check is put in place to prevent automated hacking systems from
gaining access

Version 1.0 Page 7 of 20


Example: - Login Entry Screen: -

Once your login details are verified entry into the system will be granted and you will
be taken to your Client contract summary, which is also referred to as the
‘Homepage’

Example: - Client Contract Summary (Homepage) screen: -

Within the homepage, you will see all the contract agreements for your Company.
For each contract you will see the start and end date of the contract and the number
of tokens that were purchased. For each contract there will be on the right hand side
a coloured status display, which will give a general indication of the tokens used. It
will be green from 0% –> 80%, then it will change to yellow from 81% –> 90% and
then it will become red from 90% –> 100%.

Version 1.0 Page 8 of 20


5 License creation
From the homepage – to create a license from a contract click the ‘call off’ button on
the far right hand side this will then take you to the License Fulfilment Screen.

Once the screen is displayed select a license server from the drop down list of
available servers. License server details will have been added by AVEVA when the
account was arranged. (See section headed License Servers). When you have
selected the license server the screen will refresh. CALM will display the details of all
active licenses (if any) on that server with the new license call off area at the bottom.

Version 1.0 Page 9 of 20


To create your license requirement:-
1. Select the PRODUCT required from the drop down list of products available to
the contract.
2. Depending on the type of LAU’s assigned to the product (daily, monthly or
both) select the license UNIT option you require. If you select either DAY or
MONTH you will then need to type in the QTY field the number of days or
months required. The system will then fill in the END date based on the LAU
selected and the QTY number from the START DATE you give. If you select
SET DATES the QTY field will be ‘greyed out’ and you will need to choose the
START and END dates yourself.
3. Select the START DATE using the drop down calendar and (if day or month
LAU was chosen) the system will complete the END DATE.
4. If SET DATES was chosen then select the END DATE using the drop down
calendar.
5. CALM will prevent you from setting dates that begin before the contract start
date and from setting dates that occur after the contract end date.
6. Add the number of users required in the USERS field
7. Add a value in the PROJECT NUMBER field if you wish; it is not mandatory.
The value you give here will be displayed in reports and is intended to provide
you with the information to enable Company project cross charging. The
number of characters available to you is ten.
8. Click the ADD button and this completed license line will be added to your
order and displayed just above the call off line. The current and project
balance will also be updated to reflect the token count of the order. Note at
this stage you have not yet committed this order.

Version 1.0 Page 10 of 20


9. If the token count for a license order exceeds the token limits a warning will
appear and you will be prevented from confirming your selection and
PREVIEWING your order.

10. To resolve this warning, or if you want to make any changes to a license line
press the EDIT button on the license line and a new line will appear allowing
you to make changes to any of the parameters.

Version 1.0 Page 11 of 20


11. Once you have made the changes, press the SAVE button to confirm. The
token amounts will then be recalculated and the amended result displayed.
12. Further license lines can be added by simply following steps 1 to 8.
13. Once all license lines are complete you are then ready to confirm your order.
Click the PREVIEW ORDER to move to the next screen.

Version 1.0 Page 12 of 20


The confirmation screen will show you all the license lines for the chosen server.
These license lines will be both licenses that have been created previously but are
still active and the new licenses that you have requested. This will comprise the
entire license file that will be sent to you when you click the SUBMIT button.

Please check the new license lines that you have requested. These are highlighted
with a token value shown down the right hand side. If they are incorrect then click the
BACK button to return to the call off screen to make changes. If you are sure this
new license request in correct then click the SUBMIT button, remembering that once
called off licenses and tokens consumed will not be credited back to the account. By
pressing the SUBMIT button you are accepting this stipulation. You will then be taken
to the license generation screen where the license will be generated and when
complete emailed to your email address.

Version 1.0 Page 13 of 20


From time to time you might want to use a license call-off created previously as a
basis for a new license call off and just increment it by one month. For example a
PDMS license created for 4 users covering July 1st to July 31st needs to be continued
on from August 1st to August 31st. This license approach is a usual requirement of
monthly rental type license agreements. CALM provides you with this facility by
displaying in the CALL-OFF screen those license lines that are still active (Orange
header) above the call-off section (green header) together with the ability to easily
increment the chosen lines by one month as shown in the example below.

Version 1.0 Page 14 of 20


Should you want to use the active license as a basis for a new license but
incremented by one month, simply click the check box on the right hand side of the
license line(s) and click ‘+1 MONTH’

The new license line will appear in the CALL-OFF section along with any other new
license lines that you are creating. Changes to this license line can be made as
described earlier in this document by clicking the EDIT button.

Version 1.0 Page 15 of 20


6 User Logins
CALM provides three levels of user privilege:-

• Client User Administrator – creates other users, licenses and runs reports
• Standard User – creates licenses and runs reports
• Read Only User – view details, runs reports

If you are the Client System User it will be your responsibility to add new users to
your Client’s account and to set their privilege level. To add a new user click the
‘USERS’ tab which will take you to the users screen.

To create a new user click the ADD USER button this will take you to the ‘new user’
screen. Complete all details as required for the new user including setting the
privilege level. It is anticipated for each Client only two or three Client System Level
Administrators will be registered, all others being standard users or read only users.
However this is entirely your choice. The first and last names you give will be used to
construct their login user name but the initial password is automatically generated by
CALM. This can be changed by the user afterwards if needed. The email address
you give will be used by CALM to email the new user his username and password
details.

All users can edit their own details which includes the setting of alerts. Only Client
System Administrators can edit the details of other users.

Client System Users can access the details of all users on the account by clicking the
USERS tab and then selecting a user to edit by clicking the DETAILS button.

Standard and read only users can edit their details by clicking the ‘edit my details’ link
located in the grey bar at the top of every screen. Clicking the link takes you to your
details only. The main USERS tab is not displayed for standard and read only users.

Version 1.0 Page 16 of 20


The details available for you to change are:-

• Email address
• Telephone number
• Password
• Confirm password
• Setting alerts – clicking a tick in any of the boxes will send you
an alert to your email address when the token amount reaches
that point. You will be notified once only.

Click the SAVE button to retain any changes you wish to make. CALM will send a
confirmation email should you change your password. To ignore any changes made
simply click on any TAB.

Version 1.0 Page 17 of 20


7 License Servers
The license servers used by your Company are added to the CALM system by the
AVEVA Administrators. AVEVA will make host name and host ID changes or
additions/deletions to your license servers at any time in accordance with your
instructions. To see the details assigned to license servers within CALM for your
Company click the SERVER DETAILS tab.

Whilst AVEVA Administrators retain the task of adding or removing license servers or
changing the host name and host id, CALM provides two user defined fields (USER
FIELD1 & USER FIELD2) for you to enter data which can then be made available in
reports.

Any standard user can add data to a license server field in this screen, but only the
client system user can define the field headings. To define the field headings click the
EDIT HEADERS button and enter your values. When complete click the SAVE
button. Values can then be added to the license servers themselves. When finished
click the SAVE button to save the changes made.

Version 1.0 Page 18 of 20


8 Running Reports
To run a report from CALM click the REPORTS tab which will list a fixed set of report
formats.

To run a particular report, click the VIEW REPORT button. A full output will be
immediately displayed, but depending on the report chosen, you can filter down the
output. Chose values from the fields available and then click the FILTER button to
run the report again.

9 Previous Orders
Should you wish to see a list of all previously created license lines / orders, then
please click the ORDERS tab which will take to the screen displaying all past license
call-offs

Version 1.0 Page 19 of 20


10 Getting Help / Support
Should you encounter any difficulties with CALM and require help or advice, click the
SUPPORT tab which takes to the contact details screen. A support telephone
number together with a contact email address is also permanently displayed in the
grey band at the top right hand of every screen.

11 Logging Off
When finished in CALM click the LOG OUT tab to exit.

Version 1.0 Page 20 of 20

You might also like