Sign in

Ship Help Center

Using the Custom Operations setup item

Avatar
Malene Tidemann
Updated

ship-label.png on-premises-label.png


The Custom Operations setup item enables you to make expressions without having to make a Shipping rules file. You can include the expressions supported in the Shipping Rules <expressions> node. See the Shipping Rules nodes description here.   

 

Adding the setup item

  1. Go to Setup and navigate to the Location/Actor in your installation where you want expressions to work.
     
  2. Right-click in the pane to the right and select New > Custom Operations.

    custom-operations.png
     
  3. Select the type of operation and click New. There are 5 different types of operations:
    1.  
      1. Expressions when reading request - the expression will run after the shipment JSON is parsed.
      2. Expressions at submit - the expression will run at the time of submit, which is when a shipment is created. 
      3. Expressions at transmit - the expression will run at the time of transmit, which is when EDI is sent to the carrier.
      4. Expression at validation - the expression will run together with other validations.
      5. Patch Options for API - set default values for the Option parameter for Shipment Server. (Not relevant for On-premises customers).
      6. Patch Data for API - replace values, set a delimiter, etc. (Not relevant for On-premises customers).

        customoperationsform.png
         
  4. Add the expression/code in the field. If you create a new XML file, you need to add your expression in the predefined <Expressions> node. 

    expressions-box.PNG
     
  5. Click OK to save.

 

 

Examples

Expressions 

This expression sets a default value of 15:00 in the Pickup start field if the current time (when the expression is run, depending on the type of operation) is less than 14:00. If you want the expression to run on a specific carrier only, it is important to specify this. (Note: this feature does not work with custom carriers.) 

You can use expressions supported in the Shipping Rules <expressions> node. See the Shipping Rules nodes description here.   

 

<Expression targetfield="fld_RefPickupStart">
<!-- if(currenttime less than 14:00) today 15:00     -->
<Condition name="intlimits" field="fld_SubcarrierConceptID" min="448" max="448" />
<Condition name="timelimits" field="fld_Now" min="00:00" max="14:00"/>
<Item special="datenow" format="YYYY-MM-DD"/>
<Item expression=" "/>
<Item expression="15:00:00"/>
</Expression>
<Expression targetfield="fld_RefPickupStart">
<!-- if(currenttime more than 14:00) today(+1) 15:00     -->
<Item special="datenow" adddays="1" format="YYYY-MM-DD"/>
<Item expression=" "/>
<Item expression="15:00:00"/>
</Expression>

 

 

SSOptions.ini

In this example, postcode validation is turned off on PreAdviseOrder, and labels are set to ZPLGK. 

[PreAdviseOrder]
ValidatePostCode=0

[SubmitOrder]
Labels=ZPLGK

The Patch options file follows this format:

[<MethodName>]

<Param Name]=[Param Value]

If the parameter is in the call, it will not be changed. It will only be added if it is not included.

 

 

SSData.ini

In this example, the delimiter is set to default | and four strings are replaced for PreAdviseOrder.

[PreAdviseOrder]
Delimeter=|
1="Name2"|"Street2"|
2="Kind": 176,|"Kind": 177,
3="Kind": 176,|"Kind": 177,
4="Kind": 176,|"Kind": 177,

The Patch data file follows this format: 

[<MethodName>]

<n>=<OldValue><NewValue>

n is a number starting with 1. If you have gaps in numbers, values after the gap will be ignored.

OldValue is the string to be replaced, and NewValue is the string to replace the old value.

 

Note:

If a configuration is made in a way that both Custom Operations and Shipping Rules target the same field, the value from Shipping Rules will apply last and can overwrite the value previously set by Custom Operations

Related articles