Skip to main content
Contact Support
Sign up for Product News
25.3
25.2
25.1
25.0
Main navigation
Close navigation
25.3
25.2
25.1
25.0
Main
Contact Support
Sign up for Product News
Main
Ask the PAS Chatbot!
Getting Started With the Integration (Bridge) Documentation
Bridging in a Nutshell
Getting Started with the Cameo Builder
Integration (Bridge) User's Guide
Overview on the Scheer PAS Bridge
Bridge Architecture Overview
Domain Architecture
Bridge Architecture
xUML Runtime Architecture
xUML Runtime Transaction Concepts
Bridge Domains
Operational Concepts
Batch Processing
Configuration Management
Load Balancing
Secure Bridge Setup
Bridge: First Steps
Composition of the Web-Based User Interface
BRIDGE Housekeeping
Bridge Backup
File Clean-up
Managing a Bridge Domain
Creating a Bridge Domain
Importing and Removing Bridge Node Instances
Deleting a Bridge Domain
Managing Groups
Group Roles
Summary of Default User Access Rights
Modifying User Access Rights
Creating a Group
Modifying a Group
Deleting a Group
Managing Users
Managing Users in a Scheer PAS Environment
Managing Users of a Standalone Bridge
Creating a User
Modifying a User
Deleting a User
Managing a Bridge Node Instance
Node Instance Preferences
Monitoring Node Instances
Inspecting the Logging Information
Managing the xUML Runtime of the Node Instance
Managing the Bridge Certificate
Managing xUML Services
Managing All xUML Services
xUML Service Ports
Preferences of the xUML Services
License for Running xUML Services
Deploying and Managing Resources
Deploying and Managing Java Archives
Deploying and Managing XSLT Scripts
Defining Global Setting Variables
Managing a Single xUML Service
Deployment of xUML Services
xUML Service Details
Preferences of an xUML Service
Bridge Server Log Levels of an xUML Service
Transaction Log Levels of an xUML Service
Starting and Stopping xUML Services
Killing xUML Services
Deleting xUML Services
Documentation of an xUML Service
History of an xUML Service
Logging of xUML Services
xUML Service Standard Log
xUML Service Transaction Log
xUML Service Start Log
xUML Service Stop Log
xUML Service Dump
xUML Service Settings
Exporting Settings
Using Global Setting Variables
Persistent States of xUML Services
Persistent State Classes and Objects of xUML Services
Primary Key Search of Persistent State Objects
Persistent State Ownership
Orphaned Persistent State Classes
Stalled Persistent State Objects
Additional xUML Service Tabs
Managing Node.js Services
Deployment of Node.js Services
Node.js Service Details
Logging of Node.js Services
Node.js Service Settings
Setting Environment Variables for Node.js Services
Managing Java Services
Deployment of Java Services
Java Service Details
Logging of Java Services
Setting Environment Variables for Java Services
Managing Proxy Services
Starting and Stopping the Proxy Service
Changing the Proxy Service Preferences
Managing Proxy Nodes
Viewing the Proxy Log File
Configuring the Proxy
Managing Proxy Entries
Managing Bridge Proxy Server Certificates
Requesting and Installing a Certificate
Importing and Exporting Proxy Server Certificates
Renewing the Self-signed Proxy Certificate
Debugging HTTPS Communication
Bridge Automation
Bridge API
Bridge API Reference
xUML Runtime API
xUML Runtime API Reference
Bridge Command Line Interface
Starting and Stopping the Bridge on Linux
xUML Runtime Configuration
Troubleshooting the Bridge and Related Problems
Troubleshooting Bridge Connection Problems
Troubleshooting Login Problems
Troubleshooting General Bridge Problems
Troubleshooting Bridge Domains
Troubleshooting Proxies
Troubleshooting License Problems
Troubleshooting Persistent States
Troubleshooting xUML Services
xUML Services Reference Guide
Basic Structural Modeling
Base Types
Attribute Specification
Relationships
Associations
Aggregations and Compositions
Generalizations
Data Mapping
Simple Mapping of Attributes
Simple Mapping of Classes
More Complex Mappings
Mapping with a Mapping Handler
Constraints
XML - UML Class Mapping
Type Mapping
Content Model Mapping
Troubleshooting XML - UML Class Mapping
Basic Behavioral Modeling
Activity Diagrams
Input and Output of Activity Diagrams
Input and Output of Activities
Actions
Call Behavior Actions
Decisions
Repeats (Loops)
Iterations
Objects
Classes, Ports, and Operations
Encoding of SOAP Operations
Operation Parameters
Implementing Port Type Operations
Calling Class Operations
Class Design
Modeling Error Handling
SOAP Error Response
Catching Errors
User Defined Errors
xUML Action Language
Basics of the xUML Action Language
Syntax Scheme of the xUML Action Language
Creating Objects of Base and Complex Types
The Essential Thing: Object References
Guarded Statements
Local Variables
NULL Values
Constructors
Any Type Operations
cast() Operation
classToExtendedJSON() Operation
classToJSON() Operation
classToXML() Operation
classToXMLFragment() Operation
copy() Operation
exists() Operation() Operation
getMetaAttributes() Operation
staticTypeOf() Operation
typeOf() Operation
Arithmetic Operations
Array Operations
append Statement
apply Statement
buildMap() Operation for Arrays
compact() Operation
concatArrays() Operation
count() Operation
Get Array Element Operator [ ]
join() Operation
reduce Statement
select Statement
Set Array Element Operator [ ]
sort Statement
Blob Operations
blobLength() Operation
concatBlob() Operation
convertBinaryToInteger() Operation
convertToHex() Operation
convertToString Blobs() Operation
subblob() Operation
transcodeToString() Operation
xmlToClass Blobs() Operation for Blobs
Boolean Operations
Logical Operators
Boolean Operators
like Operator
unlike Operator
not() Operation of Boolean Expressions
condition () Statement
convertToInteger() Operation
convertToString() Operation for Booleans
set Assignment Statement with Boolean Constants
set Assignment Statement with Boolean Expressions
UML Example
DateTime Operations
add() / subtract() Operation
convertDateTimeToStructure() Operation
convertDateTimeToTimeTicks() Operation
convertStructureToDateTime() Operation
convertToString() Operation for DateTime Objects
difference() Operation
printDateTimeExpression() Operation
printLocalDateTimeExpression() Operation
DateTime Functions
currentDateTime() Function
currentLocalDateTime() Function
currentTimeTicks() Function
getTimestamp() Function
Error Functions
getError() Function
getErrors() Function
Float Operations
absolute() Operation for Float Values
ceil() Operation
convertToInteger() Operation for Float Values
convertToString() Operation for Float Values
floor() Operation
power() Operation for Float Values
printFloatExpression() Operation
random() Operation returning a Float Value
round() Operation
Integer Operations
absolute() Operation for Integer Values
convertTimeTicksToDateTime() Operation
convertToFloat() Operation for Integer Values
convertToString() Operation for Integer Values
modulo() Operation
power() Operation for Integer Values
printIntegerExpression() Operation
random() Operation returning an Integer Value
Macros
Deployment Macros
getCompositeHost() Macro
getCompositeCategory() Macro
getCompositeName() Macro
getCompositeVersion() Macro
getEncodingFromAlias() Macro
getHostFromAlias() Macro
getMethodFromAlias() Macro
getPathFromAlias() Macro
getPortFromAlias() Macro
getProtocolFromAlias() Macro
getResourceNameFromAlias() Macro
getResourceTypeFromAlias() Macro
getURLFromAlias() Macro
getUserFromAlias() Macro
mapAttributes() Macro
mapEqualNames() Macro
setting macro() Macro
text() Macro
Map Operations
buildMap() Operation
getMapEntries() Operation
getMapValue() Operation
removeMapValue() Operation
setMapValue() Operation
Security Functions
getPrincipal() Function
SOAP Operations
getSOAPHeaders() Operation
setSOAPHeaders() Operation
String Operations
capture() Operation
concat() Operation
convertBase64ToBlob() Operation
convertDurationToDateTime() Operation
convertHexToBlob() Operation
convertToBoolean() Operation
convertToDateTime() Operation
convertToFloat() Operation for Strings
convertToInteger() Operation for Strings
endsWith() Operation
escapeURI() Operation
extendedJSONToClass() Operation
findPattern() Operation
findPatterns() Operation
findString() Operation
jsonToClass() Operation
match() Operation
normalizeSpaces() Operation
padLeft() Operation
padRight() Operation
parseFloatExpression() Operation
parseIntegerExpression() Operation
parseLocalDateTimeExpression() Operation
removeAccents() Operation
replace() Operation
split() Operation
startsWith() Operation
stringLength() Operation
substring() Operation
substringAfter() Operation
substringBefore() Operation
toASCII() Operation
toLower() Operation
toUpper() Operation
transcodeToBlob() Operation
transliterate() Operation
unescapeURI() Operation
xmlToClass Strings() Operation
parseDateTimeExpression() Operation
Utility Functions
Overview of All Type Conversion Operations
castValue() Function
composeUrl() Operation
createUniqueID() Operation
createUUID() Operation
getSequenceNumber() Operation
getServiceContext() Function() Operation
getServiceContextValue() Function
getTransactionID() Operation
log() Operation
logTo() Operation
parseUrl() Operation
removeFromMemory() Operation
report() Operation
retrieveFromMemory() Operation
setTransactionID() Operation
storeInMemory() Operation
uuidFromBlob() Operation
uuidToBlob() Operation
REST Functions
getRestHttpRequest() Functions
getRestHttpResponse() Function
Advanced Behavioral Modeling
BPMN execution on the Bridge
Requirements and Constraints on BPMN
The Implementation of the Process
A Simple Business Process
Importing the BPMN Process
The Model Implementing the BPMN Process
Starting the BPMN process
Interacting with the Process
Making a Decision
Realizing the Duration Timer
BPMN Error Handling
BPMN Default Error Handling
BPMN Task Compensation
Mapping BPMN to UML
Processes, Pools and Swimlanes
Connectors
Sequence Flows
Message Flows
Start and End Events
Tasks
Sub-Processes
Intermediate Events
Gateways
Modeling User Interfaces
The UI Application Development Process
UI Tutorial
Defining the Use Case
Designing the UI Template
Modeling the User Interface
Defining the Service
Defining the UI State Machine
Defining the Data Binding
Deploying the UI and the UI Service
Running the UI Application
Using the xUML UI Project Template
Easy and Faster UI Setup with the xUML Importer
Debugging a UI
Prerequisites for Debugging a UI
Debugging the Binding
Overview on the Generated Artifacts
xUML Service UI Technology and Generation
Overview on the Used Web 2.0 Components
Overview on the Used Frameworks
Overview on the Generated Browser Code Elements
Debugging Custom JavaScript Functions
Optimizing Generated JavaScript
UI Layout and Design
Base Layouts
Overview on the UI Design Capabilities
Working with design agency
HTML Utilities
Overview on the Supported UI Widgets
Autocomplete
Checkbox
Combo Box
Date Chooser
Multi-select Lists
Radio Button Group
Tables
Custom Client-Side Sorting of Table Columns
Dynamic Content
Open/Close Row Details
Server Side Pagination
Tabs
UI Error Handling
Catching AJAX Errors
Catching Errors in JavaScript Operations
Modeling Advanced UI Behavior
Authentication and Authorization
File Upload
HTTPS
History State
Form and Form Validation
Calling a UI from external Applications
Usage of Choices
Service Calls
HTTP Proxy
Controller States
Back Button and Browser History
Mock-Ups
xUML Service UI and the Bridge
Monitoring
Persistent States and Signals
Getting Started with Persistent State Databases
Persistent States Concept
Persistent State Classes
Persistent State Signals
State Machine Diagrams
States
Transitions
Persistent State Transaction Concept
Handling Persistent State Objects With the Persistent State Adapter
Sending Persistent State Signals
Conversations
Persistent State Components
Some Persistent State Particularities
Debugging Persistent State Objects
Large Persistent State Objects in MySQL Databases
Monitoring Persistent State Objects
Performance Considerations of Persistent State
Persistent State Using Clustered Oracle Database
Retrieving Persistent State Metadata with the PersistentStateControl Adapter
Polymorphism
Security Model
Concepts of the Security Model
Applying Security Features to an Existing Service
Advanced Security Options
Accessing Preprocessor Information in the Postprocessor
Debugging Authentication and Authorization
Proxy
Security Reference
xUML Service Libraries
Concepts of xUML Service Libraries
Creating xUML Service Libraries
Using xUML Service Libraries
xUML Service Library Dependencies
xUML Service Startup and Shutdown Activities
Basic Architectural Modeling
Frontend Components
Backend Components
Adapters
Alias Reader
Apache Kafka Producer Adapter
Apache Kafka Producer
Crypto Adapter
Crypto Adapter Reference
UN/EDIFACT Message Processing
Parsing UN/EDIFACT Messages
Composing UN/EDIFACT X12 Messages
Debugging a UN/EDIFACT Adapter Call
UN/EDIFACT Adapter Reference
Excel Adapter
Spreadsheet Adapter
Big Excel Generator
Excel Generator
File System Adapter
Handling of Files
Reading a File
Reading a File Line by Line
Writing a File
Appending Data to a File
Retrieving File Information
Renaming a File
Making a Copy of a File
Removing a File
Closing a File
Handling of Directories
Reading the Content of a Directory
Creating a Directory
Retrieving Directory Information
Removing a Directory
File System Components
Dynamic File System Access
File System Adapter Reference
Flat File Adapter
Parsing Simple Flat Files
Defining a Flat File Adapter Action
Defining a Simple Flat File Record
Flat File Adapter Parsing Process
Defining a Flat File
Composing Flat Files
Some Common Flat File Issues
Flat File Records Without Data
Flat File With Header Lines
Handling of Empty Lines When Composing a Flat File
Handling of White Spaces When Parsing Flat Files With Fixed Length
Mapping of Hierarchical Record Structures
Using Patterns to Separate Attributes
Flat File Adapter Reference
FOP Adapter
Java Adapter
Getting Started with the Java Adapter
Importing Java Class Files and Resources
Calling Java Methods from a xUML Model
Modeling the Java Components
JavaMail Adapter
Mail Server Connection
Receiving and Processing Emails
Sending Messages
Folder Handling
Keys and Certificates
Exception Signatures
JavaMail Library Reference
Documentation up to version 1.7.0 (obsolete)
Connection to a Mail Server
Creating a Folder
Deleting Emails
Mail Retrieval Constraints
Moving Emails
Reading Email Envelopes
Reading Messages
Reading Raw Text Emails
Sending Emails
JavaScript Adapter
JavaScript Specifics
JavaScript Adapter Reference
JMS Adapter
JMS Concepts
Modeling the Sending and Receiving of JMS Messages
Static Sending and Receiving
Dynamic Sending and Receiving
Listening on a JMS Topic
JMS Connection and Session Pooling
Component Diagram of a SOAP Service as a JMS Client
Defining the Components
Characteristics Concerning Particular JMS Providers
Exchanging the JMS Provider JAR Files
JMS Parameters in Detail
JMS Message in Detail
JMS Adapter Reference
Log Adapter
Writing into the Standard xUML Service Log
Writing into the xUML Service Transaction Log
Defining a Custom Logger Configuration
Log Adapter Reference
Memory Adapter
Using the Memory Adapter with Maps
Memory Adapter Reference
MIME Adapter
MIME Adapter Reference
MongoDB Adapter
MongoDB Components
Querying MongoDB
Updating MongoDB Documents
Aggregating Data
Inserting and Deleting Documents
MongoDB Adapter Reference
OData Adapter
POP3 Adapter
POP3 Adapter Reference
REST Adapter
Manually Providing the REST Interface
Setting REST Request Options
Getting the REST Adapter Response
REST Adapter Error Handling
REST Adapter Reference
SAP Adapter
RFC Client
RFC Arguments
tRFC Client
IDoc Handling
Composing IDocs
Parsing IDocs
Reading IDocs From File
SAP Adapter Troubleshooting
SAP Adapter Reference
SMTP Adapter
Static E-mail
Dynamic E-mail
Combination of Static and Dynamic SMTP Parameters
Sending Mails with Attachments
SMTP Authentication
SMTP Adapter Reference
SOAP Adapter
Adding Attachments to a SOAP Call
Accessing the SOAP Headers
SOAP Call and HTTP Headers
Providing the SOAP Adapter with URL Parameter
SOAP
SQL Adapter
Querying Databases
SQL Deployment
SQLite Deployment Options
Dynamic Configuration of SQL Adapters
Bulk Fetch
Stored Procedures
Using ODBC for Database Access
Troubleshooting the SQL Adapter
Oracle: Performance Problems Due to Index Not Used
SQL Adapter Reference
System Adapter
Invoking a Perl Script by the Use of the System Adapter
Executing a Shell Command by the Use of the System Adapter
Executing a Calculated Command Line by the Use of the System Adapter
Thread Adapter
Create a Thread (deprecated)
Block a Thread
Wait for a Thread (deprecated)
Thread Adapter Reference
URL Adapter
Using the URL Adapter with the LDAP Protocol
Using the URL Adapter with the FTP Protocol and Related Protocols
SFTP
FTPS
Using the URL Adapter with the HTTP Protocol
Using the URL Adapter with the File Protocol
Accessing URL Resources via the URL Adapter
Setting cURL Options on the URL Adapter
URL Adapter Reference
XSLT Adapter
ZIP Adapter
ZIP Adapter Reference
Service Implementations
FTP Service
FTP Server Usage
FTP Server Implementation
HTTP Service
Plain HTTP Service
RESTful HTTP Service
HTTP Service Reference
Java Callback Service
Java Implementation for Java Callback
xUML Service Model for Java Callback
REST Service
Defining a REST Service Interface
Handling Blobs in the REST Interface
Documenting a REST Service
Implementing REST Methods
REST Service Error Handling
Calling REST Services
Testing REST Services
REST Service Authentication
REST Service Reference
SAP Service
RFC Service
tRFC Service
A Simple tRFC Callback Interface Example
RFC Arguments (SAP Service)
Scheduler Service
Scheduler Class
Scheduler Components
Scheduler Event Handler
Date Time Patterns
SOAP Service
SOAP Headers within Service Context
SOAP Service Components
SOAP Service Reference
Timer and Event Observer Service
Timer Service
Event Observer Service
Time Durations
Troubleshooting Timer and Event Observer Services
xUML Service Model Debugging, Testing and Quality Assurance (QA) Concepts
Testing Services
Testable Classes
Using Testable Classes
Document Encoding versus RPC Encoding
Testable Classes and Persistent States
Continuous Delivery with the Bridge
Import - Export Mechanisms
IDoc Import Rules
OData Import Rules
REST Import Rules
REST Parameter Object
REST Schema Object
SOAP Encoding Styles
SOAP Import Rules
Import of Simple SOAP Types
Import of Compound SOAP Types
Import of SOAP Namespaces
WSDL Import Rules
Documentation Element
Import Element
Types Element
Message Element
Bindings
Ports
Services
XML Schema Import Rules
Import of Complex XSD Type Definitions, Element and Attribute Declarations
Import of Simple XSD Types
Import of Anonymous XSD Type Definitions
Import of the XSD Element Content
Import of XSD Annotations
Building Content Models
Import of XSD Attribute Groups
Import of XSD Nil Values
Import of the XSD Namespace
Import of Complex XSD Type Deriving from a Simple Type
Appendix
Charset Definitions
Contents of the Transaction Log
Database Specifics
Database Server-Specific Notes for SQL Adapters
Database-Specific Mappings
Date and Time Formatting
E2E Profile
Edifact and X12 Versions
Error Codes
Log Errors
System Errors
HTTP Header Support
JSON Type Mapping
Number Formatting
Regular Expressions
Meta Characters
Operators
Replacement Text
SAP - ABAP Types Mappings
Time Zones
Java Services Reference Guide
Node.js Services Reference Guide
Developing Node.js Services
Easy Configuration for Bridge Node.js Services
E2E Authorization Package
Transaction Logger for Node.js
Documentation of the E2E Transaction Logger
Tutorial 1: Logging the Transactions of a Simple HTTP Server
Tutorial 2: Backend Access
Tutorial 3: Express
Node.js Interface to the Bridge
Node.js Proxy Configuration
Utilities
Monitoring Service With UI
Monitoring Base Service
Monitoring UI
Usage of the Monitoring UI
Custom Notification Implementation
RESTifier for SAP
Overview on the RESTifier UI
REST API of the RESTifier for SAP
WSDL Generator for SAP RFC
Builder User's Guide
Builder for MagicDraw Basics
xUML Service Template
Starting the Builder for MagicDraw After an Update
The Elements of the Builder for MagicDraw Window
Working with Builder Projects
Menu Overview of the Builder for MagicDraw
The xUML Action Script Editor
Using the Suggestion Features of the Action Script Editor
Using Keywords and Special Characters in Action Scripts
Using Action Script Editor on Special UML Elements and Actions
Syntax Error Handling
Action Script Editor Mouse and Keyboard Action Overview
Action Script Editor Menu Overview
The Components Wizard
Overview on the Window Layout of the Components Wizard
Creating a Component Diagram
Defining More Than One Deployment
The xUML Service Library Wizard
Creating a Library Diagram
The xUML Model Compiler
Panels and Files of the Model Compiler
Changing the Model Compiler Settings
Working with the Deployment View
Working with the File View
Menu Overview of the xUML Model Compiler
Starting the xUML Model Compiler from Command Line
The Importers
Importing an XMI File
Importing xUML Service Libraries
Importing WSDL or XSD
Errors Importing a WSDL / XSD File
Importing OData Entities and Services
Importing OpenAPI Files (REST)
Importing SAP IDoc Meta Data
Importing File Resources
Importing Java™ Classes and Properties Resource Files
Importing Flat File Definitions
Warnings during the Import of Flat File Definitions
Importing UN/EDIFACT Directory Definitions
E2E BPMN Importer
Errors Importing a BPMN Definition
Importing a UI Prototype
The Embedded xUML Runtime
Working with the Run View
Changing the Service Preferences
Overview on the Debug View
Overview on the Remote Debug View
Overview on the States View
Working with the Test Cases View
Modifying the Test Case Properties
Working with the SOAP Test Tool
Mocking of Backends
Overview on the WSDL View
The Interactive Debugger
Using the Debug View
Managing Breakpoints and Exceptions
Inspecting Action Script and Runtime Values
Inspecting the Callstack
Remote Debugging
xUML Modeling Guidelines
Project Organization
Naming Conventions and Containment Tree Organisation
Model Documentation
Settings
Mappings
Sub-activities
Logging
Error Handling
Troubleshooting the Builder
Troubleshooting MagicDraw 18
Analyzer User's Guide
Glossary
Breadcrumbs
Scheer PAS | Integration (Bridge) Documentation
xUML Services Reference Guide
Import - Export Mechanisms
XML Schema Import Rules
On this Page
Import of XSD Annotations
The WSDL Importer does not import XSD annotations yet.
