Skip to main content

Contact Support
Sign up for Product News

Main

Scheer PAS | Business Modeler Guide

Introduction to Scheer PAS Business Modeler

Login & Logout

Business Model Editor

Account Bar

Administration Tab

System Configuration
Application Theme
Database Configuration

Reports

SAP Solution Manager Integration

Standard Reports

EPC to BPMN Conversion
RACI(.xlsx) Report

Logging
Backup and Restore
Reorganization
Modeling Templates
Role Settings for models and objects
Symbol Customization
Identifiers

User Preferences
Messages Tab

Navigation Bar

Explorer Tab

Description Bar
Structure Bar
Toolbar

Starting with Scheer PAS Business Modeler

How to create a new user
How to Create a Database/Profile for a User
How to Give Access to a Folder
How to Create a Group of Users

Working with Scheer PAS Business Modeler

Permissions
Canvases

Panels

Overview

Attributes

Text Attribute
Rich Text Attribute
Date Attribute
Date/time attribute
Number Attribute
Select Attribute
Multiselect attribute
Link Attribute

Assignments
Occurrences
Model-Object Properties
Objects
Fragments

Validation

Validation Rules

Language Panel
Compare Model

Model Toolbar

Create model as Word
Copy model to the Clipboard

Fast Draw

Fast Draw Functions
Hierarchical Models with Fast Draw
Process Flow Models with Fast Draw

Working with Templates on Canvas

Export and Import

Export as / Import from EXCEL (.xlsx)
Multi document Export and Import

Keyboard and Mouse Shortcuts
Reusing Objects
Messaging
Query Wizard

Model Processes
Video Tutorials

Scheer PAS Release Notes

Scheer PAS Release Management
Scheer PAS Release Overview

PAS 25.3 Release Notes

Release Details of PAS 25.3

PAS 25.2 Release Notes

Release Details of PAS 25.2

PAS 25.1 Release Notes

Release Details of PAS 25.1

PAS 25.0 Release Notes

Release Details of PAS 25.0

Migration Tasks

Overview on the Changes to the Persistent State Implementation

How to migrate a Persistent State DB used by multiple independent services

Older PAS Release Notes

PAS 24.3 Release Notes

Release Details of PAS 24.3

PAS 24.2 Release Notes

Release Details of PAS 24.2

PAS 24.1 Release Notes

Release Details of PAS 24.1

PAS 24.0 Release Notes

Release Details of PAS 24.0

PAS 23.2 Release Notes

Release Details of PAS 23.2

PAS 23.1 Release Notes

Release Details of PAS 23.1

PAS 22.2 Release Notes

Release Details of PAS 22.2
Release Details of PAS 22.2.1

PAS 22.1 Release Notes

Release Details of PAS 22.1.2

PAS 21.2 Release Notes
PAS 21.1 Release Notes

Release Notes up to PAS 21.1

BPaaS Release Notes
Designer Release Notes

Process Mining Release Notes

Process Mining Bridge

Integration Release Notes

Integration Migration Tasks

Integration: Overview on the Changes to the Persistent State Implementation

Integration: How to migrate a Persistent State DB used by multiple independent services

Runtime Release Notes

Bug: Session Commit on Exception
Runtime 5 Release Notes

Bridge Release Notes

Bridge 6 Release Notes
Bridge 5 Release Notes

Builder Release Notes

Builder 6 Release Notes
Builder 5 Release Notes

Analyzer Release Notes

Analyzer 6 Release Notes
Analyzer 5 Release Notes

RESTifier for SAP Release Notes
RFC WSDL Generator Release Notes

Scheer PAS | API Management Guide

Ask the PAS Chatbot!

Getting Started With API Management

The Concepts of API Management
API Types: Public vs. Private
Working With the API Management

Administration

API Management Housekeeping
API Management Logging
Accessing the API Management REST API

APIs

API Settings
Creating an API
Configuring an API
Importing APIs
Publishing an API
Retiring an API
Testing APIs
Deleting an API

Clients

Client Settings
Creating a Client
Registering a Client
Retiring a Client
Deleting a Client

Contracts

Creating a Contract
Deleting a Contract
Handling Approval Requests

Organizations

Organization Settings
Creating an Organization
Administrating Organization Members
Deleting an Organization

Plans

Plan Settings
Creating a Plan
Locking a Plan
Deleting a Plan

Policies

Attaching Policies

Policy Configuration

API Key
Authorization
Basic Authentication
Caching Resources
CORS
Header Allow/Deny
HTTP Security
Ignored Resources
IP Allowlist
IP Blocklist
JSONP
JWT
Keycloak OAuth
Rate Limiting
Simple Header
SOAP Authorization
Timeout
Time Restricted Access
Transfer Quota
URL Rewriting

Metrics
Notifications

Developer Portal

Managing the Developer Portal

Developer Access to APIs

Consuming a Public API
Subscribing to a Private API
Using "My Clients"
Unsubscribing from an API

Customizing the API Developer Portal

Tips and Tricks

API Security: Authentication and Authorization

