4. Designer Event Blocks

Home/4. Designer Event Blocks

4. Designer Event Blocks

You are here:

The designer events are generally triggered either by actions taken by users (scanning barcodes, pressing menus, etc.) or by specific processes internal to the application framework (opening or closing an application, loading data, etc.).  There should only be one instance of an event per application and should only be added to the application as needed.

The following sections will outline each available event and provide a brief example of how the event can be used.

After a Row is Selected

After Item Reservation is Added

This event is triggered after an Item tracking entry has been added via the Show Reservations block. 

Item Reservation

When triggered the following variables will available to the user:

  • VariantCode
    • The variant code of the originating line
  • LotNumber
    • The lot number entered by the user
  • SerialNumber
    • The serial number entered by the user
  • QuantityUserUOM
    • The quantity entered by the user
  • TotalQuantityLineUOM
    • The new combined quantity based on line UOM. This will be the original line quantity to handle + the quantity entered by the user.
  • QuantityLineUOM
    • The quantity entered by the user but converted to the line UOM if different than the one entered by the user
  • UnitOfMeasure
    • The unit of measure entered by the user
  • NumberOfLabels
    • The number of labels requested (if applicable)
  • ExpiryDate
    • The expiry date entered by the user

After Item Reservation is Added Example

The following blocks illustrate an example of using the “After Item Reservation is Added” event. 

Application Designer:

Application Designer

After Item Reservation is Changed

This event is triggered after an Item tracking entry has been modified via the Show Reservations block.

IR Changed

When triggered the following variables will available to the user:

  • form.VariantCode
    • The variant code of the originating line
  • form.LotNumber
    • The lot number modified by the user
  • form.SerialNumber
    • The serial number modified by the user
  • form.QuantityUserUOM
    • The quantity entered by the user
  • form.TotalQuantityLineUOM
    • The new combined quantity based on line UOM. This will be the original line quantity to handle + the quantity entered by the user – the item tracking quantity before modification.
  • form.QuantityLineUOM
    • The quantity entered by the user but converted to the line UOM if different than the one entered by the user
  • form.UnitOfMeasure
    • The unit of measure entered by the user
  • form.NumberOfLabels
    • The number of labels requested (if applicable)
  • form.ExpiryDate
    • The expiry date entered by the user

After Item Reservation is Changed Example

The following blocks illustrate an example of using the “After Item Reservation is Changed” event.

Application Designer:

Application Designer

After Item Reservation is Deleted

This event is triggered after an Item tracking entry has been deleted via the Show Reservations block.

Item Reservation Deleted

When triggered the following variables will available to the user:

  • form.VariantCode
    • The variant code of the originating line
  • form.LotNumber
    • The lot number deleted by the user
  • form.SerialNumber
    • The serial number deleted by the user
  • form.TotalQuantityLineUOM
    • The new combined quantity based on line UOM. This will be the original line quantity to handle – the item tracking quantity being deleted.
  • form.QuantityLineUOM
    • The negative quantity of the item tracking quantity being deleted but converted to line UOM
  • form.UnitOfMeasure
    • The unit of measure of the originating line
  • form.ExpiryDate
    • The expiry date of the item tracking entry

After Item Reservation is Deleted Example

The following blocks illustrate an example of using the “After Item Reservation is Deleted” event. 

Application Designer:

Item Reservation Deleted Example

Custom Event

The custom event block is triggered by one of two ways:

  • A PDA Menu with a standard action of: “Application Event”
    • The event to trigger is specified in the “Custom 1” field on the menu
  • Using a “Start Event” block

You can use this block to tie menu actions to custom processes as well as making the application design more readable and re-usable.

Custom Event Name

Block Configuration:

Option

Description
Name The name of the event.  This will be referenced in the “Custom 1” field on a PDA menu or the “Event Name” configuration option on the “Start Event” block.

Custom Event Example

The following blocks illustrate an example of using the “Custom Event” event. 

Application Designer:

Custom Event

When a Bin is Scanned

This event is triggered when a Bin barcode is scanned.  This event will be fired after the barcode has been validated by NAV (if required).  You will need to handle the actions to take (if any) when a Bin is scanned.  Typically, you would include a “Using the Last Scanned Barcode” block to push the Bin barcode variables into the page context and then take appropriate action from there.

Bin Scanned

When a Bin is Scanned Example

The following blocks illustrate an example of using the “When a Bin is Scanned” event. 

Application Designer:

Scanned Bin

When a Document is Scanned

This event is triggered when a Document barcode is scanned.  Document barcode formats are fixed and are always preceded by a unique type identifier.  If you are intending to scan a document that does not have the identifiers present then it will need to be interpreted as a “Text” barcode.

You will need to handle the actions to take (if any) when a Document is scanned.  Typically, you would include a “Using the Last Scanned Barcode” block to push the Document barcode variables into the page context and then take appropriate action from there.

Document Scanned

When a Document is Scanned Example

The following blocks illustrate an example of using the “When a Document is Scanned” event. 

Application Designer:

Scanned Document

When a License Plate is Scanned

This event is triggered when a License Plate barcode is scanned.  This event will be fired after the barcode has been validated by NAV.  You will need to handle the actions to take (if any) when a License Plate is scanned.  Typically, you would include a “Using the Last Scanned Barcode” block to push the License Plate barcode variables into the page context and then take appropriate action from there.

License Plate Scanned

When a License Plate is Scanned Example

The following blocks illustrate an example of using the “When a License Plate is Scanned” event. 

Application Designer:

Scanned License Plate

When a License Plate is Started

