Skip to main content

X4 Produktdokumentation

German

English

X4 Produktdokumentation

German

English

Main

Main

X4 Release Notes

Release Notes 7.5.x.

Release Notes 7.5.0

Release Highlights 7.5.0

New Features and Changes 7.5.0

X4 Adapter 7.5.0
X4 Server 7.5.0
X4 Web Apps 7.5.0

Bug fixes in Release 7.5.0

X4 Adapters: Bug fixes 7.5.0
X4 Designer Bug fixes 7.5.0
X4 Server: Bug fixes 7.5.0
X4 Web Apps: Bug fixes 7.5.0
X4 Documentation: Bug fixes 7.5.0

Known Issues 7.5.0

Release Notes 7.4.x

Release Notes 7.4.13

Known Issues 7.4.13

Release Notes 7.4.16

Known Issues 7.4.16

Release Notes 7.4.15

Known Issues 7.4.15

Release Notes 7.4.14

Known Issues 7.4.14

Release Notes 7.4.11
Release Notes 7.4.10
Release Notes 7.4.9
Release Notes 7.4.8
Release Notes 7.4.7
Release Notes 7.4.6
Release Notes 7.4.5

Release Notes 7.4.4

Known Issues 7.4.4

Release Notes 7.4.3

Known Issues 7.4.3

Release Notes 7.4.2

Known Issues 7.4.2

Release Notes 7.4.1

Product Enhancements 7.4.1

X4 Adapter 7.4.1
X4 Designer 7.4.1
X4 Server 7.4.1
X4 Web Apps 7.4.1
X4 Documentation 7.4.1

Migration Information 7.4.1

Bug Fixes in Release 7.4.1

X4 Adapter: Bug fixes 7.4.1
X4 Server: Bug Fixes 7.4.1
X4 Web Apps: Bug Fixes 7.4.1
X4 Documentation: Bug Fixes 7.4.1

Known Issues 7.4.1

Release Notes 7.3.x

Release Notes 7.3.11
Release Notes 7.3.9
Release Notes 7.3.8
Release Notes 7.3.7
Release Notes 7.3.6

Release Notes 7.3.1

Release Highlights 7.3.1

Product Enhancements 7.3.1

X4 Adapter 7.3.1
X4 Control Center 7.3.1
X4 Designer 7.3.1
X4 Server 7.3.1
X4 Web Apps 7.3.1

Deprecated Features 7.3.1
Migration Information 7.3.1
Bugfixes 7.3.1

Release Notes 7.2.x

Release Notes 7.2.5
Release Notes 7.2.3
Release Notes 7.2.2
Release Notes 7.2.1

Release Notes 7.2.0

Release Highlights 7.2.0

Product Enhancements 7.2.0

X4 Adapter
X4 Designer 7.2.0
X4 Server
X4 Web Apps 7.2.0

Deprecated functions 7.2.0
Bug fixes 7.2.0

Release Notes 7.1.x

Release Notes 7.1.5

Getting Started

Setup and Licenses

Connecting the X4 Designer to the X4 Server
Starting the X4 Server and the Identity Provider
Installing a License

Working with the X4 Designer

Structure of the X4 Designer
Creating New Projects
Project Types
Importing Existing Projects
Exporting Projects

Example: BPM Project

Creating a BPM Process (.bpm)
Creating Pools and Lanes
Defining Business Process Data
Defining Case States
Defining the Start Element
Inserting the First Activity
Inserting the First Intermediate Event
Creating a Decision Table and Inserting a Rule
Inserting an Exclusive Gateway and More Activities
Setting Execution Conditions
Creating and Defining a Human Task
Inserting an Exclusive Gateway and Defining the Execution Conditions
Inserting End Points and Defining Execution Conditions
Result: BPM Project

Example: ESB Project

Creating a Technical Process (.wrf)
Creating, Inserting, and Configuring the File System Adapter
Inserting a Variable and Adding a Description
Creating, Inserting, and Configuring a Mapping
(Optional) Creating and Inserting a Case Management Adapter
Inserting an End Point
(Advanced) Integrating the Technical Process in a Business Process
Result: ESB Project

Example: Web App Project

