Designer Examples Overview

ActionScript_ArrayOperations_Example

This example shows some basic Action Script operations for array handling.

• apply Statement

• concatArrays() Operation

• reduce Statement

• select Statement

• sort Statement

Refer to Array Operations pp. for more information on array handling in general.

ActionScript_Calculations_Example

This example shows some basic arithmetics that can be performed in Action Script with Integer, Float and and DateTime operands.

Refer to Arithmetic Operations for more information on Action Script arithmetics.
For more general information on the usage of Action Script, refer to Action Script Language.

ActionScript_TimeConversions_Example

This example shows some basic Action Script operations for DateTime handling.

Refer to DateTime Operations or DateTime Functions in the Designer Guide for more information.
For more general information on the usage of Action Script, refer to Action Script Language.

ActionScript_TypeConversions_Example

This example shows some Action Script operations for converting types. The following types are covered:

• Float

• Integer

• Boolean

Click the links in the above list to read more about the conversion operations.
For more general information on the usage of Action Script, refer to Action Script Language.

Activity_Decision_Example

This example shows how to use decisions in activity diagrams.
The user can enter a positive number. The process will then return a message depending on if the number is smaller or greater than 10 and divisible by 4.

Refer to Adding a Decision in the Designer Guide for more information on the topic.
For more information on activity diagrams, refer to chapter Drawing an Activity Diagram.

Activity_Loop_Example

This example shows how to use loops in activity diagrams. The user can enter a number of iterations. The service will then run a loop the specified number of times and display the result.

Refer to Implementing a Loop for more information on the topic.
For more information on activity diagrams, refer to chapter Drawing an Activity Diagram.

FilesystemAdapter_ProductExport_Example

This example shows how to use the Filesystem adapter to write and read files to and from the filesystem in service context.

The service implements a simple product list where products to be exported can be selected. The selected data is written to a file in the filesystem (tmp/Export) in the service folder. The Export directory is created on start event.
In the next process step, the exported data is read from filesystem and displayed to the user.

The example service shows the following actions of the Filesystem adapter:

• create a directory in the filesystem

• append data to a file in the filesystem

• read data from a file in the filesystem

• read the status information of a directory and a file from the filesystem

Chapter Filesystem Adapter explains in detail all options of the Filesystem adapter.

JSONAdapter_Example

This example shows how to handle JSON documents.

Refer to classToJSON() Operation in the Designer Guide for details.

S3Adapter_ProductExport_Example

This example shows how to use the s3 adapter to write and read files to and from an S3 bucket.

The service implements a simple product list where products to be exported can be selected. The selected data is converted to JSON and saved to an S3 bucket.
In the next process step, the export data is read back from the bucket and displayed to the user afterwards.

The example service shows the following actions of the S3 adapter:

• createBucket: Create a new bucket

• putObject: Save an object to a bucket

• getObject: Read an object from a bucket

Chapter S3 Adapter explains in detail all options of the Filesystem adapter.

MongoDBAdapter_CustomerData_Example

This example implements a simple customer data management. It shows how to use the MongoDB adapter to access data from a MongoDB:

• how to insert documents to a database

• how to read and update data from a data table

• how to update parts of a document with an update string

• how to delete documents from the database

• how to aggregate data using an aggregation pipeline

• how to find documents using a regular expression.

Refer to MongoDB Adapter for more information.

SQLAdapter_CustomerData_Example

This example implements a simple customer data management. It shows how to use the SQL adapter to access data from a SQL database, in particular:

• how to create a table

• how to insert records into a table

• how to update records

• how to delete records from a table

• how to aggregate data using an aggregation function

Refer to SQL Adapter for more information.

FlatFileAdapter_Hierarchic_Example

This example shows how to use the Flat File adapter to compose data to a hierarchic flat file structure.

The service initializes a list of orders which is composed to a flat file and displayed to the user.
The flat file is composed as a hierarchic structure that gives general information about the order, as well as details about the stock of the ordered items.

