Simplifier Makers ClubSimplifier Makers Club
  • Docs
  • Knowledge
  • F.A.Q
  • Forum
  • Courses
  • Marketplace
  • Login
  • Try for free
  • German
  • English
  • Try for free
  • Docs
  • Knowledge
  • F.A.Q
  • Forum
  • Courses
  • Marketplace
  • Login
  • Try for free
  • German
  • English
  • Try for free

Current Release

home/Documentation/Current Release
  • Getting Started
    • Basic Concept and Capabilities
      • Interaction
      • Governance
      • Collaboration
      • User Experience
      • Integration
      • Automation
      • Operations
  • App Builder Guide
    • Design
      • OpenUI5, SAPUI5 and Fiori
      • Accessibility
      • Widget Groups
      • Widgets
    • Build
      • Build Workflows
        • Create Workflow
        • Using Conditions
        • Working with Outcomes and Variables
        • Start Workflow within App
        • Using Automated Task
        • Using User Task
        • Using Notification Task
        • Create Custom Task UI
        • Customizing User Task Notifications
        • Run Workflows in parallel
      • Add and Format Data
      • Create Apps via Wizard
        • Login
        • Table with Details
        • Layout
        • Form Assistant
        • Upgrade UI5 Version
        • Database Data Editor
      • Using Keyboard shortcuts
      • Create Apps from Scratch
        • Device Condition
        • Design Apps in Real Time across all devices
        • Create the User Interface
          • Collaboration
          • Manage Screens
          • Design Screen
          • Assets
          • CSS Editor
          • Libraries
          • Theming
        • Access Business Object via Script
      • Add Application Logic
        • Login/Logout into an App
        • Modify the UI at runtime
        • Events
        • Variables and Datatypes
        • Auto-Fields
        • Logic
          • Device Condition
          • Condition
          • Iterate over List of Data Records
          • Custom Scripting
          • Access Business Object via Script
        • Navigate between Screens
        • Data Services
        • Data Object
          • Filters for Connectors
        • Mapping Area
      • Using native mobile Features
        • Contacts API
        • Internal camera application
        • Mobile Actions
        • App Links / Deep Links
        • Offline Usage
          • Offline Storage
          • Offline Events
      • Modularize your Apps
        • Use Modules
        • Interfaces
      • Manage Access
      • Working with Text and Mails
        • Dynamic Text
        • Sending Email
      • Localization
        • Translate Workflows
        • Import/Export Workflow Translations
        • Translate Applications
      • Run Application
        • Run in Browser
    • Integrate
      • Integrate into SAP
      • Connectors
        • Login Methods
          • Username or -alias
          • Single-Sign-On with oAuth 2.0 Bearer Token
          • Certificates
          • Token
          • Username/Password
          • SAP Logon
        • Create and Manage Connectors
        • Websocket Communication
          • Token Generation
          • Websocket Generation
          • Websocket API Documentation (Incomplete)
          • Request Types (Asynchronous Connectors)
          • Token, Websocket and Request Sending Example
          • Asynchronous Connector Request Json Examples
            • OPC-UA Monitoring Requests
            • OPC-UA Monitoring Requests Examples
        • Create and manage connector calls
          • Connector Call Specific Parameters
          • Copy Connector Calls
          • Test a Connector Call
        • SOAP Connector
          • SOAP Connector Calls
        • REST Connector
          • REST Connector Calls
          • REST Connector Call Query Parameters
          • REST Connector Call Header Parameters
        • OData V2 Connector
          • OData V2 Connector Calls
        • SAP RFC Connector
          • SAP RFC Quickstart
          • SAP RFC Connector Calls
            • Create SAP RFC Calls manually
        • SQL Connector
          • SQL Connector Calls
          • Up-Download of SQLite Databases
        • MQTT Connector
        • OPC UA Connector
          • OPC UA Connector Calls
            • READ Call - OPC UA Connector
            • WRITE Call - OPC UA Connector
            • BROWSE Call - OPC UA Connector
            • SUBSCRIBE Call - OPC UA Connector
        • CSV Connector
          • CSV Connector Calls
        • Email Connector
          • Email Connector Call
        • Push Notification Connector
          • Assign Roles
          • Send message via Process Dashboard
          • Receive message via Process Dashboard
          • Push Notification Connector Calls
        • Proxy Connector
        • Simplifier SAP
          • SAP ERP6 Business Partner
          • SAP ERP6 Object Status
          • SAP ERP6 Status Profile
          • SAP ERP6 ArchiveLink
          • SAP ERP6 Generic Object Services
          • SAP ERP6 Object Classification
          • SAP ERP6 Text
          • SAP ERP6 Partner Schema
          • SAP ERP6 Document (DIS/DRAW)
          • SAP ERP6 Change Document
          • SAP ERP6 Material
          • SAP ERP6 User
          • SAP SD Sales Order
          • SAP SD Customer
          • SAP SD Customer Quotation
          • SAP SD Vendor
          • SAP SD Billing Document
          • SAP IS-U Connection Object
          • SAP IS-U Business Partner
          • SAP ISU Premise
          • SAP ISU Device Location
          • SAP ISU Meter Reading Order
          • SAP ISU Installation
          • SAP ISU Meter
          • SAP ISU Owner Allocation
          • SAP ISU Point of Delivery
          • SAP ISU Service Order
          • SAP ISU Street
          • SAP ITIZ Handler
          • SAP IS-U Account
          • SAP IS-U Contract
          • SAP ITIZ SDSH
          • SAP ITIZ Key Value
          • SAP ITIZ UI5
          • SAP ITIZ DB Table
          • SAP MM Service Master
          • SAP MM Purchase Order
          • SAP MM Entry Sheet
          • SAP MM Goods Movement
          • SAP MM Purchase Requisition
          • SAP PM Equipment
          • SAP PM Functional Location
          • SAP PM Measurement Point
          • SAP PM Maintenance Notification
          • SAP PM Service Notification
          • SAP PM Service Order
          • SAP PM Maintenance Order Confirmation
          • SAP PP Material BOM
          • SAP PP Production Order Confirmation
          • SAP PP Production Order
          • SAP WM Transfer Order
          • SAP HR Personal Time Management
          • SAP HR Time Sheet
          • SAP QM Quality Notification
      • Code Designer
      • Business Objects
        • Create server-side Business Objects
          • Server-Side Business Object API
          • Server-Side - Access Connectors
          • Server-Side - Access other Business Objects
          • Server-Side - Access Plugins
          • Changes in Business Objects with Release 8 EHP 1
          • Convert XML to/from JSON
          • Encode/Decode Base64
          • Extended Functionality
        • Create client-side Business Object
          • Client-Side Business Object API
          • Client-Side - Access Connectors
          • Client-Side - Access Plugins
          • Client-Side - Access other Business Objects
        • Create and Manage Functions
          • Test Business Object Functions
          • Versioning of Business Objects
      • Data Types
        • Domain Type
        • Struct Type
        • Collection Type
        • Copy Data Types
      • Database Designer
        • Schema Overview
        • Data Editor
        • Create/Modify Schema
        • Import existing Database
        • Deploy Schema
      • SAP Systems
      • Jobs
    • Debugging
      • Debugging on Browser
      • Debugging on Mobile Client iOS
      • Debug Server-Side Business Objects
      • Debugging on Mobile Client Android
    • Test & Secure
      • Automated Testing
      • Automated Testing on mobile
    • Deploy
      • Application Properties and Releases
      • Deploy on Simplifier Runtime
        • Transports
          • Packages
          • Create a Transport
          • Import Manual Transport
          • Release and Transport an Application
      • Simplifier Mobile Client
        • Features
        • Intune
      • Deploy as Standalone Mobile
      • Deploy to SAP onPremise
      • Deploy to SAP BTP
    • Manage
      • Projects
    • Maintain & Optimize
      • Monitoring
        • Monitoring
        • Monitor Workflows
        • Monitoring Sub Workflows
        • Statistics
        • Logs
          • Filter
          • User-Log
          • Execution Log
    • Extend
      • Create custom App Wizards
      • Create Widget Groups
      • Create custom Widgets
        • Single Widget
          • Enumeration in Widget Properties
        • Widget Categories
      • System Libraries
      • Simplifier Client API
      • Integrate external Libraries
        • Add a new Library
          • Integration of Libraries - addScript
          • Integration of Libraries - addStyle
          • Integration of Libraries - addBeforeInitHandler
          • Integration of Libraries - addAfterInitHandler
      • Workflow API
      • Simplifier App Wizard API
      • Plugins
        • Overview
        • List of Plugins
          • PDF Plugin
            • Installation PDF Plugin
            • Build a PDF Template
            • Technical call of a PDF Plugin
              • Delete a PDF Template
              • Start PDF Generation
              • List your PDF Templates
              • Fetch a PDF Template
              • Edit a PDF Template
              • Add a PDF Template
            • Typical Use-Case PDF Plugin
          • Content Repository
            • Content Files
          • keyValueStore / JSON Store Plugin
        • Plugins via Script
        • Plugin development
        • Anonymous Profile for Plugins
        • Plugin Secrets
  • End User Guide
    • Mobile Client
      • Login
      • Using Apps
      • Handling User Task mobile
      • Adjust Mobile Settings
      • Report Errors
    • Launchpad
      • Handling Tasks
      • Update your Profile
  • Operator Guide
    • Operation Model (PMT)
      • People
      • Method
        • Preparation - Sprint 0
        • Implementation - Sprint 1 - x
    • Roles and Rights
      • Overview
      • Global Roles
      • Project Roles
      • Business Roles
      • Best Practices with Projects
      • Permission Overview
        • Workflow Permission
    • Automation
      • Automate Transport
    • Support
      • Support Requirements
      • Your contact within Simplifier
      • Manage your Simplifier MyID and support users
      • How to login to our support portal
  • Administrator Guide
    • Release Cycle
    • Feature Lifecycle
    • Launchpad Settings
    • Requirements and Instructions
      • Server Requirements
      • Client Requirements
      • Firewall Requirements
      • Reverse Proxy Requirements
        • Testing WebSocket Connection through Reverse Proxy
      • Additional Requirements for Oracle Databases as Backend
      • Additional Requirements for MySQL Databases as Backend
      • Validate CORS Header
      • Validate I/O Storage Performance
    • Installation
      • Docker Security Runtime
      • Checklist - Simplifier Installation
      • Cluster Mode
      • Docker Image Configuration
      • Configure Proxy Settings
      • On Premise
        • General Requirements for On-Premise-Installations
        • Installing Simplifier MAKERS CHOICE
        • Installing Simplifier LTS
        • Oracle Database Setup
        • Setting up custom certificates for transport system
      • AWS
        • Install via AWS Marketplace
        • High Availability and High Performance Cluster (Horizontal Scaling)
      • Azure
        • Install via Azure Marketplace
      • Simplifier Cloud
        • Simplifier Cloud SLA
          • Simplifier Cloud SLA 1.2
          • Simplifier Cloud SLA 1.1
        • Checklist - Your System Integration
        • Cloud Security
        • Operation Models
          • Hosting Models until 25-03-31
          • Hosting Models until 23-05-01
        • Cloud FAQ
        • Data Centers of Simplifier Cloud
        • Backups
        • ISO Certificates and Audits
      • SAP BTP
    • Quality Update
      • Update via docker compose
      • Automatic Update
    • Upgrade to next MAKERS CHOICE or LTS
      • Upgrade from MC 25-03 to MC 25-05
      • Upgrade from Release 9 to MC 25-05
      • Upgrade from Release 8 to Simplifier 9 LTS
      • Upgrade from Release 8 EHP 4 to Simplifier 9 LTS
    • User Management
      • User Overview - Create a new user
      • Reset Passwords
      • Enable Multi-Factor-Authentication (MFA/2FA)
      • Role Overview
        • Restrict Roles Assignment
      • Group Overview
      • QR Login-Generator
      • Permissions
        • Permission Overview
    • Security
      • Mobile Security
      • Overview
      • Basic Protection of Internet Access
      • Secure Simplifier API
      • Implementation of Web Application Firewalls
      • Operation Best Practice - Public Access
      • Authentication for Web Applications
      • Access Control for Web Applications
      • Secure Session Management
      • Controlled Integration of Data and Content into Web Applications
      • Logging of security-relevant Events of Web Applications
      • Protection against Unauthorized Automated Usage of Web Applications
      • Protection against SQL Injection
      • Security Team (ISIRT)
    • Setup external Identity Provider
      • Using OAuth for authorization on Google
      • SAML and SAP Single Sign-On over SOAP
      • SAP SSO via SNC and Identity Provider
      • Troubleshoot SAP SSO via SNC
      • Setup Principal Propagation for SAP BTP
      • Using OAuth for authorization on Azure / Entra ID
      • Configure SAML Setup with Azure AD / EntraID
      • Using OpenID Connect for authorization in SAP BTP
    • Settings
      • Server Settings
      • Security
      • License
      • Authentication
        • Project Permissions
        • LDAP
        • SAP Single Sign On via SOAP
          • Checklist SAP SSO over SOAP
        • SAP Single Sign On via RFC
        • Active Directory
        • Open Authorization (OAuth)
          • Using OAuth for authorization on Amazon
        • Security Assertion Markup Language (SAML)
          • Using SAML with Google - G Suite
          • Using SAML with Microsoft ADFS
        • User Details Mapping
        • User Attributes Synchronization
        • User Roles Synchronization
        • Test Authentication
      • Messages
      • Log
      • Server Environment
      • SAP Security
      • New Features
      • Workflow Monitoring
      • Native Settings (include.conf)
    • Archiving
      • Archiving Workflow Logs
  • Release Notes
    • Release Notes MAKERS CHOICE 25-05
    • Pre-Release Notes 10
    • Release Notes 9
    • Release Notes Mobile Client
    • Archive MAKERS CHOICE
      • Release Notes MAKERS CHOICE 25-03
      • Release Notes MAKERS CHOICE 25-01
      • Release Notes MAKERS CHOICE 24-11
      • Release 8 Enhancement Package 4 (EHP4)
      • Release 8 Enhancement Package 3 (EHP3)
      • Release 8 Enhancement Package 2 (EHP2)
      • Release 8 Enhancement Package 1 (EHP1)
    • Archive Long Term Support
      • Release Notes 8
      • Release 7 Enhancement Package 1 (EHP1)
      • Release Notes 7.0
      • Release Notes 6.5
      • Release Notes 6.0
      • Release Notes 5.5
      • Release Notes 5.0
      • Release Notes 4.5
      • Release Notes 4.0
      • Release Notes 3.5
      • Release Notes 3.0
      • Release Notes 2.5
      • Release Notes 2.0

Upgrade from Release 8 to Simplifier 9 LTS

501 views 0

Introduction

This documentation is divided into 2 parts:

  • Part 1 describes the actual update of the containers and comes in two options
    • Option 1 in case you use our recommended docker compose setup.
    • Option 2 in case you have a custom setup. It describes the relevant changes that come with Simplifier 9 in a generic way.
  • Part 2 describes steps which have to be done independently of the container orchestration mode.

Make sure you read our Release Notes and Migration Notes for Simplifier 9 before you start upgrading your instance.

Part 1: Upgrading Simplifier

Option 1: Upgrade using default docker compose

Step 1 – Shutdown Simplifier Instance

Go to the directory where you placed the docker-compose file. Switch into that folder:

cd docker-compose

To stop Simplifier, run

docker compose -f simplifier-standalone.yml down

Step 2 – Get Simplifier setup files

Update the content and switch to the new release branch:

git pull
git checkout --track origin/release/LTS

The filename simplifier-standalone.yml was changed to docker-compose.yml to comply to the docker standards. You now can omit the -f <filename> parameter to execute docker compose commands.

Step 3 Update .env

Make a copy of your .env file

cp .env .env.8.0

Copy the template as new .env

cp .env.template .env

Edit the new .env file

nano .env

It is mandatory that you adjust the first 3 entries to your needs:

# these 3 variables need to be changed
SIMPLIFIER_HOSTNAME=example.simplifier.cloud
DB_PASSWORD=MySecret123
DB_ROOT_PASSWORD=MySuperSecret

Set these three values to the same ones you used in your previous .env file. DB passwords are not automatically changed if you change it here.

Optional: a list of all env variables with a short description. Change these as needed.

 

SIMPLIFIER_HOSTNAME
Simplifier Hostname, FQDN, without protocoll. To access Simplifer, https://${SIMPLIFIER_HOSTNAME} needs to be used
DB_PASSWORD
MySQL Database Password
DB_ROOT_PASSWORD
Password for the MySQL root user
DB_NAME
Database name for the Simplifier database. Used as prefix for all plugin/module databases.
SIMPLIFIER_VERSION
Version of Simplifier you want to install. You should not change this. If you want to have another Simplifier version, please check out the appropriate branch instead
HOST_DATA_PATH
Path were all data is stored in the host.
PLUGINLIST
List of all plugins which should be started. Technically, the Workflow Engine is not a plugin, so it is not mentioned here
SIMPLIFIER_JVM_HEAP_GB
How much heap space for Simplier App Server in GB
TZ
Timezone. Only used in Workflow Context
WF_RT_JVM_HEAP_GB
How much heap space for Workflow Runtime in GB
WF_ARCHIVE_ENABLED
For archive related settings, please refer to this documentation.
WF_ARCHIVE_INTERVAL
WF_ARCHIVE_MAX_AGE_COMPLETED
WF_ARCHIVE_TIME
WF_DT_JVM_HEAP_GB
How much heap space for Workflow Designtime in GB
LAUNCHPAD_JVM_HEAP_GB
How much heap space for Launchpad in GB
FEATURE_SSBO_JS_DEBUGGING
Should the experimental feature “Debugging of Server Side Business Objects” be enabled? (Read more)
DEBUG_CHROME_DEV_TOOLS_EXPOSED_PORT
Port used to connect to the debugger. This port needs to be open in your firewall setup. (Read more)
PDFPLUGIN_SECURITY_ALLOW_JAVASCRIPT
Should Javascript execution be allowed in PDF templates? (Read more)
DYNAMIC_TAB_TITLES_ENABLED
Should the experimental feature ‘dynamic tab icons and tab titles’ be activated? (Read more)

