Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Command Name

Description

Options

Anchor
Run Job command
Run Job command
Run

Performs the following actions:

  1. Defines a new SAP, job based on either a USAP Definition file or an SAP Model Job.
  2. Starts the defined job.
  3. Waits for the job to complete.
  4. Prints the job's joblog to standard error and the spoollists to standard output.
  5. Purges the job from the SAP system.
  • Definition or Model
    Include Page
    IL:Definition or Model
    IL:Definition or Model
  • Script or File System
    Include Page
    IL:Library or File System - SAP
    IL:Library or File System - SAP
  • Script
    Include Page
    IL:Script - SAP
    IL:Script - SAP
  • Definition File
    Include Page
    IL:Definition File
    IL:Definition File
  • SAP Job Name
    Include Page
    IL:SAP Job Name
    IL:SAP Job Name
  • SAP Job ID
    Include Page
    IL:SAP Job ID - 6.4.5.0
    IL:SAP Job ID - 6.4.5.0
  • Target Job Name
    Include Page
    IL:Target Job Name
    IL:Target Job Name
  • Start Immediately
    Include Page
    IL:Start Immediately
    IL:Start Immediately
  • SAP Target Server
    Include Page
    IL:SAP Target Server
    IL:SAP Target Server
  • Print Application Log
    Include Page
    IL:Print Application Log
    IL:Print Application Log
  • Print Application RC
    Include Page
    IL:Print Application RC
    IL:Print Application RC
  • Use Application RC
    Include Page
    IL:Use Application RC
    IL:Use Application RC

Anchor
Run Process Chain command
Run Process Chain command
Run Process Chain

Performs the following actions:

  1. Starts a process chain.
  2. Waits for the process chain to complete.
  3. Returns the process chain log.
  4. Returns process logs.
  5. Returns process spool lists.
  • Chain ID
    ID of the process chain to run.

Anchor
Run InfoPackage command
Run InfoPackage command
Run InfoPackage

Performs the following actions:

  1. Starts an InfoPackage.
  2. Wait for the InfoPackage request to complete.
  3. Returns status messages for the completed Infopackage request.
  • InfoPackage
    Name of the InfoPackage to run.
  • InfoPackage Job Name
    Include Page
    IL:InfoPackage Job Name
    IL:InfoPackage Job Name

Anchor
Submit Job command
Submit Job command
Submit

Defines a new SAP job.

  • Definition or Model
    Include Page
    IL:Definition or Model
    IL:Definition or Model
  • Script or File System
    Include Page
    IL:Library or File System - SAP
    IL:Library or File System - SAP
  • Script
    Include Page
    IL:Script - SAP
    IL:Script - SAP
  • Definition File
    Include Page
    IL:Definition File
    IL:Definition File
  • SAP Job Name
    Include Page
    IL:SAP Job Name
    IL:SAP Job Name
  • SAP Job ID
    Include Page
    IL:SAP Job ID - 6.4.5.0
    IL:SAP Job ID - 6.4.5.0
  • Target Job Name
    Include Page
    IL:Target Job Name
    IL:Target Job Name
  • Start
    Include Page
    IL:Start
    IL:Start
  • Start Immediately
    Include Page
    IL:Start Immediately
    IL:Start Immediately
  • SAP Target Server
    Include Page
    IL:SAP Target Server
    IL:SAP Target Server
  • Wait
    Include Page
    IL:Wait
    IL:Wait
  • Print Job Log
    Include Page
    IL:Print Job Log
    IL:Print Job Log
  • Print Spooled Output
    Include Page
    IL:Print Spooled Output
    IL:Print Spooled Output
  • Print Application Log
    Include Page
    IL:Print Application Log
    IL:Print Application Log
  • Print Application RC
    Include Page
    IL:Print Application RC
    IL:Print Application RC
  • Use Application RC
    Include Page
    IL:Use Application RC
    IL:Use Application RC
  • SAP ABAP Program Name
    Include Page
    IL:SAP ABAP Program Name
    IL:SAP ABAP Program Name
  • SAP Variant Name
    Include Page
    IL:SAP Variant Name
    IL:SAP Variant Name
  • Target Variant Name
    Include Page
    IL:Target Variant Name
    IL:Target Variant Name

Anchor
Modify Job command
Modify Job command
Modify

Modifies an SAP job that already exists in an SAP system. A USAP job definition file is used to specify the modifications.

  • Script Library or File System
    Include Page
    IL:Library or File System - SAP
    IL:Library or File System - SAP
  • Script
    Include Page
    IL:Script
    IL:Script
  • Definition File
    Include Page
    IL:Definition File
    IL:Definition File
  • SAP Job ID
    Include Page
    IL:SAP Job ID
    IL:SAP Job ID

Anchor
Start Job command
Start Job command
Start

Starts a currently defined SAP job.

  • SAP Job Name
    Include Page
    IL:SAP Job Name
    IL:SAP Job Name
  • SAP Job ID
    Include Page
    IL:SAP Job ID - 6.4.5.0
    IL:SAP Job ID - 6.4.5.0
  • Start Immediately
    Include Page
    IL:Start Immediately
    IL:Start Immediately
  • SAP Target Server
    Include Page
    IL:SAP Target Server
    IL:SAP Target Server
  • Wait
    Include Page
    IL:Wait
    IL:Wait
  • Print Job Log
    Include Page
    IL:Print Job Log
    IL:Print Job Log
  • Print Spooled Output
    Include Page
    IL:Print Spooled Output
    IL:Print Spooled Output
  • Print Application Log
    Include Page
    IL:Print Application Log
    IL:Print Application Log
  • Print Application RC
    Include Page
    IL:Print Application RC
    IL:Print Application RC
  • Use Application RC
    Include Page
    IL:Use Application RC
    IL:Use Application RC

Anchor
Start Process Chain command
Start Process Chain command
Start Process Chain

Starts the specified process chain on the SAP system.

  • Chain ID
    ID of process chain to start.
  • Restart
    Include Page
    IL:Restart Process Chain
    IL:Restart Process Chain
  • Log ID
    Include Page
    IL:Log ID
    IL:Log ID
  • Wait
    Include Page
    IL:Wait
    IL:Wait
  • Print Job Log
    Include Page
    IL:Print Job Log
    IL:Print Job Log
  • Print Spooled Output
    Include Page
    IL:Print Spooled Output
    IL:Print Spooled Output
  • Print Application Log
    Include Page
    IL:Print Application Log
    IL:Print Application Log
  • Print Application RC
    Include Page
    IL:Print Application RC
    IL:Print Application RC
  • Use Application RC
    Include Page
    IL:Use Application RC
    IL:Use Application RC

Anchor
Start InfoPackage command
Start InfoPackage command
Start InfoPackage

Starts the specified InfoPackage on the SAP system.

  • InfoPackage
    Name of the InfoPackage to start.
  • InfoPackage Job Name
    Include Page
    IL:InfoPackage Job Name
    IL:InfoPackage Job Name
  • Wait
    Specifies whether the Controller should wait for the SAP InfoPackage to complete processing.

Anchor
Wait for Job command
Wait for Job command
Wait

Reconnects to a started job and monitors it through completion.

  • SAP Job Name
    Include Page
    IL:SAP Job Name
    IL:SAP Job Name
  • SAP Job ID
    Include Page
    IL:SAP Job ID
    IL:SAP Job ID
  • Print Job Log
    Include Page
    IL:Print Job Log
    IL:Print Job Log
  • Print Spooled Output
    Include Page
    IL:Print Spooled Output
    IL:Print Spooled Output
  • Print Application Log
    Include Page
    IL:Print Application Log
    IL:Print Application Log
  • Print Application RC
    Include Page
    IL:Print Application RC
    IL:Print Application RC
  • Use Application RC
    Include Page
    IL:Use Application RC
    IL:Use Application RC

Anchor
Wait for Process Chain command
Wait for Process Chain command
Wait Process Chain

Waits for a Process Chain to complete.

  • Chain ID
    ID of process chain to be monitored to completion.
  • Log ID
    Include Page
    IL:Process Chain Log ID
    IL:Process Chain Log ID

Anchor
Wait for InfoPackage command
Wait for InfoPackage command
Wait InfoPackage

Waits for an InfoPackage to complete.

  • Request ID
    Include Page
    IL:InfoPackage Request ID
    IL:InfoPackage Request ID

Anchor
Abort command
Abort command
Abort

Cancels a running SAP job.

  • SAP Job Name
    Include Page
    IL:SAP Job Name
    IL:SAP Job Name
  • SAP Job ID
    Include Page
    IL:SAP Job ID
    IL:SAP Job ID

Anchor
Interrupt Process Chain command
Interrupt Process Chain command
Interrupt Process Chain

Removes the specified process chain from the schedule.

  • Chain ID
    ID of process chain that is to be interrupted.

Anchor
Purge Job command
Purge Job command
Purge Job

Deletes a defined SAP job, its joblog, and all of its spoollists. This command is not available on SAP 3.1 and SAP 4.0.

  • SAP Job Name
    Include Page
    IL:SAP Job Name
    IL:SAP Job Name
  • SAP Job ID
    Include Page
    IL:SAP Job ID
    IL:SAP Job ID

Anchor
Purge Variant command
Purge Variant command
Purge Variant

Deletes a variant from an SAP system.

  • SAP ABAP Program Name
    Name of the ABAP program for which the variant will be deleted.
  • SAP Variant Name
    Name of the variant to be deleted.

Anchor
Raise Event command
Raise Event command
Raise Event

Raises the specified SAP background processing event.

  • SAP Event
    Include Page
    IL:SAP Event
    IL:SAP Event
  • SAP Event Parameter
    Include Page
    IL:SAP Event Parameter
    IL:SAP Event Parameter

Anchor
Display command
Display command
Display

Displays the data specified in the Display Command field. The data is written to standard output.

  • Display Command
    Include Page
    IL:Display Command
    IL:Display Command

Anchor
Generate Variant Definition File command
Generate Variant Definition File command
Generate Variant Definition

Generates a USAP variant definition file based on a model SAP variant. The generated definition file is written to standard output. Requires XBP interface 2.0 or greater.

  • SAP ABAP Program Name
    Include Page
    IL:SAP ABAP Program Name
    IL:SAP ABAP Program Name
  • SAP Variant Name
    Include Page
    IL:SAP Variant Name
    IL:SAP Variant Name

Anchor
Generate Job Definition File command
Generate Job Definition File command
Generate Job Definition

Generates a USAP job definition file based on a model SAP job. The generated definition file is written to standard output.

  • SAP Job Name
    Include Page
    IL:SAP Job Name
    IL:SAP Job Name
  • SAP Job ID
    Include Page
    IL:SAP Job ID - 6.4.5.0
    IL:SAP Job ID - 6.4.5.0

Anchor
Create CM Profile command
Create CM Profile command
Create CM Profile

Creates a new Criteria Manager profile.

  • Script or File System
    Include Page
    IL:Library or File System - SAP
    IL:Library or File System - SAP
  • Script
    Include Page
    IL:Script - SAP
    IL:Script - SAP
  • SAP Criteria Manager XML File
    Include Page
    IL:SAP Criteria Manager XML File
    IL:SAP Criteria Manager XML File
  • Event Select State
    Include Page
    IL:SAP Event Select State
    IL:SAP Event Select State
  • SAP Event
    Include Page
    IL:SAP Event
    IL:SAP Event
  • SAP Event Parameter
    Include Page
    IL:SAP Event Parameter
    IL:SAP Event Parameter
  • Confirm Returned Events
    Include Page
    IL:SAP Confirm Returned Events
    IL:SAP Confirm Returned Events

