Overview

This is a template that accelerates the automation of asynchronous services with your Mendix app. Plug a batch scripts running on-prem behind firewalls and based on non-web technologies like command line scripts, desktop programs.

The implementation is fast because the creation of a new “service” is guided and based on a module template.

Then, it’s super easy to consume it with the module “AsyncServiceConsumer”. You compose the logic with workflows, handle the inputs and outputs data with external entities of datahub, and fire the request in one generic call (on workflow task start).

The end of the tasks can be checked periodically or triggered by a callback URL (if your consumer is reachable).

This is a community module that you should consider as a template accelerating your implementation. Its fully implemented with low-code and open-source. Security and authentication are the area that you may want to personalize. Feedbacks are welcome.

A sample app is available Async Service Sample app

Documentation

Description

This is a template that accelerates the automation of asynchronous services with your Mendix app. Plug a batch scripts running on-prem behind firewalls and based on non-web technologies like command line scripts, desktop programs.

The implementation is fast because the creation of a new “service” is guided and based on a module template.

Then, it’s super easy to consume it with the module “AsyncServiceConsumer”. You compose the logic with workflows, handle the inputs and outputs data with external entities of datahub, and fire the request in one generic call (on workflow task start).

The end of the tasks can be checked periodically or triggered by a callback URL (if your consumer is reachable).

This is a community module that you should consider as a template accelerating your implementation. Its fully implemented with low-code and open-source. Security and authentication are the area that you may want to personalize. Feedbacks are welcome.

Typical usage scenario

Long calculation like simulations. Integrate desktop applications (like CAD, Simulation) supporting command lines. Integrate old and non-web technologies without web services.

Features and limitations

Manage asynchronous services like batch scripts, could be any other kind of asynchonous task like web or “remote sub-workflow”.

List of services

• Processor Registration : basic authentication. Gives a unique ID to the processor to be able to later monitor activity of machines and services.
• AsyncTask : basic authentication
  • StartFromAPI : From consumer to Service app. Create a new AsyncTask.
  • PublishRequest : Batch processor to take a job and download the inputs
  • PublishResult : Batch processor upload the result
  • AsyncTaskStatusCheck : Return the status of a task
• Callback : Not requiring authentication. Not exchanging data except a task UID in the path. Triggers the same “status check” than the timer
• Odata in “AsyncServiceConnector” to expose input and output of each Service modules as external entities via datahub.

Dependencies 

• Mx 9.22
• CommunityCommons, Encryption
• AsyncServiceConnector works with the AsyncServiceConsumer

Installation and Configuration

See “UseMe” folders directly in Studio Pro App Explorer.

Known bugs 

[Describe the known bugs]

Frequently Asked Questions [optional]

• Q:
• A: