Designer Best Practices

This page provides an overview of Scheer PAS best practice topics. Find here links to practical how‑to guides and example scenarios that help you apply Scheer PAS efficiently in your daily work. Use these topics as a starting point to design, implement, and operate your solutions based on proven approaches.

Project Setup

This chapter on best practices for project setup focuses on the question: How do I develop services that are useful and maintainable? It summarizes our best practices for planning integration projects, structuring your designer models, and preparing services for long-term operation.

  • Starting an Integration project

    Before you start with the actual implementation of your integration project, it is worth making some preliminary considerations. In this article, we share our many years of project experience with you and give some tips for sensible project planning.

  • PAS Modeling Guidelines

    Our modeling guidelines help you to better organize, develop, and document your Designer project.

    • Project Organization

      Learn more about how to set up a change-friendly, clear project organization.

      • Versioning of Services

        Versioning is an important topic to consider when you develop services in the Designer. This article describes our recommendations.

    • Naming Conventions

      Learn more about our recommendations for useful naming conventions and how to manage the content of your Implementation folder in the Designer.

    • Project Documentation

      Get to know why comprehensible documentation is important in a project - and how to document in Designer projects.

    • Settings

      Read more about our recommendations on how to use your own service settings in your model.

    • Mappings

      Get to know the advantages and disadvantages of the two different data mapping options in the Designer: graphical mapping and script mapping.

    • Logging

      In this article, we give an overview on the differences between the service log and the transaction log - with useful hints on how to integrate logging in your own services.

    • Error Handling

      In this article we explain the integrated error handling of the generated root state machine - with useful hints for the error handling in your own services.

Development Fundamentals

The pages in this chapter focus on the question: What techniques are available to me for development in the Scheer PAS environment? The information is designed to help you structure reusable logic, keep your solutions consistent and maintainable, and choose the most appropriate technology for each task.

  • Library Development

    This article contains a number of recommendations that you should consider when developing your own libraries for use in Scheer PAS Designer.

    • Versioning of Libraries

      Versioning is an important topic to consider when you develop your own libraries in the Designer. This article describes our recommendations.

Development Process

This best practices chapter provides guidance on how to best navigate the development process in Scheer PAS so that you can work efficiently and securely. Together, these guides help you structure your work from first test runs to go-live, ensuring that services are not only implemented, but delivered reliably.

  • Developing with Designer Test Environment

    This article describes the change in the development process that comes with PAS 23.1, where development and deployment have been decoupled to speed-up development.

  • Going Live with a Designer Service

    This article describes the procedure to go live with a Designer service from a test system to a productive system.

    • Solving Transport-Related Problems

      Sometimes it is necessary to transport a service from one system to another. If one of the points explained on this page applies to your service, you must take action.

Common Development Challenges

This best practice chapter focuses on solving specific problems during development. Each topic addresses a common challenge and shows you how to resolve it efficiently, so you can keep your project moving without getting stuck in the details.

Service Operation

If you are wondering how to use your services productively and manage their lifecycle, you will find answers in this best practice chapter. Together, these guidelines help you keep services stable, transparent, and adaptable throughout their entire lifecycle.

  • Changing the Database for Persistent States

    By default, the database that stores all persistent states for the BPMN process is a SQLite database that resides in the xUML service container itself. This article describes how you can use any other supported RDBMS system.

  • Exposing Designer Services via API Management

    This article describes how you can make services, that have been deployed from the Designer, available to others. You can publish them via Scheer PAS API Management and restrict their usage with additional policies.

Missing a use case? Contact us!

The content of this chapter is constantly being expanded. If you are missing a use case that you have often come across, please contact our support and documentation team and let us know!

📘

Related Documentation: