RCE User Guide
Next
RCE User Guide
Build 10.5.0.0202412170900_SNAPSHOT
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.5. Known Issues
1.5.1. KDE on Red Hat Enterprise Linux 7
1.5.2. KDE with Oxygen
1.5.3. Jython scripts are executed sequentially
1.5.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 Service on a
Linux Server
2.2. Configuration and Profiles
2.2.1. Choosing the Profile Directory
2.2.2. Contents of the Profile Directory
2.2.3. Configuration Parameters
2.2.4. Configuration UI
2.2.4.1. Remote Access: SSH account configuration
2.2.4.2. Mail: SMTP server configuration
2.2.5. Importing authorization data without GUI access
2.2.5.1. Importing or deleting RCE authorization group keys
2.2.5.2. Importing SSH Uplink passwords or keyfile passphrases
2.2.5.3. Importing SSH Remote Access passwords or keyfile passphrases
3. Usage
3.1. Command Line Parameters
3.2. Graphical User Interface
3.3. Workflows
3.3.1. Rationale
3.3.2. Getting Started
3.3.3. Workflow Components
3.3.4. Coupling Workflow Components
3.3.5. Execution Scheduling of Workflow Components
3.3.6. (Nested) Loops
3.3.7. Fault-tolerant Loops
3.3.8. Manual Tool Result Verification
3.4. User-Defined Components
3.4.1. Integrating External Tools as Components
3.4.1.1. Directory Structure for Integrated Tools
3.4.1.2. Copying of Integrated Tools
3.4.1.3. Integration of CPACS Tools
3.4.1.4. Known Issues
3.4.2. Integrating Workflows as Components (Experimental)
3.4.2.1. Integrating a Workflow via command console
3.4.2.2. Workflow Integration Editor
3.4.2.3. Technical Details of Executing an Integrated Workflow
3.4.2.4. Limitations, Caveats, and FAQ
3.5. Connecting RCE instances
3.5.1. RCE Network Connections
3.5.2. Uplink Connections
3.5.2.1. Configuring an RCE instance as an Uplink relay
3.5.2.2. Configuring an RCE instance as an Uplink client or gateway (in GUI mode)
3.5.2.3. Configuring an Uplink Gateway in non-GUI mode
3.5.2.4. Tool publishing
3.5.2.5. Possibly surprising behavior (or non-behavior)
3.5.2.6. Known issues/limitations of the current release
3.5.3. Example of a Cross-Organization Network
3.5.4. SSH Remote Access Connections
3.5.4.1. Configuring an RCE instance as an SSH server
3.5.4.2. Configuring an RCE instance as an SSH client
3.6. Tool publishing and authorization
3.6.1. Managing authorization groups
3.6.2. Publishing tools on the command console
3.7. RCE’s Command Console
3.7.1. Commands
3.7.2. Parameters
3.7.2.1. Configuration Placeholder Value Files
3.8. The Event Log
3.8.1. Design Principles
3.8.2. Event Structure and File Representation
3.8.3. Events Types and Attributes
A. Script API Reference
List of Figures
List of Tables
List of Examples