Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: prerequisites_api_tutorials moved here from academy_excerpts_big

...

Info

Some Academy excerpts are saved within in the documenation, see Academy exerpts managed directly in the Academy space for an overview.


ChapterName
Table Filter
AND
fixedCols
totalrowinverse,,,
hidelabelsfalse
ddSeparator
sparkNameSparkline
limitHeighthidePane
sortChapter ⇧,Name ⇧
separatorPoint (.)
Filtration panel
customNoTableMsgText
limitHeight
sparklinefalselabels‚‚‚
default,,,
isFirstTimeEntertrue
cell-width150,150,,150
userfilterChapter,Name,Excerpt
datepatterndd M yy
globalFiltertrue
id1576227229659_-1811953137
worklog5|8|w d h m|w d h m
hideColumnsfalse
totalRowName
totalColName
customNoTableMsgfalse
disabledfalse
enabledInEditorfalse
globalFiltertrue
id1697628533674_589155580
iconfilterisOR
order0,1,2,3
hideControls
false
inversefalse,false,false
numbering
datefilter
column
sortChapter ⇧,Name ⇧
totalcol
disableSavefalse
rowsPerPage
separatorPoint (.)
labelsChapter‚Name‚Filter whole table
thousandSeparator
ignoreFirstNrows
ddOperator
userfilterChapter,Name
datepatterndd M yy
numberfilter
heightValue
updateSelectOptionsfalse
worklog5|8|w d h m|w d h m
isORAND
showNRowsifNotFiltered


ChapterNameExcerptUsage
Allhinweis_beispiele


Multiexcerpt
MultiExcerptNamehinweis_beispiele


Info

Inhalte in hellgrauer Schrift bezieht sich auf die im Tutorial verwendeten Beispiele.



Allnote_doc_story


Multiexcerpt
MultiExcerptNamenote_doc_story


Info

All content in a lighter font color refers to the story of the tutorial.



Alltrial


Multiexcerpt
MultiExcerptNametrial


Tip

If you are doing a trial and you have already received your personal credentials, you can access the PAS systems as follows:



API Tutorialsadministration_service_running


Multiexcerpt
MultiExcerptNameadministration_service_running

As described in the prerequisites of the tutorial, you need to have access to the PAS Administration, and the RESTAPI_Echo_Example must be deployed and running in the Administration.

To import the API, open your service within the PAS Administration and go to tab Details.


API Tutorialsapi_definition_details


Multiexcerpt
MultiExcerptNameapi_definition_details

Refer to API Management Guide > API Settings for detailed information about the necessary settings in the definition file.


API Tutorialsemail_notifications


Multiexcerpt
MultiExcerptNameemail_notifications


Info

If the email notification feature is enabled on your system, the requester and the approver will also receive emails for each step of the approval process.



API Tutorials
good_to_know_api


Multiexcerpt
MultiExcerptNamegood_to_know_api


Info
iconfalse
titleGood to Know


Expand
titleWhat is an API?

APIs represent real backend APIs (Application Programming Interfaces). An API is also known as a service, which offers a HTTP, REST or SOAP interface that can be invoked remotely by a client.

Scheer PAS API Management provides a way to turn unmanaged (raw) back-end APIs into managed APIs by attaching policies to them. Any policies configured on an API will be applied at runtime, regardless of the client and API contract.

An API has to be fully configured, including policies and implementation (and in case of public APIs including plans) to be published. If the API has been published to the gateway it can be consumed - in case of private APIs by clients.

Refer to API Management Guide > APIs for more details.




API Tutorials
good_to_know_developer_portal


Multiexcerpt
MultiExcerptNamegood_to_know_developer_portal


Info
iconfalse
titleGood to Know


Expand
titleWhat is the API Developer Portal?

The API Developer Portal allows you to grant customer developers access to your APIs. In the Developer Portal, developers can sign up for APIs, access them,

ExcerptUsageAllhinweis_beispiele
Multiexcerpt
MultiExcerptNamehinweis_beispiele
Info

Inhalte in hellgrauer Schrift bezieht sich auf die im Tutorial verwendeten Beispiele.

