id

Holds the unique ID for the ExtJs component.

iconCls

Specifies the CSS class for the button, which in turn determines the icon used on the button.

tooltip

Provides the button tooltip.

taskKeyId

Holds the ID of the workflow task to be executed.

readOnlyDisable

Specifies if a button is to be displayed when you open a transaction in read-only mode. The possible values are true or false.

enableStatusList

Lists the pack statuses that enable this button. The button is only enabled when every pack on a shipment has a status on this list.

disableOnZeroPackCount

Specifies whether the shipment extension button is disabled when no packs exist on the selected shipment. By default, the shipment extension button is enabled. The possible values are true or false. In the sample configuration, this is set to true for the Rate Shop button, because you cannot rate shop for an empty shipment.

allItemsPacked

Activates a precondition check to determine if all items on the shipment have been packed before the configured workflow task is executed.

confirmRun

Specifies if a pop-up message is displayed, prompting you to confirm that you want to execute the workflow task.

handler

Provides the function that is executed when you click the button.

readOnlyAllowReadWrite

Allows you to execute a shipment-level workflow task in read-write mode when the shipment has been loaded in read-only mode. A shipment can be in read-only mode for different reasons:

Where you load a shipment in read-only mode, the workflow task is executed in read-only mode. To allow the task to execute in read-write mode, you add the member readOnlyAllowReadWrite to the workflow task configuration object. The member readOnlyAllowReadWrite is expressed as an array of values and must include all reasons why the shipment was loaded in read-only mode before the workflow task can be executed in read-write mode. In the sample configuration, you can execute the Manifest button when a rated shipment is loaded in read-only mode.

progress

When set to true, indicates that the shipment header workflow task must be executed through a black-box message to the Progress logic. By default, this member is set to false and the task is executed as a Web UI workflow task.

You can configure a Web UI workflow task to initiate a Progress-based workflow task. However, this involves additional setup that you avoid by using the progress member. It also enables handling of error, information, and warning status codes on the browser client by initiating response actions using the member responseStatus.

responseStatus

Lists handler actions for the response codes that can be returned by a black box call to execute a Progress-based workflow task. The handler action is implemented to initiate a button on the Scan, Pack and Ship screen. You configure the handler action using a JavaScript object with the following members:

enableReadWriteList

Lists the pack statuses for which the button can be executed in read-write mode. Use this condition to further restrict read-write access when:

When you set enableReadWriteList, the button is executed in read-write mode only when all packs on the shipment have a status on the list. Use enableReadWriteList to force readOnly access to a workflow task. This member appears in the sample configuration under the Addresses button.

enableOnShipmentStatus

Lists the shipment statuses for which a button is enabled. If enableOnShipmentStatus is not included in the button configuration, shipment status is not considered when determining if the button is enabled.