Creating a List Component
Creating the Technical Process for the Web App (.wrf)
Defining the Technical Process: CSV Converter
Defining the Technical Process: Buffer
Defining the Technical Process: Mapping
Defining the Technical Process: Inserting an End Point
Configuring and Inserting the List Component
Opening the Web App in the Browser
Result: Web App Project

Migration Guide

X4 Web Apps
X4 Designer
X4 Server
X4 Adapter
Update Tool

X4 System Requirements 7.5.0

X4 BPMS and Keycloak – Compatibility Matrix

X4 Installation

Installation Packages for Windows

X4 Designer – Interactive Installation
X4 Server – ZIP archive for Windows
X4 Designer – ZIP archive for Windows
All-in-One - Interactive Installation

License Information

Installation Packages for macOS

X4 Designer – ZIP archive for macOS

Installation Packages for Linux

X4 Server – ZIP archive for Linux
X4 Server – RPM package for SUSE Linux Enterprise Server
X4 Server and Keycloak – RPM package for Red Hat Enterprise Linux
X4 Server and Keycloak – Debian Package for Ubuntu Linux
Instructions: Creating and Managing systemd Services for X4-Server and X4-Authentication-Provider

Docker Image

X4 Administration

Configuration

Configuring the X4 Server

Setting up the Database

Setting up the Oracle Database
Configuration for MSSQL and PostgreSQL

Configuring via the X4config.xml

iXServ Configuration
SNMP Configuration
Persisting Global Parameters in the Database
LDAPS Configuration

Configuring the Logging

Savepoint Configuration for the X4 Server
SNMP trap appender
Ad-hoc Logging at Runtime

Setting up SSL and HTTPS for the X4 Server
Creating a Workspace

Using a Reverse Proxy Server

Configuring a Reverse Proxy Server
Setting Up the X4 Server for the Usage of a Reverse Proxy Server

Setting Up Keycloak for the Usage of a Reverse Proxy Server

Creating an Administrator User in Keycloak
Adjusting the Root URL for the X4 Client in Keycloak
Adopting the Proxy Configuration in Keycloak
Starting the Keycloak
Practical Hints: How to Set Up a Reverse Proxy Server

Known Issues

Using Runtime Configurations
Configuring the Worker Thread Pool
Scheduler Configuration (Quartz)

Configuring the X4 Designer

Editing the Connection Configuration
Configuring the Process Editor
Configuring the Run/Debug Mode
Configuring the Mapping Editor
Managing Templates for Repository Elements
Assigning File Types to External or Internal Editors
Configuring the Web Browser
Configuring the JSON Editor
Disabling the Authentication

Administering the X4 Server

Updating the X4 Repository in production mode
Controlled Shutdown of the X4 Server (via JMX)
Providing Process Libraries

Analyzing storage problems

Automatic Creation of Heap Dumps

Heap Dumps for Directly Executed X4 Installations
Heap Dumps for Service Installations

Manually Creating Heap Dumps

High Availability

Load Balancing
Fail Over
Load Balancing via Scheduler

X4 Control Center

Authentication with OpenID Connect (OIDC)

OIDC Configuration
Notes on migration
Keycloak Integration with OIDC for X4 Designer and X4 Server
Enabling Debug Logs for OIDC

X4 BPM

Interface

Context menu
Perspectives
Views

Editors

Adapter-Editor 1
BPMN Editor
Database Editor
JSON Editor

Mapping Editor

Shortcuts in the Mapping Editor

Process Editor

Process Quality Index
Shortcuts in the Process Editor

XML Editor

Toolbar

Working with BPM Projects

Modelling Process Landscapes

Creating a Business Process

Use of private files within Business Processes

Importing Business Processes in BPMN or XML Format
Properties of Business Processes (.bpm)
Aligning Process Components 3
Adding Process Metadata
Importing projects
Exporting projects

Case Management

Implementing processes and workflows

Managing Domain Models

Defining Business Data
Defining Data Objects

Managing Case States

Task Management Web App

Editing Tasks in the Task Management Web App

Scheduler in BPM Processes

Executing processes on a scheduled basis

Server start
BPM Processes: Cron

