...
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.
| ||||||||||||||||||
Type | The type of form field.
| ||||||||||||||||||
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.
| ||||||||||||||||||
Type | The type of form field.
| ||||||||||||||||||
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. |
...
Note that special character literals like $, %, and ^ should be escaped where appropriate in the regular expression via double backslashes. Creating invalid regular expressions will cause the field (or other fields) to pass validation when they otherwise should notAdditionally, so should special characters in JSON format, like quotes (") and back slashes (\)themselves. Creating invalid JSON will cause all fields to pass validation because the JSON cannot be parsed to retrieve the rules. Creating invalid regular expressions will cause unexpected behavior.
Notifications
Notifications allow the universal module to post to a given URL or email a given address when a certain action occurs.
...
Option | Description | ||||||
---|---|---|---|---|---|---|---|
Notice | The action triggers the notification.
| ||||||
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.
| ||||||||||||||||
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.
|
Client Service Info
Client Service Info renders the information shown in the expandable area and on the Information tab when clicking to manage the service 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. |
...