Order Modules

We have included a group of initial action modules in the system, and will continue to release them to the Ubersmith community as fast as we can get them out. In the future we will be releasing documentation on how users can write their own custom modules that can easily be added to their existing Ubersmith system. These modules are designed to be a single file you drop into a folder on your server, so they are not contingent upon full Ubersmith releases.

Add Client

Creates an Ubersmith Login for the client

Add Credit Card

Associates credit card data with client's account in Ubersmith

Add SSL Cert

Orders an SSL Cert

Add Services

Associates services that have been purchased with client's account in Ubersmith

FraudGate

Third party fraud scoring and telephone verification. Config options: FraudGate login and password.

Generate Invoice

Creates an invoice and attempts to bill the client.

MaxMind minFraud

Third party fraud scoring. Config options: MaxMind login, password, and account type.

Order cPanel License

Orders a cPanel server license. Config options: cPanel Manage User, cPanel Manage Password.

Provision InterWorx Account

Setup

The InterWorx order module is used to interactively create SiteWorx accounts on an InterWorx host from within Ubersmith. When configuring your order step that uses the InterWorx order module, you will need at least two pieces of information:

InterWorx Access/API Key

InterWorx Host or IP

To retrieve or generate your InterWorx Access/API Key, from within InterWorx, go to

Server -> Setup -> API Key

The InterWorx Host or IP is the hostname or IP address you use to connect to InterWorx through your web browser.

In the 'Config' tab of the order step that uses the InterWorx order module, paste your API key into the field labeled 'InterWorx Access Key'. Type or paste your InterWorx Host or IP address into the field labeled 'Host or IP'. The remaining fields should be left as is, unless you have a reason to change them. The default values are '2443', and '/nodeworx/xmlrpc-api.php'.

Use

Clicking 'Process' for the order step that uses the InterWorx order module will present you with a pop-up configuration dialog. Most of the fields will be filled in based on the information collected from your new client during the order process, but can be modified as needed.

These fields are:

Username

Email Address

Password

Domain Name

IP Address

The module will present shared IP addresses as well as available dedicated IP addresses, as specified on your InterWorx server. The InterWorx account feature and option fields can be modified to suit the plan your client has purchased, and function exactly the same as they would on the InterWorx server.

When the account is configured to your liking, click 'Process' to create the account on the InterWorx server. If there is an error, a red dialog box will be displayed in the pop-up. If it succeeds, the pop-up will close, and the order process will continue to the next step.

Config Options: InterWorx Access Key, Host or IP, Port Number, Path to XML-RPC server

Provision cPanel Account

Creates a virtual hosting account on a cPanel server. Config Options: Package Number.

Provision Client in Ubersmith

Creates an Ubersmith Login for the client.

Send Notification to Admins

Send an e-mail notification to all administrators.

Send Templated Email to Client

Sends an e-mail to prospective client. Config Options: to customize the from address, CC, BCC, the subject, and the body of the e-mail.  Send Welcome Letter

Simple Process

       Allows administrator to mark a process as completed.  This is useful for order steps that do not have a custom order module.  For example, making sure required hardware is on site.

Simple Question

Poses a question to the administrator that must be responded to with an "Accepted Answer" in order for the step to be marked complete. Config options: Question to be answered by the admin, accepted answers, unaccepted answers.

Update Fields

Allows you to update any information collected during the order process.  Adding this at any point will create a popup that will show all collected data as editable text fields.