Download the PHP package processmaker/docker-executor-lua without Composer
On this page you can find all versions of the php package processmaker/docker-executor-lua. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download processmaker/docker-executor-lua
More information about processmaker/docker-executor-lua
Files in processmaker/docker-executor-lua
Package docker-executor-lua
Short Description Lua script executor for processmaker 4
License GAGPL-3.0-or-later
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package docker-executor-lua
executor-lua
Script Task Executor Engine with LUA Runtime
This docker image provides a sandboxed protected environment to run custom LUA scripts that are written in ProcessMaker 4. User created script tasks should be isolated however have utilities available to them in order to get most common tasks done. This LUA environment has modules available so Script Tasks can take advantage of the following libraries:
- dkjson
- TODO : Identify most common libraries used for existing script tasks
How to use
The execution requires a data.json, config.json and an output.json file be present on the host system. The data.json represents the Request instance data. The config.json represents configuration specific for this Script Task. And the output.json should be a blank file that will be populated by the successful output of the script task. It is the responsibility of the caller to have these files prepared before executing the engine via command line (or docker API). The script task is represented by a script.lua file. It is the responsibility of the caller to have these files prepared before executing the engine via command line (or docker API).
Script Task design
When writing a Script Task, three global variables are available. They are:
- data - A record that represents the data loaded from data.json
- config - A record that represents the config loaded from config.json
- client - The ProcessMaker 4 LUA SDK Client preconfigured to access the API via OAuth authentication
Your script should execute quickly. Once the script is complete, your return statement will be used and converted to JSON which will be stored in the output.json file. Once the docker execution is complete, you should the return code of the docker execution. If the code is 0, then the script task executed successfully and you can read output.json for the valid output. If it is non-zero, then you should review STDERR to see the error that was displayed during execution.
Example data.json
Example Script Task
Example output.json
Using the PM4 SDK
The executor comes pre-configured with the ProcessMaker 4 SDK ready to use.
Get an instance by calling client.make('name').
Here is an example of fetching all pm4 users:
See ProcessMaker API documentation for more info at /api/documentation on your ProcessMaker 4 instance
Command Line Usage
License
Distributed under the AGPL Version 3
ProcessMaker (C) 2002 - 2021 ProcessMaker Inc.
For further information visit: http://www.processmaker.com/