Chapter Flat File Adapter explains in detail all options of the Flat File adapter.

FlatFileAdapter_ProductExport_Example

This example shows how to use the Flat File adapter to parse or compose data from or to a flat file structure.

The service implements a simple product list where products to be exported can be selected. The selected data is composed to a flat file. In the next process step, the exported data is parsed back to a data structure and displayed to the user.

The example service shows the following actions of the Flat File adapter:  

• compose a flat file from a data structure

• parse a flat file to a data structure

• handle header lines in the flat file

• automatic numbering of flat file records

Chapter Flat File Adapter explains in detail all options of the Flat File adapter.

FlatFileAdapter_Quotes_Example

This example shows how to use the Flat File adapter to compose data to a flat file structure showing strings in quotes.

The service initializes a list of customer data which is composed to a flat file and displayed to the user. The flat file includes a header and has the layout of a CSV file with records being separated by commas.
The service shows how you can set the quote character of a flat file so that all strings in the file are automatically enclosed in quotation marks.

Chapter Flat File Adapter explains in detail all options of the Flat File Adapter.

MemoryAdapter_GuessingGame_Example

This example implements a guessing game. It shows

• how to use the Memory adapter to store, retrieve and remove data to/from memory

• how to use different start events to trigger the same process

Chapter Memory Adapter explains in detail all options of the Memory adapter.
For details about the different start events, refer to Modeling Process Start.

MemoryAdapter_HashMap_Example

This example shows how to handle hash maps with the Memory adapter. It implements a small product management, where products are stored in a hash map in memory.

The example shows how you can

• create a hash map from given data

• store a hash map to memory

• retrieve a single value from a hash map

• store a single value to a hash map

• remove a single value from a hash map

• remove a complete hash map from memory

• clear the memory

For more information on this topic refer to Using the Memory Adapter with Maps in the Designer Guide. Chapter Memory Adapter in the explains in detail all options of the Memory adapter.

RESTAdapter_BlobContent_Example
RESTAPI_BlobContent_Example

The RESTAdapter_BlobContent_Example shows how to access an API with blob content.

Important Note

The RESTAPI_BlobContent_Example needs to be deployed and running to make test calls.

The RESTAPI_BlobContent_Example implements an API that  

• receives pictures, stores them to memory and returns an ID (POST)

• returns the stored pictures for a provided ID (GET)

Together, these examples show how to handle blob content for POST and GET requests.

You can  

• send a picture to the REST service to be stored and get an ID

• request a picture via its ID

Chapter REST API explains how REST concepts are implemented to Designer services.
Refer to REST Adapter for more information about the REST adapter.

RESTAdapter_CallProcessWithRoles_Example

This example shows how to use the REST adapter to trigger a subprocess from a parent process with special consideration of authorization if the subprocess has lanes.

Refer to REST Adapter for more information about the different options of the REST adapter.
For more information on role usage, refer to Role-based Authorization Concept and Running Role-based Applications.

RESTAdapter_SupportManager_Example
RESTAPI_SupportManager_Example

The RESTAdapter_SupportManager_Example implements a simple support manager. It shows

• how to use the REST adapter to access a divergent service

• how to implement a class operation with an activity diagram

• how to loop over selected items from a table and perform some action

Important Note

The RESTAPI_SupportManager_Example needs to be deployed and running to make test calls.

The RESTAPI_SupportManager_Example implements a REST service to handle support cases that are stored to a MongoDB. It contains neither forms nor a process.  

It shows how to

• how to define a REST API

• how to implement REST methods and parameters

• how to return errors

• and more.

For easy try-out: Either use it with the RESTAdapter_SupportManager_Example or deploy it to an API Management organization, and use the test UI to make calls to the API.

Refer to REST Adapter for more information about the different options of the REST adapter.
Chapter REST API explains how REST concepts are implemented to Designer services.
For more information on activity diagrams, refer to chapter Drawing an Activity Diagram.

SAPAdapter_RFC_Example

This example connects to the SAP system that has been configured in the SAP alias, and reads the system information via an RFC call to an SAP ABAP function (RFC_SYSTEM_INFO).

Refer to SAP Adapter in the Designer Guide for more details.

SAPAdapter_SingleIDoc_Example

This example shows how to process an IDOC from an IDoc string to an IDoc structure.

Refer to SAP Adapter in the Designer Guide for more details.

UrlAdapter_AccessFile_Example

This example shows how you can access resources with the URL adapter. It uses a GET request to access a JSON address file stored in the Scheer PAS Documentation. The contents of the file are then displayed in a form.

Refer to URL Adapter for more information on what you can do with the URL adapter.

UrlAdapter_Example

This example shows how to use the URL adapter with the HTTP protocol to make requests to web resources.

It contains two processes which show

• how to make a static GET request and

• how to make a dynamic GET request.

Refer to URL Adapter for more information on what you can do with the URL adapter.

AIAgent_InsuranceCase_Example

This example shows how to use an AI agent to process unstructured data.

Important Note

• The AI Agent feature is only available on Kubernetes.

• To execute this example, you need an API key from OpenAI. This key must be configured in the OpenAI alias.

Refer to the Designer Guide for more details about AI agents and what you can do with them.

OpenAI_Video_Example

The example shows how to use the OpenAI Library and the OpenAI endpoints: Audio transcription, chat completion and image generation.

BPMN_EndEvent_Example

This example shows the usage of End Events. Look at the xUML service logs to follow the process flow.

Refer to End Event in the Designer Guide for details about the configuration options of this BPMN element.
Refer to Modeling Process End for more information on the usage of the end event.

BPMN_Event_Example

This examples shows the usage of Events.

Start a process instance - you will be guided through the process execution.

Refer to Plain Event and Message Event for more information on this topic.

BPMN_Gateway_Example

This example shows the usage of Gateways. The forms guide you through the process flow of the exclusive gateway. To see the process flow of the parallel gateway, look at the xUML service logs.

Refer to Exclusive Gateway and Parallel Gateway for details about the configuration options of these BPMN elements.
Refer to Modeling Decisions for more information on the usage of gateways.

BPMN_ReceiveTask_Example

This example shows the usage of a Receive Task. Start a process instance - you will be guided through the process execution.

Refer to Receive Task for details about the configuration options of this BPMN element.
Refer to Modeling Tasks and Modeling Message Reception for more information on the usage of the receive task element.

BPMN_ServiceTask_Example

This example shows the usage of a Service Task element.

Refer to Service Task for an overview on all configuration options of the Service Task element.
For more details on the usage of task elements, refer to Modeling Tasks.

BPMN_StartEvent_Example

This example shows the usage of the different Start Events. Look at the xUML service logs to see the process flow.

Refer to Start Event, Message Start Event and Timer Start Event for details about the configuration options of these BPMN elements.
Refer to Modeling Process Start for more information on the usage of start events.
Refer to Modeling Message Reception for details about the usage of the message start event.

BPMN_TimerEvent_Example

This example shows the usage of Boundary and Intermediate Timer Events. The forms guide you through the process flows of the two different timer events. Alternatively, you can also look at the xUML service to see the process flows.

Refer to Timer Event for details about the configuration options of this BPMN element.

BPMN_UserTask_Example

This example shows the usage of User Tasks. The service implements the transmission of a short message the user can enter, which is then shown in the service logs.

Refer to User Task for details about the configuration options of this BPMN element.
Refer to Modeling Tasks for more information on the usage of tasks.

Polymorphism_ArticleSerialization_Example

This example shows how polymorphism can be implemented in the Designer. The PAS documentation explains the example in detail.

Refer to Custom Complex Types pp., Polymorphism in particular, for more information.

Transformation_VerifyAddress_Example

This example shows how to transform data on an object flow via the Get attribute.

The service implements a simple customer address verification. The user can enter a customer ID and an address and the service then checks if the entered address matches the address that is saved for that customer.

XML_Serialization_Example

This example shows how you can control the serialization of data structures to XML with a set of dedicated stereotypes, e.g.  

• how to set an external name for an XML element (Serialize With External Name)

• how to handle nillable properties (Serialize Nillable Element)

• how to order the XML elements (Serialize With Ordered Elements)

• how to handle mixed content (Serialize Mixed Content)

• how to handle arrays (Serialize Branches Array)

Chapter XML Serialization explains in detail how you can control the serialization process, and provides a comprehensive list of available stereotypes and their related attributes.

ArrayMapping_Condition_Example

This mapping example shows how you can extract data out of an input array using a condition as an index to access a dedicated array element.

The process shows employee data entered into a form and then extracts the employee addresses as an array. From this array of addresses, only the private address is selected via a conditional mapping and then shown to the user.

Refer to Supported Mapping Functions for more information on this topic.

ArrayMapping_Foreach_Example

This mapping example shows how to map array content for each array element to a target array.

Refer to Array Mapping for more information on this topic.

ArrayMapping_Simple_Example

This example shows a simple array mapping with the Designer.

Refer to Supported Mapping Functions for more information on this topic.

DataMapping_Simple_Example

This example shows two different implementations of the same mapping:  

• a simple data mapping between address objects and sub objects

• the same mapping using a sub-diagram and mapEqualNames

Refer to Supported Mapping Functions for more information on this topic.

Form_CSS_Example

This example shows how to apply custom CSS to forms and form elements in the Designer.

Important Note

To be able to execute this example, you need to upload the sample CSS file example-ccs-acme.css as a resource to the File Manager. You can download the CSS file here. Refer to Managing File Resources for more information on how to upload the file.

Refer to Styling Form Elements for more information on the topic of how to apply custom CSS to forms.

Form_CustomDirective_Example

This example shows how to add Angular directives to a form element. It uses the custom directive "textareaAdjust" to resize a text area in a form in relation to its content.

Refer to Developing Custom Directives for more information about custom directives.

Form_DataTransfer_Example

This example shows how to transfer form data from one form to another.

For more information on this topic refer to Using Forms.

Form_DefaultValue_Example

This example shows how default values on form elements can be set dynamically.

For more information on this topic refer to Using Forms.

Form_InitialDataLoading_Checkbox_Example

This example shows how to dynamically load data into the checkbox form element during initialization.

Refer to Setting Form Elements Dynamically for more information on initial data loading and a list of form elements and attributes for which initial data loading is available in the Designer.

Form_Simple_Example

This example is a simple form example that shows all kinds of elements and how they can be configured.

• all elements plain

• all elements mandatory

• all elements read only

• all elements with default values

For more information on this topic refer to Supported Form Elements.

Form_SimpleSubform_Example

This example shows how to use subforms to add the same content to multiple forms.

Refer to Subform for details about the configuration options of this form element.
Refer to Subform Handling for more information on the usage of subforms.

DataTable_ClickAction_Example

This example shows the click action on data table rows.

Refer to Data Table for details about the configuration options of this form element.
Refer to Data Table Handling for more information on what you can do with data tables.

DataTable_Simple_Example

This example shows a simple data table with initialization of a table row.

Refer to Data Table for details about the form element and its configuration options.
Refer to Data Table Handling for more information on data table usage.

JavaScript_PasswordGeneration_Example

This example shows how to use JavaScript operations in the Designer.

It implements a password generator that will return a password to the user's specifications.

JavaScript_Session_Example

This example shows how to use the session object in a Designer service. This object resides in the globalThis of JavaScript. The example is twofold:

