Document a Script

Let ProcessMaker's AI Assistant to document functionality within a Script without coding skills.

Document a Script

Use ProcessMaker's AI Assistant to add comments into the Script to document its functionality. Your Script does not need to have been generated by AI Assistant to document it.

Your user account or group membership must have the following permissions to document a Script:

  • Scripts: View Scripts

  • Scripts: Create Scripts

  • Scripts: Edit Scripts

See the Scripts permissions or ask your Administrator for assistance.

Follow these steps to use AI Assistant to document a Script:

  1. Generate or edit a Script to document.

  2. Expand the AI Assistant panel. The AI Assistant features display.

  3. Click the Document option. AI Assistant processes the currently displayed script, and then Script Editor displays two panes:

    • Current Script: The Current Script pane displays the script prior to its documentation.

    • AI Generated Response: The AI Generated Response pane displays the AI-documented script. Additional lines of code that document functionality display with a green-colored highlight.

  4. Click one of the following buttons from the AI Generated Response pane:

    • Apply: Click the Apply button to accept the AI-documented script. Script Editor displays the AI-documented script in its default view.

    • Cancel: Click the Cancel button to not accept the AI-documented script. Script Editor displays the current script in its default view.

pageScript Editor OverviewpageGenerate Your Script Using AI AssistantpageClean a Script to Improve its CodepageExplain How a Script FunctionspageDevelop Your Script in Script EditorpageEnter Mock Request Data Coming Into Your ScriptpageEnter Other JSON Data as Input to Your ScriptpageTest Your ScriptpagePass Request Data into Your ScriptpageEnvironment Variable and Magic Variable Syntax, Usage, SDK, and Script Examples

© Copyright 2000-2024 ProcessMaker Inc. All rights reserved.