Step 4 – renaming data folder

Up to release 7, there was only one storage folder called data. With Release 7 EHP 1 und Release 8, new container images were added with their own persistant storage. Out of historic reason, the folder for simplifier was still called data in our default setup, but the other folders were named accoring to the names of the containers. To have a consistent naming, our default setup now uses simplifier as folder name for the simplifier container. To match this, you should rename the existing folder. If you used the recommended folder structure, you need to do:

mv /var/lib/simplifier/data /var/lib/simplifier/simplifier

Step 5 – Creating shared folder

A new folder is necessary, which acts as a shared volume.

mkdir /var/lib/simplifier/shared

Remark

Since release 8 EHP 2, monitoring data is moved to a separate database. In the default setup, the same MySQL server is used and automatically configured.

Option 2: Generic upgrade instructions, if you are not using our default docker compose setup

Step 1 – Configure monitoring database

Since release 8 EHP 2, monitoring data is moved to a separate database. This database must be a MySQL database and it may be on the same MySQL server as the main simplifier database, but also may reside on a different MySQL server. In either case, the connection has to be configured separatly.

To configure this database, the following environtment variables have to be set:

- MONITORING_DBMS=mysql // fixed string
- MONITORING_DB_HOST=<hostname>
- MONITORING_DB_PORT=<port> // by default MySQL uses 3306
- MONITORING_DB_USER=<dbUserName>
- MONITORING_DB_PASS=<password>
- MONITORING_DB=<databaseName>

The database has to be present on the configured MySQL server.

Step 2 – update reverse Proxy

Expand header access-control-expose-headers configuration

OData-Version needs to be added to access-control-expose-headers. The complete list is now

access-control-expose-headers: remainingTokenLifetime,OData-Version
Expand header access-control-allow-headers configuration

OData-MaxVersion, OData-Version have to be added to access-control-allow-headers. The complete list is now

access-control-allow-headers: DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization,SimplifierToken,SimplifierApp,SimplifierModule,SimplifierModuleInterface,SimplifierClientBusinessObject,SimplifierClientBusinessObjectFunction,sap-cancel-on-close,sap-contextid-accept,MaxDataServiceVersion,DataServiceVersion,Content-Length,SimplifierApiKey,OData-MaxVersion,OData-Version,MIME-Version,X-CSRF-Token

Step 3 – create shared folder

A new folder is necessary, which acts as a shared volume. E.g. you can create /var/lib/simplifier/shared:

mkdir /var/lib/simplifier/shared

You have to mount this path to the simplifier container and to the workflow designtime container.

For the Simplifier container:

/var/lib/simplifier/shared:/opt/simplifier/shared

For the workflow designtime container:

/var/lib/simplifier/shared:/home/workflowDesigntime/shared

You can change /var/lib/simplifier/shared to whatever folder you prefer. You must leave the mount targets /opt/simplifier/shared and /home/workflowDesigntime/shared unchanged!

Part 2: Doings after upgrade

Step 1: Recreate keystores (optional)

Recreating keystores is only necessary, if you are using a custom keystore in your current setup. If you did not implement this, you can skip this step.

With Simplifier Release 8 EHP 1, the JVM version changed. Because of this, the keystore format changed, as well as the correct location for the keystore.

To edit the keystore, please always use keytool from within the container. The path to keytool is

/usr/lib/jvm/graalvm-community-openjdk-20.0.1+9.1/bin/keytool

The path of the cacerts file is

/usr/lib/jvm/graalvm-community-openjdk-20.0.1+9.1/lib/security/cacerts

Step 2: Update Simplifier Standard Content

Download the latest Standard Content from Marketplace and import it to your Simplifier Instance. Make sure using import scenarios ‘Overwrite all’ or ‘Skip unchanged’ (recommended).

Step 3: Implement Changes mentioned in Release and Migration Notes

Follow our Release Notes and Migration Notes and implement the necessary changes described there.

Tags:upgradeinstructions
Related Articles
  • Release Cycle
  • Release Notes 9
  • Release Notes MAKERS CHOICE 25-03
  • Pre-Release Notes 10
  • Form Assistant
  • Translate Workflows
Previous
Upgrade from Release 9 to MC 25-05
Next
Upgrade from Release 8 EHP 4 to Simplifier 9 LTS

Insert/edit link

Enter the destination URL

Or link to existing content

    No search term specified. Showing recent items. Search or use up and down arrow keys to select an item.