Custom Procedures

Custom procedures execute pre-set SQL scripts to compile information or to execute a command. Custom procedures can be used for exports, manifests, reports, settlements, shipping labels, and can modify dispatch board data. 

Custom procedures are available based on user permission under Maintenance Functions > Custom Procedures > Allowed Custom Procedures.



Go to MaintenanceCustom Procedures.

Field Name

Description

Field Name

Description

ProcedureID

Unique numerical ID for the custom procedure.

Quick Tip: CXT predefined custom procedures are represented with a negative ID value.

Description

Description of the custom procedure.

SQL

SQL stored procedure to be used for the custom procedure. 

Type

Type of custom procedure. 

  • Invoice Export: The custom procedure will be available in the Invoice Center when exporting an invoice or invoice batch.

  • Settlement Export: The custom procedure will be available in the Display Settlements section.

  • On Demand Dispatch: The custom procedure will be available when right-clicking on the Active Orders grid of the On-Demand Dispatch board.

  • Route Dispatch: The custom procedure will be available when right-clicking on the Active Routes grid of the Route Dispatch board.

  • On Demand Dispatch - Drivers: The custom procedure will be available when right-clicking on the Active Drivers grid of the On-Demand Dispatch board.

  • X-Internet Order Information: The custom procedure will be an available shipping label option in the Client Portal.

  • X Internet Account Reporting: The custom procedure will be available in the Client Portal Report section.

  • Shipping Label: The custom procedure will be an available shipping label option on the order form.

  • X Internet Driver Settlement: The custom procedure will be available in the Estimated Settlements section in the X Internet Driver Portal as a settlement option.

  • X Internet Driver Settlement Batch: The custom procedure will be available in the Settlements section in the X Internet Driver Portal as a report option.

CustomReportFormatID

Custom report format ID used for the custom procedure.

How to Add a New Custom Procedure

  1. Go to Maintenance > Custom Procedures.

  2. Click the New button in the toolbar.

Alternate Steps

  1. Click the arrow next to the New button, or press the Alt and N keys.

  2. Click Custom Procedure.

How to Copy a Custom Procedure

  1. Go to Maintenance > Custom Procedures.

  2. Right-click on the custom procedure you would like to copy and select Copy.

  3. Enter the new custom procedure procedure ID then click OK.

How to Edit a Custom Procedure 

CXT predefined custom procedures (represented with a negative ProcedureID) cannot be edited. You must make a copy if edits are needed.

  1. Go to Maintenance > Custom Procedures.

  2. Double-click on the custom procedure you would like to edit.

How to Delete a Custom Procedure

This cannot be undone.

  1. Go to Maintenance > Custom Procedures.

  2. Right-click on the custom procedure you would like to delete and select Delete.

  3. Confirm by clicking Yes.

Custom Procedure Form

Field

Description

Field

Description

Procedure ID

Unique numerical ID for the custom procedure. 

Quick Tip: CXT predefined custom procedures are represented with a negative ID value and cannot be edited. If you would like to edit a CXT predefined custom procedure, you must make a copy. 

Description

Description of the custom procedure.

Procedure Type

Type of custom procedure.

  • Invoice Export

  • Settlement Export

  • On Demand Dispatch

  • Route Dispatch

  • On Demand Dispatch - Drivers

  • X-Internet Order Information

  • X Internet Account Reporting

  • Shipping Label

  • X Internet Driver Settlement

  • X Internet Driver Settlement Batch

These SQL parameters should be included in your custom procedure

Required criteria to for the SQL to run.

SQL

SQL stored procedure to be used for the custom procedure.

Report Format

Selected report format to use in the custom procedure.

Click Add New to add a new custom report format or click Edit to edit the selected report format.

Filename

The default filename when saving export procedure type custom procedures.

Visible when Output Specification is set to "use literal name".

Data Field

The declared field name from the SQL of the value to use as the default filename when saving export procedure type custom procedures. 

Visible when Output Specification is set to "use data field".

Output Specification

The selected method of how the default filename will be populated for export procedure type custom procedures.

  • use literal name - Use Filename as the default filename. 

  • user data field - Use Data Field to populate the default filename.