Jump to: navigation, search
(Redirected from Category:License Manager)

Overview

  • The license manager module was introduced in Connect XF 3.14+.
  • To see the admin document for versions prior to Connect Xf 3.12, click here.
  • On placing an order with Mithi, a license will be generated for your organization, which has to be uploaded on the Connect Xf or SkyConnect system.
  • The license manager module of Connect Xf ensures that you adhere to the license agreement by restricting the usage to the licensed number of days and users.
  • In Connect Xf 3.12, the enhancements in the license manager are as follows:
- In earlier versions, the licenses were applied per domain. This created a problem when an enterprise bought licenses across domains. From version 3.12, a license can be applied for an organization and is applicable to all the domains belonging to the organization.
- Starting from Connect Xf 3.12, you can configure email alerts at predefined intervals on the license status.
- The license enforcement will depend on whether you are a SkyConnect (Mithi's hosted service) user or an enterprise user (where you host your own Connect Xf servers).
- The table below gives a summary of the impact of the license on the Connect Xf/SkyConnect working.
License Type Max number of days Max number of users Mithi support Admin operations Application access
Enterprise

As per license

As per license

Will be suspended on the day license expires

As per the tables in the next section.

Will continue to function even after license expiry

SkyConnect

As per license

As per license

Will be suspended on the day license expires

As per the tables in the next section.

Will continue to function for 14 days after license expiry, after which users will not be able to access email and chat accounts using HTTP/POP/IMAP/SMTP or XMPP

License status and administration restrictions

  • Admin operations related to the server setup such as backup, changing server setup etc are all allowed irrespective of the license status.
  • The restrictions are placed on the operations allowed using the application manager or the CLI to manage the Connect Xf/SkyConnect entities.
  • The sections below give the details:

Provisioning entities

  • This table assumes that your admin role allows you to provision all the entities below.
  • If your role does not allow provisioning of a certain entity, then it will be disallowed irrespective of the state of the license.
  • Some of the operations which reduce user count are:
- Deleting users
- Disabling users
- Moving them to another mail system
License State Organization Domain User Group Cos Role
Active

Allowed

Allowed

Allowed

Allowed

Allowed

Allowed

Near user limit threshold

Allowed

Allowed

Allowed to add only as many users as permitted by the license.

Allowed

Allowed

Allowed

User limit has expired

Allowed

Allowed

Allow only those operations that decrease the licensed user count.

Allowed

Allowed

Allowed

Near the time expiry

Allowed

Allowed

Allowed

Allowed

Allowed

Allowed

Time expired

Not allowed

Not allowed

Not allowed

Not allowed

Not allowed

Not allowed

Managing entities

  • This table assumes that your admin role allows you to manage all the entities below.
  • If your role does not allow managing of a certain entity, then it will be disallowed irrespective of the state of the license.
  • Critical operations are
- Uploading of licenses
- Resetting user/group passwords
- Resetting account lockout status


License State Organization Domain User Group Cos Role
Active

Allowed

Allowed

Certain operations, such as changing the account status affect the licensed user count. Such operations are checked with the license status. All other operations are allowed.

Allowed

Certain operations, such as changing the account status affect the licensed user count. Such operations are checked with the license status.

All other operations are allowed.

Allowed

Near user limit threshold

Allowed

Allowed

Certain operations, such as changing the account status affect the licensed user count. Such operations are checked with the license status.
All other operations are allowed.

Allowed

Certain operations, such as changing the account status affect the licensed user count. Such operations are checked with the license status.
All other operations are allowed.

Allowed

User limit has expired

Allowed

Allowed

Allow only those operations which reduce the licensed user count.

Allowed

Allow only those operations which reduce the licensed user count.

Allowed

Near time expiry

Allowed

Allowed

Certain operations, such as changing the account status affect the licensed user count. Such operations are checked with the license status.
All other operations are allowed.

Allowed

Certain operations, such as changing the account status affect the licensed user count. Such operations are checked with the license status.
All other operations are allowed.

Allowed


Time expired

Allow only the critical operations.

Allow only the critical operations.

Allow only the critical operations.

Allow only the critical operations.

Allow only the critical operations.

Not Allowed

Calculating the licensed users in the system

  • A licensed user is a user whose mailbox location is Connect XF and whose account status is enabled (full or partial).
  • The following do not add to the licensed users count:
- System users such as postmaster.
- Users whose accountstatus is disabled or expired.
- Users whose mailsystem is Others. (Users with Others mailsystem are hosted on the co-existence servers.)
- Aliases
- Groups
  • The command to get the number of licensed users for a domain is as given below:
/mithi/mcs/bin/getdomainlicensedusercount.sh

Alerts

  • As an admin you are alerted in two different ways:
- Notifications in the App Manager and the Command Line Interface(CLI).
- Email alerts to selected email ids at predefine intervals.
  • You will get alerts about the license status well in advance, so that the license can be renewed before it affects the daily working.

Notifications

  • The notifications in the App Manager will be given when performing operations which are controlled by the license. For example, when adding users to a domain, if the number of users have crossed a threshold as defined by you, then you will be given an immediate notification.
Example of an alert when the license time period is getting exhausted
Example of an alert when the number of licensed users has crossed the threshold
  • The thresholds for receiving notifications can be controlled by you. Please refer to the section on Configuring Organizations.

Email alerts

  • Email alerts are sent when you are nearing or crossed the user limit or the time limit.
  • Email alerts for user limits are generated everyday on crossing the 90% threshold.
  • Email alerts for time limits are generated 30,15,7,5,4,3,2 and 1 day before license expiry.

Installation

  • The license manager has been integrated in Connect Xf version 3.4+. The installation programs will automatically install all the components required.
  • The installation of Connect Xf does not require you to install the license immediately. Upon installation, you can continue to use the system for 60 days from the date of installation. After this trial period is over, admin operations such as changing properties of domains, users etc. will be suspended. Similarly, user addition will not be allowed after the trial period is over.

Upgrade

Upgrade from Connect XF 3.12.x.x to a higher version

  • The terms of the license do not change when Connect XF is upgraded.

Upgrade from Connect Xf 3.10.x.x to Connect Xf 3.12.x.x

(A) On upgrading from a Connect Xf 3.10 version to 3.12, the licenses applied to the domains will function as an enterprise license with the given user and time limits.
(B). The license will be applied to individual domains. However it is advisable to change the licenses to the new organizational licenses as given in the Operations section.
(C) In addition, the roles have to be updated to allow provisioning and managing the organization entities. For this you will have to review all the roles and update as necessary.

Upgrade from versions before 3.4.x.x

  • The upgrade framework will ensure that an upgrade from a lower version to Connect XF 3.4 will install all the required components automatically.
  • On upgrading from a lower version to Connect XF 3.4.x.x., the system will work as in the trial period. You can continue to have unrestricted usage for 90 days.
  • It is advisable to get a new license from Mithi which can be installed as soon as the upgrade is done.

Configuration

Server Configuration

None.

Roles

  • For an admin to be able to manage the licenses for his domain, his role must allow him to manage his organization.
  • Refer to Roles for more details.

Organizations

  • All domains created on Connect Xf 3.12 setup need to have an organization id.
  • The organization entity is where the license information is maintained.
  • On information on how to provision organizations click here and here

Upload an organization license using the command line interface

  • To upload a organization license using the command line, the license file has to be copied to the server.
  • After copying the file to the server, execute the following command from the command line
sh /mithi/mcs/bin/setorgproperties.sh --org <organizationname> --importlicense <license file absolute path> --replace --callerid <admin id> --callerpassword <admin password>

Upload a license using the App Manager

1. Login to the Application Manager interface using an account which has a role allowing you to manage and provision organizations.

2. Select the Entity View.

3. Click the + sign next to the Enterprise link. This will show Organizations, Domain and Role entities.

4. Click the + sign next to the Organizations link. This will display the list of existing organizations.

5. Click to select the name of the organization.

6. The Detail View will display the properties for the selected organization.

7. Click to select the Organization license tab.

8. The Detail view will show the details of the existing license.

9. To upload a new license, click the Upload license button on the bar.

10. An Upload license dialog box will be displayed on the screen.

11. Click the Add file button and select the license file to be uploaded.

12. The selected license file will be displayed in the list box.

13. Click the Upload button to upload the license file to the server.

14. If successful, the list box will display a message that the license has been uploaded.

15. Now, click the Apply license button to change the organization license properties.

16. For the new license to come into effect, restart the tomcat service and memcached services.

Query the license using the command line interface

  • The command to get the license details is as follows:
sh /mithi/mcs/bin/getorgproperties.sh --org <organizationname> --output orglicense  --outputtype list

Query the license using the App Manager

1. Login to the Application Manager interface.

2. Select the Entity View.

3. Click the + sign next to Enterprise' link. This will show Organization, Domain and Role entities.

4. Click the + sign next to the Organizations link. This will display the list of existing organizations.

5. Click to select the name of the organization.

6. The Detail View will display the properties for the selected organization.

7. Click the Organization license tab.

8. The Detail view will show the details of the existing license.

Managing the organization

  • The organization properties can be set from Entity View->Enterprise->Organization stage.


Organization Property Description
org

Name of the organization (used when creating the domain)

license

A non-editable property uploaded from the license.

licenseid

A non-editable property uploaded from the license.

licenserecipientname

A non-editable property uploaded from the license.

licenseorganizationname

A non-editable property uploaded from the license.

licensegenerationdate

A non-editable property uploaded from the license.

licenseenddate

A non-editable property uploaded from the license.

licensedomain

A non-editable property uploaded from the license.

licenseuserlimit

A non-editable property uploaded from the license.
This property gives the user limit specified by the license.

licensedusersadded

A non-editable property generated by the system.
This property gives the number of licensed users present.

licensetype

A non-editable property uploaded from the license.

licenseuserthreshold
  • This is an editable property and can be changed by you.
  • This is the threshold of user licenses before the maximum number of users allowed, from when you will be alerted to renew your license.
  • The alert will be in the form of a notification after user addition operations.

For example, if your license allows you to add 50 users and the threshold has been set to 10, then for every user addition after the 40th licensed user, you will be alerted to renew your license.

licenseperiodthreshold
  • This is an editable property and can be changed by you.
  • This is the number of days before license expiry, from when you will be alerted to renew your license.
  • The alert will be in the form of a notification after any operation which checks the license status.
  • For example, if your license is of 60 days and the threshold has been set to 10, then from the 50th day onwards, you will be alerted to renew your license after every operation that sets domain/user/group /cos property.
licensealertmailrecipients
  • The list of email ids to which the email alerts about the license status has to be sent.

Domain Configuration

Domain addition

  • In Connect Xf 3.12+, when creating a domain, you have to specify the organization to which the domain belongs.
  • The license applied to the domain will be that of the organization.
  • For instructions on how to add an organization, click here.
  • Note: You cannot keep the organization of a domain as blank, however you can change the organization.

Uploading a license for the domain

  • If your Connect Xf has been upgraded from 3.10 or below to Connect Xf 3.12, then the domains created before the upgradation will not have the organization id set.
  • In this case you can upload a license directly to the domain. For details on how to upload a domain license, refer to the Operations section.
  • However, this is not advised as you will not get the benefits of using an organizational license. Refer to the section on uploading licenses on how to upgrade from a domain license to an organization license.

User Configuration

  • To ensure that the co-existence users are not counted in the license the mailsystem user property of all users whose mailbox is hosted on a co-existence server (such as Exchange or Lotus) must be set to Others.
  • The mdcforwardtomailboxec property of all users must be set to Skip. Refer: Administration:Forward_to_mailbox

Operations

For a system upgraded from 3.10 to 3.12

Create a organization license for domain(s) having 3.10 licenses

  • After upgrading from 3.10 to 3.12, the domains on the server will still have the old 3.10 licenses.
  • The old licenses are applied on individual domains and are all enterprise licenses.
  • After upgrade, the licenses should be updated so that they are now organizational licenses.
  • The license updation is done only by the user having the a role which allows him to create organizations and upload licenses.
  • The process would be as follows:
- Get the list of domains on the server.
- Classify them into different organizations.
- Get the current license information, that is the number of users and the expiry date of the license of each domain.
- For each organization now we have to define the license details:
- The number of users for an organization will be the total of licensed users of all the domains under it.
- The expiry date should be ideally be same for all domains under an organization. If not, then separate licenses will have to be created.
- Once all the details are collated, then with the help of the relationship manager at Mithi, generate the new organizational licenses.
- Note: Generate the license without specifying any domain name.
- On the Connect Xf 3.12 system, create the required organizations, change at least 1 role to allow it to update the organisation properties and upload the licenses for the organizations using the updated role.
- Go over all the domains and change the organization id property for each domain.
- On changing the organization id, the domain license will not be referenced and the new organizational license will come into effect.

Create a domain license for domains having 3.10 license

  • Sometimes, it may be necessary to maintain a domain license for certain domains even after upgrading to Connect Xf 3.12.
  • The way to do it is to generate a new license with the domain name specified while generating the license.
  • This license can be uploaded to the domain itself.
  • Note: Once an organization id is given to any domain, after that you cannot upload a domain license for this domain. All subsequent licenses uploaded will have to be to the organization.

Upload a organization license for a new domain created after upgrade to 3.12

  • Any new domain created on a 3.12 system (even upgraded from 3.10) will behave same as a domain created on a freshly installed 3.12 system.

For a fresh installation of 3.12

  • For any domain on 3.12, we have to define the organization to which it belongs.
  • Licenses can be uploaded only to organizations.
  • The license expiry date will apply to all the domains of the organization.
  • The number of licensed users will be distributed across all the domains of the organization.
  • The email alerts of license expiry and user limit will be sent to the email ids specified in the organization.

Troubleshooting

The Upload license dialog box is exhibiting erratic behavior

  • This can happen if the App Manager session has expired.
  • Close the browser window and re-login to the App Manager.

Frequently asked questions

How will I know the details about my deployed license?

  • License status can be seen in the Application manager.
  • For version 3.12, the licenses can be uploaded for an organization or for a domain.

What happens if I dont renew the subscription before it expires or that I add more users than I am allowed to?

Please refer to the Overview section.

How will I know that my subscription is expiring or that I am about to cross my limit on number of users?

  • There are two ways you will be alerted.
- Every time you perform an operation on the CLI or the application manager console, if you have crossed a threshold, the system will show a warning message.
- You will also receive email alerts at predefined threshold.

What do I do, if I want to renew my License

As soon as you (administrator) start receiving alerts for your subscription period expiry date approaching OR for the total number of users about to cross a threshold, you may please raise a ticket on Mithi's helpdesk by sending a mail support@mithi.com so we can help you renew the subscription.