...
| Option | Description |
|---|
| Label | The display name of the form field. |
| Name | The name of the input field. This is the name of the value sent in all post and email notifications, and is also used when validating input rules. | Info |
|---|
If you've set the label to Email address then you'd likely want to set the name to email_address. |
|
| Type | The type of form field. | Option | Description |
|---|
| Text | A regular text input field. | | Textarea | A large text area field, for inserting multiple lines of text. | | Password | A password input field, masking the user's input. | | Select | A drop-down menu. | | Radio | A radio field. | | Checkbox | A checkbox field. | | Hidden | A hidden field not visible to the user. | | Secret | A field that is never rendered or stored for the package, but is sent in all post and email notifications. |
|
| Required | If enabled, will require that some value is given for the field. |
| Encrypt | If enabled, will store input values encrypted in the database. |
| Values | See Values Format. |
| Input Rules | See Input Rules. |
| Notifications | See Notifications. |
...
| Option | Description |
|---|
| Label | The display name of the form field. |
| Name | The name of the input field. This is the name of the value sent in all post and email notifications, and is also used when validating input rules. | Info |
|---|
If you've set the label to Email address then you'd likely want to set the name to email_address. |
| Note |
|---|
A field name of qty has special meaning. It will set the quantity recorded for the service. |
|
| Type | The type of form field. | Option | Description |
|---|
| Text | A regular text input field. | | Textarea | A large text area field, for inserting multiple lines of text. | | Password | A password input field, masking the user's input. | | Select | A drop-down menu. | | Radio | A radio field. | | Checkbox | A checkbox field. | | Hidden | A hidden field not visible to the user. | | Secret | A field that is never rendered or stored for the service, but is sent in all post and email notifications. |
|
| Required | If enabled, will require that some value is given for the field. |
| Encrypt | If enabled, will store input values encrypted in the database. |
| Values | See Values Format. |
| Input Rules | See Input Rules. |
| Notifications | See Notifications. |
...
| Option | Description |
|---|
| Notice | The action triggers the notification. | Option | Description |
|---|
| Add | Executed when a package is created. | | Edit | Executed when a package is updated. |
|
| Post URL/Email | The URL to post to, or the email address to email, when the notice is triggered |
| HTTP Code | The HTTP Response Code returned by the URL that signifies a successful transmission. |
| Response Contains | Some portion of the output returned by the URL that signifies a successful transmission. This can be used separately, or in conjunction with the HTTP Code for more refined control over successful responses. |
| From Email | The address to send email notifications from. |
| Subject | The subject of the email notification. |
| HTML/Text | The HTML and Text body content for the email notification. |
...
| Option | Description |
|---|
| Notice | The action triggers the notification. | Option | Description |
|---|
| Add | Executed when a service is created. | | Edit | Executed when a service is updated. | | Suspend | Executed when a service is suspended. | | Unsuspend | Executed when a service is unsuspended. | | Cancel | Executed when a service is canceled. | | Renew | Executed when a service is renewed. That is, the invoice generated for the service renewal is paid. | | Package Change | Executed when the package is changed for the service. |
|
| Post URL/Email | The URL to post to, or the email address to email, when the notice is triggered |
| HTTP Code | The HTTP Response Code returned by the URL that signifies a successful transmission. |
| Response Contains | Some portion of the output returned by the URL that signifies a successful transmission. This can be used separately, or in conjunction with the HTTP Code for more refined control over successful responses. |
| From Email | The address to send email notifications from. |
| Subject | The subject of the email notification. |
| HTML/Text | The HTML and Text body content for the email notification. |
...
| Expand |
|---|
|
Due to the nature of tag objects containing several fields, many of which are likely irrelevant for use in email templates, but may be useful to you in certain circumstances, a dump of the tags are shown below.
| Code Block |
|---|
| title | The {service} object |
|---|
| collapse | true |
|---|
| stdClass Object
(
[id] => 234
[parent_service_id] =>
[package_group_id] => 1
[id_format] => PD-{num}
[id_value] => 229
[pricing_id] => 22
[client_id] => 3
[module_row_id] => 6
[coupon_id] =>
[qty] => 1
[status] => in_review
[date_added] => 2013-05-13 18:33:14
[date_renews] => 2013-06-13 18:33:14
[date_last_renewed] =>
[date_suspended] =>
[date_canceled] =>
[id_code] => PD-229
[fields] => Array
(
[0] => stdClass Object
(
[key] => cpanel_confirm_password
[value] => password
[serialized] => 0
[encrypted] => 1
)
[1] => stdClass Object
(
[key] => cpanel_domain
[value] => domain.com
[serialized] => 0
[encrypted] => 0
)
[2] => stdClass Object
(
[key] => cpanel_password
[value] => password
[serialized] => 0
[encrypted] => 1
)
[3] => stdClass Object
(
[key] => cpanel_username
[value] => domainco
[serialized] => 0
[encrypted] => 0
)
)
[package_pricing] => stdClass Object
(
[id] => 22
[package_id] => 13
[term] => 1
[period] => month
[price] => 8.0000
[setup_fee] => 0.0000
[cancel_fee] => 0.0000
[currency] => USD
)
[package] => stdClass Object
(
[id] => 13
[id_format] => {num}
[id_value] => 1
[module_id] => 4
[name] => Bronze Standard
[description] =>
[description_html] => <p>
<span style="color:#008000;"><em>Good Value!</em></span></p>
[qty] =>
[module_row] => 6
[module_group] =>
[taxable] => 0
[status] => active
[company_id] => 1
)
[name] => domain.com
[coupon] => stdClass Object
(
[id] => 2
[code] => knW3Lesn
[company_id] => 1
[used_qty] => 16
[max_qty] => 0
[start_date] => 2017-02-02 08:00:00
[end_date] => 2018-02-03 07:59:59
[status] => active
[recurring] => 0
[limit_recurring] => 0
[apply_package_options] => 1
[internal_use_only] => 0
[type] => exclusive
[amounts] => Array
(
[0] => stdClass Object
(
[coupon_id] => 2
[currency] => USD
[amount] => 5.0000
[type] => amount
)
)
[packages] => Array
(
[0] => stdClass Object
(
[coupon_id] => 2
[package_id] => 80
)
)
)
) |
| Code Block |
|---|
| title | The {package} object |
|---|
| collapse | true |
|---|
| stdClass Object
(
[id] => '94'
[id_format] => '{num}'
[id_value] => '92'
[module_id] => '2'
[name] => 'Test Universal Package'
[description] => 'A test package for the universal module.'
[description_html] => '<p>A test package for the Universal Module.</p>'
[qty] => null
[module_row] => '1'
[module_group] => null
[taxable] => '1'
[single_term] => '0'
[status] => 'active'
[company_id] => '1'
[prorata_day] => null
[prorata_cutoff] => null
[id_code] => '92'
[email_content] => Array
(
[0] => stdClass Object
(
[lang] => 'en_us'
[html] => '<p>Welcome email for the Universal Module.</p>'
[text] => 'Welcome email for the Universal Module.'
)
)
[pricing] => Array
(
[0] => stdClass Object
(
[id] => '628'
[pricing_id] => '875'
[package_id] => '94'
[term] => '1'
[period] => 'month'
[price] => '2500.0000'
[setup_fee] => '0.0000'
[cancel_fee] => '0.0000'
[currency] => 'USD'
)
)
[meta] => stdClass Object
[groups] => Array
(
[0] => stdClass Object
(
[id] => '10'
[name] => 'Test Universal Package Group'
[description] => null
[type] => 'standard'
[company_id] => '1'
[allow_upgrades] => '1'
)
)
[option_groups] => Array
(
[0] => stdClass Object
(
[id] => '26'
[name] => 'Test Universal Option Group'
[description] => 'A list of options'
)
)
) |
|
Client Service Info
Client Service Info renders the information shown in the expandable area within the client area when clicking on the service row.
Example Code (Replace tags with appropriate service or package tags. In this example, we have service fields called vpnuser, vpnpass, vpnhost)
| Code Block |
|---|
|
<div class="table-responsive">
<table class="table table-curved table-striped">
<thead><tr>
<th>VPN USer</th>
<th>VPN Pass</th>
<th>VPN Host</th>
</tr>
</thead>
<tbody>
<tr>
<td>{service.fields.vpnuser}</td>
<td>{service.fields.vpnpass}</td>
<td>Login at <a href="https://{service.fields.vpnhost}">{service.fields.vpnhost}</a></td>
</tr>
</tbody>
</table>
</div> |
Admin Service Info
Admin Service Info renders the information shown in the expandable area within the client profile when clicking on the service row in the admin area.
Example Code (Replace tags with appropriate service or package tags. In this example, we have service fields called vpnuser, vpnpass, vpnhost)
| Code Block |
|---|
|
<table class="table">
<tbody><tr class="heading_row">
<td class="border_left">VPN USer</td>
<td>VPN Pass</td>
<td>VPN Host</td>
</tr>
<tr>
<td>{service.fields.vpnuser}</td>
<td>{service.fields.vpnpass}</td>
<td>Login at <a href="https://{service.fields.vpnhost}">{service.fields.vpnhost}</a></td>
</tr>
</tbody>
</table>
|
Creating Packages
| Info |
|---|
|
Universal Module product service field names are used for the email tag. For example, a service field with the name "hostname" would result in a tag available to the welcome email of {service.hostname}. Universal module products are unique in this regard because each product may have different tags, defined by the staff member who created them. |
...