Authentication With Keycloak OAuth
Additional Authorization

Regular Expressions
Exposing Designer Services via API Management
Troubleshooting

FAQ

Scheer PAS Examples and Community Assets

Designer Examples Overview

Community Assets Overview

Commons BPMN Library

Commons BPMN Library: Usage

Commons xUML Library

Commons xUML Library: GlobalOps
Commons xUML Library: Binary
Commons xUML Library: DateTime
Commons xUML Library: String
Commons xUML Library: Array
Commons xUML Library: File

JavaMail Library

Mail Server Connection
Receiving and Processing Emails
Sending Messages
Folder Handling
Keys and Certificates
Exception Signatures
JavaMail Library Reference

PDF Adapter

PDF Adapter: Release Notes

Scheer PAS | Process Mining Guide

Ask the PAS Chatbot!
Introduction to Process Mining

The User Interface

The Navigation Bar

The Process Analyzer

Working with the Process Analyzer

The Sidebar

The Analyses Sidebar
The Variants Sidebar
The Templates Sidebar

Analyses

Creating an Analysis
Configuring Axis Allocation
Configuring Filters
Duplicating an Analysis

Templates

Creating a Template
Creating a Template from an Analysis
Editing a Template
Duplicating a Template
Using a Template

Examining xUML Service Instances

Configuring the Instance List Designer
Showing Process History
Analyzing Process-specifc Values from Designer Services
Analyzing Process-specifc Values from Integration Services

Examining BPaaS Instances

Configuring the Instance List BPaaS
Showing Process History BPaaS
Analyzing Process-specifc Values from BPaaS

Troubleshooting

Error Handling Analyses
Error Handling Monitored xUML Services

Process Mining Glossary
FAQ

Scheer PAS | Designer Guide

Ask the PAS Chatbot!

Getting Started With Designer

Logging In and Out
Setting the User Preferences

Working with the Designer

Customizing Editors and Panels
Searching in the Designer

PAS Designer User Guide

Working With the Explorer

Namespaces
Folders
Services
Exporting and Importing Explorer Contents

Designer Panel Overview

Service Panel

Managing the Service Details

Service Deployment Details
Service Configuration Details
Aliases

Base Types

Bridge Base
PAS Platform
PAS Form Elements

Connectors
Single Connector
Process
BPMN Model
Forms
Single Form
API
Implementation
Libraries
Exporting and Importing Service Panel Contents

Controls Panel
Attributes Panel
Styling Panel
Overview Panel
Search Panel
Validation Panel

Creating Connectors

Creating an OData Connector

OData Import Rules

Creating an OpenAPI Connector

OpenAPI Import Rules

Swagger 2
OpenAPI 3

Creating an SAP RFC Connector

Modeling BPMN

Working with the BPMN Editor

Adding BPMN Elements
Selecting BPMN Elements
Resizing BPMN Elements
Changing BPMN Element Attributes
Styling BPMN Elements

Role-based Authorization Concept

Modeling Roles

Using a Main Lane

Assigning Roles

Modeling Forms

Working with the Form Editor
Adding Form Elements
Selecting Form Elements
Configuring Form Elements
Reusing Form Elements
Grouping Form Elements
Validating Form Fields
Styling Form Elements

Modeling APIs

Using AI Agents

Creating an AI Agent
Testing an AI Agent
Using an AI Agent in an xUML Service
AI Service Provider Reference

Implementing Your Process

Modeling Data Structures

Adding Parameters to Operations
Adding Suboperations to Operations
Changing the Attributes of Data Model Elements

Modeling Data Mapping

Working with the Mapping Editor

Drawing Mapping Relations
Assigning a Literal Value to a Mapping Target
Adding Operations to Mapping Relations
Adding Parameters in the Mapping Editor

Mapping Element Attributes

Modeling Activities

Working with the Activity Editor

Adding Operations in the Activity Editor
Drawing the Control Flow
Adding Local Variables
Adding Literals
Adding Comments
Drawing Object Flow (Activity)
Adding Parameters in the Activity Editor
Moving Pins

Changing the Attributes of Elements on the Activity Diagram

Using Action Script

Working with the Action Script Editor

Using JavaScript

Working with the JavaScript Editor

Modeling Execution

Working with the Execution Editor

Adding Variables
Persisting Data
Adding Operation Calls
Drawing Object Flow (Execution)
Adding Parameters in the Execution Editor

Changing the Attributes of Execution Elements

Using Connectors

Sharing Designer Content

Publishing Assets
Documenting Assets

Working With the Asset Drawer

Accessing the Asset's Documentation
Adding Assets
Updating Assets
Removing Assets

Working With Libraries

Accessing the Library's Documentation
Adding Libraries
Updating Libraries
Removing Libraries

PAS Standard Libraries

Configuring the Instance List

The Role Concept of the Instance List
Configuring the Columns of the Instance List
Displaying Custom Data in the Instance List

Validating a Service

Using the Validation
Working with the Test Environment

Deploying a Service

Running Designer Applications

Creating a Process Instance
Showing the Instance List
Running Role-based Applications

