Follow

Reseller Information - User Account Summary Letter

Prerequisites

Reseller Account, please contact sales@itsolutionsnow.com

Summary

This article will demonstrate how to enable and customize the user account summary letter.


The user account summary letter provides reference material for the end user and their associated account. The letters can be adjusted to the needs and policies of the reseller via a mail template that supports an extensive list of variables. Variables include user information, available services, and licensed quotas.

 

1. In a web browser navigate to the ITSolutionsNow services control panel:  https://cp.myhostedsolution.com/

1.jpg

2. From the account home of the reseller account click on the link in the far bottom right of the page under Settings, Mail Templates.

2.png

3. The User Account Mail Templates, will display the available mail templates, click on User Account Summary Letter.

3.png

4. To modify and enable the user account summary letter select, Override Host Settings via the drop down menu. Once selected click, Enable Account Summary Letter, and complete the following four fields:

  1. From: Primary contact for the end user, receives a copy of the user settings.
  2. CC: Secondary contact for the end user, also receives a copy of the user settings.
  3. Subject: Supports user variables for individualized subject lines.
  4. Priority: The priority of the outgoing email.

Ensure the accuracy of the fields, then proceed to step 5 for instructions on how to modify the templates.

4.png

5. The Subject, HTML Body and the Text Body are all editable templates that support the following constructs and variables. Once finished with editing the templates, click Save, to save any changes made.

#Signup# - is equal to "true" if the letter is sent during user account creation; otherwise when user re-sends the letter it is "false".

Can be used in the template as following:

<ad:if test="#Signup#">
This content will be included in the summary during signup only.
</ad:if>

#user# - account owner. It is a complex structure with the following available fields:

  • Username (string)

  • Password (string)

  • Email (string)

  • SecondaryEmail (string)

  • FirstName (string)

  • LastName (string)

  • FullName (string)

  • Address (string)

  • City (string)

  • Country (string)

  • State (string)

  • Zip (string)

  • PrimaryPhone (string)

  • SecondaryPhone (string)

  • Fax (string)

  • InstantMessenger (string)

  • IsDemo (bool)

  • IsPeer (bool)

  • HtmlMail (bool)

  • Created (DateTime)

  • Changed (DateTime)

  • RoleId (int)

In templates it can be used as following:

Hello, #user.FullName#
Your registered e-mail address is: #user.Email#

#reseller# -  host account. It is a complex structure with the same fields as "user" one.

#Spaces# - the collection of hosting spaces for the account. Each item in the collection is a complex structure with the following fields:

  • PackageId (int)

  • PlanId (int)

  • PackageName (string)

  • PurchaseDate

  • StatusId (int)

In the templates collection can be iterated as following:

You have the following spaces under your account:
<ad:foreach collection="#Spaces#" var="Space" index="i">
<h2>#Space.PackageName#</h2>
</ad:foreach>

#Plans# - the dictionary (key-value pairs) of hosting plans. Each key in #Plans# dictionary is PlanId of hosting plan and each value is a complex structure with the following fields:

  • PlanId (int)

  • PlanName (string)

  • PlanDescription (string)

  • SetupPrice (decimal)

  • RecurringPrice (decimal)

  • RecurrenceUnit (int)

  • RecurrenceLength (int)

Both #Spaces# and #Plans# collections can be used together in a single loop as shown below (corresponding space plan is referenced by PlanId):

The following hosting spaces have been created under your account:
<ad:foreach collection="#Spaces#" var="Space" index="i">
Hosting space name: #Space.PackageName#
Hosting plan name: Hosting Plan: #Plans[Space.PlanId].PlanName#
</ad:foreach>

