uDocs Unicon™

Smart Card Actions Configuration

Goal

Configure Smart Card Actions on eLux devices to control system behavior when a smart card is inserted or removed. This includes session locking, logoff, user switching, and execution of custom scripts.

Prerequisites

Before you begin, ensure the following:

  • You have access to Scout with permission to edit device profiles.
  • The target device is assigned to the correct profile.
  • Smart card hardware is installed and functioning.
  • Any required Bash scripts are prepared and available for upload.

Configuration Overview

The Smart Card Actions feature provides seven configuration parameters. Configuration must be done via Advanced File Entries:

  • Scout → Device Profile → Advanced device configuration → Advanced file entries

The relevant sections are:

[Hotkeys]
PauseAction

[SmartCard]
OnScInsert
OnScRemoval
ScInsertScript
ScRemoveScript
PauseActionOnDifferentCardInserted
PauseActionTimeoutSeconds
<!--NeedCopy-->

Configuration Details

The following parameters control system behavior when a smart card is inserted, paused or removed.

PauseAction

Defines the modifier key used to trigger the pause action.

  • Default value: <shift>
  • Valid values: <shift>, <ctrl>, <alt>

This setting does not distinguish between left and right modifier keys.

OnScInsert

Defines the action performed when a smart card is inserted.

  • Default value: none
  • Valid values: none, runscript
  • Requirement: Value must be lowercase.
Value Behavior
none No action is performed.
runscript Executes the script defined in ScInsertScript.

OnScRemoval

Defines the action performed when a smart card is removed.

  • Default value: none
  • Valid values: none, lock, logoff, runscript
  • Requirement: Value must be lowercase.
Value Behavior
none No action is performed.
lock Locks the current eLux session.
logoff Logs off the current eLux session.
runscript Executes the script defined in ScRemoveScript.

ScInsertScript

Specifies the script executed when a smart card is inserted.

  • Default value: empty
  • Valid values: Full path to a Bash script on the device.

The file must exist on the device and match the configured path exactly.


ScRemoveScript

Specifies the script executed when a smart card is removed.

  • Default value: empty
  • Valid values: Full path to a Bash script on the device.

The file must exist on the device and match the configured path exactly.


PauseActionOnDifferentCardInserted

Defines system behavior when a different smart card is inserted during an active session.

  • Default value: switchuser
  • Valid values: switchuser, ignore
  • Requirement: Value must be lowercase.
Value Behavior
switchuser Logs off the current session and displays the Smart Card login screen.
ignore Continues the current session without interruption.

PauseActionTimeoutSeconds

Defines the timeout (in seconds) for the pause action.

  • Default value: 30
  • Valid values: Numeric (5–300 seconds)

Behavior outside valid range:

  • Values below 5 are automatically adjusted to 5.
  • Values above 300 are automatically adjusted to 300.

Script Files

Smart Card Actions support custom Bash scripts that can be executed on card insertion or removal.

Supported Script Type

  • Only Bash (.sh) scripts are supported.
  • Scripts must be uploaded in Scout under:

Advanced device configuration → Files


File Location Requirements

The destination path configured during file upload must exactly match the value specified in:

  • ScInsertScript
  • ScRemoveScript

If the configured path and the uploaded file location do not match, the script will not execute.

Ensure the script has the correct permissions and is accessible on the device.

Smart Card Actions Configuration