PAS Designer Developer Guide

Technical Concepts

xUML Service State Machines

State Transitions of the Root State Machine
Error Handling of Root State Machine
Generated Executions in Process State Machine

Persistent State Data Storage

Configuring the Persistent State Database

xUML Service Interface
Form Communication
Distributed Tracing
xUML Runtime Architecture and Transaction Concept

Development Approach

Concepts of Data Modeling

Available Base Types

Custom Complex Types

Classes
Class Properties
Interfaces
Relationships
Polymorphism

XML Serialization

Controlling the XML Serialization With Extensions
Troubleshooting the XML Serialization

Creating an Implementation Factory

Designing a Form

Supported Form Elements

Button
Checkbox
Data Table
Date Picker
File Upload
Grouping
Image (Form)
Label
Radio Button Group
Select Field
Subform
Text Area
Text Box

Data Table Handling

Handling the Click Event of Data Table Rows

Form - Process Interaction
Setting Form Elements Dynamically
Styling Forms With CSS
Subform Handling

Drawing a Business Process

Supported BPMN Elements

End Event
Exclusive Gateway
Free Text
Image (BPMN)
Lane
Message Event
Message Start Event
Parallel Gateway
Plain Event
Receive Task
Relation
Service Task
Start Event
Timer Event
Timer Start Event
User Task

Modeling Process Start
Modeling Process End
Modeling Tasks
Modeling Decisions
Modeling Message Reception
Using Forms

Mapping Data Structures

Supported Mapping Functions
Array Mapping

Drawing an Activity Diagram

Supported UML Elements

Comment
Control Flow
Decision
Final Node
Initial Node
Literal
Local Variable
Object Flow
Operation
Throw Exception

Adding a Decision
Implementing a Loop
Throwing a User-defined Error
Catching Errors
Transforming Data on an Object Flow

Action Script Language

Basics of the Action Script Language

Creating Objects of Base and Complex Types
Constructors
self Context
Invoking Operations from Within Action Script
NULL Values
Local Variables
Object References
Guarded Statements

Arithmetic Operations
Overview on All Type Conversion Operations

Any Type Operations

cast() Operation
classToExtendedJSON() Operation
classToJSON() Operation
classToXML() Operation
classToXMLFragment() Operation
copy() Operation
exists() Operation
getMetaAttributes() Operation
staticTypeOf() Operation
typeOf() Operation

Array Operations

append Statement
apply Statement
buildMap() Operation
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() Operation for Blobs
subblob() Operation
transcodeToString() Operation
xmlToClass() Operation for Blobs

Boolean Operations

Logical Operators
Boolean Operators
condition () Statement
convertToInteger() Operation for Booleans
convertToString() Operation for Booleans
like Operator
not() Operation of Boolean Expressions
set Assignment Statement with Boolean Constants
set Assignment Statement with Boolean Expressions
unlike Operator

DateTime Operations

add() / subtract() Operation
convertDateTimeToStructure() Operation
convertDateTimeToTimeTicks() Operation
convertStructureToDateTime() Operation
convertToString DateTime() Operation
difference() Operation
printDateTimeExpression() Operation
printLocalDateTimeExpression() Operation

DateTime Functions

currentDateTime() Function
currentTimeTicks() Function
getTimestamp() Function

Error Functions

getError() Function
getErrors() Function

Float Operations

absolute() Operation for Float Values
ceil() Operation
convertToInteger() 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

getCompositeCategory() Macro
getCompositeName() Macro
getCompositeVersion() Macro

mapEqualNames() Macro
mapEqualNamesIfExists() Macro
setting() Macro
text() Macro

Map Operations

buildMap() Operation in Map Context
getMapEntries() Operation
getMapValue() Operation
removeMapValue() Operation
setMapValue() Operation

REST Functions

getRestHttpRequest() Function
getRestHttpResponse() Function

SOAP Functions

getSOAPHeaders() Function
setSOAPHeaders() Function

String Operations

capture() Operation
castValue() 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
parseDateTimeExpression
parseFloatExpression() Operation
parseIntegerExpression() Operation
parseLocalDateTimeExpression() Operation
removeAccents() Operation
replace() Operation
replaceSubstring() 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() Operation for Strings

Utility Functions

composeUrl() Function
createUniqueID() Function
createUUID() Function
getSequenceNumber() Function
getServiceContext() Function
getServiceContextValue() Function
getTransactionID() Function
integerSequence() Operation
log() Function
logTo() Function
parseUrl() Function
report() Function
setTransactionID() Function
uuidFromBlob() Operation
uuidToBlob() Operation

JavaScript Specifics

this Context
JavaScript Type Mapping
Unprovided Input Parameters
Data Exchange Between JavaScript Calls
Using Maps in JavaScript
Calling xUML Operations from JavaScript

PAS Platform Operations

Authenticator Service

getAuthService()
getAuthorizationOptions()
getServiceAccountToken()
getServiceToken()
getServiceTokenBearer()
getUUIDFromToken()

Security Service

getCurrentUserRoles()
getCurrentUserUUID()
getSecurityService()
hasRole()
isAuthorized()

