Scanner Application Configuration


Overview

The FSM Scanner Application is an extension to the BMC Helix platform designed to streamline the management of Configuration Items (CIs) by automating updates, replacements, and workflow-driven asset actions. This manual provides administrators and technical personnel with a structured guide to configuring, maintaining, and operating the Scanner Application within the Helix environment.

The document explains how the Scanner Application integrates with Helix using REST APIs, how authentication tokens are generated, and how CI-related information is processed during scanning events. It also outlines the configuration screens, navigation paths, workflow triggers, and the detailed setup of CI actions, covering both Original and Replacement CIs. The configuration options include lifecycle status updates, site changes, inventory movements, work order associations, relationship adjustments, and other workflow-driven actions.

This guide also details the structure and purpose of key screens such as the Scanner Workflow Setup, Scanner Config tabs, Worklog Information, Work Order, and SRT settings. Each configuration field is described to assist administrators in aligning the scanner behaviour with organisational asset-management processes. Additionally, guidance is provided on sending attachments and data through REST calls via Postman for integration and testing purposes.

By following the steps and configuration guidelines in this manual, administrators can ensure the FSM Scanner Application is correctly implemented, consistently maintained, and aligned to business rules governing asset management across the enterprise.

Navigation

Navigation to the Configuration Page:

Log into the Helix system and select the Application navigator on the right side of the home page.

Select FSM Scanner Integration Application and the FSM Scanner Management Console.

Select the Navigation Setup navigator.

Select Scan Setup then the Scan Workflow Setup option.

The above steps will open the List of configured options for the Scanner application.

The Configuration Page Layout

The  picture below shows the layout of the Scanner Workflow Setup page.

Here you will find the required setup fields like Company, Scanner Action, Status fields and the four main tabs; Scanner Config, Worklog Information, Work Order and SRT.

1764312675385-615.png

The Main Page Fields

This table below contains the detailed descriptions of the workflow configurations fields.

#Config DescriptionNotes
1Company*The company of the Original.
2Inventory Company*The Company of the Inventory Ci.
3Scanner Action*Name Of the Scanner Action.
4Status*Status of the config record Enabled or Disabled (If disabled the Scanner action will not fire the records workflow).
5Get CI Info *Default Setting for background workflow Actions in this version of the application it is required.
 *Required Field

Scanner Config

The scanner Config tab is divided under the following headings: 

  • CI Original -  It consists of the Actions/Configs for the original Ci.
  • Replacement Ci - It consists of the Actions/Configs for the replacement Ci.
  • Relationships - It consists of the Actions/Configs for the different relationships between the Ci and People relationships.

Scanner Config tab – Ci Original Configuration options

The table below contains the detailed descriptions of the workflow configurations under the Ci Original heading:

#Config DescriptionNotes
1AssetLifecycleStatus *

The AssetLifecycleStatus configuration field sets the Original Ci Status it should be set to it have the following settings that concordant with the Asset Management  Ci  AssetLifecycleStatus.

  • Ordered
  • Received
  • Being Assembled
  • Deployed
  • In Repair
  • Down
  • End of Live
  • Transfer
  • Delete
  • In Inventory
  • On Loan
  • Disposed
  • Reserved
  • Return to Vendor
2Status Reason

The Status Reason set the Status Reasons of the  AssetLifecycleStatus field

It can be set to Null or status that is listed below

  • Scheduled
  • Maintenance
  • Out of Service
  • Obsolete
  • RMA - Return To Vendor
  • RMA - Return To Distributor
  • Replacement
  • Loan Replacement
  • Loan Replacement
  • Reserved
  • Stolen
  • Faulty
  • Dismantled
  • Permanently Replaced
  • Backup
  • Under Review
  • Damaged
  • Loan
  • Retired

Please see Note**

3Dataset*The Default data set value is BMC Asset custom data sets can be configured as well.
4Create CI

Options for this config is No and Yes

Yes – a New CI will be created.

5Update CI

Options for this config is No and Yes

Yes - the CI will be updated

6StatusThe Status Options is selected to update the Status of the Ci
7SiteThe Site Options is selected to update the Site of the Ci
8Tag NoThe Tag No Options is selected to update the Tag No of the Ci
9Link WO SitesThis Option is used where there is more than one Company Linked to a Site it will create a Related Company record if it does not exist on the Site It would compare the Company and Inventory Company.
10Move to InventoryThis Option is used and must be selected if the AssetLifecycleStatus is set to In Inventory it use In Inventory  workflow to set the inventory location.
11Remove From InventoryThis Option is used where the Ci is removed from the inventory location.
12Update Inventory Company InfoThe Update Inventory Company Info Option is used where the Ci is moved to a specific inventory location. It use the Inventory Lookup Value field to put the Inventory in that Inventory location.
13Inventory Lookup Value
 

Note**

The following must be setup on the AST:Attributes form the StatusReason (1000000150) the values that is not out of the Box.

 1764313017928-732.png  

And the Status Reasons must also be configured on the SYS:Status Reason Menu Items form

1764313017930-374.png

 *Required Field

Scanner Config tab – Replacement Ci Configuration options

The table below contains the detailed descriptions of the workflow configurations under the Replacement Ci heading:

#Config DescriptionNotes
1AssetLifecycleStatus *

The AssetLifecycleStatus configuration field sets the Original Ci Status it should be set to it have the following settings that concordant with the Asset Management  Ci  AssetLifecycleStatus.

  • Ordered
  • Received
  • Being Assembled
  • Deployed
  • In Repair
  • Down
  • End of Live
  • Transfer
  • Delete
  • In Inventory
  • On Loan
  • Disposed
  • Reserved

Return to Vendor

2Status Reason

The Status Reason set the Status Reasons of the  AssetLifecycleStatus field

It can be set to Null or status that is listed below

  • Scheduled
  • Maintenance
  • Out of Service
  • Obsolete
  • RMA - Return To Vendor
  • RMA - Return To Distributor
  • Replacement
  • Loan Replacement
  • Loan Replacement
  • Reserved
  • Stolen
  • Faulty
  • Dismantled
  • Permanently Replaced
  • Backup
  • Under Review
  • Damaged
  • Loan
  • Retired

Please See Note***

3StatusThe Status Options is selected to update the Status of the Ci
4SiteThe Site Options is selected to update the Site of the Ci
5  
 

Note***

The following must be setup on the AST:Attributes form the StatusReason (1000000150) the values that is not out of the Box.

 1764313185710-154.png  

And the Status Reasons must also be configured on the SYS:Status Reason Menu Items form

1764313185712-972.png

 *Required Field

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Helix Field Service Management 26.2