Shipment Group Agent Actions

Add Transactional Interest

This is a utility agent action. See Add Transactional Interest.

Ad Hoc Notify Contact

This is a utility agent action. See Ad Hoc Notify Contact.

Allocate Ship Group Shipments

Use this agent action to allocate cost to all the shipments in a shipment group.

Also see Allocate Shipments of Shipment Group.

This action allows you to assign document sets to selected objects. You can assign a single or multiple document sets to an object or multiple objects.

Note: If a document set is already assigned to an object, the action will proceed with assigning the remaining document sets.

Parameter:

Document Set

Assign Variable

This is a utility agent action. See Assign Variable.

Build Trade Transaction

See Build Trade Transaction topic.

Parameters:

Consider secondary charge shipments of a primary shipment

Consider handling charge shipments of a primary shipment

Call Service

This is a utility agent action. See Call Service.

Cancel Pickup

See the Cancel Pickup Notification action.

Change Appointment Activity Type - Shipment Group

Changes the appointment activity type of an appointment.

Parameters:

Appointment Activity Type

Location

First Stop

Last Stop

Copy Flexfields To

This is a utility agent action. See Copy Flexfields To.

Copy Refnums from Ship Group

This is a utility agent action. See Copy Refnums from <object>.

Copy Refnums to Ship Group

This is a utility agent action. See Copy Refnums to <object>.

Create Invoice

Use this action to generate an invoice or Bill of Lading (BOL) from a shipment group. (Also see the web action Create Invoice.)

Parameters:

Invoice/Bill Rule ID 

Match Rule

Direct SQL Update

This is a utility agent action. See Direct SQL Update.

Dont Persist

This is a utility agent action. See Dont Persist.

Else

This is a utility agent action. See Else.

Elseif

This is a utility agent action. See Elseif.

Else If Shipment Group Event

Obsolete

Endfor

This is a utility agent action. See Endfor.

Endif

This is a utility agent action. See Endif.

Endlock

This is a utility agent action. See Endlock.

Estimate Distance

This is a utility agent action. See Estimate Distance.

For

This is a utility agent action. See For.

For Each

This is a utility agent action. See For Each.

Generate Invoice

Use this action to generate an invoice from a shipment group. (Refer to the web action Create Invoice.)

Parameters:

Invoice/Bill Rule ID 

Match Rule

Generate Refnum

This is a utility agent action. See Generate Refnum.

If

This is a utility agent action. See If.

If Shipment Group Event

Obsolete

Lock

This is a utility agent action. See Lock.

Log

This is a utility agent action. See Log.

Log to Transmission Report

This is a utility agent action. See Log to Transmission Report.

Modify Pickup

See the Modify Pickup Notification action.

Notify Contact

This is a utility agent action. See Notify Contact.

Notify Involved Party

This is a utility agent action. See Notify Involved Party.

Persist

This is a utility agent action. See Persist.

Prepare Document

This is a utility agent action. See Prepare Document.

Prepare Report

This is a utility agent action. See Prepare Report.

Print Document

This is a utility agent action. See Print Document.

Propagate Changes to Trade Transaction

See Propagate Changes to Trade Transaction topic.

Parameter:

Consider related shipments of a shipment

Queue Event

This is a utility agent action. See Queue Event.

Raise Error

This is a utility agent action. See Raise Error.

Raise Event

This is a utility agent action. See Raise Event.

Raise Internal Event

This is a utility agent action. See Raise Internal Event.

Reassociate Secondary Charge Shipments

When the equipment of the shipments of the shipment group is modified then this action is used to reassociate the equipment of the real shipments of the shipment group with the secondary charge shipments and recalculate the cost.

Rebuild Secondary Charge Shipments

Deletes the secondary charge shipments present on the shipment group and rebuilds the new secondary charge shipments based on the secondary charge rule provided on the shipment group rule of the shipment group.

For example, if the source location of any shipment group is modified, the secondary charges on the shipment group will have to be deleted and rebuilt based on the applicable rate offering and rate record of the new location. 

If the shipment group rule is not present on the shipment group, the action will not delete or rebuild the secondary charge shipments.

Reevaluate Auto Assign

This is a utility agent action.

Remove Appointment - Shipment Group

If no option is provided, all appointments scheduled for the shipment, regardless of stop, will be removed. If only the location is provided, the stops will be determined from which the appointments are removed. If you provide the stop, then they are only removed from that stop. If you provide both the location and the stop, the stop overrides the location if the location is different from the stop.

Parameters:

Location

First Stop

Last Stop

Remove from Trade Transaction

See Remove from Trade Transaction topic.

Parameter:

Remove Related Shipments from Transaction for all Primary Shipments

Remove Transactional Interest

This is a utility agent action. See Remove Transactional Interest.

Resend Pickup

See the Re-Transmit Pickup Notification action.

Schedule Appointment - Shipment Group

Allows you to schedule an appointment.

If you don't specify any option, the appointments are scheduled for each stop of the shipment. If you only provide the location, then the stops are automatically determined. If you provide stops, then the appointment is scheduled only for that stop. If both stops and locations are provided, then the stops override the specified location if there is a conflict between the two. In all scenarios, if the Reschedule check box is not selected, the appointment will not be scheduled if the shipment has existing appointments on the stop.

Parameters:

Location

First Stop

Last Stop

Reschedule

Send Document Sets

This agent action follows the same logic as the web action Send Documents with the option of sending document sets.

Note:
The agent action  will check if  the given document sets are assigned to the business object. If not, the agent action fails and will not send the document sets to the user.
Also, if any document set is not provided in the agent action, it fails.

Parameter:

Document Set

Schedule Event

This is a utility agent action. See Schedule Event.

Send Integration

This is a utility agent action. See Send Integration.

Send Pickup

See the Send Pickup Notification action.

Send Shipment Group Status XML

When a shipment event is received, this agent action forwards the ShipmentGroupStatus that was just received to the external system defined on the involved party.

The involved party on the shipment must have a communication method of HTTPPOST or BY CONTACT and must have a external system defined on the contact record.

Also, you cannot send shipment group status XML if your automation agent is listening to a non-shipment status event, such as Shipment - Created. In this case a warning is logged stating that the action is not going to be run. (It is only a warning so this does not halt the execution of the agent. So it will continue with whatever agent actions may take place after this agent action.)

Parameters:

Notify Method

Involved Party: Contacts that are assigned to the Involved Party Qualifier should have an external system identified.

Send ID Only

Set Appointment Fixed - Shipment Group

This agent action sets the Fixed check box on an appointment to Y based on location, first stop, and last stop, if provided.

Parameters:

Location

First Stop

Last Stop

Set Appointment Priority - Shipment Group

This agent action sets the appointment priority on shipments. See Set Appointment Priority action.

Parameters:

Appointment Priority

Set Indicator

This is a utility agent action. See Set Indicator.

Set Internal Status

This is a utility agent action. See Set Internal Status.

Set Status

This is a utility agent action. See Set Status.

Set User Defined Image

This is a utility agent action. See Set User Defined Image.

Shipment Group - Re-associate Secondary Charge

Updates existing secondary charges associated with a shipment group as changes occur to the composition of a shipment group. For example, if shipments are added to or deleted from a shipment group, this action updates the secondary charge.

Shipment Group - Recalc Secondary Charge

Recreates all secondary charges associated with the shipment group.

Stop

This is a utility agent action. See Stop.

Update Status for External Event

This is a utility agent action. See Update Status for External Event.

Wait

This is a utility agent action. See Wait.