Developing and Using Libraries

Creating a Library
Using a Library
Updating to a new Library Version

Pro-Code Development

Changing the Generated Angular Application

Developing Custom Forms in a Library

Developing Custom Directives

Developing Designer Libraries Using Java

Java Development: Setting-up the Development Project
Java Development: Some Development Particularities

Java Development: Callback Service

Java Implementation for Java Callback
xUML Implementation for Java Callback

Java Development: Build Tasks

Internationalization: Translations for Forms
Access to Custom Node.js Services

Service Testing and Quality Assurance

Manual Service Tests

BPMN Process API Reference

Testable Classes

Adapters

Apache Kafka Producer Adapter

Writing a Message to a Kafka Topic
Apache Kafka Producer Reference

Filesystem Adapter

Handling of Files

Reading a File
Writing to a File
Handling the File Object

Handling of Directories
Filesystem Adapter Reference

Flat File Adapter

Defining a Flat File Data Structure
Parsing Flat Files
Composing Flat Files
Using Macro Expressions on Parsing or Composing a Flat File

Common Flat File Issues

Flat File With Header Lines
Handling Empty Lines When Composing a Flat File
Handling of White Spaces When Parsing Flat Files With Fixed Length
Handling Quotes When Composing a Flat File
Mapping of Hierarchical Record Structures
Parsing Flat File Records Without Data
Using Patterns to Separate Attributes

Flat File Adapter Reference

JSON Adapter

JSON Adapter Reference

Logger Adapter

Writing into the Standard xUML Service Log
Writing into the xUML Service Transaction Log
Logger Adapter Reference

Memory Adapter

Storing to and Retrieving Data from Memory
Removing Stored Data
Using the Memory Adapter with Maps
Memory Adapter Reference

MongoDB Adapter

Querying MongoDB
Updating MongoDB Documents
Aggregating Data
Inserting and Deleting Documents
MongoDB Adapter Reference

OData Adapter

Manually Providing the OData REST Interface
OData Adapter Reference

REST Adapter

Manually Providing the REST Interface
Handling Blobs in the REST Interface
Setting REST Request Options
Getting the REST Adapter Response
REST Adapter Error Handling
REST Adapter Reference

S3 Adapter

Handling of S3 Buckets
Handling of S3 Objects
S3 Adapter Reference

SAP Adapter

RFC Communication
Description of the SAP Interface
Native SAP - ABAP - xUML Base Type Mappings
Manually Building an SAP IDoc Structure
SAP Adapter Performance Considerations
SAP Adapter Troubleshooting
SAP Adapter Reference

SQL Adapter

Querying SQL Databases
Handling Big Data Sets
SQL Transaction Handling

Troubleshooting the SQL Adapter

Oracle: Performance Problems Due to Index Not Used

SQL Adapter Reference

URL Adapter

Using the URL Adapter with the HTTP Protocol

Using the URL Adapter with the FTP Protocol and Related Protocols

FTPS

Using the URL Adapter with the LDAP Protocol
Setting cURL Options on the URL Adapter
URL Adapter Reference

API Implementations

REST API

Defining a REST API
Implementing REST Methods
Handling Blobs in the REST API
REST Error Handling
Calling the REST API
REST API Reference

Constants and Names

Charset Definitions
Date and Time Formatting Patterns
Date and Time Scheduling Patterns
HTTP Header Support
JSON Parsing and Composing Rules
Number Formatting

Regular Expressions

Meta Characters
Operators
Replacement Text

Reserved Words
Extensions
Supported cURL Options
Time Durations
Time Zones
Type Strings
xUML Service Log Levels

Database Specifics

Database Server-Specific Notes for SQL Adapters
Database-Specific Mappings

Error Codes

Log Errors
System Errors

Troubleshooting

Error Handling AI Agents
Error Handling Application Execution
Error Handling Designer Editors
Error Handling Designer Services
Error Handling Validation

Designer Best Practices

PAS Designer Administration

Configuring the Bridge Connection
Changing the Looks of PAS Designer
Reading the Designer Logs
Creating and Restoring Backups of Namespaces
Administrating Libraries

FAQ

Scheer PAS | Support

What can I check on my own?

Ask the PAS Chatbot!

The Scheer PAS Support Center

Creating a Support Ticket
Managing a Support Ticket
Managing Your Profile
Support Priority Levels

Information to Include in a Support Request

Support Request for Standalone Integration (Bridge)

FAQ about PAS

FAQ: Administration & User Management
FAQ: API Management
FAQ: Designer
FAQ: Process Mining

Troubleshooting

Troubleshooting PAS Administration Applications

Troubleshooting Kubernetes
Troubleshooting Log Analyzer
Troubleshooting PAS Administration
Troubleshooting PAS Portal
Troubleshooting User Management

Troubleshooting API Management

Troubleshooting Designer

Error Handling AI Agents
Error Handling Application Execution
Error Handling Designer Editors
Error Handling Designer Services
Error Handling Validation

Troubleshooting Process Mining