Profiling

BPMN Process Components and Their Use

Events

Start
Intermediate
Timer-based Intermediate
Non-Interrupting Intermediate Event
End

Activities

Activity
Human Task
Rule

Sequence Flow
Gateways

Artefacts

Message Flow
Association
Pool/Lane
Data Object
Data Store
Annotation
Group

Drawing

Connection
Connector
Rectangle and Ellipse
Textbox
Polygon
Polyline and Line
Image

X4 ESB

Interface

Toolbar
Context Menu
Perspectives
Views

Editors

Adapter Editor
BPMN Editor
Database Editor
JSON Editor

Mapping Editor

Shortcuts in the Mapping Editor

Process Editor

Process Quality Index
Shortcuts in the Process Editor

XML Editor

Process Components and Their Use

Connecting Process Components

Control Components

Stop
Fork and Join
Merge

Condition

Creating and Using Conditions
Condition Editor

Connection
Pause
Counter
Transaction
Variable

Module Components

Adapter

XML

XML Editor 2

JSON

JSON Editor 2

Document

ASCII Descriptor
Text Editor

Subprocess

Mapping

Creating and Using an XSL Mapping
Mapping Editor

PDF Creator

Drawing Elements

Working with ESB Projects

The Structure of ESB Projects
Creating ESB Projects

Managing Projects

Import repository elements
Export repository elements
Renaming elements and updating references automatically
Moving elements and updating references automatically
Repairing repository references
Deleting Unused Resources
Searching Repository Elements
Migrating Outdated Projects

Creating and Modelling Processes

Creating Processes

Using Private Files Below Processes

Properties of a Technical Process (.wrf)
Aligning Process Components
Validating Processes

Parameterizing Process Components

Parameterization Options
Use Cases for Parameters
Setting Dynamic Parameters
Using Component Parameters
Setting Status Dynamically with ConditionState
Using Parameters in XSL Mappings

Creating and Using Parameters

System Parameters

Overview of System Parameters
Using System Parameters

Global Parameters and Groups

Creating Global Parameters and Groups
Copying Global to Project Parameters
Using Global Parameters

Project Parameters

Creating Project Parameters
Renaming Project Parameters
Creating custom types
Reusing Global and System Parameters

XSL Help Functions

TimeHelper (deprecated)
WorkingTimeCalculator (deprecated)
checkXML

XSLT functions
XPath Functions
Developer Utilities

URL Protocols

context:-URL-Protokoll
xstore:// URL Protocol
x4db:/ URL Protocol
cryptstore:// URL Protocol
globalcontext: URL Protocol

Logging Technical Processes

Activating .log file

Using Savepoints for Restartable Processes

Deploying Web Services via HTTP(S)

Graphically Editing the Web Service Configuration

Providing ReSTful Webservices

Deploying Processes as ReSTful HTTP Web Service
ReSTful Webservices: Input XML structure
ReSTful Web Services: Expected Output XML

Providing SOAP Web Services

Deploying SOAP Webservices in the RPC Style
Providing SOAP Web Services in Document Mode
Providing SOAP Web Services with External WSDL Definition
Deploying a SOAP Webservice without a WSDL Definition
SOAP Web Services: Input and Output XML

Providing File Web Services

Providing Web Services via Open API

Graphically Editing the Web Service Configuration
Providing ReSTful Web Services
Deploying a Technical Process as an OpenAPI ReST service

COBOL Copybook Converter Wizard
Extracting the SessionID of a Web App
Reading out the Groups of a User
Reading out the Claims of a User

Debugging and Running Processes

Debugging Technical Processes

Execute debug session without debugging
Terminate debug session
Attach debugger with server

Executing Processes
Status Values for Processes and Process Steps

Scheduler in ESB Processes

Executing ESB Processes on a Scheduled Basis

ESB Processes: Server start
ESB Processes: Cron

Process Monitoring 3

Configuring the Monitoring of Profiling Data in the Design View
Configuring the Monitoring of Profiling Data in the Source View

X4 Adapters

Developing Custom X4 BPMS Adapters (ADK)

General Notes on Adapters

Installing Adapters and Plugins Manually

X4 BPMS Standard Adapters

Big Data

Amazon S3 DynamoDB Connector

Operation: CreateTable
Operation: UpdateTable
Operation: ListTable
Operation: EnableAutoScaling
Operation: DisableAutoScaling
Operation: PutItem
Operation: BatchPutMultipleItems:
Operation: UpdateItem
Operation: GetItem
Operation: BatchGetMultipleItems
Operation: Delete
Operation: BatchDeleteMultipleItems:
Operation: Query

Apache Cassandra Connector

Operation: Execute
Operation: Terminate

Google Cloud Storage BigTable Connector

Operation: CreateTable
Operation: ListTable
Operation: PutRow
Operation: GetRow
Operation: Scan
Operation: EnableTable
Operation: DisableTable
Operation: Delete 2

Microsoft Azure Data Lake Gen 1 Storage Connector

Operation: AppendFile
Operation: ConcatenateFiles
Operation: CreateFolder
Operation: DeleteFile
Operation: DeleteFolder
Operation: EnumerateDirectory
Operation: GetMetadata
Operation: ReadFile
Operation: RenameFile
Operation: RenameFolder
Operation: SetPermission
Operation: UploadFile

Cloud

Amazon S3 Simple Storage Connector
Amazon SimpleDB Connector
Dropbox Connector
Google Cloud Storage Objects Connector
Google Drive Connector
Microsoft Azure Blob Storage Connector
Microsoft Azure Table Storage Connector

Communication

AS/400 PCML

File System

Operation: Write File
Operation: Append File
Operation: Read File
Operation: Delete
Operation: Copy
Operation: Move
Operation: Exists
Operation: Create Folder
Operation: List Folder

File System Bulk

FTP

FTP Connector

Operation: List
Operation: Send File
Operation: Receive File
Operation: Append File
Operation: Move
Operation: Delete File
Operation: Create Folder
Operation: Delete Folder
Operation: Exists

FTP Connector (Advanced)

iCalendar
Ping
SCP
TCP/IP Communication
Telnet Connector

Compression

gzip Converter

Operation: Encode
Operation: Decode

ZIP Converter

Operation: Zip
Operation: Unzip

ZIP in Memory Converter

Operation: Zip
Operation: Unzip

Databases

JDBC Connector

Statement: Direct SQL
StatementBatch: Direktes SQL im Batch-Modus
PreparedStatement: SQL mit Werten
PreparedStatementBatch: SQL mit Werten im Batch-Modus
CallableStatement: Stored Procedures
CallableStatementBatch: Stored Procedures im Batch-Modus
NamedPreparedStatement: SQL with Named Parameters 1
NamedPreparedStatementBatch: SQL with Named Parameters in Batch Mode 1
Passing XML Structures
Retrieving Database Metadata

JDBC Iterator

Statement: Direktes SQL
StatementBatch: Direct SQL in Batch Mode
PreparedStatement: SQL with Values
PreparedStatementBatch: SQL with Values in Batch Mode
CallableStatement: Stored Procedures
CallableStatementBatch: Stored Procedures in Batch Mode
NamedPreparedStatement: SQL with Named Parameters
NamedPreparedStatementBatch: SQL with Named Parameters in Batch Mode
Abrufen von Datenbank-Metadaten

JDBC Metadata Explorer

Retrieving Database Metadata 1
Retrieving table metadata
Retrieving column metadata
Retrieving primary keys of a table
Retrieving foreign keys of a table
Retrieving referenced foreign keys

EDI

EDIFACT Adapter
Supported EDIFACT Message Types

E-Mail

MIME Multipart
MIME Multipart Reader
POP/SMTP
IMAP

ERP

SAP Connector

IDoc structures
SAP Connector (JCo 2)
SAP Connector (JCo 3)
SAP Explorer (JCo 2)
SAP Explorer (JCo 3)

SAP Listener (JCo 2)

Installing X4 SAP JCo 2

Configuring the SAP Server (JCo 2)

SAP JCo 2 Server Configuration
Properties for the JCo 2 Server
Function Block/Method Definitions (X4 SAP JCo 2)
Connection Pooling (X4 SAP JCo 2)
Updating the JCo 2 Server Configuration

SAP Listener (JCo 3)

Installing X4 SAP JCo 3

Configuring X4 SAP JCo 3

SAP JCo 3 server configuration (X4config.xml)
JCo 3 Listener configuration
JCo 3 properties
Function block/method definitions (X4 SAP JCo 3)

Abas ERP Connector

File Processing

ASCII to XML

ASCII to XML Converter
ASCII Writer
Text to Lines Converter
Text to Lines Converter from URL

Base64 Batch Decoder
Base64 Converter
Charset Changer

CSV

CSV Converter
CSV Converter from URL
XML to CSV Converter

Encoding Converter
Hex Converter

Image Processing

Image to Image Converter
Multipage TIFF Creator
TIFF Properties Reader

Java Properties File Reader
QR Code Generator
Regular Expression
Stream Splitter

Structured Text

Structured Text Converter
COBOL Copybook Reader
COBOL Copybook Writer

Text Replacement
Transliteration Adapter

Geo Location

Geo Calculation

Operation: Line Conversion
Operation: LineLength
Operation: LineIntersection
Operation: BoundingBox
Operation: SegmentLineByPolygon
Operation: LineSimplificationPercent / LineSimplificationKilometer

Google Maps

Operation: Geocode
Operation: ReverseGeocode
Operation: GetRoutes
Operation: CreateGoogleURL

Insurance

Audatex DV90 Converter

GDV

GDV Message Plausibility Checker
GDV Message Reader
GDV Message Writer
GDV-VU

SZF Reader

Internet of Things

IEC 61850 Client
Modbus TCP Connector

MQTT Publisher/Subscriber

MQTT Publisher
MQTT Subscriber

OPC Client Connector

OPC UA Publisher/Subscriber

OPC UA Publisher Adapter
OPC UA Subscriber Adapter

SIMATIC S7 Connector

Message Oriented Middleware

AMQP Publisher/Subscriber

AMQP Subscriber
AMQP Publisher

Apache Kafka Publisher/Subscriber

Apache Kafka Publisher

Operation: Publish

Apache Kafka Subscriber

Operation: Assign
Operation: Subscribe
Operation: Last offset
Operation: Unsubscribe

JMS

Websphere MQ

IBM MQ Monitoring
MQ Series Transfer
Websphere MQ Connector

MS Graph

MS Graph Auth Adapter (Version 1.0.0)

Kompatibilitätsübersicht

Funktionen und Operationen

Operation: GetToken

Manual Installation

MS Graph E-Mail Connector (Version 1.0.0)

Compatibility Matrix

Funktionen und Operationen

Operation: ListMailFolders
Operation: ListMails
Operation: CreateMailFolder
Operation: RenameMailFolder
Operation: DeleteMailFolder
Operation: DeleteMail
Operation: GetMail
Operation: MoveMail
Operation: SendMail
Operation: CreateDraftMail
Operation: SendDraftMail

Manuelle Installation

Office

Microsoft Excel Writer
Microsoft Excel Reader
Microsoft Word Properties
Microsoft Word to Text Converter
Working Time Calculator

PDF Processing

PDF Data Processing

PDF Barcode Adder

PDF Form

Operation: Flatten XFDF
Operation: Flatten FDF
Operation: Export FDF
Operation: Import XFDF
Operation: Import FDF
Operation: Set Fields
Operation: Flatten

PDF Metadata

Operation: GetMetadata
Operation: SetMetadata

PDF to Text Converter

ZUGFeRD (Version 1.0.1)

Operation: Detect XML
Operation: Extract XML
Operation: Get Version
Operation: Validate
Operation: Embed XML

PDF Image Processing

PDF Image Adder
PDF Multipage TIFF Adder
PDF to Image Converter
PDF to TIFF Converter
TIFF to PDF Converter

PDF Split and Merge

PDF Merger
PDF Page Counter
PDF Recombiner
PDF Splitter Iterator

PDF Compression (Version 1.1.0)

Installing the Third-Party Libraries

PDF Compression: Functions and Operations

Operation: Compress

PDF to PDF/A Converter (Version 1.0.0)

Installing the Third-Party Libraries 1

PDF to PDF/A Converter: Functions and Operations

Operation: Convert to PDF/A.
Parameter Strategies: Possible Values

Security

Antivirus
BCrypt Calculator
Checksum Creator
Digest Calculator
JSON WebToken Calculator
LDAP Connector
Password Generator
Random Number Generator
RSA Encryption
SAML Calculator
SSH Connector
TOTP One-Time Password Generator
UUID Generator

XML Encryption

XML Encryption (Keystore)
XML Encryption (Password)

XML Signature
AES Encryption

System Administration

JMeter Test Execution
JMX MBean
JMX Number
JMX Switch
SNMP Management
Windows Event Reader
Windows Services Explorer

Tools

WebSMS

Web Services

JSON

JSON Converter 2.0
JSON Validation

OData Connector
URL Encoding Converter
URL Reader

Webservice

HTTP(S) Connector
Webservice (SOAP) Connector
SOAP Connector 8.0.0

X4 Streaming Support
XOP (MTOM)
YAML Converter

XML Tools

Inline Content Expander
Record Counter
XHTML Form Extractor
XML Checker
XML Element Wrapper
XML Iterator
XML Text Extractor
XPath Iterator
XML Validation

X4 API

Deployments
Global Parameter Management

Process Monitoring

Operation: Find Process Execution Detail

Operation: List Process Executions

Filtering for all Subprocesses of a Process
Filtering by Process Paths
Filtering by Process Status
Filtering for Subprocesses of a Process
Filtering by Time Periods
Sorting Data in the Output
Issuing Data in Subsets
Filtering for Debug Modes
Filtering for Parent or Subprocesses

Operation: List Process Execution Steps Detail

Process Monitoring Management

Operation List Profilings
Operation Get Profiling by Id
Operation Update Profiling

Process Runtime Management

Operation: List Running Processes
Operation: Stop Process
Operation: Terminate Process

Project Parameter Management

Operation: Get Project Parameter Ids
Operation: Get Project Parameter Structure
Operation: List Project Parameters
Operation: Patch Project Parameters

Savepoint Management

Operation: List Savepoints
Operation: Delete Savepoint
Operation: Resume Savepoint

Schedule Management

Operation: List Schedules
Operation: Get Schedule by Id
Operation: Update Schedule
Operation: Jobs information

System Configuration Management

Operation: List Configurations
Operation: Get Configuration by configurationName

Third Party License Summary

Operation: Get Summary

Web App Configuration Management

Operation: Get Configuration by Id
Operation: List WebApp Configurations
Operation: Update Configuration

Web App Theme Management

Operation: Update Theme
Operation: Get Theme by Id
Operation: List WebApp Themes

Keycloak Management 2

Gruppen

Create new Group
Create New Sub-Group
List Groups
Get Group by Id
Update Group
Delete Group
Add Member to Group
Get Members of Group
Remove Member from Group

Roles

Create new Role
List Roles
Get Role by Id
Get Role by Name
Update Role
Delete Role
Add Composite to Role
Get Composite of Role
Add Roles to User
Get Users with Role
Remove Roles from a User
Add Roles to Group
Remove Roles From a Group

Users

Create new User
List Users
Get User by Id
Update User
Activate User
Deactivate User
Delete User

X4 Tools

Commandline

BAM Log Adapter (Version 1.1.0)

Kompatibilitätsübersicht
Manuelle Installation
Migrationstool

Functions and Operations

Operation: Log Status
Operation: Log Data
Operation: Log Message
Operation: Log Batch Message
Operation: Read Status
Operation: Read Data
Operation: Read Messages

Task Management

Operation: GetAllTasks
Operation: GetTask
Operation: EditTask
Operation: CloseTask
Operation: DeclineTask
Operation: ForwardTask
Operation: CancelTask
Operation: ResubmitTask
Operation: WriteTaskDataObject
Operation: GetTaskDataObject

BAM Logging Adapter (Version 2.2.1)

BAM Logging: Manual installation
BAM Logging: Migration

BAM Logging: Functionality and Operation

BAM Logging: Operation: Log Status
BAM Logging: Operation: Log Data
BAM Logging: Operation: Log Message
BAM Logging: Operation: Log Batch Messages

