LongJump Support Wiki

MSP Settings

From LongJump Support Wiki
Revision as of 00:53, 28 June 2011 by imported>Aeric

MSP Settings provide the MSP (Managed Service Provider) with the ability to customize the user interface, support information and branding for MSP tenants. These settings are part of the LongJump Platform Tenant Management System.

Compare to: Service Provider Settings for ISVs

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), Copyright Notices, 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)

Lock-tiny.gif

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

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)

Service Configuration

Basic Service Configuration

These values define the basic service configuration:

Parameter Description Typical Value
Service Name Name of the MSP service Carling Cloud Services
Prefix for Service Domain Optional, a subdomain name
Learn more: About the Prefix for Service Domain
 Allowed characters: a-z, A-Z, 0-9, - (alphanumeric, plus hyphen)
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
Copyright Notice Copyright notice, appears at the bottom of all pages Copyright 2009
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

About the Prefix for Service Domain

This defines the subdomain name for the service. The subdomain name can only accept alphanumeric characters or the underscore character.

Before configuring a prefix for the service domain, contact your Service Provider, who is responsible for configuring the related DNS settings


Examples
Prefix for Service Domain Service Domain Domain URL (Read Only)
www.abcde.com www.abcde.com
xyz www.abcde.com xyz.abcde.com
xyz abcde.com xyz.abcde.com

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 Helpicon.gif icon in a Custom Object.

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
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


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
Available Case Types Picklist of types of support cases
Issue
Request
Query


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

Tenant Configuration

This section is used by:
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


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

Registration Configuration

Registration Configuration

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

Application Container URL

Application Container URL

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]

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]

Service Header Image

File:Mspserviceheader.gif

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

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:

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).

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:

Tenant

Manage Tenant Welcome Messages:

Tenant Self-Registration Welcome Email
Tenant Registration by ISV/MSP Welcome Email
Email Verification

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

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

Appointment

Manage Appointment Notification Related Emails:

New/Edit Appointment Email
Appointment Reminder Email

Status

Templates for Status Notification Emails:

Export Status Email
Mass Operation Status Email
Import Status Email
Report Status Email
Translation Export Status Email

Package

Templates for Package Notification Emails:

Package Approval Email
Package Rejection Email
Package Publish Email
Package Deploy Notification Email

Storage Notifications

Set Up Templates for Storage Notifications:

90% Storage Space Exhausted Status Email
100% Storage Space Exhausted Status Email

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

Other

Manage Other Notification Emails:

Ownership Change Mail
Accessories exceeded notification email
Templates to used when:
  • Scheduled Job Limits exceeded
  • API Calls Limit exceeded

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.
Retrieved from "https://agileappscloud.info/ljwiki-src/index.php?title=MSP_Settings&oldid=5805"