Badge Reader Integration customization

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 1 minute to read

    • Badge Reader Integration includes several scripted extension points for you to customize script includes installed with the feature.

    The underlying Badge Reader Integration script includes are read only. Customers who want to modify the look and feel of the feature can alter several script includes using scripted extension points.

    Various scenarios exist whereby the ability to modify script-includes code is beneficial. For example, if you already use a data model to store your badge numbers, you may not want to use the Badge Reader Integration application User Badge (sn_badge_user_badge) table to store your badge numbers. Instead, you can create an extension implementation for sn_badge.BadgeReader that supports your data model.

    Perhaps you want to customize the types of data you receive from a badge scan or how you want to parse that data. You can create an extension implementation for sn_badge.BadgeReaderParser that supports your data model.

    The following code is available for alteration using scripted extension points with the Badge Reader Integration application:

    Scripted Extension Points Description
    BadgeReader

    API name: sn_badge.BadgeReader

    Extension point used by the BadgeReaderImpl script includes.

    Use this script to find a badge reader by its device identifier.
    BadgeReaderParser

    API name: sn_badge.BadgeReaderParser

    Extension point used by the BadgeReaderParserImpl script include.

    Use this to parse the card data string from the API.
    BadgeReaderUser

    API name: sn_badge.BadgeReaderUser

    Extension point used by the BadgeReaderUserImpl script include.

    Use this script to find a sys_user from a badge number and facility code.
    Note:
    If you already have a data model for storing your badge numbers, this is the script to use to override the Badge Reader Integration application code to support your data model.
    BadgeReaderScanProcessor

    API name: sn_badge.BadgeReaderScanProcessor

    Extension point used by the BadgeReaderScanProcessor script include.

    Use this frontage to manage the badge scan event.

    For complete details about scripted extension points and how to create and use them, refer to Using extension points to extend application functionality and Creating and adding a scripted extension point.