Error Handling Analyses
Error Handling Monitored xUML Services
Error Handling Process Mining Administration

Troubleshooting BPaaS

Error Handling Login Page
Error Handling Cockpit
Error Handling BPaaS Editor
Error Handling App Execution

Scheer PAS System Requirements
Scheer PAS Release Management

Legal Information

Imprint
License Information
Chatbot Privacy Policy

Scheer PAS | Administration Guide

Ask the PAS Chatbot!
Overview on Administration Profiles

Administrating the Platform Components

Working With the Administration

Working With the Deployment Wizard

Docker Setup

Controlling Docker Container

Adapting Docker Container Configuration
Changing the Log Level of a Docker Container
Showing Docker Container Logs

Controlling Containerized xUML Services (Docker)

Adapting the Configuration of Containerized xUML Services
Changing the Log Level of a Containerized xUML Service

Disable Tracing for a Containerized xUML Service (Docker)

Tracing Settings for xUML Services in Docker

Persistent States of Containerized xUML Services
Showing Logs of a Containerized xUML Service (Docker)

Controlling Integration Services

Adapting Integration Service Configuration
Showing Integration Service Logs

Kubernetes Setup

Controlling Kubernetes Workloads

Adapting Workload Configuration
Changing the Log Level of a Workload
Handling Workload Errors
Showing Workload Logs

Controlling Containerized xUML Services (Kubernetes)

Adapting the Configuration of Containerized xUML Services (Kubernetes)
Changing the Log Level of a Containerized xUML Service (Kubernetes)
Connecting External Volumes

Disable Tracing for a Containerized xUML Service (Kubernetes)

Tracing Settings for xUML Services in Kubernetes

Managing Global Variables for Containerized xUML Services
Persistent States of Containerized xUML Services (Kubernetes)
Showing Logs of a Containerized xUML Service (Kubernetes)

Administrating Users

The Concepts of User Management

Working With the User Management

Monitoring System Activities

Component-specific Details

BPaaS Specifics
Integration (Bridge) Specifics
Process Mining Specifics

Managing Users

Adding a User
Editing a User

Managing Profiles

Overview of Standard Profiles
Adding a Profile
Editing a Profile

Managing Roles

Adding a Role
Editing a Role

Managing Permissions

Reusing User Data

Exporting User Data
Importing User Data
Reusing Central Roles

Working with the Identity Management

Common User Administration Use Cases

Creating Shared Designer Namespaces
Defining a Profile Set for Standard Users
Granting Write Permission for Namespaces

Administrating Process Mining

Collecting Logs
Adding Diagrams
Setting a Retention Time for Instance Data

Using Calculated Metrics

Adding Calculated Metrics
Editing Calculated Metrics
Creating Calculations

Monitoring the ETL Process State
Monitoring the Log File Queue

Analyzing Logs

Contents of the xUML Service Log
Contents of the xUML Transaction Log

Working With the Log Analyzer

Using Dashboards
Log Analyzer Indexes
Exporting Logs
Searching Log Entries

Inspecting the Logs: Tips & Tricks

Managing File Resources

Working With the File Manager
Managing Files

Monitoring Container Activities

Working With the Resource Monitor

Monitoring xUML Services

Working With the xUML Service Monitor
Managing Error Definitions
Managing Error Groups
Downtimes and Change Log

Administrating Cron Jobs

Working With the Cron Manager
Creating a Cron Job
Editing a Cron Job
Reading the Logs of a Cron Job

Platform Services

How to configure the opcua-connector-service

Platform Concepts

xUML Runtime

xUML Runtime API

xUML Runtime API Reference

xUML Runtime Command Line Options
xUML Runtime Logger Configuration
xUML Runtime Tool

Customizing PAS

Troubleshooting

Troubleshooting Kubernetes
Troubleshooting PAS Portal
Troubleshooting User Management

FAQ

Scheer PAS | Software Installation Guides

Scheer PAS System Requirements

API Management Installation Guide

Installing API Management

Advanced API Management Settings
Certificates and Keystores
Setting-up Kibana

Troubleshooting the API Management Installation

Updating API Management

API Management Migration Notes 7.1.0 -> 7.2.0
API Management Migration Notes 7.2.0 -> 7.3.0
API Management Migration Notes 7.4.0 -> 7.5.0
API Management Migration Notes 7.5.0 -> 7.6.0
API Management Migration Notes 7.6.0 -> 7.7.0

Analyzer Installation Guide

Analyzer Installation Process
Installing the Analyzer on Linux
Uninstalling the Analyzer

Integration (Bridge) Software Installation Guides

Bridge Installation Guide

Installation Modes and Bridge Domain

Bridge Installation Using an Installer

Installing the Bridge (Installer)

Guided Installation of the Bridge with GUI
Gui-less Installation of the Bridge

Updating a Bridge

Guided Update of the Bridge with GUI
Updating a Gui-less Installation of the Bridge

Uninstalling the Bridge

