Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WDESIGNER and version 24.0

The Library Concept

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamepanelslibrary_general_descriptionconcepts
PageWithExcerptINTERNAL:_designer_excerpts

Using libraries has several advantages for developers:

  • You can provide additional data types and operations via libraries.
  • You can reuse implementations you have already developed with the Builder.
  • You can use libraries for modularization:
    • Implementations can be recycled in various processes via libraries.
    • Multiple developers can contribute to the same process implementation by working on different libraries.
  • You can add features to the Designer, for example access to backend systems, via libraries.
  • You can use different versions of the same library as the library administration supports versioning.

Library Usage in Designer

In the Designer, you can create your own libraries, see page Creating a Library for details. If you want to use the libraries in a Designer service, you have to upload them to a namespace. This is done in the Libraries section of the Designer administration. The uploaded libraries are then available in all services created in this namespace. Since PAS 23.1.1 it is also possible to share a library with all users on your PAS installation. Refer to Sharing Designer Content for details.
How to upload your libraries to the Designer is explained in detail on page Administrating Libraries.

Once a library has been uploaded, you can add it to any service created in this namespace. To do so, open the service, click the Image Added button and use the Asset Drawer to add them or go to the Libraries folder in the Service panel and use its context menu.

Tip

Go to page Adding Libraries for detailed information on how to add a library to a service. Refer to chapter Modeling Execution for further information about the usage of libraries during modeling.

The Service Panel

The libraries you have added to a service reside in the Service panel.

The icon Image Removed represents the library panel.

Image Added

If you use the panel preset of the BPMN editor, the Service

Image Removed

The Library panel gives you direct access to your all libraries of your project, and thus to all of your predefined classes, interfaces, operations and parameters.

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNametip_library_administration
DisableCachingtrue
PageWithExcerptINTERNAL:_designer_excerpts

Image Removed

Each library element can have a documentation. Hover your mouse on a library element to see if documentation is available. This is indicated by the Image Removed icon. The documentation is displayed as a tooltip.

For easier reading of longer documentation, you can click the icon to see the complete documentation in a pop-up window.

Image Removed

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamebridge_base
PageWithExcerptINTERNAL:_designer_excerpts

Image Removed

If you use the panel preset, the library

panel is displayed in the upper left corner of the editor.

Image Removed

PageWithExcerptINTERNAL:_designer_excerpts

Image Removed

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameshow_panels

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptName

hide_panels

tip_panel_management
DisableCachingtrue

PageWithExcerptINTERNAL:_designer_excerpts

Application Options

Image Added

The Service panel

shows all libraries available in this project. You can use the panel to manage your libraries and to use the contents of the libraries during modeling on the execution pane.

Managing Libraries

Image Removed

If you want to add your own libraries, click the Manage libraries button.

Image Removed

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamemanage_libraries
DisableCachingtrue
PageWithExcerptINTERNAL:_designer_excerpts

Image Removed

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameadd_library
DisableCachingtrue
PageWithExcerptINTERNAL:_designer_excerpts

Image Removed

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameused_libraries
DisableCachingtrue
PageWithExcerptINTERNAL:_designer_excerpts

Image Removed

The added library is now displayed in the library panel and you can use it during modeling.

Image Removed

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameremove_libraries
DisableCachingtrue
PageWithExcerptINTERNAL:_designer_excerpts

Image Removed

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameshow_library_doc
PageWithExcerptINTERNAL:_designer_excerpts

Image Removed

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamelibrary_documentation
PageWithExcerptINTERNAL:_designer_excerpts

gives you direct access to all libraries of your service, and thus to all of your predefined classes, interfaces, operations and parameters.

Tip

Open menu Libraries in the Designer administration to upload your own libraries

Using Library Content

In your own libraries you can define the classes, operations and parameters you want to use during modeling= = == = If show less content in the tree, use the icon Image Removedto close the corresponding

Image Removed

.

A library can contain the following elements:

IconName
Image Modified
Package
Image Modified
Class
Image Modified
Property
Image Added
Interface
Image Modified
Operation
Image Modified
Parameter

To expand an element in the tree, click on Image Modified.


UseImage Addedif you want to

collapse a tree below an element.


Image RemovedImage Added

You can drag & drop elements from the library panel to the execution pane.

Operations are dropped to the operations flow in the middle of the execution pane.

Image Removed

Input and output parameters of the operation are displayed in the library panel and as pins on the execution pane.

Image Removed

You can drag & drop classes, interfaces and parameters to the fields Persisted and Local:

  • Persisted: The information is persisted and is therefore available in your whole BPMN model.
  • Local: The information is only existing in the current operations flow.

Image Removed

If you start dragging a relation on the execution pane, the eligible pins of the operation call(s) are highlighted.
Tip

For more detailed information see page The Execution Pane.

Each library element can have a documentation. Hover your mouse on an element in the libraries folder to see if documentation is available. The documentation is displayed as a tooltip.

Image Added

You can also copy & paste content from a library to the data model of your service: packages, classes, properties, operations and parameters - including their subelements.
The implementation of a copied operation, however, will be empty.

In addition to imported libraries with predefined data types, you can use the provided Base Types, or you can create your own data model.

Image Added

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamebridge_base
PageWithExcerptINTERNAL:_designer_excerpts

Image Added

You can also define your own data types in folder Implementation. You can add your own packages, classes, interfaces, operations, properties and parameters.

Tip

Go to page Modeling Data Structures for more detailed information on how to work on your own data model and to page Modeling Data Mapping for further explanations on how to define mappings between data types.

Go to chapter Developing and Using Libraries to find out how to create your own libraries in the Designer.