Installation

To support the CLM features, your ubersmith instance must first be on version 5.1.0 or greater.It is recommended that you test out the CLM 1st on a dev instance before installing it in production.  To gain access to the add-on, it must be enabled for your license. You need to contact the Ubersmith team to enable it for you. 

Once you have the confirmation that your license has been updated, you must refresh your ubersmith instance token to see the change.

Navigate to Settings -> License Details, Under the Instance Details section, click the Update Token link. To confirm you have access to the CLM add-on, it should now appear as Active: Yes in the add-on list. 

Note that the add-on is enable per license. This means that all your ubersmith instances linked to that license will gain access to the CLM add-on.

First Things to do

Set Permissions

The Admin and Client permissions should be adjusted according to your needs.

Clients/Contacts

For Clients, the permission is added as a child permission under Client Portal and Billing & Services. If Those parent sections are set to Allow , the new contract permission will inherit this value.

If you prefer to hide the CLM from the client portal, make sure that this permission is set to Deny .

Bellow is an example with the default inherited value and then changed afterward with the role.

Admin users

Verify the permissions for the admin Users. By default, the new contract permissions will inherit their parent section access level. They can be managed like any other permission: directly on the user profile or by using roles.

Contract Settings

Each contract will will be assigned a unique number. This sequence is configurable in Settings ➝ Contract settings.

By default the prefix is CON with a 6 digits number starting at 1 with leading zeros.

At any points in time, this can be updated. The only limitation is with the sequence number. Once a contract has been generated and assigned a number, the sequence cannot be changed for a lower value. In other words, the sequence number can only be set to larger value.

When setting the next sequence number, as long as no contract as been generated, this value can still be edited.

Reminder: Those settings are brands specific, but contract numbers will be unique across all brands.

Where can I use the CLM add-on?

It is recommended to read the full CLM Documentation but the following sections offer a quick overview of what to expect once the CLM is enabled on an ubersmith instance.

Admin User Interface

After enabling the CLM add-on, new features and new sections will be available in the UI of the admin portal.

Under the Clients section, a new Contracts tab will show when viewing a client.

The Add Quote popup will have a new button to add a contract directly to it.

On a Quote, there will be a new Contract section. If none is present, a new one can be added.

Quote with a contract defined:

There is a new Contract section in the Settings.

Client Portal User Interface

When given access, a contact can view their contracts by clicking the View Contracts menu link under Billing & Services.

A link for the open and closed tickets will be displayed in the contract view allowing the user to view the list of tickets for which the contract is associated with.