Uninstalling an E2E Bridge of Version 5
Uninstalling an E2E Bridge of Version 4.1
Uninstalling E2E Server of Bridge Version 5 (Unix)
Uninstalling E2E Server of E2E Bridge® Version 4 (Unix)
Error while Uninstalling E2E Server (Unix)

Bridge Installation Using Docker

Installing the Bridge Image to a Docker Container
Updating a Docker Installation of the Bridge
Uninstalling a Docker Bridge
Creating Your Own Bridge Docker Image

Checking the Installation
Installing a Bridge License Key

Troubleshooting Bridge Installation

Troubleshooting the Bridge Installer
No Connection to the Web Interface
Login Fails
Other Bridge Installation Problems

Configuring a Proxy in Front of the Bridge

Backend Installation and Configuration

Installing SAP Backend Access

Troubleshooting the Installation of SAP Backend Access

Configuring Java Access

Troubleshooting the Configuration of Java Access

Installing and Configuring Database Access

Installing and Configuring Database Access for DB2
Installing and Configuring Database Access for Informix
Installing and Configuring Database Access for MS SQL Server
Installing and Configuring Database Access for MySQL
Installing and Configuring Database Access for Oracle
Troubleshooting Database Access

Bridge Hardening

xUML Service

Installing an xUML Service Image
Updating an xUML Service Image

Installing the Builder for MagicDraw

Installing the Builder for MagicDraw 18

Installing MagicDraw 18.0
Installing the Cameo Business Modeler Plugin
Installing the Builder
Updating the Builder

Unzipping the Builder Examples
Uninstalling the Builder for MagicDraw

Platform Services Installation Guide

Installing the Platform Services

Setting up the Session Storage
Setting up the User Database
Deploying the Platform Services
Configuring the Platform Services
Updating the User Database

Troubleshooting the Installation of the Platform Services

RESTifier for SAP

Installing the Restifier for SAP
Configuring the RESTifier for SAP
Using the RESTifier Behind a Proxy

Getting Started With Scheer PAS

Ask the PAS Chatbot!
Accessing the Scheer PAS Components
Logging In and Out
Managing the User Preferences
Defining the Portal Content
Customizing PAS
FAQ about PAS

Scheer PAS | Analyzer Guide

Getting Started with the Analyzer

Managing Service Descriptions With the Trace Analyzer
Overview on the Analyzer Menus

Using the Analyzer with Designer Services

Creating a Builder Project
Importing the Service Description (Designer)
Connecting to an xUML Service

Browsing Through the Execution Path of a Designer Service

How BPMN Elements Are Generated to xUML
How Execution Diagrams Are Generated to xUML
How Mapping Diagrams are Generated to xUML
Inspecting Object Values
Inspecting Action Script
Inspecting Errors

Using the Analyzer with Builder Services

Creating/Opening a Builder Project
Importing the Service Description (Builder)

Using the xUML Trace Analyzer

Creating Test Cases

Inserting Test Data
Managing Test Cases
Modifying Test Case Properties

Running a Test

Inspecting the Test Case Results
Browsing through the Execution Path of the Service

Testing Non-SOAP Services
Overview of Trace Settings

Troubleshooting the Trace Analyzer

Missing Tracing Information
General Connection Error
Runtime Errors
Exceeding Maximum Trace Size
Outdated Test Cases

Performing Regression Tests

Building up a Test Scenario

Using Existing Test Cases to Create Reference Data
Importing the Existing Test Cases into the Regression Test Tool
Running a Test Suite and Evaluating the Test Results
Starting and Stopping the xUML Service
Adding an Additional Test Case
Using a Test Suite as a Library
Adding Build and Deploy Tests

Managing Tests

Re-importing Test Cases
Modifying the Test Preferences
Managing Test Suites and Tests

Creating Additional Tests

Adding a Build Test
Adding a Deploy Test
Adding a Start/Stop Test
Adding a Wait Test
Adding a ServiceCommand Test
Adding a ParallelRequest Test

Adding Options to a Test Suite

Options: Build Bridge Repository
Options: Compare the result of a Bridge request
Options: Compare two XML Documents
Options: Deploy Bridge Repository
Options: Send a Request to a Bridge
Options: Start/Stop Bridge Service
Options: Wait for a Specific Time Interval

Logging Test Runs

Advanced Regression Test Features

Mocking Backend Access
Regression Test File and Folder Structure
Running Regression Tests From Command Line
Setting a Request Timeout

Regression Testing and Persistent State

Scheer PAS | Integration (Bridge) Documentation

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

Scheer PAS | BPaaS Guide

Getting Started With the BPaaS Documentation

Starting BPaaS

Login
User Preferences

The Scheer PAS Cockpit

The Navigation Bar
The Content Area

The Sidebar

The New Elements Sidebar
The Hierarchy Sidebar
The Additional Actions Sidebar

Logout & Help
Supported Browsers

Working with BPaaS Editor

Searching in BPaaS Editor
Hashtags

Managing Translations

Displaying Translations

Documentation Tools

Transporting Models

Exporting Models

Importing Models

Importing BPMN Models
Using Imported Models

Modeling Processes

EPC Elements

Models

App Project
CSS
EPC Model
Organization Model
Administration Model

General

Connectors
Event
Function
Organization Unit
Person
Role
Local Role

Execution

E-Mail
Integration
Mobile App - Create
Mobile App - Overview
Mobile Form
Mobile Overview
Process App - Create
Process App - Overview
Responsive Form EPC
System
Worker
User Role Administration

Structuring

Document
Folder
Frame
Image
Note

Adapter

Machine Learning
Platform Service
REST
SAP Restifier

Modeling EPCs

Form Combinations
Creating New EPC Elements
Selecting EPC Elements
Connecting EPC Elements
Copying EPC Elements
Deleting EPC Elements
Resizing EPC Elements
Aligning EPC Elements
Opening EPC Elements
Grouping EPC Elements
Reversing Work Steps
Dispatch of E-Mail Attachments

Configuring EPC Branching

AND Branching
XOR Branching
Loop Installation

Nesting EPCs

Modeling Conventions

Executing Processes

The Container Principle

Form Elements

General (Forms)

Button
Checkbox
Date Picker
Drop-down Field
Input Field
Radio Button
Text Area

Complex

Camera
Division
File Upload
Files Upload
Icon
Search Field
Signature
Table
URL Field

App-specific

Instance Table
Instance View
Process App Links
Process Navigation

Structuring (Forms)

Responsive Element
Responsive Form (Sub Form)

Creating Forms

Creating Form Elements
Editing Form Elements
Copying Form Elements
Deleting Form Elements
Grouping Form Elements
Configuring Buttons

Configuring Tables

Manual Table Configuration
Using the Column Wizard
Defining Column Types

HTML Basics
Possible Values: Value and Label

Using App Links

Using the App Link (single)
Using the App Link (multiple)
Extending the App Link (multiple)
App Links in Role-based Apps
Copying Values to Form Fields

Using the Camera Element
Using the Instance View
Using the Signature Element
Validating Form Fields

Process Apps

Creating an App Project
Creating Instances

Searching for Instances

Configuring Overview Tables
Setting Search Filters Using Search Query
Using Meta Information

Saving and Deleting Instances

Role-based Authorization Concept

Creating Roles
Creating Role-based Apps
Role-specific Access Rights

Service

Sample Processes

The Processes of ACME Corp.

Bidding Process
Damage Reporting Process
Idea Management Process
Onboarding Process
Procurement Process

BPaaS Support

Error Handling Login Page
Error Handling Cockpit
Error Handling BPaaS Editor
Error Handling App Execution

Downloads
Glossary

Administrating BPaaS

Administration Basics

Administrator Login
Filtering
Sorting Content
Monitoring System Activities

Module-specific Details

BPaaS Specifics
Bridge Specifics
Process Mining Specifics

Managing Users

Users

Add a User
Edit a User

Profiles

Add a Profile
Edit a Profile

Roles

Add a Role
Edit a Role

Permissions
Creating Copies

Data Transport

Export
Import
Reusing Central Roles

Maintaining Process Mining

Processes
Log File Queue
Services

Calculated Attributes

Add a Calculated Attribute
Edit a Calculated Attribute

Managing Cron Jobs

Creating a Cron Job
Cron Manager Basics
Editing a Cron Job
View Log Entries

3rd Party Tools

Keycloak
Kibana
Portainer

BPaaS Entwicklerhandbuch (German)

Das Benutzerobjekt

Layout & Design

CSS-Konfigurationen

CSS-Modell anlegen
CSS-Anweisungen
CSS-Elemente identifizieren

Widget-Tabelle

Prozess-Modellierung

E-Mail Worker

E-Mail: Anhänge ermitteln
E-Mail: Einstiegslinks versenden
E-Mail-Empfänger dynamisch ermitteln
E-Mail-Inhalt dynamisch ermitteln
E-Mail: Platzhalter verwenden

Formularfunktionen

Felder vorbelegen

Widgets anpassen

Felder ausblenden

Zahlen runden

Worker einsetzen

Containerwerte beeinflussen
Einen Alert einbauen
Eine ID generieren
Flüchtige Werte in die Datenbank speichern
Initialisierungsmodell verwenden
Komplexe Bedingungsprüfung
Umgebungsvariablen
Worker-Kontext ändern

Integration externer Datenquellen

Einsatz von REST
Einsatz des SAP-Restifiers
Einsatz des Plattform Service

Formular-Erstellung

Ausblenden der Icons von App Verknüpfungen
Auswahlliste als Filter verwenden
Auswahlliste dynamisch befüllen
Bild-Upload in Formular anzeigen

Buttonfunktionen

E-Mail-Versand per Knopfdruck
Webseite per Knopfdruck öffnen

Datum, Uhrzeit und Zeitstempel
Download anbieten
Download einer hochgeladenen Datei
Einbau von Statusfeldern
Export von Instanzdaten
Felder füllen mit Werten aus einer App Verknüpfung
Formulare schließen
Suchfeld verwenden

Code-Bibliothek

Beispiele und Glossar

Beispiele: Prozesse und Anwendungen

