RCE User Guide
Next
RCE User Guide
Build 10.2.2.202102041529
Table of Contents
1. Preface
1.1. Abstract
1.2. Intended Audience
1.3. License Information
1.4. Compatible Operating Systems
1.4.1. Support of 32 Bit Operating Systems
1.4.2. Known Issues
1.4.2.1. KDE on Red Hat Enterprise Linux 7
1.4.2.2. KDE with Oxygen
1.4.2.3. Jython scripts are executed sequentially
1.4.2.4. 32-bit Java is not supported
2. Setup
2.1. Installation on
Linux
2.1.1. Prerequisites
2.1.2. Obtaining the Signing Key
2.1.3. Installation
2.1.3.1. Installing from the Package Repository (recommended for Debian/Ubuntu/Mint)
2.1.3.2. Installation of the .deb/.rpm Package (recommended for CentOS/Red Hat/SUSE, alternative for Debian/Ubuntu/Mint)
2.1.3.3. Installation from the .zip File (alternative for all distributions)
2.1.4. Starting RCE as a GUI Client
2.1.5. Starting a Non-GUI ("Headless") Instance
2.1.6. Installation as a
Daemon on a Linux Server
2.1.6.1. Installation and
Daemon
Management
2.1.6.2.
Daemon
Configuration
2.2. Configuration
2.2.1. Configuration Locations and Files
2.2.2. Configuration Parameters
2.2.3. Configuration UI
2.2.3.1. Remote Access: SSH account configuration
2.2.3.2. Mail: SMTP server configuration
2.2.4. Importing authorization data without GUI access
2.2.4.1. Importing or deleting RCE authorization group keys
2.2.4.2. Importing SSH Uplink passwords or keyfile passphrases
2.2.4.3. Importing SSH Remote Access passwords or keyfile passphrases
3. Usage
3.1. Graphical User Interface
3.2. Workflows
3.2.1. Rationale
3.2.2. Getting Started
3.2.3. Workflow Components
3.2.4. Coupling Workflow Components
3.2.5. Execution Scheduling of Workflow Components
3.2.6. (Nested) Loops
3.2.7. Fault-tolerant Loops
3.2.8. Manual Tool Result Verification
3.3. Commands
3.3.1. Command Line Parameters
3.3.2. Profile Selection UI
3.3.3. Command Shell
3.3.3.1. Configuration Placeholder Value Files
3.4. Integration of External Tools
3.4.1. Basic Concepts
3.4.2. Directory Structure for Integrated Tools
3.4.3. Copying of Integrated Tools
3.4.3.1. Tool Execution Return Codes
3.4.4. Integration of CPACS Tools
3.4.4.1. Additional concepts of CPACS Tool Integration
3.4.4.2. Integrate a CPACS Tool into a Client Instance
3.4.4.3. Integrate a CPACS Tool into a Server Instance in Headless Mode
3.4.5. Workflows as Components (Experimental)
3.4.5.1. Integrating a Workflow
3.4.5.2. Executing an Integrated Workflow
3.4.5.3. Limitations, Caveats, and FAQ
3.5. Tool publishing and authorization
3.5.1. Managing authorization groups
3.5.2. Publishing tools on the command console
3.6. Connecting RCE instances
3.6.1. RCE Network Connections
3.6.2. Uplink Connections
3.6.2.1. Configuring an RCE instance as an Uplink relay
3.6.2.2. Configuring an RCE instance as an Uplink client or gateway (in GUI mode)
3.6.2.3. Configuring an Uplink Gateway in non-GUI mode
3.6.2.4. Tool publishing
3.6.2.5. Possibly surprising behavior (or non-behavior)
3.6.2.6. Known issues/limitations of the current release
3.6.3. Example of a Cross-Organization Network
3.6.4. SSH Remote Access Connections
3.6.4.1. Configuring an RCE instance as an SSH server
3.6.4.2. Configuring an RCE instance as an SSH client
3.7. Remote Workflow Access
3.7.1. Setting up the Workflow Execution Example/Template
3.7.2. Building Your Own Remote Access Workflow
A. Script API Reference
List of Figures
List of Tables