MSP Settings

MSP Settings provide the MSP (Managed Service Provider) with the ability to customize the user interface, support information and branding for MSP tenants.

Compare to: Service Provider Settings for ISVs

1 Working with MSP Settings

In order to configure the MSP Settings, the following information should be available:

• Name of your Service (Domain Name), Email Support Address (Secure Email Service Provider Name), Terms of Service
• Header and Footer HTML code (Brand messaging that appears at the top and bottom of some pages: Login, Logout, Password Reset)
• Header and Footer image/logo (Images that appear in the Header/Footer areas)
• Default applications to be loaded when a new tenant is created
• Starting application for a newly registered user
• Application Catalog URL (Page that lists your available applications; Users will install applications from this page)
• Customization settings for the Customer Welcome Email (Personalize the message with the user's name, login name and password)

Users that have the Manage Tenants and Company Capabilities permission can manage MSP Settings

2 To Change Settings

1. Click Settings > MSP Settings
2. Select one of the configuration options shown below.
3. Make changes:

a. If it exists, click the [Edit] button, make changes, and then click [Save].

b. Otherwise, click one of the links in the page to work with that option.

Configuration options:

Service Configuration - Customize service configuration settings

Service Header HTML - Customize service header

Service Footer HTML - Customize service footer

Service Header Image - Customize service header logo

Manage Email Templates - Customize email templates

Manage Catalog - Customize the Catalog packages (requires the same kind of format as the default catalog page noted above)

3 Service Configuration

3.1 Basic Service Configuration

These values define the basic service configuration:

Parameter	Description	Typical Value
Service Name	Name of the MSP service	Carling Cloud Services
Service Domain	Choose a service domain from the list of service domains configured by the ISV	mydomain.com alternatedomain.com
Domain URL	Automatically populated, created from Prefix + Service Domain Learn more: About the Prefix for Service Domain	service.mydomain.com
Custom Help Domain	Optional; If present, it is the domain name for user help; Can be used with a custom Help URL in Custom Object	http://www.customhelp_mydomain.com Or, with Help URL http://www.customhelp_mydomain.com/userdefined_object_name

3.1.1 About the Custom Help Domain

The Custom Help Domain operates like the Help Domain, however it has an added benefit: it can be combined with the Help URL function to create custom help links for Custom Objects (excludes Built-in or CRM objects).

The following sections describe typical situations and the result when a user clicks the Help icon in a Custom Object.

3.1.1.1 How the Custom Help Domain and Help URL Work

• The platform automatically checks for http/https protocols; If they are not present, they are prefixed to the Help URL
• The custom Help URL can be an Absolute URL or it can be combined with the Custom Help Domain as a Relative URL:

• Absolute URL Example

Custom Help Domain	not applicable (When the Help URL is specified as an absolute URL, this value is ignored)
Help URL for an Inventory object	http://www.mydomain.com/help/inventory
Result: Click the Help icon in the Inventory object to invoke help at: http://www.mydomain.com/help/inventory

• Relative URL Example

Custom Help Domain	www.customhelp_mydomain.com
Help URL for an Inventory object	inventory
Result: Click the Help icon in the Inventory object to invoke help at: http://www.customhelp_mydomain.com/inventory

3.1.1.2 The Effect of Custom Help Domain and Help URL Settings

Both the Custom Help Domain and the Help URL are optional. These examples describe how user help is provided when these values are specified or omitted.

• Custom Help Domain and Help URL are specified

  All the specified Help URLs for Custom Objects are treated as relative to Custom Help Domain if they do not start with http:// or https://

Example:

Custom Help Domain	www.customhelp_mydomain.com
Help URL	inventory
Resulting help URL for the object is: http://www.customhelp_mydomain.com/inventory

Example:

Custom Help Domain	www.customhelp_mydomain.com
Help URL	http://myhelpdomain.com/inventory Because the http:// is specified in the Help URL, the Custom Help Domain information is not used
Resulting help URL for the object is: http://myhelpdomain.com/inventory

• Custom Help Domain is not specified

  The Custom Help URLs for objects are treated as complete URLs and are used to display help

Example:

Custom Help Domain:	n/a
Help URL	http://myhelpdomain.com/inventory
Resulting help URL for the object is: http://myhelpdomain.com/inventory

• Custom Help Domain and Help URL are not specified

  A generic help URL is formed using the 'Help Domain' field in Service Provider Settings.

Example:

Custom Help Domain:	n/a
Help URL:	n/a
Resulting help URL for the object: Reverts to the default Help Domain

3.2 Support Service Configuration

This information is published for users to contact you regarding your service.

• When tenants publish Packages, this email address receives the notification

Parameter	Description	Typical Value
Support Organization	Name of the Support Organization	Service Provider Support Team
Support Email	Email address to send support requests	support@mydomain.com

3.3 Service Theme and Stylesheet

Parameter	Description
Theme	Select a default Theme; Defines the tab, background and highlight colors
Allow Users to Change Colors	Optionally, allow users to personalize the color scheme for their pages. Checkbox: Yes/No

3.4 Tenant Configuration

This section is used by:

• ISVs and MSPs who are hosting clients on a shared instance of the platform.
• ISV users who are setting up an instance of the Installable Version in order to Develop on Separate Platforms.

Allow Unauthenticated Tenant Creation

Allows any prospective customer to create a new tenancy (a trial account).

• Unchecked by default
• If checked, trial accounts can be created by unauthenticated users who have a computer and network connection that meets the Minimum System Requirements

Enable Tenant Subdomains

This setting lets customers specify a URL subdomain when registering, giving them a unique URL they can use to access their platform applications.

Learn more: Tenant Subdomains

3.5 Catalog Configuration

Configuration for application Packages:

Package Catalog URL

The URL of the Application Catalog, where Packages are published.

Default is Service?t=8 (https://na.longjump.com/networking/Service?t=8)

Include Global ISV Catalog

Checkbox.

• Default is Yes.
• When checked, application packages in the ISV catalog are available for installation.

Considerations

• This is the older format used to display a list of published packages. In this format, only an image and a short description are displayed for each package. The newer Community Marketplace functionality can be selected in the Community section that follows. That format allows more Catalog Information to be displayed for each application package.

• If you want to use this functionality, you should disable the Community Tenant defined in the next section. Otherwise, you should clear the Package Catalog URL field.

• The list of Packages available for installation can vary, depending on whether packages are approved for publication, and whether the approval comes from the ISV or the MSP.

• Packages approved by an MSP are available to MSP users and MSP tenants.
• Packages approved by the ISV are available to ISV users.
• By default, such packages are available to MSP users and their tenants, as long as the MSP has Include Global ISV Catalog option enabled in their MSP Settings.

Learn more: Manage Catalog

3.6 Registration Configuration

Choose the default settings for new tenants:

Registration Sidebar

HTML for the Sidebar on the user registration page. (If empty, this section of the registration page is not displayed.)

Enable App Center

Gives tenants access to the My Applications / App Center functionality.

If enabled:

• A [My Applications] button appears in the GUI.
• Clicking it takes the user to the App Center.
• Installed applications are listed in the My Applications tab
• The specified HTML is displayed in the Sidebar.
• The user has access to wizards to create objects, import spreadsheets, and establish Object Relationships.
• Many-to-Many relationships can be created merely by specifying the desired relationship.
  (The inner Junction Objects are created automatically.)

If disabled:

• An [Applications] button appears in the GUI.
• Clicking it displays a dropdown list of applications.
• A link in that list takes the user to the application Catalog.
• Wizards are not available.
• Many-to-Many relationships are established manually, by creating the junction object and creating the appropriate Lookup relationships to the endpoint objects.

URL for Terms of Service

URL of the Terms of Service page, created by the ISV

Optionally, MSPs can supply a URL to a custom Terms-of-Service page. (If empty, this section of the registration page is not displayed.)

Default Packages

• This section appears only when the App Center has been disabled.
• The contents of the application Catalog are shown.
• Choose the applications that will be loaded by default when a new tenant is created.

3.7 Starting Application Configuration

• From this section, choose the starting application for newly registered users.
  Users can change the default starting application at a later time

4 Service Header HTML

Settings > Service Provider Settings > Service Header HTML

The Service Header appears at the top of the page (header), and defines the stylesheet for these pages:

• Login
• Logout
• Applications Catalog
• Reset Password

Find a cut-and-paste example: Service Header HTML Code Sample

To Edit the Service Header HTML:

1. Enter Raw HTML Text (Copy & Paste Raw HTML) into the editing area
2. Click [Save]

5 Service Footer HTML

Settings > Service Provider Settings > Service Footer HTML

The Service Footer appears at the bottom of the page (footer), and defines the stylesheet for these pages:

• Login
• Logout
• Catalog
• Reset Password

Find a cut-and-paste example: Service Footer HTML Code Sample

To Edit the Service Footer HTML:

1. Enter Raw HTML Text (Copy & Paste Raw HTML) into the editing area
2. Click [Save]

6 Service Header Image

Use this option to change the Service Header logo. This logo appears in the heading area of every page. Required dimensions: 900px by 55px.

7 Manage Email Templates

Settings > MSP Settings > Manage Email Templates

With these options, Service Providers can personalize communications with tenants and build value with customized branding and messaging.

Template variables can be used to personalize the Subject or Body of the message.

Learn more:

• Template Variables in Service Provider Email Messages
• Template Variables in Email Templates

7.1 Managing Email Templates

To edit an email template:

1. Click Manage Email Templates
2. Select a template from the list
3. Click [Edit], and modify the settings:

   Email Subject

   Subject of the email message

   Use Email Header & Footer

   Default is Yes; if enabled, displays the Service Header HTML and Service Footer HTML

   HTML Email Body

   HTML code is provided, which can be edited in place, or replaced (via cut-and-paste action from an HTML editor).

7.1.1 Email Header/Footer

Manage Email Header/Footer Settings

Email Header HTML

Email Footer HTML

Use this option to specify the Email Header and Footer HTML code used in system-generated Email Notifications. Examples of typical system-generated email notifications are:

• Task status update/notifications
• Welcome email message sent to new users
• Appointment reminder email messages

The HTML code creates a template for system-generated messages, and can be used to brand your notification messages.

1. Email Header HTML - appears at the top of system-generated email messages
2. Email Footer HTML - appears at the bottom of system-generated email messages

Find cut-and-paste examples here:

• Email Header HTML Code Sample
• Email Footer HTML Code Sample

7.1.2 Tenant

Manage Tenant Welcome Messages:

Tenant Self-Registration Welcome Email

Tenant Registration by ISV/MSP Welcome Email

Email Verification

7.1.3 User

Manage User Notification Related Emails:

User Welcome Email

Used in messages sent when a user account is created, and provides a link to the Login page

Reset Password Email

Used in messages sent when the user password has been reset, and provides the user's password

Forgot Password Link Email

• Used in messages sent when the user clicks the Forgot my Password link, and provides a link to the Security Question
• Learn more: Login

Forgot Reset Password Email

• Used in messages sent after a user requests a password change, and provides a new, temporary password
• Also used when a new user/tenant is added via REST API - Add a User, and a password not specified when the user record is created

7.1.4 Task

Manage Task Notification Related Emails:

New/Edit Task Email

Change new/edit task email template

Task Completed Mail

Change task completed email template

Task Reminder Email

Change task reminder email template

Project Task Reminder Email

Change project task reminder email template

Send Note Email

Change send note email template

7.1.5 Appointment

Manage Appointment Notification Related Emails:

New/Edit Appointment Email

Appointment Reminder Email

7.1.6 Status

Templates for Status Notification Emails:

Export Status Email

Mass Operation Status Email

Import Status Email

Report Status Email

Translation Export Status Email

7.1.7 Package

Templates for Package Notification Emails:

Package Approval Email

Package Rejection Email

Package Publish Email

Package Deploy Notification Email

7.1.8 Storage Notifications

Set Up Templates for Storage Notifications:

90% Storage Space Exhausted Status Email

100% Storage Space Exhausted Status Email

7.1.9 Case

Manage Case Related Notification Emails:

New Suppport Case Notification Email

Support Case Update Notification Email from Provider

Support Case Update Notification Email from Customer

7.1.10 Other

Manage Other Notification Emails:

Ownership Change Mail

Accessories exceeded notification email

Templates to used when:

• Scheduled Job Limits exceeded
• API Calls Limit exceeded

8 Manage Catalog

Settings > Service Provider Settings > Manage Catalog

Configure Catalog options.

Catalog

View the current Catalog

Approve Packages

Review Packages pending approval

User can either:

• [Approve] package for publication to the catalog
• [Reject] package, and deny publication to the catalog

In either case, an email is sent to the submitter, to tell them the outcome.

Learn more: Package Approval or Rejection

Select Packages

Choose the packages to display in the Catalog

User can either:

• Move a package into the Visible column to display the package in the catalog
• Move a package into the Hidden column to remove the package from the catalog
• Set the order of the list of Packages in the catalog

Considerations

• If an ISV moves a package from the Visible column to the Hidden column, it is removed from all the Tenant and MSP Catalog pages, and is no longer available for installation.
• If an ISV moves a package from the Hidden column to the Visible column in Manage Catalog, the package will be displayed in the Tenant and MSP Catalog pages.
• If an MSP removes a package from the MSP Catalog, it is removed from that MSP Catalog page only, and is no longer available to the Tenants of that MSP.