Logo

Docs

  • HOME

Index

A B C D E F G H I J L N P R S T U Z

A

aggregate_collection
Run an aggregation query over a collection
append_file
Append data to an existing file. Works only for uploaded files.
attach_file
Attach a file or a list of files to an application.

B

bubble_babble
Bubble/Babble encoder that provides a human readable encoding of an input stream.

C

cipher
Returns the ciphered version of input as well as an initialization vector.
count_objects
Count documents verifying a condition in a collection
create_collection
Create a new collection
create_file
Create a new file. Works only for uploaded files.
create_file
Create a new file. Works only for uploaded files.
csv_to_json
Convert the CSV input to JSON format

D

date_format
Modify the format of a date.
date_offset
Return the a date +/- a number of days.
decipher
Returns the deciphered version of the ciphered string provided in input.
decode
Decode a string.
delete_file
Delete an existing file. Works only for uploaded files.
detach_file
Detach a file or a list of files from an application.
drop_collection
Drop the content a collection

E

encrypt
Returns the encrypted version of a string.

F

file_replace
Replace the occurrences of a string in a file and save it. Works only for uploaded files.

G

generate_key
Generate a secret key.
get_access_url
Get the URL of the RunMyProcess server.
get_applications
Get the list of applications authorized to a user.
get_custom_list
Get the content of a custom list.
get_date
Format a timestamp in seconds into a date.
get_history
Get the history of modifications of application instances.
get_i18n
Internationalization method. Get the translation of a key in a given language. With this method, you can enforce the language type. Unlike the i18n() method, it applies to all process activities, not only to email activities.
get_instance_info
Get the metadata describing an application instance
get_lane_job_number
Get the expected job number to be done to complete the calculation of the users lane.
get_lane_users
Get the list of users pertaining to a lane.
get_lanes
Get the list of lanes a user pertains to.
get_manager
Get the user's manager.
get_next_url
Return the URL of a manual task.
get_parent_params
Retrieves all parameters from the parent process request.
get_preferences
Get the preferences associated to a user.
get_project_metadata
Get the metadata of a project.
get_random
Returns a random number generated by a uniform distribution.
get_random_gaussian
Returns a random number generated by a gaussian distribution.
get_request_info
Describe a process request.
get_task_url
Return the URL of the current manual task.
get_time
Transform a date into a timestamp.
get_user_data
Get a user's basic information (id, name, profile) from its login.
get_user_metadata
Get the metadata of a user.

H

has_right
Check if a user belongs to a lane in the current execution mode context.

I

i18n
Internationalization method. Get the translation of a key in a given language for email activities.
impersonate
Impersonate another user.
import_objects
Import objects in a collection from a file
import_objects
Import objects in a collection from a file
inject_objects
Inject retrieved objects in the execution context of a request
inject_params
Add the result of the last executed task to the context of a process request.
is_user_in_lane
Check if the user belongs to at least one lane of the list.

J

json_to_csv
Convert the JSON input array to CSV format

L

list_attached_file
List the files attached to an application.
list_objects
Retrieve objects from a collection
load
Convert/parse input to JSON according to its original format
load_object
Load a document from a collection

N

next_value
Get the next value of a named and persistent counter.
now
Get the current date and time.

P

P_add_user_to_lane
Add a user to the given runtime lane.
P_change_metadata
Change a value of the metadata user
P_change_preferences
Change a value of the preferences user
P_custom_header
Set an HTTP header for the response of a composite API
P_delete_project_vault
Delete a project vault
P_get_oauth2_token
Retrieve an OAuth2 service token
P_json_accumulate
Add a field to an existing object
P_json_accumulateAll
Add all fields of an object into another object.
P_json_parse
Parse an expression representing a JSONObject, into an object.
P_json_put
Add a field to an existing object
P_json_put_ext
Add a field to an existing object. This also works for nested objects. Objects within the path, that don't exist, will be created.
P_json_putAll
Add all fields of an object into another object.
P_json_remove
Remove a field from an object.
P_json_remove_ext
Remove a field from an object. This also works for nested objects. If attributes in the path don't exist, nothing will be done.
P_json_stringify
Serialize an object into a JSON string.
P_load_project_vault
Retrieve the project vault associated to the project containing the current request
P_log
Log a message.
P_log
Equivalent to P_log('FINEST', message).
P_markdown_to_html
Converts a Markdown document into its HTML representation. Markdown processor
P_quoted
Convenient method to quote a string.
P_remove_user_from_lane
Remove a user from the given runtime lane.
P_save_oauth2_token
Modify or create an OAuth2 service token
P_save_project_vault
Modify or create a project vault
P_set_request_status
Set the status of the current request to the statusCode.
P_to_array
Returns a JSONArray containing the content associated to a certain key in a JSONObject.
password_digest
Returns the encrypted version of a password that can be used in a Digest authentication

R

R_create_index
Creates indexes on collection
R_delete_index
Remove index on a collection
R_encode
Encode a string.
R_file_content
Read the content of a file.
R_file_desc
Get the metadata describing a file on the platform.
R_file_index_of
Find the index of the first occurrence of a string in a file.
R_file_last_index_of
Find the the last occurrence of a string in a file.
R_file_size
Get the size in KBytes of a file on the platform.
R_file_substring
Find the index of the first occurrence of a string in a file.
R_hmac_hash
HMAC is a keyed-hash message authentication code.
R_list_indexes
List of all indexes on a collection
R_lock
Lock a resource.
R_read_excel_cells
Read cells from an Excel worksheet.
R_read_file_add_lane
Add lanes allowed to READ the file(s).
R_read_file_add_user
Add users allowed to READ the file(s).
R_read_file_remove_lane
Remove lanes allowed to READ the file(s).
R_read_file_remove_user
Remove users allowed to READ the file(s).
R_rsa_hash
Generating RSA digital signature
R_unlock
Release a lock.
R_update_file_add_lane
Add lanes allowed to WRITE/DELETE the file(s).
R_update_file_add_user
Add users allowed to WRITE/DELETE the file(s).
R_update_file_remove_lane
Remove lanes allowed to WRITE/DELETE the file(s).
R_update_file_remove_user
Remove users allowed to WRITE/DELETE the file(s).
remove_collection
Remove a collection
remove_field
Remove a field from documents matching a where clause
remove_objects
Remove a subset of objects from a collection
rename_collection
Rename a collection.

S

safe_get
Returns the value of the key in the current context or defaultValue when key is undefined.
save_custom_list
Update a custom list with a new content.
save_file
Overwrite an existing file. Works only for uploaded files.
save_file
Overwrite an existing file. Works only for uploaded files.
save_file_desc
Modify the metadata describing a file on the platform.
save_object
Save object(s) in a collection
save_preferences
Modify the preferences of the current user.
save_user_metadata
Modify the metadata of a user.
set_status
Set the return HTTP status of a composite API.

T

throw
Throw an error.
timestamp
Get a timestamp.
to_xml
Transform a JSON object into a XML. Fields starting with @ will be output as XML attributes.
transpose
Transposition method of an array (in the application widget sense).

U

unblock_user
Unblock a user.
unzip_file
Unzip a file, and create a new file with the unzipped data. Works only for uploaded files.
update_field
Update a field on a subset of the documents in a collection
update_file
Update file metadata. Works only for uploaded files.
update_objects
Update a field on a subset of the documents in a collection
uuid
Generate a UUID.

Z

zip_file
Zip an file, and create a new file with the zipped data. Works only for uploaded files.

Index

  • Application

  • Collections

  • CompositeApi

  • File

  • Request

  • User

  • Utilities


© Akorbi Digital RMP. All Rights Reserved - Legal terms - Contact