1. The example service contains a REST API. Only the REST operation postAndGet implements the correct way of how to use the session object: store and read in the same call.

2. The example service contains two processes depicting the good and bad way to handle the session object. Only user task Show value (good case) implements the correct way of how to use the session object: store and read in the same BPMN task.

Refer to Data Exchange Between JavaScript Calls for a more detailed explanation.

CustomerAddress_Lib

UseLib_CustomerData_Example

This library is part of the Scheer PAS Designer example series, and provides types and operations for a simple customer address handling.

The functionality of the library can be tested with a simple test process, e.g. the UseLib_CustomerData_Example:

This example shows how to use a Designer library (CustomerAddress_Lib) in a service.

JavaLibrary_HelloWorld_Example

This example shows the usage of a Java library that has been compiled into an xUML library (xlib).

Spoiler

There is no difference to using an xUML library that has been created with the Designer.

Refer to Developing Designer Libraries Using Java for more information.

JavaLibrary_HTTPServer_Example

This example implements a simple HTTP server. It shows how to implement Java callbacks from a Java library that has been compiled into an xUML library (xlib).

The HTTP server replies to

• GET .../hello

• GET .../goodbye

• POST .../hello

• POST .../goodbye

To be able to access the HTTP server, you need to setup a route in API Management after service deployment. The route must point to http://javalibrary-httpserver-example:11112 if you are using the default service name and port.

Refer to Developing Designer Libraries Using Java pp. for more information on Java libraries and Java callbacks.

Idea_Management_Example

This example implements a simple idea management process.

It shows how to manage different employee roles using lanes, and how to propagate data between forms and the process.

Refer to the Scheer PAS documentation for more information:

• To Using Forms for more details on form handling.

• To Role-based Authorization Concept for more information on role handling with lanes.

• To Running Designer Applications for more details on application execution.

Instance_List_Example

This example shows how you can add custom values to the instance list. The process shows a simple complaint management process, where a user can enter a complaint as well as the customer name, the concerned product and the complaint status into a form.

The process will then transfer these values to the instance list and a second form will be shown for the user to check the entered complaint.

Take a look at the instance table to see the custom values displayed.

On Configuring the Instance List you can find more information on this topic.

ParallelTasks_Onboarding_Example

This example implements a simple onboarding process with parallel tasks.
It shows how the parallel execution of user tasks with different roles is implemented using lanes.

Refer to the Scheer PAS documentation for more information:

• To Modeling Decisions for more information on parallel gateways.

• To Role-based Authorization Concept for more information on role handling with lanes.

• To Running Designer Applications for more details on application execution.

PersistentState_Query_Example
Simple_Order_Service

The PersistentState_Query_Example shows how to access data from BPMN process instances from another service.

You can access another service in two ways:

• by querying the xUML runtime API for persistent state objects or

• by using the REST API service interface.

Important Note

This example accesses instances of the Simple_Order_Service, filters them by their attribute values and displays the instances in a table.

To run this example, you first have to deploy the Simple_Order_Service, start some instances and proceed them until the second form appears.

This is to have data to query from this service.

Refer to xUML Runtime API and xUML Runtime API Reference in the Administration Guide for more information on the xUML runtime API.

Read_User_Data_Example

This example shows how you can access the user details from the logged-in user from a Designer service.

The process reads the user data and displays the user's name, id, company and email in a form.

SettingExtension_Example

This example shows how to implement custom service settings.

• The defined default values are read from the service configuration and displayed in a form.

• The user can change the settings in the PAS Administration.

• The new values are displayed in the form upon reload.

Refer to Class Properties > Using Properties to Configure a Service in the Designer Guide for more information on settings.

The best practice page How to Define Custom Service Settings in a Designer Service explains the necessary steps to define your own custom service settings.

Depending on your setup, refer to Adapting the Configuration of Containerized xUML Services for Docker or Kubernetes in the Administration Guide for more information on how to change the configuration of an xUML service.