Service Provider Settings

Settings > Service Provider Settings

The Service Provider Settings provide options for ISVs to customize the user interface, brand the platform, and customize the user experience with personalized logos, art, fonts, color schemes, email messaging, campaigns, and more.

Compare to: MSP Settings, a set of configuration options for MSPs

Working with Service Provider Settings

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

In order to configure the Service Provider 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 during user registration
Starting application for a newly registered user
Application Catalog URL
- Page that lists available applications; Users will install applications from this page
- Default is https://{domain}/networking/Service?t=9
Customization settings for the Customer Welcome Email (Personalize the message with the user's name, login name and password)

To change settings: :

Click Settings > Service Provider Settings
Select one of the configuration options below.
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

Settings > Service Provider Settings > Service Configuration

Basic Service Configuration

These values define the basic service configuration:

These parameters are required for First-Time Service Configuration:

Configure the Service Settings and specify Service and Domain names:

Parameter	Description	Typical Value
Service Name	Name of the service provider	`Financiocorp Services`
Prefix for Service Domain	Optional subdomain name	Allowed characters: `a-z, A-Z, 0-9, -` (alphanumeric, plus hyphen) Example: `service`
Service Domain	The Domain Name part of the URL	`mydomain.com`
Domain URL	Read Only Automatically populated as: Prefix + Service Domain	`service.mydomain.com`

The remaining parameters are also required:

Parameter	Description	Typical Value
Copyright Notice	Copyright notice, appears at the bottom of all pages	`Copyright 2010`
Space Notification Email Address	An email message is sent to this address when Storage Space limits are reached	`systemadministrator@mydomain.com`
Error Notification Email Address	An email message is sent to this address when errors occur	`customer_support@mydomain.com`
Help Domain	Required field; Domain name for user help; This page is opened in a new browser window when Help is invoked from the platform	`http://www.mydomain.com/help`
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`
Document Directory	File location for Documents	`/usr/local/`
Temp Directory	Used as a temporary storage location	`/temp/`

About the Prefix for Service Domain

About the Help Domain and the Custom Help Domain

As a Service Provider, you might create a help website to align with a customer's branded instance of the platform. In this case, the URL of this help website would be used as the default Help Domain. When a user clicks the Help link in the platform, this default Help Domain opens in a new browser window.

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

Email Configuration

Configuration for all the emails sent from the AgileApps Cloud platform.

Parameter	Description	Typical Value
Hostname For Relay Server	Hostname	`localhost`
User Name	User/login name for the email relay server
Password	Password related to the user/login name for the email relay server

Bounced email configuration for processing for all the emails bounced from the platform.

Learn more: Bounced Email Configuration for Alternate Service Domains

Parameter	Description	Typical Value
Enable Bounced Email processing	Email Bounce Address	Checkbox: Yes/No
Hostname	Hostname	`pop.my_secure_email_provider.net`
Mailbox Address	Email Mailbox Address	`bounce@myemailprovider.com`
Mailbox Password	Specify the password for this email account	`T0pS3cr3tPa$$word`
Enable Bounced Email Processing to the Alternate Service Domain	Email Bounce Address	Checkbox: Yes/No
Hostname	Hostname	`pop.my_secure_email_provider.net`
Mailbox Address	Email Mailbox Address	`bounce@my-alternate-emailprovider.com`
Mailbox Password	Specify the password for this email account	`T0pS3cr3tPa$$word`

Bounced Email Configuration

This email configuration will process all the bounced emails sent through the platform. When an email message does not reach the recipient, it is returned (considered "bounced"). This can happen when an email address is no longer active, or because the recipients' email box is full.

To enable Bounced Email Processing:

From the Email Configuration section, complete the following information:
Enable Bounced Email Processing
Click the checkbox icon to enable processing for bounced email messages and complete the information in the required fields
Optionally, Enable Bounced Email Processing to the Alternate Service Domain
Click the checkbox icon to enable processing for bounced email messages and complete the information in the required fields

Test Email Configuration

To test the email configuration:

From the Email Configuration section, click the [Test Email Configuration] button
Complete the following information:
Address

Email address of the intended recipient

Subject

Description of the message

Text

Message body

File:Testemailconfig.gif

Marketing Campaign Email Configuration

This email configuration is used to send email messages as part of an Email Campaign. This email setup provides the ability to personalize the marketing messages sent from your organization. It is possible to configure Marketing Campaign Email from a email relay server. This configuration is applied immediately after settings are saved, and are used for any new Email Marketing Campaign.

To setup Marketing Campaign Email Configuration:

Click Settings > Service Provider Settings > Service Configuration
In the Marketing Campaign Email Configuration section, and complete the following information:
Use Vertical Response

Checkbox

If checked, use a Vertical Response account; Learn more: Vertical Response Configuration

The following information is required to configure Email Marketing with Vertical Response

Login: Vertical Response account username
Password: Vertical Response account password
Keystore Password: Password of Vertical Response keystore file

If unchecked, complete the following information to configure Marketing Campaign Email:

Hostname For Relay Server: IP address or the Domain name of the email relay server
Port: The TCP port of the email relay server; The default value is 25 and can be changed
User Name: The username associated with the mailbox used to connect to the email relay server
Password: The password associated with the mailbox used to connect to the email relay server
From Email Address: This address is displayed on the email as from email address

To process bounced emails for Marketing Campaign, complete the following information:

Hostname: Hostname used for processing the bounced emails generated by the marketing campaign
Port: The TCP port of the email relay server; The default value is 25 and can be changed
Mailbox Address: The mailbox used for processing the bounced emails from the Email Marketing campaigns
Password: The password for the mailbox used to track bounced emails

Considerations

If the email relay server details are specified:

Any Marketing campaign that is launched is routed through the configured server, including Test email messages
Bounce email configuration is required if the email relay server details are specified

It is not possible to specify just the email relay server details without specifying the bounce mailbox and password

The bounce mailbox address must be validated to ensure that the value does not match the other Mailbox addresses that are present in Service Provider Settings

If the email relay server details are not specified:

Campaigns can be created, however it is not possible to send a test message or launch the campaign
Any Callback URL in the Marketing campaign emails point back to the Service Domain that has been specified in the Service Provider Settings

External Email Tracking Configuration

To enable external email tracking, set the following attributes to initialize the service:

Parameter	Description	Typical Value
Enable External Email Tracking	Option to enable External Email Tracking	Checkbox: `Yes/No`
Hostname	Specify the email provider hostname that manages email messaging to/from your site	`pop.my_secure_email_provider.net`
Mailbox Address	Specify the email address used for email messaging to your site	`service@mydomain.com`
Mailbox Password	Specify the password for this email account	`T0pS3cr3tPa$$word`

Process Workflow by Email Configuration

Workflows can be email-enabled, using these attributes:

Parameter	Description	Typical Value
Enable Workflow By Email	Option to allow Workflow managment via email	Checkbox: Yes/No
Hostname	Specify the email provider hostname that manages email messaging to/from your site	`pop.my_secure_email_provider.net`
Mailbox Address	Specify the email address used for email messaging to your site	`service@mydomain.com`
Mailbox Password	Specify the password for this email account	`T0pS3cr3tPa$$word`

Service Theme and Stylesheet

Parameter	Description
Theme	Select a default Theme; Defines the color for the tabs, background and highlight colors
Allow Users to Change Colors	Optionally, allow users to personalize the color scheme for their pages. Checkbox: Yes/No
URL for Custom Style sheet	Specify the URL for a CSS (Cascading Style Sheet) that is applied to all pages

Develop Configuration

Java code running in a tenancy is subject to strict limits--or governors:

Some settings put limits on the number of resources that tenants can use, to prevent infinite loops and other kinds of runaway programs. The limits apply to each tenant execution interval--from the time that the platform application instance gives control to tenant code, until the time that control returns to the platform. Up to that limit, an application can use as many resources as it wants. But once a constraint is exceeded, the executing code aborts with an exception.

Other settings restrict the kinds of Java classes that can be used, to prevent unwarranted access to the server and/or security violations.

The Service Provider Settings can be used to tighten those restrictions, ameliorate them, or lift them entirely.

Considerations

Settings are global. They apply to all tenants in the platform instance.
Settings apply to scheduled (background) jobs, as well as foreground applications.
The minimum for all numeric settings is "1".
Changes to these settings take effect only when the platform application instance is restarted.

Here are the default settings:

Parameter Description Default Value

Apply Governors in Java Code?

Whether or not governors are applied to this platform instance. A development instance may want to turn them off, in some cases. Any multi-tenant production instance will want them on, to ensure that a runaway program in one tenant does not interfere with other tenants.

Note: Currently, the code governance is available for Linux installations only.

Yes

Max Number of Statements allowed

The maximum number of Java code statements that can be run during an execution interval.

10000

Maximum String Length allowed

The total size of all strings allocated in the Java heap space during an execution interval.

30000

Maximum CPU Time allowed (milliseconds)

The maximum number of CPU milliseconds that can be consumed during an execution interval.

60000

Java classes not allowed in code

There are certain Java classes which are disallowed in tenant classes, to prevent access to the server and any compromise of server security. (They are, however, allowed in global classes developed by the ISV for use by all tenants.)

In order to protect the security of the server, enter a comma-separated list of fully qualified Java Class Names for this option. At compile time, application will check if any of these classes are referenced in the user code and throw an exception if they are. Note that this will take effect only after the server is restarted.

<syntaxhighlight lang="java" enclose="div"> java.lang.System, java.lang.Runtime, java.lang.Class, java.lang.ClassLoader, java.lang.Thread, java.lang.ThreadGroup, java.lang.ThreadLocal, java.lang.Runnable, java.lang.Compiler, java.lang.RuntimePermission,

java.lang.reflect.AccessibleObject, java.lang.reflect.Array, java.lang.reflect.Constructor, java.lang.reflect.Field, java.lang.reflect.Method, java.lang.reflect.Modifier, java.lang.reflect.Proxy, java.lang.reflect.ReflectPermission,

java.io.FileReader, java.io.FileWriter, java.io.FileInputStream, java.io.FileOutputStream,

java.net.DatagramSocket, java.net.DatagramSocketImpl, java.net.HttpURLConnection, java.net.Inet4Address, java.net.Inet6Address, java.net.InetAddress, java.net.InetSocketAddress, java.net.JarURLConnection, java.net.MulticastSocket, java.net.ServerSocket, java.net.Socket, java.net.URL, java.net.URI, java.net.URLClassLoader, java.net.URLConnection, java.net.URLStreamHandler, java.lang.Process, java.lang.ProcessBuilder </syntaxhighlight>

Libraries supported in Java Code

When compiling user-defined code, the platform allows certain libraries like jars or internal java packages:

If a custom library is required, the jar can be placed in the ../tomcat/lib folder of the Apache Tomcat installation

To include these library files, enter a comma-separated list of such jar files for this option
Note that this will take effect only after the server is restarted.

Empty

No. of Objects in Database Views

Database Views allow the creation of custom categories that join multiple objects

These database views can be used as the base category for a Report
The maximum number of tables that are allowed is five (5), with a default value of three (3)

The number of joins in these tables is restricted to the maximum number + 1

Default: 3, Range is 3-5

Maximum rows in a List View

Maximum number of rows that are fetched in a List View for an object is defined by this option

This number is limited by the maximum int value supported by Java/MySQL i.e. 2^16 = 4G

10000

Maximum rows in a report

Maximum number of rows that are fetched in a report
This number is limited by the maximum int value supported by Java/MySQL i.e. 2^16 = 4G

5000

Maximum rows in a Scheduled Report

Maximum number of rows that are fetched in a report that runs in the background queue.
This number is limited by the maximum int value supported by Java/MySQL i.e. 2^16 = 4G

5000

Maximum Savepoints Intermediate placemarks, which identify points at which the data fields contain intact, legitimate values 5

Maximum Recursions in Java API Allow a function to call itself the specified number of times 10

Tenant Configuration

This section is used by:

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

Instance Configuration

This section is used by ISVs who are using the Installable Version of the platform to set up multiple collaborating instances.

Instance Type: Choose one of: Development, Testing, Production

When a single instance of the platform will be used to host client tenants and/or development tenancies for cloud development, use the default instance type (production).

When multiple instances of the platform will be used for testing, development, and production, choose the type that corresponds to the work that will be done on this instance of the platform.

Learn more: Collaborative Development Configurations

Considerations:

For Development and Testing instances, the instance type is part of the generated namespace.
If Instance Type is Development, then the Metadata Repository feature can be enabled

Catalog Configuration

Catalog Considerations

Community Site Configuration

A Community can be created to support community applications like Support Portal, Answers, Ideas, Social Networking. When enabled, all Users in all the tenancies (under a single ISV) can share knowledge and collaborate, without requiring a separate login to the platform.

Enable Community: Checkbox
Community Tenancy ID: Enter the Tenant ID
Community Site Name: Enter the Site name for the community; this name is displayed on each page

Custom Authentication Configuration

Provide URL for a custom Login Page. Leave this field blank if you are using the default AgileApps Cloud platform login page.

Custom Login Page URL

Recycling Configuration

Registration Configuration

Starting Application Configuration

Application Container URL

Field Encryption Settings

Specify a Field Encryption key to use when storing sensitive data. The key is unique to this instance of the platform. Once specified, it does not change.

Generate Encryption Key: This button is available when editing Service Provider Settings. Clicking it generates a new, unique key that is used by the AES128 algorithm to store encrypted data in secure fields.

Service Header HTML

Service Provider URL: http://{yourDomain}/networking/Service?t=1&targetpage=ViewPort.jsp
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:

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

Service Footer HTML

Service Provider URL: http://{yourDomain}/networking/Service?t=1&targetpage=ViewPort.jsp
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:

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

Service Header Image

Settings > Service Provider Settings > 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:

Available Email Templates

To edit an email template:

Click Manage Email Templates
Select a category from the list
Select a template from the category
For User Notification emails:
- Select the version of the template that corresponds to one of the languages supported in this instance of the platform.
- Then click the folder icon to view that version
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.

Email Header HTML - appears at the top of system-generated email messages
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 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

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

Manage Catalog

Service Provider URL: http://{yourDomain}/networking/Service?t=1&targetpage=ViewPort.jsp
Settings > Service Provider Settings > Manage Catalog

Note: To view the catalog option when creating a new application, Marketplace Service Domain field should be blank under Community Site Configuration section of the Configure Service Settings page.

Categories

Add and delete categories. Specify category names.

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

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

Important: Including a package in the catalog is a two-step process. First it must be approved. Then it must be moved to the Visible column, in whatever order you choose.

Learn More