#SpaceContexts# - the dictionary (key-value pairs) of hosting space contexts for all spaces in #Spaces# collection. Each key in #SpaceContexts# dictionary is PackageId of hosting space and each value is a complex structure with the following fields:

  • Package - hosting space details. It is a complex structure with the fields similar to item in #Spaces# collection.

  • Groups - dictionary with resource groups available in hosting space. Key is the name of the resource group and value is a complex structure with the following fields:

    • GroupId (int)

    • GroupName (string)

    • Enabled (bool) - always true for space context groups

    • CalculateDiskSpace (bool)

    • CalculateBandwidth (bool)
      The following group names are currently supported:

    • OS

    • Web

    • FTP

    • Mail

    • MySQL4

    • MySQL5

    • DNS

    • Statistics

    • SharePoint

    • MsSQL2000

    • MsSQL2005

    • MsSQL2008

  • Quotas  - dictionary with hosting space quotas. Key is the name of the quota and value is a complex structure with the following fields:
      • QuotaName (string)

    • QuotaAllocatedValue (int) - the maximum number of items (bandwidth in MB, disk space in MB, web sites, FTP accounts, etc.) for this quota. "-1" if unlimited.

    • QuotaUsedValue (int) - the number of items (bandwidth in MB, disk space in MB, web sites, FTP accounts, etc.) created for this quota.
      The following quota names are currently supported:

    • OS.Diskspace

    • OS.Bandwidth

    • OS.Domains

    • OS.SubDomains

    • OS.ODBC

    • OS.FileManager

    • OS.AppInstaller

    • OS.ExtraApplications

    • OS.ScheduledTasks

    • OS.ScheduledIntervalTasks

    • OS.MinimumTaskInterval

    • Web.Sites

    • Web.Asp

    • Web.AspNet11

    • Web.AspNet20

    • Web.Php4

    • Web.Php5

    • Web.Perl

    • Web.Python

    • Web.CgiBin

    • Web.SecuredFolders

    • Web.SharedSSL

    • Web.Redirections

    • Web.HomeFolders

    • Web.VirtualDirs

    • Web.FrontPage

    • Web.Security

    • Web.DefaultDocs

    • Web.AppPools

    • Web.Headers

    • Web.Errors

    • Web.Mime

    • ftp://ftp.accounts/

    • Mail.Accounts

    • Mail.MaxBoxSize

    • Mail.Forwardings

    • Mail.Groups

    • Mail.MaxGroupMembers

    • Mail.Lists

    • Mail.MaxListMembers

    • MySQL4.Databases
    • MySQL4.Users

    • MySQL4.Backup

    • MySQL5.Databases

    • MySQL5.Users

    • MySQL5.Backup

    • DNS.Editor

    • Stats.Sites

    • SharePoint.Sites

    • SharePoint.Users

    • SharePoint.Groups

    • MsSQL2000.Databases

    • MsSQL2000.Users

    • MsSQL2000.MaxDatabaseSize

    • MsSQL2000.Backup

    • MsSQL2000.Restore

    • MsSQL2000.Truncate

    • MsSQL2005.Databases

    • MsSQL2005.Users

    • MsSQL2005.MaxDatabaseSize

    • MsSQL2005.Backup

    • MsSQL2005.Restore

    • MsSQL2005.Truncate

    • MsSQL2008.Databases

    • MsSQL2008.Users

    • MsSQL2008.MaxDatabaseSize

    • MsSQL2008.Backup

    • MsSQL2008.Restore

    • MsSQL2008.Truncate 

All dictionaries support the following methods:

  • bool ContainsKey(keyName) - allows to check if specified key-value pair exists in the dictionary

  • object [keyName] - allows to get specified value from dictionary by its key

Some examples of using "Groups" and "Quotas" dictionaries:

1. To check if "MS SQL 2000" resource exists in the spaces:

<ad:foreach collection="#Spaces#" var="Space" index="i">
Space name: #SpaceContexts[Space.PackageId].PackageName#
<ad:if test="#SpaceContexts[Space.PackageId].Groups.ContainsKey("MsSQL2000")#">
You have an ability to create MS SQL 2000 databases!
</ad:if>

2. To show how many MySQL 4 databases and database users are allocated within each space:

<ad:foreach collection="#Spaces#" var="Space" index="i">
Space name: #SpaceContexts[Space.PackageId].PackageName#
<ad:if test="#SpaceContexts[Space.PackageId].Groups.ContainsKey("MySQL4")#">
Databases: #SpaceContexts[Space.PackageId].Quotas["MySQL4.Databases"]#
Users: #SpaceContexts[Space.PackageId].Quotas["MySQL4.Users"]#
<ad:else>
You do not have MySQL 4 resource in this space!
</ad:if>

 

 

What Is Next?

Create A Customer

Create A Hosting Space

Hosting Space Summary Letter

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

1 Comments

Please sign in to leave a comment.