Anchor
Set CM Criteria command
Set CM Criteria command
Set CM Criteria

Sets the criteria for a profile.

  • Script or File System
    Include Page
    IL:Library or File System - SAP
    IL:Library or File System - SAP
  • Script
    Include Page
    IL:Script - SAP
    IL:Script - SAP
  • SAP Criteria Manager XML File
    Include Page
    IL:SAP Criteria Manager XML File
    IL:SAP Criteria Manager XML File
  • SAP Criteria Manager Profile ID
    Include Page
    IL:SAP Criteria Manager Profile ID
    IL:SAP Criteria Manager Profile ID
  • SAP Criteria Manager Profile Type
    Include Page
    IL:SAP Criteria Manager Profile Type
    IL:SAP Criteria Manager Profile Type
  • Event Select State
    Include Page
    IL:SAP Event Select State
    IL:SAP Event Select State
  • SAP Event
    Include Page
    IL:SAP Event
    IL:SAP Event
  • SAP Event Parameter
    Include Page
    IL:SAP Event Parameter
    IL:SAP Event Parameter
  • Confirm Returned Events
    Include Page
    IL:SAP Confirm Returned Events
    IL:SAP Confirm Returned Events

Anchor
Activate CM Profile command
Activate CM Profile command
Activate CM Profile

Activates a criteria profile of the specified type.

  • SAP Criteria Manager Profile ID
    Include Page
    IL:SAP Criteria Manager Profile ID
    IL:SAP Criteria Manager Profile ID
  • SAP Criteria Manager Profile Type
    Include Page
    IL:SAP Criteria Manager Profile Type
    IL:SAP Criteria Manager Profile Type
  • Event Select State
    Include Page
    IL:SAP Event Select State
    IL:SAP Event Select State
  • SAP Event
    Include Page
    IL:SAP Event
    IL:SAP Event
  • SAP Event Parameter
    Include Page
    IL:SAP Event Parameter
    IL:SAP Event Parameter
  • Confirm Returned Events
    Include Page
    IL:SAP Confirm Returned Events
    IL:SAP Confirm Returned Events

Anchor
Deactivate CM Profile command
Deactivate CM Profile command
Deactivate CM Profile

Deactivates a criteria profile of the specified type.

  • SAP Criteria Manager Profile Type
    Include Page
    IL:SAP Criteria Manager Profile Type
    IL:SAP Criteria Manager Profile Type
  • Event Select State
    Include Page
    IL:SAP Event Select State
    IL:SAP Event Select State
  • SAP Event
    Include Page
    IL:SAP Event
    IL:SAP Event
  • SAP Event Parameter
    Include Page
    IL:SAP Event Parameter
    IL:SAP Event Parameter
  • Confirm Returned Events
    Include Page
    IL:SAP Confirm Returned Events
    IL:SAP Confirm Returned Events

Anchor
Delete CM Profile command
Delete CM Profile command
Delete CM Profile

Deletes a criteria profile from an SAP system.

  • SAP Criteria Manager Profile ID
    Include Page
    IL:SAP Criteria Manager Profile ID
    IL:SAP Criteria Manager Profile ID
  • SAP Criteria Manager Profile Type
    Include Page
    IL:SAP Criteria Manager Profile Type
    IL:SAP Criteria Manager Profile Type
  • Event Select State
    Include Page
    IL:SAP Event Select State
    IL:SAP Event Select State
  • SAP Event
    Include Page
    IL:SAP Event
    IL:SAP Event
  • SAP Event Parameter
    Include Page
    IL:SAP Event Parameter
    IL:SAP Event Parameter
  • Confirm Returned Events
    Include Page
    IL:SAP Confirm Returned Events
    IL:SAP Confirm Returned Events

...