This event is triggered when a PDA menu with a standard action of “LP Create” is pressed.  The application internally will keep track of the menu state and toggle it between ‘start’ and ‘stop’ so depending on what state the menu is in this or the “When a License Plate is Stopped” event will be triggered.

License Plate Started

You will need to handle the actions to take (if any) when the request is made.

When a License Plate is Started Example

The following blocks illustrate an example of using the “When a License Plate is Started” event. 

Application Designer:

Started License Plate

When a License Plate is Stopped

This event is triggered when a PDA menu with a standard action of “LP Create” is pressed.  The application internally will keep track of the menu state and toggle it between ‘start’ and ‘stop’ so depending on what state the menu is in this or the “When a License Plate is Started” event will be triggered.

License Plate Stopped

You will need to handle the actions to take (if any) when the request is made.

When a License Plate is Stopped Example

The following blocks illustrate an example of using the “When a License Plate is Stopped” event.

Application Designer:

Stopped License Plate

When a License Plate Template is Scanned

This event is triggered when a License Plate Template barcode is scanned.  You will need to handle the actions to take (if any) when a License Plate Template is scanned.  Typically, you would include a “Using the Last Scanned Barcode” block to push the License Plate Template barcode variables into the page context and then take appropriate action from there.

License Plate Template Scanned

When a License Plate Template is Scanned Example

The following blocks illustrate an example of using the “When a License Plate is Scanned” event. 

Application Designer:

Scanned License Plate Template

When a Location is Scanned

This event is triggered when a Location barcode is scanned.  This event will be fired after the barcode has been validated by NAV.  You will need to handle the actions to take (if any) when a Location is scanned.  Typically, you would include a “Using the Last Scanned Barcode” block to push the Location barcode variables into the page context and then take appropriate action from there.

Location Scanned

When a Location is Scanned Example

The following blocks illustrate an example of using the event. 

Application Designer:

Scanned Location

When a Tag is Scanned

This event is triggered when a Tag barcode is scanned.  You will need to handle the actions to take (if any) when a Tag is scanned.  Typically, you would include a “Using the Last Scanned Barcode” block to push the Tag barcode variables into the page context and then take appropriate action from there.

Tag Scanned

When a Tag is Scanned Example

The following blocks illustrate an example of using the “When a Tag is Scanned” event. 

Application Designer:

Scanned Tag

When an Item is Scanned

This event is triggered when an Item barcode is scanned.  This event will be fired after the barcode has been decoded/processed in NAV.  You will need to handle the actions to take (if any) when an Item is scanned.  Typically, you would include a “Using the Last Scanned Barcode” block to push the Item barcode variables into the page context and then take appropriate action from there.

Item Scanned

This event is integrated with the “scan quantity change” scan behaviors defined in NAV.

Note: For more information in Item decoding please reference the Warehouse Insight documentation.

When an Item is Scanned Example

The following blocks illustrate an example of using the “When an Item  is Scanned” event.

Application Designer:

Scanned Item
Note: For more information on Scan Behaviors reference the Warehouse Insight documentation.

When Loading Document Data

If this block is added the application will automatically present a Data Grid or Card Panel to the user.  This block will be triggered immediately after the “When the Form Opens”.  In addition the event can be triggered by an “Update Data…” block.

Loading Document Data

Typically the only action required in this event is to get the dataset from NAV so that the grid can be populated.

When Loading Document Data Example

The following blocks illustrate an example of using the “When Loading Document Data” event. 

Application Designer:

Document Data Loading
Note: See the “Update Data” block for an example of how to return data to the handheld.

When Quantity Should Change on a Row

This event is only triggered when a menu option with a standard action of “Change Qty” is pressed.  This event is meant for manual quantity changes for a selected line and is integrated with the “manual quantity change” scan behaviors defined in NAV.

Quantity Change

When Quantity Should Change on a Row Example

The following blocks illustrate an example of using the “When Quantity Should Change on a Row” event.

Application Designer:

Row Quantity Change
Note: For more information on Scan Behaviors reference the Warehouse Insight documentation.

When Text is Scanned

This event is triggered when a text barcode is scanned.  A “text barcode” is a barcode that is not decodable as anything else (Item, Bin, LP, document, etc.).  The process flow internally will be to first attempt to decode the text barcode as an Item or Bin.  If those fail then this event will be raised. 

You will need to handle the actions to take (if any) when a Text barcode is scanned.  Typically, you would include a “Using the Last Scanned Barcode” block to push the text barcode variables into the page context and then take appropriate action from there.

Text Scanned

The variables added as a result of the “Using the last scanned barcode” are:

Note: If this block is not present an error will be displayed indicating that the barcode could not be decoded as a valid Item barcode.

When Text is Scanned Example

The following blocks illustrate an example of using the “When Text is Scanned” event.

Application Designer:

Scanned Text

When The Form Closes

This event is triggered just prior to the application closing.  You may take additional action at this point (posting, printing, etc.) but you will not be able to prevent the page from being closed.

Form Closes

When The Form Closes Example

The following blocks illustrate an example of using the “When the Form Closes” event.

Application Designer:

Form Closes

When The Form Opens

The “When the Form Opens” event is triggered when the application first loads.  The event is only ever fired once and should be used to initialize the application.  For example setting the form title, initializing variables, etc.  For simple processes (like asking users for input and then closing the form) this event should be considered the starting point.

Form Opens

When The Form Opens Example

The following blocks illustrate an example of using the “When the Form Opens” event.

Application Designer:

Form Opens
Was this article helpful?
0 out of 5 stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Need help?

Leave A Comment

Go to Top