Allnote_doc_story Multiexcerpt
MultiExcerptNamenote_doc_story
Info

All content in a lighter font color refers to the story of the tutorial.

Designer Tutorialsnote_order_value
Multiexcerpt
MultiExcerptNamenote_order_value
Info

Remember: The value of the order limit is 1.000.

Alltrial Multiexcerpt
MultiExcerptNametrial
Tip

If you are doing a trial and you have already received your personal credentials, you can access the PAS systems as follows:

API Tutorialsapi_definition_details Multiexcerpt
MultiExcerptNameapi_definition_details
Tip

Detailed information about the necessary settings in the definition file can be found on page API Settings.

API Tutorialsemail_notifications
Multiexcerpt
MultiExcerptNameemail_notifications
Info

If the email notification feature is enabled on your system, the requester and the approver will also receive emails for each step of the approval process.

API Tutorialsgoto_chapter_apis Multiexcerpt
MultiExcerptNamegoto_chapter_apis
Tip

Go to APIs to learn more about the details of an API and its configuration options.

API Tutorialsgoto_chapter_organizations Multiexcerpt
MultiExcerptNamegoto_chapter_organizations
Tip

Go to Organizations to learn more about the details of an organization and its configuration options.

API Tutorialsnote_on_swagger_docu Multiexcerpt
MultiExcerptNamenote_on_swagger_docu
Tip

Refer to the API Management Guide > API Management Best Practices to know more about Swagger documentation.

API Tutorialsstep_by_step_policies Multiexcerpt
MultiExcerptNamestep_by_step_policies
Tip

On page Policies you can find an overview of all policies provided in API Management. Each policy and its configuration options are explained on dedicated pages.

API Tutorialsuse_your_own_name
Multiexcerpt
MultiExcerptNameuse_your_own_name
Note

Please make sure that the name of the created elements such as organizations, APIs, clients etc. is unique. You can use your own name as pre- or suffix (PublicSupportManager_David...).

API Tutorialswhy_dev_portal Multiexcerpt
MultiExcerptNamewhy_dev_portal
Info
titleWhy a Developer Portal?
Why does Scheer PAS API Management also provide a separate Developer Portal?
The portal allows you to grant your customers' developers access to your APIs. Developers can list

and try out APIs that you have enabled for them.

