Variable Syntax, Usage, SDK, and Examples

This is a sample Script that uses Lua. Refer to the comments denoted with -- that describe how the script works.

• How to get an Environment Variable.

• How to get a value from the configuration object.

• How to get a value from a data object.

• Call the Software Development Kit (SDK).

-- Get a ProcessMaker Platform Environment Variable, in this example TEST_VAR.
local envVar = os.getenv("TEST_VAR")
   
-- Get a value from the config object.
-- In this example, 'test' in the JSON config: {"test":"test config value"}
local configTest = config["test"]

-- Get a value from the data object.
-- In this example, the user_id for the _request.
local requestUserId = data["_request"]["user_id"]

-- Get the email address for user id 1 using the API/SDK.
-- Use client.make to get a pre-configured api client.
-- See https://github.com/ProcessMaker/sdk-lua/tree/master/pmsdk/api for available clients.
local users_api = client.make('users_api')
local user = users_api:get_user_by_id("1")
local userEmail = user.email

return {envVar=envVar, configTest=configTest, requestUserId=requestUserId, userEmail=userEmail}

This is a sample Script that uses JavaScript. Refer to the comments denoted with // that describe how the script works.

• How to get an Environment Variable.

• How to get a value from the configuration object.

• How to get a value from a data object.  Call the Software Development Kit (SDK).

// A Script written in JavaScript should return a Promise that
// resolves with the output data. You can also return a basic object.
// For example `return {"key":"value"}`
return new Promise((resolve, reject) => {

    // Get a ProcessMaker Platform Environment Variable, in this example TEST_VAR.
    const envVar = process.env['TEST_VAR'];
    
    // Get a value from the config object.
    // In this example, 'test' in the JSON config: {"test":"test config value"}
    const configTest = config['test'];
    
    // Get a value from the data object.
    // In this case the user_id for the _request.
    const requestUserId = data["_request"]["user_id"];
    
    // Get the email address for user id 1 using the API/SDK.
    // Use the global `api` object to get a pre-configured client.
    let usersApi = new api.UsersApi();
    usersApi.getUserById("1", (error, user) => {
    
        const userEmail = user.email;
        
        resolve({
            'envVar' : envVar,
            'configTest' : configTest,
            'requestUserId' : requestUserId,
            'userEmail' : userEmail
        });
    });
});

This is a sample Script that uses C#. Refer to the comments denoted with // that describe how the script works.

• How to get an Environment Variable.

• How to get a value from the configuration object.

• How to get a value from a data object.

• Call the Software Development Kit (SDK).

using System;
using ProcessMakerSDK.Api;
using ProcessMakerSDK.Client;
using ProcessMakerSDK.Model;

// A Script written in C# must have a 'Script' class that implements 'BaseScript'.
// It must include a method named 'Execute'. Results must be added to the 'output' map.
public class Script : BaseScript
{
    public override void Execute(
        dynamic data,
        dynamic config,
        dynamic output,
        Configuration apiConfig)
    {
        // Get a ProcessMaker Platform Environment Variable, in this example TEST_VAR.
        output.envVar = Environment.GetEnvironmentVariable("TEST_VAR");
        
        // Get a value from the config object.
        // In this example, 'test' in the JSON config: {"test":"test config value"}
        output.configTest = config["test"];
        
        // Get a value from the data object.
        // In this example, the user_id for the _request.
        output.requestUserId = data["_request"]["user_id"];
        
        // Get the email address for user id 1 using the API/SDK.
        try {
            var apiInstance = new UsersApi(apiConfig);
            Users user = apiInstance.GetUserById("1");
            output.userEmail = user.Email;
        } catch (ApiException e) {
            Console.WriteLine(e.StackTrace);
        }
    }
}

This is a sample Script that uses Java. Refer to the comments denoted with // that describe how the the script works.

• How to get an Environment Variable.

• How to get a value from the configuration object.

• How to get a value from a data object.  Call the Software Development Kit (SDK).

import java.io.*;
import java.util.*;
import ProcessMaker_Client.ApiClient;
import ProcessMaker_Client.ApiException;
import ProcessMaker_Model.Users;
import ProcessMaker_Api.UsersApi;

// A Script written in Java must have a 'Script' class that implements 'BaseScript'.
// It must include a method named 'execute'. Results must be pushed to the 'output' map.
public class Script implements BaseScript {
    public void execute(
        Map<String, Object> data,
        Map<String, Object> config,
        Map<String, Object> output,
        ApiClient api
    ) {

        // Get a ProcessMaker Platform Environment Variable, in this example TEST_VAR.
        Map<String, String> env = System.getenv();
        output.put("env-var", env.get("TEST_VAR"));
        
        // Get a value from the config object.
        // In this example, 'test' in the JSON config: {"test":"test config value"}
        output.put("config-test", config.get("test"));

        // Get a value from the data object.
        // In this example, the user_id for the _request.
        Map requestData = ((Map)data.get("_request")); 
        output.put("data-request-user-id", requestData.get("user_id"));
        
        // Get the email address for user id 1 using the API/SDK.
        try {
            UsersApi apiInstance = new UsersApi(api);
            Users user = apiInstance.getUserById("1");
            output.put("user-1-email", user.getEmail());
        } catch (ApiException e) {
            e.printStackTrace();
        }
    }
}

This is a sample Script that uses Python. Refer to the comments denoted with # that describe how the script works.

• How to get an Environment Variable.

• How to get a value from the configuration object.

• How to get a value from a data object.  Call the Software Development Kit (SDK).

import os
from processmaker.client.api.users_api import UsersApi
from processmaker.client.configuration import Configuration
from processmaker.client.api_client import ApiClient

# Initialize the output dictionary
output = {}

# Get a ProcessMaker Platform Environment Variable, in this case TEST_VAR
output['envVar'] = os.getenv('TEST_VAR')

# Get a value from the config object
# Example: 'test' in the JSON config: {"test": "test config value"}
config = {"test": "test config value"}  # Replace with actual config if available
output['configTest'] = config.get("test")

# Get a value from the data object
# Example: user_id for the _request
data = {'_request': {'user_id': 123}}  # Replace with actual data if available
output['requestUserId'] = data.get('_request', {}).get('user_id')

# Get the email address for user ID 1 using the API/SDK
# Use the global `api_config` to set credentials automatically
api_config = Configuration()
api_config.host = "https://your-processmaker-instance.com"  # Replace with your instance URL
api_client = ApiClient(configuration=api_config)
users_api = UsersApi(api_client)

# Fetch user details for user ID 1
user = users_api.get_user_by_id("1")
output['userEmail'] = user.email

# Return the output dictionary
print(output)