|
This document explains how to modify standard user signup (order) forms
or to replace them with the custom forms.
Before you begin signup customization, please note the following:
- The default signup forms contain validation scripts. It is recommended
that your custom signup forms also provide a
client side validation mechanism.
- When H-Sphere server-side validation rejects user data, the user is redirected to the
error page generated based on the template ~cpanel/shiva/shiva-templates/common/signup/end.html
which has the look and feel of the standard H-Sphere interface and links to the STANDARD
H-Sphere signup forms. Normally, you would want to customize this template to ensure that
(i) it has the look and feel of your custom signup forms, and
(ii) it gives a way to go back to the signup forms, then modify and re-submit the signup data.
The template has been written in FreeMarker 1.5.1, and in order to make changes to its code,
please become familiar with the FreeMarker technology version 1.5.1, the documentation
available at http://freemarker.org.
The way you customize the page will totally depend on how you organize your signup forms.
- Custom signup fields must match those in the default signup.
If more fields are added in newer versions, you will need to update
your custom forms.
Your signup script has to put the collected
data into the html fields below and submit them to the following
URL:
<form name="login" action="psoft.hsphere.CP"
method="POST">
or
<form name="login" action="protocol://cp.domain.name:PORT/psoft/servlet/psoft.hsphere.CP"
method="POST">. For example:
<form name="login" action="http://www.psoft.net:8080/psoft/servlet/psoft.hsphere.CP"
method="POST">
Note: psoft.hsphere.CP is
case sensitive!
Some signup texts can be customized through the control panel from Look And Feel -> Signup Texts.
If you have customized texts through the control panel, they will override the texts in your custom signup
forms, so you may need to remove them.
Basic (service fields signup depends on)
| Field name |
Possible Values |
Explanation |
| _eul_accept |
"1" |
Accept terms of End User License Agreement |
| _mod |
"",
"signup" - transfer domain,
"opensrs" OpenSRS registration,
"nodomain" - signup without domain,
"3ldomain" - third level domain,
"service" - service domain |
Signup modifier |
| action |
"signup" |
Service parameter |
| plan_id |
numeric |
Number of the plan for signup |
| signup |
"yes" |
Service parameter |
| login |
alphanumeric |
user login |
| password |
alphanumeric |
user password |
| password2 |
alphanumeric |
Confirm user password |
| template_name |
submit/signup/end.sbm (submit/signup/end_osrs.sbm
for OpenSRS registration) |
Processing template |
| admin_signup |
"yes" - if we sign user up
from the admin panel |
Service parameter |
Contact Info (User's contact information)
| Field name |
Possible Values |
Explanation |
| _ci_first_name |
alphanumeric |
User's first name |
| _ci_last_name |
alphanumeric |
User's last name |
| _ci_address1 |
alphanumeric |
User's address 1 |
| _ci_address2 |
alphanumeric |
User's address 2 |
| _ci_city |
alphanumeric |
User's city of residence |
| _ci_company |
alphanumeric |
User's company name |
| _ci_country |
alphanumeric |
User's country code |
| _ci_email |
alphanumeric |
User's contact e-mail address |
| _ci_phone |
numeric |
User's phone number |
| _ci_postal_code |
numeric |
User's zip code |
| _ci_state |
e.g.: "NY"; "NA" for non US or Canada residents. |
User's state code. In the custom form for non US or Canada residents, you should add this field as hidden. |
| _ci_state2 |
alphanumeric |
User's state or province for non US and Canada residents. Should be present in the custom form only in case
_ci_state='NA'.
|
| _ci_promo_code |
alphanumeric |
PROMO code for subsidized plan. Contains 2-20 chars and starts from the letter.
|
Billing Info (not used for Trial registration)
| Field name |
Possible Values |
Explanation |
| _bi_first_name |
alphanumeric |
User's first name |
| _bi_last_name |
alphanumeric |
User's last name |
| _bi_address1 |
alphanumeric |
User's address 1 |
| _bi_address2 |
alphanumeric |
User's address 2 |
| _bi_city |
alphanumeric |
User's city of residence |
| _bi_company |
alphanumeric |
User's company name |
| _bi_country |
alphanumeric |
User's country code |
| _bi_email |
alphanumeric |
User's contact e-mail address |
| _bi_phone |
numeric |
User's phone number |
| _bi_postal_code |
numeric |
User's zip code |
| _bi_state |
e.g.: "NY"; "NA" for non US or Canada residents. |
User's state code. In the custom form for non US or Canada residents, you should add this field as hidden. |
| _bi_state2 |
alphanumeric |
User's state or province for non US or Canada residents. Should be present in the custom form only in case
_bi_state='NA'.
|
| _bi_type |
"CC" - credit card,
"CHECK" - check,
"TRIAL" |
Payment type |
Only Credit Card section
| Field name |
Possible Values |
Explanation |
| _bi_cc_name |
alphanumeric |
Credit card name |
| _bi_cc_number |
numeric |
Credit Card number |
| _bi_cc_type |
strings available in the Merchant Gateway Manager: "VISA",
"MC", etc. |
Credit Card type |
| _bi_cc_exp_month |
two digits |
the month of Credit Card expiry date |
| _bi_cc_exp_year |
four digits |
the year of Credit Card expiry date |
Note: below are the fields for Solo/Switch debit
cards used in some countries:
| Field name |
Possible Values |
Explanation |
| _bi_cc_issues_no |
alphanumeric |
Issue number |
| _bi_cc_start_month |
two digits |
Card Start Month |
| _bi_cc_start_year |
four digits |
Card Start Year |
Billing period
| Field name |
Possible Values |
Explanation |
| _bp |
0 or a positive integer |
Sequence number of the billing period in the
list of billing periods for the selected plan.
To see the list of the billing periods,
go to your control panel, click the Settings
link for this plan and scroll down to the
Billing configuration section.
|
Domains
| Field name |
Possible Values |
Explanation |
| type_domain |
"transfer_new_misc_domain"
- transfer domain or register non-OpenSRS
"without_domain" - register stopgap domain
"3ldomain" - third level domain
"service_domain" - service domain
"parked_domain" - parked domain
"new_opensrs_domain" - OpenSRS domain
"domain_name" - domain name
|
Type of new domain |
OpenSRS registration
| Field name |
Possible Values |
Explanation |
| period |
numeric |
OpenSRS periods (years) |
| _srs_owner_first_name |
alphanumeric |
User's first name |
| _srs_owner_last_name |
alphanumeric |
User's last name |
| _srs_owner_address1 |
alphanumeric |
User's address 1 |
| _srs_owner_address2 |
alphanumeric |
User's address 2 |
| _srs_owner_city |
alphanumeric |
User's city of residence |
| _srs_owner_org_name |
alphanumeric |
User's company name |
| _srs_owner_country |
alphanumeric |
User's country code |
| _srs_owner_email |
alphanumeric |
User's contact e-mail address |
| _srs_owner_phone |
numeric |
User's phone number |
| _srs_owner_postal_code |
numeric |
User's zip code |
| _srs_owner_state |
e.g.: "NY"; "NA" for non US or Canada residents. |
User's state code. In the custom form for non US or Canada residents, you should add this field as hidden. |
| _srs_owner_state2 |
alphanumeric |
User's state or province for non US or Canada residents. Should be present in the custom form only in case
_srs_owner_state='NA'.
|
Contact Info
| Field name |
Possible Values |
Explanation |
| _srs_billing_first_name |
alphanumeric |
User's first name |
| _srs_billing_last_name |
alphanumeric |
User's last name |
| _srs_billing_address1 |
alphanumeric |
User's address 1 |
| _srs_billing_address2 |
alphanumeric |
User's address 2 |
| _srs_billing_city |
alphanumeric |
User's city of residence |
| _srs_billing_org_name |
alphanumeric |
User's company name |
| _srs_billing_country |
alphanumeric |
User's country code |
| _srs_billing_email |
alphanumeric |
User's contact e-mail address |
| _srs_billing_phone |
numeric |
User's phone number |
| _srs_billing_postal_code |
numeric |
User's zip code |
| _srs_billing_state |
e.g.: "NY"; "NA" for non US or Canada residents. |
User's state code. In the custom form for non US or Canada residents, you should add this field as hidden. |
| _srs_billing_state2 |
alphanumeric |
User's state or province for non US or Canada residents. Should be present in the custom form only in case
_srs_billing_state='NA'.
|
|
