Command-line interface

You configure the SeaLights ABAP Agent using a command-line interface program installed to <SLABAPAgent dir>\bin directory. You can use the command-line interface program to do the following:

Set up the agent
Connect the agent to SeaLights
Define resources
Create an Initial Build Map
Create Build Modifications
Create Footprints

Run the command-line interface

To display the command-line interface’s help file, start Windows PowerShell as an Administrator, and change to the <SLABAPAgent dir>\bin directory.

PS C:\Windows\system32> cd C:\apps\SLABAPAgent\bin

Then run the following:

PS C:\apps\SLABAPAgent\bin> .\slabapcli.exe --help
[2025-06-13 16:07:44.006+01:00] [info] Current ANSI Code Page: 65001 (UTF-8) (65001)
usage: slabapcli [-h] [-c config pathname] <resource> <command> [args]
resource:
  setup:
    install   : install
    uninstall : uninstall
  settings:
    list : list settings
  sealights:
    list : list sealights configuration
    test : test sealights configuration
    set  : set sealights configuration
  rfc:
    list : list rfc configurations
    test : test rfc configuration
    del : delete rfc configuration
    set : set rfc configuration
    phd : import performance history data
  pipeline:
    list : list pipelines
    set  : set pipeline
  buildmap:
    run : configure one-time collection of initial build map
  buildmods:
    run : configure regular collection of build mods
    stop: stop collection of build mods
  footprints
    run : configure regular collection of footprints
    stop: stop collection of footprints
  testexecution
    list : list open test executions
    open : open test execution
    close: close test execution

slabapcli <resource> help for resource specific help

You can run .\slabapcli.exe <resource> help to display the help for a specific resource.

PS C:\apps\SLABAPAgent\bin> .\slabapcli.exe settings help
[2025-06-13 16:14:16.590+01:00] [info] Current ANSI Code Page: 65001 (UTF-8) (65001)
[2025-06-13 16:14:16.590+01:00] [info] Config pathname: ../config/config.toml
settings <command>:
command:
  help : settings command help
  list : list settings

List Pipelines

To list the Pipelines defined in your config.toml file, run the following from your PowerShell window:

PS C:\apps\SLABAPAgent\bin> .\slabapcli.exe pipeline list

[2025-06-17 14:26:57.522+01:00] [info] Config pathname: ../config/config.toml

Name : HH_SLABAPCLI_170625

QAS : S21

PRD : S21

Create an Initial Build Map for your Pipeline

A Pipeline’s Initial Build Map is a snapshot of the standard and custom ABAP code components in the Pipelines QAS system (and their related objects), based on usage data from the Pipeline’s Production system.

To create an Initial Build Map for your Pipeline, run the following from your PowerShell window:

PS C:\apps\SLABAPAgent\bin> .\slabapcli.exe buildmap run --pipeline HH_SLABAPCLI_170625

[2025-06-17 15:28:19.807+01:00] [info] Current ANSI Code Page: 65001 (UTF-8) (65001)

[2025-06-17 15:28:19.807+01:00] [info] Config pathname: ../config/config.toml

The agent creates a scheduled INIT_BUILD_MAP task that runs once only (two minutes from now) to create the Initial Build Map. In SeaLights, select the Filter button to add the app for your Initial Build Map to the Coverage Dashboard.

Monitor your Pipeline for Build Modifications

The next step is to configure the agent to monitor your Pipeline for Build Modifications. The agent creates Build Modifications from changes you make by importing transports into the Pipeline’s QAS system. To see how to the agent to monitor your Pipeline for Build Modifications run the following from your PowerShell window:

PS C:\apps\SLABAPAgent\bin> .\slabapcli.exe buildmods help

[2025-06-18 09:05:39.325+01:00] [info] Current ANSI Code Page: 65001 (UTF-8) (65001)

[2025-06-18 09:05:39.326+01:00] [info] Config pathname: ../config/config.toml

buildmods <command> --pipeline <pipeline>

commands:

help : buildmods command help

run : configure collection of build mods

stop: stop collection of buildmods

To monitor your Pipeline’s QAS system for Build Modifications, run the following from your PowerShell window:

PS C:\apps\SLABAPAgent\bin> .\slabapcli.exe buildmods run --pipeline HH_SLABAPCLI_170625

[2025-06-18 09:24:49.485+01:00] [info] Current ANSI Code Page: 65001 (UTF-8) (65001)

[2025-06-18 09:24:49.486+01:00] [info] Config pathname: ../config/config.toml

[2025-06-18 09:24:49.516+01:00] [info] Total time: 00:00:00.031

This command creates a BUILD_MODS scheduled task that runs every five minutes to create Build Modifications from transports imported into the Pipeline’s QAS system.

To display the Build Modifications in SeaLights, go to the Coverage Dashboard and open the Build history window for your app.

In the Build column:

The Initial Build Map name has the format Initial <QAS system>|<QAS hostname>|<Creation datetime>
Build Modifications have the format <Transport name>|<Import datetime>

The Coverage Report’s Overall Coverage tab lists all the objects in your SeaLights app.

The Coverage Report hierarchy has the following structure:

App

{} <Component Type> <Component Name>

…

The Code Changes tab lists all the code changes introduced by Build Modifications.

Stop monitoring a Pipeline for Build Modifications

To stop monitoring a Pipeline for Build Modifications, run the following from your PowerShell window:

PS C:\apps\SLABAPAgent\bin> .\slabapcli.exe buildmods stop --pipeline HH_SLABAPCLI_170625

[2025-06-18 14:45:19.637+01:00] [info] Current ANSI Code Page: 65001 (UTF-8) (65001)

[2025-06-18 14:45:19.638+01:00] [info] Config pathname: ../config/config.toml

[2025-06-18 14:45:19.652+01:00] [info] Stopped buildmods run

[2025-06-18 14:45:19.652+01:00] [info] Total time: 00:00:00.015

Collect Footprints data for your Pipeline

If you have connected Tosca to SeaLights, you can configure the agent to collect details for test executions in Tosca. When you run a test, the agent matches the ABAP components that you executed against objects in the latest Build Modification. It then sends this data to SeaLights as a Footprint.

To configure the agent to collect Footprints data for your Pipeline, run the following command from your PowerShell window:

PS C:\apps\SLABAPAgent\bin>

[2025-06-18 15:07:58.337+01:00] [info] Current ANSI Code Page: 65001 (UTF-8) (65001)

[2025-06-18 15:07:58.337+01:00] [info] Config pathname: ../config/config.toml

[2025-06-18 15:07:58.341+01:00] [info] resource = footprints. command = run

[2025-06-18 15:07:58.341+01:00] [info] pipline: HH_SLABAPCLI_170625

[2025-06-18 15:07:58.370+01:00] [info] Run scheduled daily. interval = 5m. duration = 1d

[2025-06-18 15:07:58.370+01:00] [info] Total time: 00:00:00.033

This command creates a FOOTPRINTS scheduled task that runs every five minutes to Footprints data and sends it to SeaLights.

Stop collecting Footprints data for a Pipeline

To stop monitoring a Pipeline for Build Modifications, run the following from your PowerShell window:

PS C:\apps\SLABAPAgent\bin> .\slabapcli.exe footprints stop --pipeline HH_SLABAPCLI_170625

[2025-06-20 10:06:45.590+01:00] [info] Current ANSI Code Page: 65001 (UTF-8) (65001)

[2025-06-20 10:06:45.590+01:00] [info] Config pathname: ../config/config.toml

[2025-06-20 10:06:45.594+01:00] [info] resource = footprints. command = run

[2025-06-20 10:06:45.606+01:00] [info] Stopped footprints run

[2025-06-20 10:06:45.606+01:00] [info] Total time: 00:00:00.017

PreviousConnect Tosca to SeaLights NextSet up the agent

Last updated 27 days ago

Was this helpful?