Using the Developer Portal has several advantages:
  • Security: Each developer gets his own secure login to the portal. It is a secure way to provide API keys to customers instead of sending the keys by email, for example.
  • Service: Using the portal allows your customers' developers to test the available APIs.
  • The portal is designed to keep the discovery and use of APIs simple for the target group. 

    Refer to API Management Guide > Developer Portal for more details.




    API Tutorials
    good_to_know_policy



    Multiexcerpt
    MultiExcerptNamegood_to_know_policy


    Info
    iconfalse
    titleGood to Know


    Expand
    titleWhat is a policy?

    A policy is a rule or a set of rules API Management uses to manage access to your APIs. Policies are applied to all API requests and represent a unit of work applied at runtime to the request by API Management.

    Policies are applied through a policy chain: when a request to an API is made, API Management creates a chain of policies to be applied to that request. The policy chain is applied to the request in a fixed order: Client policies are applied first, then policies added to plans, and finally policies added to the API itself.

    Refer to API Management Guide > Policies for more details.




    API Tutorialsgood_to_know_visibility


    Multiexcerpt
    MultiExcerptNamegood_to_know_visibility


    Info
    iconfalse
    titleGood to Know


    Expand
    titleWhat is the visibility concept all about?

    The visibility concept of API Management defines which user groups can find the APIs in the Developer Portal. The visibility resides on top of the permission system as another security layer. Visibilities are applicable to public APIs and plans for private APIs. Three different visibilities are available: Organization members (default), API Management users, and API Developer Portal users.

    Refer to API Management Guide > The Concepts of API Management for more details.




    API Tutorialsgoto_chapter_apis


    Multiexcerpt
    MultiExcerptNamegoto_chapter_apis

    Refer to API Management Guide > APIs to learn more about the details of an API and its configuration options.


    API Tutorialsgoto_chapter_organizations


    Multiexcerpt
    MultiExcerptNamegoto_chapter_organizations

    Refer to API Management Guide > Organizations to learn more about the details of an organization and its configuration options.


    API Tutorialsimport_api


    Multiexcerpt
    MultiExcerptNameimport_api

    Tab Endpoints shows all service endpoints, that have automatically been created during deployment.

    Select the endpoint with your service name EchoAPI and type rest, and click Import API Image Added to start the import to API Management.


    API Tutorialsimport_api_finished


    Multiexcerpt
    MultiExcerptNameimport_api_finished

    The import is finished and you are redirected to the details page of your new API. Now you can start configuring your API.


    API Tutorialsimport_wizard_organization


    Multiexcerpt
    MultiExcerptNameimport_wizard_organization

    The creation wizard will open and you can choose your organization.

    Click Next to continue.


    API Tutorialsimport_wizard_summary


    Multiexcerpt
    MultiExcerptNameimport_wizard_summary

    The Summary displays all details of the API.

    The settings of the API such as Endpoint, Definition URL, Definition Type and API Type will be filled with the corresponding information. Refer to API Management Guide > API Settings for details about the settings of an API.

    Click Create API to finish the import.


    API Tutorialsinfo_tutorial_3


    Multiexcerpt
    MultiExcerptNameinfo_tutorial_3


    Info

    As users with different authorizations are required for the approval process, this is not a "do it yourself" tutorial.



    API Tutorialsopen_get_method


    Multiexcerpt
    MultiExcerptNameopen_get_method

    Open the GET /HelloWorld method.

    Click Execute to test the GET request.


    API Tutorialsopen_test_ui


    Multiexcerpt
    MultiExcerptNameopen_test_ui

    The test UI opens in a new browser tab.
    Refer to the Swagger homepage for more information about the functions of the Swagger UI.

    At the top of the page, the Base URL and the link to the API definition are displayed.

    Expand the displayed operations to start testing.


    API Tutorialsprerequisites_api_tutorials


    Multiexcerpt
    MultiExcerptNameprerequisites_api_tutorials

    The following elements must be present or installed in order to be able to go through the step-by-step tutorials:

    • You need an up-and-running installation of Scheer PAS and access to the components API Management and Administration.
    • The RESTAPI_Echo_Example must be deployed in the administration component. You can download the repository here to deploy it.


    API Tutorialsstep_by_step_policies


    Multiexcerpt
    MultiExcerptNamestep_by_step_policies

    For an overview on all policies provided in API Management refer to API Management Guide > Policies. Each policy and its configuration options are explained on dedicated pages.


    API Tutorialsuse_your_own_name


    Multiexcerpt
    MultiExcerptNameuse_your_own_name


    Note

    Please make sure that the name of the created elements such as organizations, APIs, clients etc. is unique. You can use your own name as pre- or suffix (PublicEchoAPI_David...).



    API Tutorialswhy_dev_portal


    Multiexcerpt
    MultiExcerptNamewhy_dev_portal


    Info
    titleWhy a Developer Portal?

    Why does Scheer PAS API Management also provide a separate Developer Portal?
    The portal allows you to grant your customers' developers access to your APIs. Developers can list and try out APIs that you have enabled for them. Using the Developer Portal has several advantages:

    • Security: Each developer gets his own secure login to the portal. It is a secure way to provide API keys to customers instead of sending the keys by email, for example.
    • Service: Using the portal allows your customers' developers to test the available APIs.
    • Life Cycle Management: Users of the portal can view all versions of the APIs. They get also an overview on the status of each API, if it is available, in development or retired, and can also access its documentation. Refer to
    page



    Access
    BPaaS / Mobile Tutorialsinfo_css_blue_default


    Multiexcerpt
    MultiExcerptNameinfo_css_blue_default


    Info

    By default, the template CSS Blue is assigned to the reference and the overview model of a newly created app project.



    BPaaS / Mobile Tutorialsinfo_mobile_installation


    Multiexcerpt
    MultiExcerptNameinfo_mobile_installation


    Info
    _mobile_installation

    For information on installing Scheer PAS Mobile visit the Mobile App Installation Guide.



    BPaaS / Mobile Tutorialsnote_fieldname_in_container


    Multiexcerpt
    MultiExcerptName
    info
    note_fieldname_
    mobile
    in_
    installation
    container
    Info

    For information on installing Scheer PAS Mobile visit the Mobile App Installation Guide.


    Note

    Make sure you use the correct Field Names in Container as defined in your input form. For further information on the concept of the Field Name in Container refer to BPaaS Guide > The Container Principle.

    Step 7: App Execution



    BPaaS / Mobile Tutorials
    note
    tip_
    fieldname
    connecting_
    in
    epc_
    container
    elements


    Multiexcerpt
    MultiExcerptName
    note
    tip_
    fieldname
    connecting_
    in
    epc_
    container
    elements
    Note

    Make sure you use the correct Field Names in Container as defined in your input form. For further information on the concept of the Field Name in Container visit the BPaaS Guide > The Container Principle.


    Tip

    Refer to BPaaS Guide > Connecting EPC Elements to learn more about connecting elements.



    Step 4: Configuring the Mobile Overview
    BPaaS / Mobile Tutorialstip_
    connecting
    container_
    epc_elements
    principle


    Multiexcerpt
    MultiExcerptNametip_
    connecting
    container_
    epc_elements
    principle


    Tip
    Visit the

    For details about the concept of the Field Name in Container refer to BPaaS Guide >

    Connecting EPC Elements to learn more about connecting elements
    2
    Modeling
    Process
    2
    Modeling
    Process2
  • Step 2: Modeling the Process mobile
  • BPaaS / Mobile Tutorialstip_creating_
    container
    epc_
    principle
    elements


    Multiexcerpt
    MultiExcerptNametip_creating_
    container
    epc_
    principle
    elements


    Tip

    The concept of the Field Name in Container is explained in detail in the BPaaS Guide on page The Container Principle.

    Refer to BPaaS Guide > Creating New EPC Elements to learn more about the creation of EPC elements and how to use them.




  • Step 3: Designing the Forms
  • Step 3: Designing the Responsive Forms
    BPaaS / Mobile Tutorialstip_creating_
    epc
    form_elements


    Multiexcerpt
    MultiExcerptNametip_creating_
    epc
    form_elements


    Tip
    Visit the
    New EPC

    Form Elements to learn more about the creation of

    EPC

    form elements and how to

    use them.Step 2: Modeling the Process

    use them.



    2
    Modeling
    Process2
    2
    Modeling
    Process mobile
    BPaaS / Mobile Tutorialstip_
    creating
    instance_
    form_elements
    view


    Multiexcerpt
    MultiExcerptNametip_
    creating
    instance_
    form_elements
    view


    Tip
    Visit the

    For further information about the usage of the Instance View refer to BPaaS Guide >

    Creating Form Elements to learn more about the creation of form elements and how to use them
    BPaaS / Mobile Tutorialstip_
    instance
    overview_
    view
    config


    Multiexcerpt
    MultiExcerptNametip_
    instance
    overview_
    view
    Tip

    Further information about the usage of the Instance View can be found in the BPaaS Guide > Using the Instance View.

    config


    Tip

    Refer to Configuring Tables and Configuring Overview Tables for further explanations on this topic.



    Designer Tutorialsgood_to_know_mapping
    BPaaS / Mobile Tutorialstip_overview_config


    Multiexcerpt
    MultiExcerptName
    tip
    good_to_
    overview_config
    Tip

    You can find further explanations on this topic in the BPaaS Guide on the pages Configuring Tables and Configuring Overview Tables.

    Designer Tutorialsnote_on_ports
    Multiexcerpt
    MultiExcerptNamenote_on_ports
    Note
    titleImportant Note on Ports
    • Use 5444 as Prox Port in the service details.
    • Make sure that an unused service port is available for your tutorial service:
      • If you are modeling on your own customer system, please ask your administrator for an unused service port.
      • If you are using an account on our trial systems, you have been provided an individual port along with your trial credentials. If this is not the case, please contact our Support team and ask about an unused service port.
    know_mapping


    Info
    iconfalse
    titleGood to Know


    Expand
    titleWhat is mapping?

    Data mapping is a very common task in the integration business: It is the process of connecting a data field from one source to a data field in another source. The Designer comes with a mapping editor that allows you to define attribute mappings directly in a mapping diagram by drawing relations between the properties of the involved classes.

    Mapping diagrams are automatically created if you create a mapping operation on a class. The mapping diagram is based on the data model contained in the Implementation folder. It defines mappings between the data structures defined in this data model. You cannot change the data model in the mapping diagram, all attributes are read-only.

    If you want to learn more about data mapping, refer to the chapters Modeling Data Mapping and Mapping Data Structures in the Designer guide.




    Designer Tutorialsgood_to_know_persisting_data


    Multiexcerpt
    MultiExcerptNamegood_to_know_persisting_data


    Info
    iconfalse
    titleGood to Know


    Expand
    titleWhat is the meaning of "persisting data"?

    Processes are based on data that is going in, is processed, and coming out. However, the application developer must determine which data can be accessed in which process step. Therefore, the execution diagram contains different sections:

    • Message: Section  Message  is shown for all BPMN elements that need to process an incoming message.  As per default, the incoming message has type any . To gain access to the data used in your process, you have to apply the correct type from a customized library.
    • Persisted: Variables created in section  Persisted  are usable in all executions of the BPMN model. They are "persisted" during the execution of the entire process.
    • Local: Variables created in section  Local  are only available for use within the current execution. They are discarded when switching to the next process step.

    Data that you want to be able to access throughout the process, you need to keep - this is the meaning of "persisting data".

    If you want to learn more about how to persist data in the Designer, refer to Designer Guide > Persisting Data.




    Designer Tutorialsnote_changed_order_value


    Multiexcerpt
    MultiExcerptNamenote_changed_order_value


    Info
    titleReminder

    If you have finished tutorial 4, the new order limit is 500.



    Designer Tutorialsnote_order_value


    Multiexcerpt
    MultiExcerptNamenote_order_value


    Info

    Remember: The value of the order limit is 1.000.



    Designer Tutorialssummary_tutorial_1


    Multiexcerpt
    MultiExcerptNamesummary_tutorial_1

    In our first tutorial, we will show

    • how to draw BPMN diagrams with the Designer
    • how to design forms with the Designer
    • how to test your application using the preview



    Designer Tutorialssummary_tutorial_2


    Multiexcerpt
    MultiExcerptNamesummary_tutorial_2

    In our second tutorial, we will show

    • how to add executions to BPMN elements
    • how to map data between forms and the BPMN process
    • how to test your application using the preview



    Designer Tutorialssummary_tutorial_3


    Multiexcerpt
    MultiExcerptNamesummary_tutorial_3

    In our third tutorial, we will show

    • how to map process data
    • how to configure the instance list to show process data
    • the functionalities of the instance list



    Designer Tutorialssummary_tutorial_4


    Multiexcerpt
    MultiExcerptNamesummary_tutorial_4

    In our fourth tutorial, we will show

    • how to deploy a service as a container
    • how to manage your containerized service
    • the differences between a test service and a deployed service



    Designer Tutorialssummary_tutorial_5


    Multiexcerpt
    MultiExcerptNamesummary_tutorial_5

    In our fifth tutorial, we will show

    • how to add roles to a process
    • how to assign roles to lanes
    • the effects of the role check



    Designer Tutorialstip_creating_new_items


    Multiexcerpt
    MultiExcerptNametip_creating_new_items


    Tip

    If you want to create new items in the Service Panel just hover over a folder (or its contents) and use the icons in the pop-up menu. To open the context menu of an item, right-click it in the tree.



    Video Notesdesigner_introduction


    Multiexcerpt
    MultiExcerptNamedesigner_introduction

    Scheer PAS Designer is the modeling tool for digitization. This easy-to-use, innovative and model-based tool allows you to create processes in BPMN 2.0 format via a graphical user interface. At the same time you can realize the technical implementation into UML by using supplied or self-created libraries. You can use the finished models without further programming as xUML micro services in the platform's integration component. The use of the Designer also boosts collaboration by allowing key users, process managers and IT responsibles to work simultaneously on the same process.



    Video Notesnote_designer_documentation


    Multiexcerpt
    MultiExcerptNamenote_designer_documentation

    Refer to the comprehensive Designer Guide explaining concepts and usage of the Designer in more detail.


    Video Notesnote_designer_tutorial


    Multiexcerpt
    MultiExcerptNamenote_designer_tutorial

    Learn more about the Scheer PAS Designer by following our Designer self-learning tutorial.
    Request a free trial account!


    Designer Tutorialstip_creating_new_items
    Multiexcerpt
    MultiExcerptNametip_creating_new_items
    Tip

    If you want to create new items in the Service Panel just hover over a folder (or its contents) and use the icons in the pop-up menu. To open the context menu of an item, right-click it in the tree.

    Video Notesdesigner_introduction
    Multiexcerpt
    MultiExcerptNamedesigner_introduction

    Scheer PAS Designer is the modeling tool for digitization. This easy-to-use, innovative and model-based tool allows you to create processes in BPMN 2.0 format via a graphical user interface. At the same time you can realize the technical implementation into UML by using supplied or self-created libraries. You can use the finished models without further programming as xUML micro services in the platform's integration component. The use of the Designer also boosts collaboration by allowing key users, process managers and IT responsibles to work simultaneously on the same process.

    Video Notesnote_designer_documentation
    Multiexcerpt
    MultiExcerptNamenote_designer_documentation

    Visit the comprehensive Designer Guide explaining concepts and usage of the Designer in more detail.

    Video Notesnote_designer_tutorial
    Multiexcerpt
    MultiExcerptNamenote_designer_tutorial

    Learn more about the Scheer PAS Designer by following our Designer self-learning tutorial.
    Request a free trial account!

  • Scheer PAS Videos
  • 2022-04-22_09-29-43_Part 2 - First Steps in PAS Designer
  • 2022-04-22_09-29-26_Part 3 - BPMN Creation in PAS Designer
  • 2022-04-22_09-29-06_Part 4 - Forms Design
  • 2022-04-22_09-28-51_Part 5 - Data Mapping
  • 2022-04-22_09-28-37_Part 6 - Library Handling
  • 2022-04-22_09-28-24_Part 7 - From Design to Deployment
  • 2022-04-22_09-28-07_Part 8 - The PAS Integration Component
  • 2022-04-22_09-27-32_Part 10 - Low-Code to Pro-Code
  • 2022-04-22_09-26-08_Part 11 - Collaborative Working
    Video Notestry_account


    Multiexcerpt
    MultiExcerptNametry_account

    Do you feel like giving Scheer PAS a try? Request a free trial account!

  • Your Free Scheer PAS Trial Account
  • 2022-04-22_09-29-58_Part 1 - Portal Overview

  • Part 9 - Creating Analytics


    Academy exerpts managed directly in the Academy space

    ChapterExcerpt NamePage of the Original(Re-)Usage
    API Management TutorialsprerequisitesAPI Management Tutorials
    API Management Tutorialsapi_management_concepts

    Managing a Private API

    API Management TutorialsPage excerptManaging a Private API Creating an Organization
    Designer TutorialsprerequisitesDesigner Tutorials
    Designer Tutorialstutorial_1Designer Tutorials
    Designer TutorialsPage excerptTutorial 1 2 Validation ErrorsDesigner Tutorials

    designer_testing_the_process

    DELETE WHEN 23.1 has been published

    Tutorial 1 Testing the Process
    Designer Tutorialsdesigner_testing_previewTutorial 1 Drawing the Business Process
    BRIDGE Development Tutorialslesson1BRIDGE Development Tutorials
    BRIDGE Development Tutorialslesson2BRIDGE Development Tutorials
    BRIDGE Development Tutorialslesson3BRIDGE Development Tutorials

    ...