Configuring Order Queues

Once you have created the default order queue, you must configure it to meet your business needs. You can customize the order process by adding steps and adding actions under those steps. 

Adding Order Steps

1. Access the Order Queues page 
2. Click edit for the order queue you want to add a step for.
   
   The Manage Order Queue page appears.
3. Click Add Order Step.
   
   The Add Order Step page appears.
4. In the Name field, enter the name of your order step.
5. Click Save or Save & New.
   
   

Editing Order Steps

1. Access the Order Queues page 
2. Click edit for the order queue you want to change a step for.
   
   The Manage Order Queue page appears.
3. Click edit for the order step you want to edit.
   
   The Edit Order Step page appears.
4. Make any necessary changes you need.
5. Click Save.
   

Adding Actions to Order Steps

In addition to the default order actions, any number of additional actions can be added to any step in the order queue.

1. Access the Order Queues page 
2. Click edit for the order queue you want to add actions for.
   
   The Manage Order Queue page appears.
3. Click add action for the order step you want to add actions.
   
   The Add Order Action page appears.

Complete the Detail Tab

1. In the Name field, enter the name of the action.
2. In the Module field, select the appropriate module for the action.
3. In the Automatic field, select Yes to have the action automatically run when the order reaches the order step the action belongs to and all prerequisites have been completed.
4. In the Optional field, select Yes if you want the action to be optional, or able to be skipped. Actions that are not optional will keep an order from moving forward until it has been processed successfully.
5. In the Client Viewable field, select Yes if you want the action to be visible to your clients in the Client Portal.

6. In the Persistent Display field, select Yes if you want the action to always display regardless of the current status of the order.

   Note

   Some actions have output that is displayed in the online order form. So the order page does not get overly cluttered, the output is only displayed for as long as that order is in the same step as the action that generated it. Selecting Yes will keep the order action displayed.

   
   

Complete the Prereqs Tab

All the order actions for the selected order step are displayed on this tab. The options on this page will be different based on how your order steps are configured. Actions that have not had their prereqs processed are not available to process or will not be run automatically.

1. Click the Prereqs tab.
2. Select the actions that are prerequisites to this action.
   
   

Complete the Config Tab

These settings determine what happens when the selected order module on the Detail tab is run. Order modules are custom PHP files that run specific code for order-related events. They carry out customized functions or integrate with third party systems. Ubersmith provides order modules that only need to be enabled and properly configured. You can also create custom modules and uploaded them directly to your Ubersmith instance without any special code or intervention from the Ubersmith team. Examples are available at Example Order Modules.

Click here to see topics related to adding order modules and plugins.

1. Click the Config tab.
2. Click Save.
   

Editing Order Actions

1. Access the Order Queues page 
2. Click edit for the order queue you want to edit actions for.
   
   The Manage Order Queue page appears.
3. Click edit for the order action you want to change.
   
   The Edit Order Action page appears.

4. Make any necessary changes you need.

5. Click Save.
   

Reordering Order Steps and Order Actions

Order steps and their order actions are run from top to bottom. Order steps and order actions can be moved up or down in order.

1. Access the Order Queues page 
2. Click edit for the order queue you want to reorder steps for.
   
   The Manage Order Queue page appears.
3. Click the up or down arrow to move the order step or order action to the desired location.
   

Deleting Order Steps and Order Actions

1. Access the Order Queues page 
2. Click edit for the order queue you want to delete a step or action for.
   
   The Manage Order Queue page appears.
3. Click delete for the order step or action.