Getting Started

A guide for new users to get started with the SOAP-2-REST platform. Learn the suggested reading order for core concepts, system requirements, and the

Applies to1.xFrom 1.5.5

Overview

This guide provides an entry point for new users of the SOAP-2-REST platform. It is designed to orient you with the core concepts and provide a clear path to deploying your first service. Following the documents in the suggested order will help you understand the platform's model, vocabulary, and requirements before performing a test deployment.

NOTE

The current release is v1.0 (General Availability). For details on this release, see the release notes.

In This Section

This section contains the foundational documents for understanding and operating the platform.

  • Introduction: Explains what the SOAP-2-REST platform is, its Publish/Consume model, its position in a typical technology stack, and its intended users.
  • Core concepts: Defines the essential vocabulary used within the platform and its documentation. Key terms include service, operation, mapping, Publish vs Consume, discovery, connector, correlation ID, and environment. Understanding these concepts is recommended before proceeding to the Quickstart.
  • Quickstart: Provides the fastest path to a running service. This guide walks through using the standalone Docker Compose stack to import a WSDL, configure a backend, generate an OpenAPI v3 specification, publish the service, and execute a test call.
  • System requirements: Details the prerequisites for deploying the platform, including PostgreSQL, container runtime, and JVM requirements. It also covers supported deployment targets, network egress for licensing, payload limits, and baseline capacity.

Suggested Reading Order

For users new to the platform, the following reading order is recommended to build a comprehensive understanding.

  1. Introduction: Understand the platform's model and purpose.
  2. Core concepts: Learn the vocabulary used in the UI and documentation.
  3. System requirements: Confirm your deployment target meets the necessary prerequisites.
  4. Quickstart: Deploy the standalone stack and publish your first service.

Documentation Conventions

The following conventions are used throughout the knowledge base documentation.

  • Error Codes: Standardized error codes follow the format S2R-RUN-0413, which includes a service prefix and a numeric code. A complete list is available in the error-codes reference.
  • Database Tables: All platform-specific database tables use the s2r_ prefix.
  • Java Packages: The root Java package is com.specaria.s2r.
  • Placeholders: Customer-specific values such as hostnames, project IDs, or group names are represented by placeholders in <angle-brackets>.
  • Feature Versioning: A Since v1.0 note indicates the release in which a specific capability was first introduced.

See Also

Once you have completed the Getting Started guides, you can proceed to more advanced topics:

  • Installation: Production deployment guides for GCP, Kubernetes/OpenShift (Helm), and Docker Compose.
  • Onboarding a Service: The complete workflow for publishing a service from a WSDL, including all configuration options.
  • Discovery & Connectors: Instructions for enabling traffic-driven service discovery.
  • Support: Information on available support tiers and how to get help.
  • Release Notes for v1.0: Detailed changes for the current general availability release.
Tagsoverview

All SOAP-to-REST docs