Die Prozesse der Mustermann GmbH

Angebotserstellung
Beschaffung
Ideenmanagement
Onboarding

Glossar

Scheer PAS Academy

An Introduction to Scheer PAS

PAS Concepts: How does Scheer PAS work?

Designer Best Practices

Accessing Data From BPMN Process Instances From the Outside

Querying Persistent State Objects via the Runtime API
Querying Persistent State Objects via the Service API

Action Script or JavaScript: A Comparison
Developing with the Designer Test Environment
Exposing Designer Services via API Management

Going Live with a Designer Service

Solving Transport-Related Problems

How to Change the Database for Persistent States
How to Define Custom Service Settings in a Designer Service
How to start an Integration project
Library Development

PAS Modeling Guidelines

Project Organization
Naming Conventions
Project Documentation
Settings
Mappings
Logging
Error Handling

Versioning of Libraries
Versioning of Services

Analyzer Tutorials

Tutorial 1: Import of a PAS Designer Service into the PAS Analyzer
Tutorial 2: Browsing Through the Execution Path of a Designer Service
Tutorial 3: Inspecting Errors

API Management Tutorials

Managing a Public API - Step by Step

Step 1: Creating an Organization
Step 2: Importing the API
Step 3: Configuring the API
Step 4: Testing and Consuming the API
Step 5: Disabling the API

Managing a Private API - Step by Step

Step 1: Creating an Organization
Step 2: Creating a Plan
Step 3: Importing the API
Step 4: Configuring the API
Step 5: Creating Clients and Contracts
Step 6: Testing and Consuming the API

Understanding the Approval Process

Step 1: The Differences in Visibility
Step 2: Responding to Approval Requests

Designer Tutorials

Tutorial 1: Modeling BPMN and Forms

Preparations
Step 1: Drawing the Business Process
Step 2: Designing the Forms
Step 3: Assign Forms to Process Steps
Step 4: Run a First Test

Tutorial 2: Adding Execution and Mapping Data

Preparations
Step 1: Adding Execution to Handle the Form Data
Step 2: Mapping the Order Data
Step 3: Handling the Decision
Step 4: Validation Errors
Step 5: Testing the Process

Tutorial 3: Showing Process Data in the Instance List

Step 1: Mapping the Form Data
Step 2: Configuring the Instance List
Step 3: Testing the Process

Tutorial 4: Deploying a Service

Step 1: Deploying a Service as Container
Step 2: Administrating a Containerized Service
Step 3: Differences in Testing

Tutorial 5: Adding Roles to the Process

Step 1: Insert and Configure Lanes in the BPMN
Step 2: Remodeling the Process
Step 3: Testing With Roles

Bridge Development Tutorials

Education Lesson 1

Introduction to the Bridge Platform
Installation of Software
Working with MagicDraw and E2E Builder
Introduction to the Development Process

Creating a Web Service

Using E2E Builder
Use Cases - Lesson 1
Classes - Lesson 1
Web Service Interface - Lesson 1
Activities - Lesson 1
Sequences - Lesson 1
Components - Lesson 1

Compiling the Web Service - Lesson1
Testing with the Interactive Debugger - Lesson1
Development Server and Bridge

Education Lesson 2

Starting with Lesson 2

Extending the Web Service of Lesson 1

Use Cases - Lesson 2
Building a New Service Structure
Classes - Lesson 2
Web Service Interface - Lesson 2
Activities - Lesson 2
Components - Lesson 2

Compiling the Web Service - Lesson 2
Testing with Interactive Debugger - Lesson 2
Runtime and Bridge - Lesson 2

Testing the Service with the Analyzer - Lesson 2

Opening a Builder Project
Test Case Properties - Lesson 2
Tracing through the Service - Lesson 2

Education Lesson 3

Starting with Lesson 3

Extending the Web Service - Lesson 3

First Iteration

Use Cases - Lesson 3
Classes - Lesson 3.1
Web Service Interface - Lesson 3

Activities Lesson 3.1

Reading the XML File
Filtering the File Content

Components - Lesson 3.1
Compilation - Lesson 3.1
Testing with SOAP Test Tool - Lesson 3.1

Second Iteration

Classes - Lesson 3.2

Activities - Lesson 3.2

Implementing the Currency Calculator
Getting the Exchange Rate from an External Web Service
Implementing the Currency Conversion
Implementing Additional Calculations

Components - Lesson 3.2
Compilation - Lesson 3.2
Testing with the SOAP Test Tool - Lesson 3.2

Testing the Service with the Analyzer - Lesson 3

Test Case Properties - Lesson 3
Tracing through the Service - Lesson 3

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
xUML Action Language
Utility Functions

On this Page

removeFromMemory() Operation

Deprecated Please use the Memory Adapter instead, see Removing Stored Data.

Related Pages:

Memory Adapter
Removing Stored Data

Pagination

Previous Page

parseUrl() Operation
Next Page

report() Operation

About us
Imprint
License Information

Copyright Scheer PAS Deutschland GmbH
Powered by Scroll Sites & Atlassian Confluence