Last updated: 10.04.2024

Valid from: 2023.07.00 and later, Opter Driver for iOS 2.4.3 and later

Consignments in Opter Driver for iOS

If working with consignments, it can be defined how the consignments are displayed in Opter Driver. Consignments can be displayed grouped in the shipment list in Opter Driver. A section is then displayed for each consignment, in which the included original shipments or the consignment shipment are displayed with pickup/delivery addresses.

Note:

When scanning, preferably scan the original shipments, even if otherwise working with consignments.

Step 1: Check the consignment type setting

  1. Click on Settings > Consignment types, and on the General tab. Select a consignment type from the list on the left by clicking on it.

  2. Check that the setting is as desired for the Create new addresses if no matching addresses when consigning checkbox.

    • Used, for example, if the consignment shipments are dispatched, rather than the original shipments.

      The app then displays a section for each consignment, where the consignment shipment is shown with the pickup/delivery address.

    • Used for example if the original shipments are dispatched, but the consignment order is used for invoicing and/or supplier bills.

      The app then displays a section for each consignment, where the included original shipments are shown with the pickup/delivery address.

    For more information, see Consignment types (window).

  3. Click on to save all changes.

Step 2: Set how to change the status of the consignment shipments and original shipments

How the statuses of the consignment shipment and the original shipments change in relation to each other can be controlled using two checkboxes in the Consignment types window:

  • Consignment status follows consigned shipment status
  • Consigned shipment status follows consignment status

Check that these two checkboxes are set as desired. For more information, see Status of consignment shipments and original shipments.

Step 3: Set up the mobile data settings for consignments

For instructions on how to add a mobile data setting, see Mobile data settings (window).

  1. In Opter, click on Settings > Mobile data > Settings mobile data.

  2. Set the mobile data setting GroupConsignments to "true", to group together consignments in the shipment list in Opter Driver.

    A section is then displayed for each consignment, in which the included original shipments or the consignment shipment are displayed with pickup/delivery addresses. The setting in the Create new addresses if no matching addresses when consigning checkbox determines whether the included original shipments or the consignment shipment are displayed with addresses, see step 1 above.

  3. Select whether only shipments that are assigned to the logged-in resource should be displayed in Opter Driver, or whether all the consignment’s original shipments should be displayed for the resource regardless of whether they are assigned or not.

    Set the App.SyncAllConsignedShipments mobile data setting to one of the following:

    • ”True” (default): If a consignment is assigned to a resource, all the consignment’s original shipments for the resource are displayed in Opter Driver regardless of whether or not they are assigned. For more information, see Mobile data settings (window).

      Note:

      GroupConsignments must be set to "true". (If GroupConsignments = "false", it works like App.SyncAllConsignedShipments = "false", even if that has been set to "true").

    • “False”: In Opter Driver, only shipments that are assigned to the logged-in resource are displayed.

  4. To display as much information as possible about consignments in the app, set both IncludeConsignments and IncludeConsignmentChildren to “true”. This shows both the original shipments that make up the consignment and the consignment shipments.

    Tip

    For Opter Driver for Android, we recommend setting either IncludeConsignments or IncludeConsignmentChildren to “true”, as consignments cannot be grouped in Opter Driver for Android.

    If you only work on original shipments in the app, and do not create extra shipments on the consignment, then set IncludeConsignmentChildren to “true” (to display the original shipments that make up the consignment) and set IncludeConsignments to “false” (so consignment shipments are not displayed in Opter Driver).

  5. Click on Save.

For more information, see Mobile data settings (window).

Step 4: Set up how consignments are displayed in Opter Driver

To set which fields to display for consignments in the app, on the shipment page and in the detail view, proceed as follows:

  1. Open the Design field for mobile window, the XML file App.Design or the XML file App.OpterDriver.Design to set the fields to be displayed for consignments.

    Tip

    If you do not know whether to use the Design field for mobile window, the App.Design XML file or the App.OpterDriver.Design XML file, see Customising the layout and features of Opter Driver.

  2. Choose which fields to display by doing one of the following:

    • In the Design field for mobile window, drag and drop in the Included list the fields that are to be displayed and in the Excluded list those that are not to be displayed. It is also possible to double-click on a field to move it to the other list. For more information, see Configuring which fields are displayed in Opter Driver for iOS.

    • In the XML file App.Design or the XML file App.OpterDriver.Design, add the tag pairs <expandedconsignment> </expandedconsignment> (for the detail view) and/or <summaryconsignment> </summaryconsignment> (for the shipment page), and then add the variables/fields that are to be displayed for consignments.

      The complete example found in App.OpterDriver.Design can be utilised for this, by commenting out the lines that are not required.

    Tip

    The fields for consignments are listed in Design field for mobile (window).

  3. Save your changes.

Show the menu item Show connected shipments in Opter Driver

The menu item Show connected shipments appears in the menu in the detail view if the following applies:

  • The current shipment is part of a consignment, i.e. the consignment shipment or one of the included original shipments.

  • The mobile data settings GroupConsignments are set to "true".

  • The mobile data setting IncludeConsignmentChildren is set to "true".

In the Connected shipments view, all the connected shipments that are assigned to the resource that is logged in to the app are displayed. If App.SyncAllConsignedShipments is set to "true", even shipments that are not assigned to the logged-in resource are displayed. They appear under the Shipment not assigned to you, cannot be changed heading.

See also