BAM Logging: Compatibility overview

Case Management Documents
Case Management
Case Management Statistics
Document Comparison
Document Properties Changer
Empty Output Adapter
Global Context Manipulation
Keycloak Token 2
Log4J Logging
Loop Adapter
Process Starter
Parallel Process Starter
Projects

Project Access

Operation: ReadFile
Operation: WriteFile
Operation: AppendFile
Operation: Exists
Operation: CreateDirectory
Operation: Delete
Operation: ListDirectory
Operation: Move
Operation: Copy

System Status

Operation: Threads Information
Operation: JVM Parameters
Operation: Processes Running
Operation: Apps Status
Operation: General Server Information

User Identity Adapter
User Session Adapter
Web App Translation
X4 Management
X4 Server Config Reader
X4 Variable Collector

Data Object Persistence Adapter

Operation: Create
Operation: Read
Operation: Update
Operation: Delete

Data Object Web App Adapter

Operation: Read

Deprecated adapters

Keycloak Management (deprecated)

Roles 1

Create new Role 1
List Roles 1
Get Role by Id 1
Get Role by Name 1
Update Role 1
Delete Role 1
Add Composite to Role 1
Get Composite of Role 1
Add Roles to User 1
Get Users with Role 1
Remove Roles from a User 1
Add Roles to Group 1
Remove Roles From a Group 1

Groups 2

Create new Group 1
Create new Sub-Group 1
List Groups 1
Get Group by Id 1
Update Group 1
Delete Group 1
Add Member to Group 1
Get Members of Group 1
Remove Member from Group 1

User 2

Create new User 1
List Users 1
Get User by Id 1
Update User 1
Activate User 1
Deactivate User 1
Delete User 1

Atlassian Jira Connector

Atlassian Jira Connector Operation Get Issue
Atlassian Jira Connector Operation Get all Issues
Atlassian Jira Connector Operation Create Issue
Atlassian Jira Connector Operation Edit Issue
Atlassian Jira Connector Operation Add Attachment
Atlassian Jira Connector Operation Remove Attachment
Atlassian Jira Connector Operation Get all Comments
Atlassian Jira Connector Operation Get Comment
Atlassian Jira Connector Operation Add Comment
Atlassian Jira Connector Operation Edit Comment
Atlassian Jira Connector Operation Search
Atlassian Jira Connector Operation Execute Transition
Atlassian Jira Connector Operation Get Transition

Atlassian Jira Connector ReST API

Bing Maps (deprecated)

Operation: Geocode
Operation: ReverseGeocode
Operation: GetDirections
Operation: CreateBingURL

Global Parameter Initializer (previously: Custom Placeholder Initializer) (deprecated)
MongoDB Connector
JSON Converter (deprecated)
ZIP Compression (Deprecated)
Keycloak Token (deprecated)
ZIP Folder Compression (Deprecated)
XML Formatter (deprecated)
Webservice Security (deprecated)

X4 Web Apps

Structure of a Web App Project

Detail Editor

Creating and Declaring a New Web App Project

Creating a New Web App Project

Displaying a Web App Project

Opening a Web App on Mobile Devices
Opening Web Apps in a Browser
Copying the Web App URL

Declaring a Web App Definition

Referencing Components in the Web App Definition

Configuring the Menu Width
Data Protection Statement
Imprint
Responsive Behavior

Theming

Colors

Main Theme
Chart Theme
Farben festlegen

Fonts

Schriftarten festlegen

Configuration

Managing Access to Web Apps

Access via the User Identity Adapter

Declaring Configurations

Access Rights Configuration: Managing access to components and modules
Declaring Configurations in the Design View

Declaring Configurations in the Source View

<Access>
<Access Rights>
<General>
<HeaderIncludes>
<SecurityHTTPHeaders>
<Logout>
<Notifications>
<Status>
<URL>

Localization
Modules

Components

Detail Component
Navigation within a Web Application
Data Model and Properties Definition

List Component

Paging

Example for Paging

Calendar Component

Master/Detail Component

Master Structural Element
Detail Structural Element
Overlay Structural Element

ExternalWeb Component

Grid Component

Filtering
Paging

Form Component

Forms Editor

Launching the Forms Editor from the X4 Designer
Structure of the Forms Editor
Creating Forms in the Forms Editor
Controls in the Forms Editor

Layouts

Box Layout

<BoxLayout>

Flow Layout

<FlowLayout>

Grid Layout

<
<ColumnDefinitions>
<Column>

Tab Group

<TabGroup>

Tab Layout

<TabLayout>
<Tab>

Responsive Layout

<ResponsiveLayout>
<Cell>

Controls

Accordion
Button
Card

Chart

Line chart
Bar Chart
Pie/Donut Chart
Tachograph

Checkbox
ComboBoxAutocomplete
ComboBox
DateTimePicker
FileLink
FileUpload
Header
HTMLDocument
Image
Label
Link
ListView
Map
RadioButtonGroup
PasswordBox
RadioButton
RichText
TextBlock
TextBox
TreeView
Video
Data Binding

Actions

"New" Action
"SaveView" Action
"Save" Action
"Delete" Action
"Upload" Action
"Download" Action
"Custom" Action
"Reload" Action
"Cancel" Action
"Select" Action
"Logout" Action
"DoubleClick" Action

HeaderSection

Create HeaderSection

<HeaderSection>

Integrating JavaScript in Web Apps

Working with Web App Control Projects

Available API Functions

Sorting
Messages
Profiling
Using URL Parameters

X4 Control Center

Installing the Preconfigured X4 Web Apps

Standard Functionality

Changing the User Interface Language
Logout User
Working with Lists
Working with Diagrams
Displaying Version Information

Parameter Editor (Version 1.1.0)

Adapting Project Parameters

Process Monitor (Version 1.4.3)

Profiling

Displaying Process Instances in the Instance View

Filtering Process Instances
Defining Configurations in the Instance View
Exporting Process Instances

Displaying Processes in the Process View

Displaying the Status Legend
Defining Configurations in the Process View

Displaying Process Steps with Errors in the Error View

Defining Configurations in the Error View
Exporting the Error List

Process Details

Starting a Process Instance
Stopping/Terminating Running Process Instances
Displaying Process Details
Downloading Process Documentation
Displaying Process Steps
Showing Statistics
Showing Savepoints

Displaying the Output of the BAM Logging Adapter

Process Scheduler

Adapting scheduled process executions

Executing processes according to specific Cron patterns
Executing Processes at Server Start
Using the Calendar Overview

3rd Party License Report (Version 1.1.0)

X4 Apps

Adding Projects
Building X4 Apps
Deploying X4 Apps

X4 Data Model

Interface

Toolbar
Context Menu
Perspectives
Views

Working with Data Model Projects

Creating a Data Model Project
Creating Entities
Using a Data Model in an ESB Project
Using a Data Model in an X4 Web App

X4 Plugins

Installing Plugins
Data Objects
SQL Parameter Storage
SQL Profiling 1.0.0

SQL Profiling 2.1.9

SQL Profiling 2.1.9: General Notes on the Versions 1.x.x and 2.1.9
SQL Profiling 2.1.9: Notes on the Data Limit
SQL Profiling 2.1.9: Configuration and Installation
SQL Profiling 2.1.9: Database Table Structure

X4 Update Tool

Starting the Update Tool
Simulation Mode of the Update Tool

Using Liquibase in the Update Tool

Setting Up the X4 Server Database with Liquibase
Executing Liquibase Scripts

Option 1: Performing a Full Update
Option 2: Updating the X4 Server
Option 3: Migrating the X4DB Folder
Option 4: Updating the X4 Database
Option 5: Migrating Custom Placeholders (=Global Parameters)

Breadcrumbs

X4 Adapters
Developing Custom X4 BPMS Adapters (ADK)

On this Page

Adapter Framework Reference

The following components of the X4 ADK are available for adapter development:

Pagination

Previous Page

Developing Custom X4 BPMS Adapters (ADK)
Next Page

General Notes on Adapters

SoftProject GmbH

Copyright SoftProject GmbH
Powered by Scroll Sites & Atlassian Confluence