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 Designer supports MongoDB - a NoSQL and document oriented database. MongoDB support is native and you do not need to install any client tools or drivers. Also, your PAS system comes with a MongoDB scheer-mongo pre-installed.

Using the MongoDB adapter, you can

TaskAdapter ActionDescriptionDocumentation Reference
Insert and update documentsinsertInsert new documents to a database.
replaceReplace one or more documents by a new one. The documents are identified by a query.
updateUpdate all or dedicated properties of one or more documents with new values. The documents are identified by a query.
Retrieve documents/informationfindGet a result set based on a provided query. You can get the result set all at once, or fetch single documents via a handle (see fetch).
fetchFetch single records from a result set that has been retrieved by find.
aggregateAggregate data based on a query and MongoDB pipelines.
Remove documentsdeleteRemove one or documents from the database. The documents are identified by a query.

To use the MongoDB adapter it is helpful if you are familiar with the concepts of MongoDB.

Note

As opposed to standard JSON, with MongoDB the order of keys does matter. Action script statement classToJSON, however, does not guarantee to preserve the order presented in the class. In many cases that will work but it may behave unexpectedly wrong.

So, with the MongoDB adapter always use classToExtendedJSON().

Adding a MongoDB Adapter Operation to a Diagram

Expand the path to the MongoDB adapter in the service panel (Base Types/Bridge Base/Base Components/Add Ons/MongoDB ).

You can drag out operations from the data model to any diagram:

The example on the left shows how to add a MongoDB adapter operation to a BPMN execution diagram.

Configuring the MongoDB Adapter Operation

Once an operation has been added to a diagram, it needs to be configured as a MongoDB adapter.

Select the newly added MongoDB adapter operation and switch to the Attributes panel. Depending on the diagram type you can see the following information (example BPMN execution diagram):

AttributeDescriptionAllowed Values / Example
NameThe name of the MongoDB adapter operation. insert
Symbol TypeOperations added to an execution diagram are execution steps. Execution Step

All this is predefined and cannot be changed.

Click Add Stereotype to define the selected operation as to bea MongoDB adapter.

Select MongoDB Adapter from the list of available adapter stereotypes.
Click Save.

The Attributes panel shows the added adapter stereotype. Now you still need to configure the adapter.

Expand the stereotype by clicking the arrow on the right.

A MongoDB adapter is configured via its alias (see Aliases for more information on aliases).

Additionally, you can insert

  • database
  • collection

See further information below and on page MongoDB. The adapter option action derives from the used operation. Do not configure this.

You can select an existing alias from a drop-down list by clicking the text Select alias.

If you want to remove an added alias, select None from the drop-down list:

You can also create and add a new alias by clicking the corresponding icon.

Refer to Aliases for more information on how to create a new alias.

A dialog opens where you can name and configure the new alias. Refer to MongoDB Adapter Reference for more information on the configuration options of this adapter.

Click Save to create and add the new alias.

Anchor
mongo_db_options
mongo_db_options

To add a database, click the corresponding icon. Enter the name of the default database to be used.

To remove a database, click the corresponding icon.

To add a collection, click the corresponding icon. Enter the name of the default collection to be used.

To remove a collection, click the corresponding icon.

Panel
titleOn this Page:
Table of Contents
OtpFloatingfalse

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameMongoDBAdapter_CustomerData_Example
PageWithExcerptINTERNAL:_designer_examples
shouldDisplayInlineCommentsInIncludesfalse

rp
Panel
titleRelated Pages:

Children Display

rde
Panel
titleRelated Documentation: