Chapter | Name | Excerpt | Usage |
---|
All | hinweis_beispiele |
Multiexcerpt |
---|
MultiExcerptName | hinweis_beispiele |
---|
|
Info |
---|
Inhalte in hellgrauer Schrift bezieht sich auf die im Tutorial verwendeten Beispiele. |
|
| |
All | note_doc_story |
Multiexcerpt |
---|
MultiExcerptName | note_doc_story |
---|
|
Info |
---|
All content in a lighter font color refers to the story of the tutorial. |
|
| |
All | trial |
Multiexcerpt |
---|
|
Tip |
---|
If you are doing a trial and you have already received your personal credentials, you can access the PAS systems as follows: |
|
| |
API Tutorials | administration_service_running
|
Multiexcerpt |
---|
MultiExcerptName | administration_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. |
| - Tutorial 1: Importing the API
- Tutorial 2: Importing the API
|
API Tutorials | api_definition_details | | |
API Tutorials | email_notifications
|
Multiexcerpt |
---|
MultiExcerptName | email_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 |
---|
MultiExcerptName | good_to_know_api |
---|
|
Div |
---|
|
Expand |
---|
title | Good to Know: What 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. |
|
|
| - Tutorial 1: Importing the API
- Tutorial 2: Importing the API
|
API Tutorials | good_to_know_developer_portal |
Multiexcerpt |
---|
MultiExcerptName | good_to_know_developer_portal |
---|
|
Div |
---|
|
Expand |
---|
title | Good to Know: What 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, and try out APIs that you have enabled for them. 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. |
|
|
| - Tutorial 1: Testing and Consuming
- Tutorial 2: Configuring the API
|
API Tutorials | |
Multiexcerpt |
---|
MultiExcerptName | good_to_know_policy |
---|
|
Div |
---|
|
Expand |
---|
title | Good to Know: What 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. |
|
|
| - Tutorial 1: Configuring the API
- Tutorial 2: Creating a Plan
|
API Tutorials | good_to_know_visibility
|
Multiexcerpt |
---|
MultiExcerptName | good_to_know_visibility |
---|
|
Div |
---|
|
Expand |
---|
title | Good to Know: What is the visibility concept all about? |
---|
| The visibility concept of API Management enables a fine-grained access to APIs and defines which user groups can find them. The visibility resides on top of the permission system as another security layer. Visibilities are applicable to public APIs and plans for private APIs. The chosen visibility affects both UIs: The content of API Management as well as the content of the API Developer Portal from where API consumers can find the 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. |
|
|
| - Tutorial 1: Configuring the API
- Tutorial 2: Configuring the API
|
API Tutorials | goto_chapter_apis |
Multiexcerpt |
---|
MultiExcerptName | goto_chapter_apis |
---|
| Refer to API Management Guide > APIs to learn more about the details of an API and its configuration options. |
| |
API Tutorials | goto_chapter_organizations |
Multiexcerpt |
---|
MultiExcerptName | goto_chapter_organizations |
---|
| Refer to API Management Guide > Organizations to learn more about the details of an organization and its configuration options. |
| |
API Tutorials | import_api
|
Multiexcerpt |
---|
MultiExcerptName | import_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 to start the import to API Management. |
| - Tutorial 1: Importing the API
- Tutorial 2: Importing the API
|
API Tutorials | import_api_finished |
Multiexcerpt |
---|
MultiExcerptName | import_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. |
| - Tutorial 1: Importing the API
- Tutorial 2: Importing the API
|
API Tutorials | import_wizard_organization
|
Multiexcerpt |
---|
MultiExcerptName | import_wizard_organization |
---|
| The creation wizard will open and you can choose your organization. Click Next to continue. |
| - Tutorial 1: Importing the API
- Tutorial 2: Importing the API
|
API Tutorials | import_wizard_summary |
Multiexcerpt |
---|
MultiExcerptName | import_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. |
| - Tutorial 1: Importing the API
- Tutorial 2: Importing the API
|
API Tutorials | note_on_swagger_docu |
Multiexcerpt |
---|
MultiExcerptName | note_on_swagger_docu |
---|
|
|
| |
API Tutorials | step_by_step_policies |
Multiexcerpt |
---|
MultiExcerptName | step_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 Tutorials | use_your_own_name
|
Multiexcerpt |
---|
MultiExcerptName | use_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 Tutorials | why_dev_portal |
Multiexcerpt |
---|
MultiExcerptName | why_dev_portal |
---|
|
Info |
---|
title | Why 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 Developer Access to APIs for detailed information.
|
|
| |
BPaaS / Mobile Tutorials | info_css_blue_default |
Multiexcerpt |
---|
MultiExcerptName | info_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 Tutorials | info_mobile_installation |
Multiexcerpt |
---|
MultiExcerptName | info_mobile_installation |
---|
|
|
| |
BPaaS / Mobile Tutorials | note_fieldname_in_container |
Multiexcerpt |
---|
MultiExcerptName | note_fieldname_in_container |
---|
|
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. |
|
| |
BPaaS / Mobile Tutorials | tip_connecting_epc_elements |
Multiexcerpt |
---|
MultiExcerptName | tip_connecting_epc_elements |
---|
|
|
| |
BPaaS / Mobile Tutorials | tip_container_principle |
Multiexcerpt |
---|
MultiExcerptName | tip_container_principle |
---|
|
Tip |
---|
The concept of the Field Name in Container is explained in detail in the BPaaS Guide on page The Container Principle. |
|
| |
BPaaS / Mobile Tutorials | tip_creating_epc_elements |
Multiexcerpt |
---|
MultiExcerptName | tip_creating_epc_elements |
---|
|
|
| |
BPaaS / Mobile Tutorials | tip_creating_form_elements |
Multiexcerpt |
---|
MultiExcerptName | tip_creating_form_elements |
---|
|
|
| |
BPaaS / Mobile Tutorials | tip_instance_view |
Multiexcerpt |
---|
MultiExcerptName | tip_instance_view |
---|
|
|
| |
BPaaS / Mobile Tutorials | tip_overview_config |
Multiexcerpt |
---|
MultiExcerptName | tip_overview_config |
---|
|
|
| |
Designer Tutorials | note_changed_order_value
|
Multiexcerpt |
---|
MultiExcerptName | note_changed_order_value |
---|
|
Info |
---|
| If you have finished tutorial 4, the new order limit is 500. |
|
| |
Designer Tutorials | note_order_value
|
Multiexcerpt |
---|
MultiExcerptName | note_order_value |
---|
|
Info |
---|
Remember: The value of the order limit is 1.000. |
|
| |
Designer Tutorials | summary_tutorial_1
|
Multiexcerpt |
---|
MultiExcerptName | summary_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 Tutorials | summary_tutorial_2 |
Multiexcerpt |
---|
MultiExcerptName | summary_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 Tutorials | summary_tutorial_3 |
Multiexcerpt |
---|
MultiExcerptName | summary_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 Tutorials | summary_tutorial_4 |
Multiexcerpt |
---|
MultiExcerptName | summary_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 Tutorials | summary_tutorial_5 |
Multiexcerpt |
---|
MultiExcerptName | summary_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 Tutorials | tip_creating_new_items
|
Multiexcerpt |
---|
MultiExcerptName | tip_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 Notes | designer_introduction
|
Multiexcerpt |
---|
MultiExcerptName | designer_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 Notes | note_designer_documentation
|
Multiexcerpt |
---|
MultiExcerptName | note_designer_documentation |
---|
| Visit the comprehensive Designer Guide explaining concepts and usage of the Designer in more detail. |
| |
Video Notes | note_designer_tutorial
| | |
Video Notes | try_account
|
Multiexcerpt |
---|
MultiExcerptName | try_account |
---|
| Do you feel like giving Scheer PAS a try? Request a free trial account! |
| |