Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Configure and manage the scenarios for a Process.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Manage your process tests.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Edit a Process's general settings, Screen translations, notifications, comments, versioning, and vocabularies.
Configure and manage the Screen translations for a Process.
Edit general settings of a process like the name, manager or the status.
Your user account or group membership must have the following permissions to configure a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to configure general settings for a Process:
Edit the following Process configuration as necessary:
In the Name setting, edit the unique name of the Process. This is a required setting.
In the Description setting, edit the description of the Process. This is a required setting.
From the Case Title setting, enter how the title for a Case displays for this Process. The Case title displays under the Case Title column in Request pages and Task pages. Customize the Case title by referencing a Request variable in mustache syntax that is used in this Process. For example, to customize the Case title for a new employee onboarding Process, use Employee Onboarding: {{ FirstName }} {{ LastName }}
. Note that the Case Title column only displays up to 200 characters after Request variable values render.
From the Request Detail Screen drop-down menu, select the Screen that displays in the Summary tab of the Request while that Request is in progress. After that Request completes, this Screen is replaced with the Summary Screen configured from the End Event element, if any.
From the Status drop-down menu, select one of these options:
Click Save.
Understand how Screen Translations work within a Process.
Use Process Translations to translate all Screens that a selected Process may use during its Requests. The original Screen is not translated directly, so that other ProcessMaker Platform assets, such as other Processes or Collections, are not affected by a translated Screen into a language not intended to display content. Instead, ProcessMaker Platform only translates Screens at the time of their use, and only for Requests. They are not translated for use in Collections.
ProcessMaker Platform evaluates how to display the Screen at the time of its use in the following way:
If the Screen is translated to a natural language that ProcessMaker Platform supports, then that Screen displays in the logged on user's language as determined by the profile setting.
For anonymous Web entry, the Web browser language preference setting determines which translated Screen to display.
If the Screen is translated to a natural language that ProcessMaker Platform does not support, then the Screen displays in the translated language at the time it renders.
When a Process is exported, and then imported to another ProcessMaker Platform instance, those Screens that have natural languages translations also export and import with that Process.
Click the ellipses icon, and then select the Configure option for your Process. The Configuration tab displays.
From the Category drop-down menu, select to which categories to assign this Process. In doing so, Process Categories may be sorted from the Processes page. To remove a Process Category that is currently selected, click the icon for that selection or press Enter
when the drop-down is visible. This is a required setting. See What is a Process Category? for more information how this affects new Requests for this Process.
From the Project drop-down menu, optionally select the Project(s) that this Process becomes an asset. This setting only displays Projects of which you are a member. To remove a Project that is currently selected, click theicon for that selection or press Enter
when the drop-down is visible.
From the Process Manager drop-down menu, select which user is the Process Manager. If this Process is not configured correctly, such as with a Process Manager, then the following icon displays preceding the process name of the Processes page:. The Processes page displays all active and inactive Processes.
From the Cancel Request drop-down menu, assign which user(s) or group(s) have permission to cancel Requests from this Process. If no users or groups are selected, no one can cancel a Request from this Process. Type into the Cancel Request setting to filter users and/or groups that display in that setting's drop-down menu. To remove a user or group that is currently selected, click the icon for that selection or press Enter
when the drop-down is visible.
From the Edit Data drop-down menu, assign which user(s) or group(s) have permission to edit Request data from this Process. To remove a user or group that is currently selected, click the icon for that selection or press Enter
when the drop-down is visible.
Active: Select the Active option to allow users to start new Requests of this Process. Active processes display the Active iconwhen viewing your Processes.
Inactive: Select the Inactive option to prevent users from starting new Requests of this Process. Setting a Process as Inactive only disables starting new Requests of this Process. Any in-progress Requests are not affected by this change and can complete. Inactive Processes display the Inactive iconwhen viewing your Processes.
View the languages to which the Screens for a Process are translated.
ProcessMaker Platform displays all translations for a Process's Screens in one location. These Screens are rendered in the translated language only for that Process's Requests, and only at the time of their use in a Request. See What is Screen Translation for a Process? for more information about how Screens are rendered for translation.
Your user account or group membership must have the following permissions to view Screen translations for a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to view all translations for a Process:
Configure general settings for the Process in which to view its Screen translations. The Configuration tab displays.
Click the Translations tab. Languages to which the Process's Screens have been translated display.
The Translations tab displays the following information in tabular format about language translations for the selected Process:
Target Language: The Target Language column displays to which target language the Screens for the Process are translated.
Created: The Created column displays the date and time the translation was created. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
Modified: The Modified column displays the date and time the translation was last modified. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
Use the Search setting to filter which language translations that display.
Click the +Translation button. See Translate Screens for a Process.
Click the Import button. See Import Language Translations for Screens Used in a Process.
Translate all Screens that are used in a Process.
Follow these steps to start translating Screens used by a Process:
Click the Translations tab. Languages to which the Process's Screens have been translated display.
Click the +Translation button. The Add Process Translation screen displays.
Do one of the following:
Manually translate Screens: Select the Manual translation checkbox to manually translate the control labels for each Screen the Process uses.
Click the Translate Process button. See one of the following sections depending on whether Screens are automatically or manually translated:
Follow these steps to automatically translate Screens a Process uses:
Screens are translating: While the Screens are translating, the following message displays: Translation in Progress. A percentage of completion displays following this message.
Screen translation error: If a Screen translation error occurs, the following message displays: An error occurred while calling OpenAI endpoint.
When translation for the Process's Screens complete, the selected language displays in the Translations tab.
Follow these steps to select which Screen control labels to translate manually:
When the control labels for those strings are retrieved, they display in tabular format:
String: The String column displays that Screen controls' labels in the original language.
Translation: The Translation column displays the translation for each control's label in the target, translated language. By default, when translating manually, there are no translations for these strings.
From the Screen drop-down menu, select from which Screen to translate its control labels.
Do one of the following:
Manually translate all or only untranslated strings from the original control labels by clicking the Translation Options button, and then selecting one of the following options:
Automatically translate all strings in this Screen: Select the Auto Translate All option to automatically translate all original control labels for the selected Screen. In doing so, all manually translated strings are automatically overwritten.
Automatically translate only strings with no current translations: Select the Auto Translate Empty option to only automatically translate those strings which have translations for the original control labels.
Click the Translate button. Strings based on your selection are automatically translated.
Manually translate all strings for the selected Screen's control labels. To enter a translation for a string, click into the field from the Translation column for that control label. The field becomes editable. Enter the string as necessary.
After finalizing the translations for each control label for all Screens, click Save Translation.
Click the ellipses icon, and then select the Edit Translation option. See Edit Screen Translations for a Process.
Click the ellipses icon for a language with partial Screen control translations, and then select the Retry Empty Translations option. ProcessMaker Platform automatically restarts the translation procedure to translate those controls that have no language translations.
Click the ellipses icon, and then select the Export option. See Export Language Translations for Screens Used in a Process.
Click the ellipses icon, and then select the Delete Translation option. See Delete Language Translations for Screens Used in a Process.
See the permissions or ask your Administrator for assistance.
.
. The Configuration tab displays.
Automatically translate Screens: From the Select a target language drop-down menu, select to which language to translate all Screens this Process may use in any Request. Screen translations are only rendered at the time of use. See for more information about how Screens are rendered for translation.
. One of the following occurs during automatic translation:
Optionally, .
. ProcessMaker Platform retrieves the control labels for those Screens.
Import a language translation for the Screens used in a Process.
Use caution when importing language translations for a Process in which its Screens are partially translated because existing translations may be overwritten upon import. Importing translations use the following protocol:
If the importing language translation contains a string that corresponds with a Screen control's translated string, the importing string overwrites the existing string for that control. For example, if the Screen control contains a translation for Full Name
, the importing translation overwrites the existing translation.
If the importing language translation contains a string that corresponds with a Screen control not containing a translated string, the importing string imports to that control's translation. For example, if there is no translation for Full Name
, the importing translation becomes the control's translation.
If the importing language translation contains a string that corresponds with a Screen control in which its value is null
, then the importing string does not import for that control's translation.
Follow these steps to import translated Screens for a selected Process:
Click the Translations tab. Languages to which the Process's Screens have been translated display.
Click the Import button. The Import Process Translation page displays.
Click the Select file from computer link to locate the language translation of a Process's Screens to import. Translations have the .json
file extension. ProcessMaker Platform evaluates the file to import. If the language translations was not exported from the same or later ProcessMaker Platform version as being imported, that language translation may not import.
The Import Process Translation page displays the Process's Screens previously translated to the language shown in the summary.
Click the Import button. The following message displays: The Process Translation was imported successfully. The Translations tab displays to indicate that the language translation imported correctly unless that language translation already existed in this ProcessMaker Platform instance.
Import that have been exported from the same version or later. In doing so, the selected Process imports all Screens used in that Process only in the language from which those Screens were previously exported for this Process. Screens cannot be imported for other than the selected Process.
See the permissions or ask your Administrator for assistance.
.
. The Configuration tab displays.
Edit the translations for the Screens used in a Process.
Your user account or group membership must have the following permissions to edit Screen translations for a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to edit Screen translations for a Process:
Configure general settings for the Process in which to edit its Screen translations. The Configuration tab displays.
Click the Translations tab. Languages to which the Process's Screens have been translated display.
From the Screen drop-down menu, select from which Screen to translate its control labels.
Do one of the following:
Manually translate all or only untranslated strings from the original control labels by clicking the Translation Options button, and then selecting one of the following options:
Automatically translate all strings in this Screen: Select the Auto Translate All option to automatically translate all original control labels for the selected Screen. In doing so, all manually translated strings are automatically overwritten.
Automatically translate only strings with no current translations: Select the Auto Translate Empty option to only automatically translate those strings which have translations for the original control labels.
Click the Translate button. Strings based on your selection are automatically translated.
Manually translate all strings for the selected Screen's control labels. To enter a translation for a string, click into the field from the Translation column for that control label. The field becomes editable. Enter the string as necessary.
After finalizing the translations for each control label for all Screens, click Save Translation.
Search for a language translation for Screens used in a Process.
Your user account or group membership must have the following permissions to search for Screen translations for a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to search Screen translations for a Process:
Configure general settings for the Process in which to search its Screen translations. The Configuration tab displays.
Click the Translations tab. Languages to which the Process's Screens have been translated display.
Enter in the Search setting the text to filter language into which Screens have been completely translated. This search does not filter against languages in which Screens are in progress of being translated.
As you enter text into the Search setting, languages display that match your entered text. This search does not filter for languages in which Screen are in the progress of being translated.
If there are no search results, the following message displays: No Results.
Export a selected language translation for the Screens used in a Process.
Export the Process's Screen translations for one selected language to which those Screens are translated. This function does not export all translations for all languages to which the Process's Screens have been translated.
Follow these steps to export the language translations for the Screens used in a Process:
Click the Translations tab. Languages to which the Process's Screens have been translated display.
Click Export.
By default, ProcessMaker Platform exports the language translation using the Process name except spaces in the name are replaced with underscores (_
), suffixed with the language name. The file has the file extension .json
. Rename the default file name if necessary, though do not change the file extension. As a best practice, specify in the file name that this is an exported language translation for that Process's Screens to distinguish it from other exported assets.
Specify a directory location to save the file. ProcessMaker Platform exports the .json
file to your local computer. The following message displays when the language translation exports successfully: The translation for the process was exported.
Optionally, click the ellipses icon for a language with partial Screen control translations, and then select the Retry Empty Translations option. ProcessMaker Platform automatically restarts the translation procedure to translate those controls that have no language translations.
Click the ellipses icon, and then select the Edit Translation option for the Screen translations of the targeted language to edit. ProcessMaker Platform retrieves the control labels for those Screens.
See the permissions or ask your Administrator for assistance.
.
. The Configuration tab displays.
Click the ellipses icon for a language translation to export, and then select the Export Translation option. The Export Process Translation page displays.
Delete a selected language translation for the Screens used in a Process.
Your user account or group membership must have the following permissions to delete Screen translations for a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Delete Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to delete Screen translations for a Process:
Configure general settings for the Process in which to delete any of its Screen translations. The Configuration tab displays.
Click the Translations tab. Languages to which the Process's Screens have been translated display.
Click Confirm. The following message displays: The Process Translation was deleted.
Click the ellipses icon, and then select the Delete Translation option for the Screen translations of a target language to delete. The Caution screen displays to confirm the deletion of the language translation.
Edit notifications for Request events for a Process.
Your user account or group membership must have the following permissions to configure a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Configure Process notifications to notify Request starters and/or participants when any of the following Request events occur:
Request started: A Request for this Process started.
Request canceled: A Request for this Process was canceled.
Request completed: A Request for this Process completed.
Request error: A Request for this Process has an error.
Request comment: A Request for this Process has comments.
Process notifications can be sent to the following sets of users or group members:
Process Manager: The Process Manager is an optional user assigned this role from the Process's configuration. The Process Manager understands the Process design and workflow dynamics to troubleshoot Request routing incidents.
Requester: A Requester is any user or group member who has been granted permission to start a Request for this Process.
Participants: A Participant is any user or group member who participates in a specific Request for this Process. A Request participant is an individual who is assigned a Task in the Request.
Follow these steps to configure notifications for a Process:
Click the Notifications tab.
Toggle any of the following settings as necessary:
Request Started: Toggle the Request Started toggle key to indicate whether Request starters are notified that a Request from this Process started.
Request Canceled: Toggle the Request Canceled toggle key to indicate whether Request starters and/or Request participants are notified that a Request from this Process was canceled.
Request Completed: Toggle the Request Completed toggle key to indicate whether Request starters and/or Request participants are notified that a Request from this Process completed.
Request Error: Toggle the Request Error toggle key to indicate whether Request starters and/or Request participants are notified that a Request from this Process has errors.
Request Commented: Toggle the Request Commented toggle key to indicate whether Request starters and/or Request participants are notified that a Request from this Process has comments.
Click Save.
Click the ellipses icon, and then select the Configure option for your Process. The Configuration tab displays.
Understand how Scenarios work within Process Testing.
Use Process Testing to evaluate runtime behavior of a Process. Process Testing provides the following benefits:
Automate testing: Eliminate manual, repetitive testing that allows Process Designers to evaluate specific behaviors and workflow. Automate multiple runs against a series of test data. Tasks in each test automatically simulate completion. Validation requirements within Screens for Form Task and Manual Task elements are ignored.
Reduce time to delivery: Greatly accelerate the time to design and deliver sophisticated, complex Processes to production.
Increase the quality of solution delivery: More rapidly evaluate, identify, and debug specific behaviors in the business solution.
Test without starting Requests: Instead, Process Testing mocks Requests using mock Request data. Therefore, Process Testing does not trigger log events nor affect Save Search results.
Specify the scope of the Process Test: Testing can run either end-to-end or from a midway breakpoint. The breakpoint may be the Process model object from which to begin your evaluation: automate the test run to that object, and then manually test the remainder of that mock Request. Tests do not need to be started from the starting object in the Process. A test may be started from a selected object when preparing to run a test.
A Process Scenario contains the scope of a Process Test run using mock Request data. Create Scenarios from that Process's configuration, and then run them from the Process model in Process Modeler.
Process Testing can automate multiple runs against a series of test data in the Scenario. Tasks in each test automatically simulate completion using the mock Request data.
View the saved scenarios for a Process.
ProcessMaker Platform displays all saved Scenarios for a Process. See What is Process Testing? for more information about how Scenarios work in Process Testing.
Your user account or group membership must have the following permissions to view Scenarios for a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to view all Scenarios for a Process:
Configure general settings for the Process. The Configuration tab displays.
Click the Scenarios tab. Testing Scenarios display.
The Scenarios tab displays the following information in tabular format for the selected Process:
Name: The Name column displays the Scenario name for the Process.
Description: The Description column displays the Scenario description.
Created: The Created column displays the date and time the Scenario was created. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
Modified: The Modified column displays the date and time the Scenario was last modified. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
Use the Search setting to filter which Scenario displays.
Click the +Scenario button. See Create a Scenario for a Process.
Create Scenarios in a Process.
The following table describes the advantages and disadvantage to this method.
Specify the specific JSON data model to test in one of the following ways:
Create a Scenario, and then enter the specific JSON data model in the Data setting.
Run the test:
Enter the specific JSON data model in the Additional Data setting.
A method by which to create a Scenario is from a Request's data. This method does not require to know JSON, the data structure for the data model from which to test, or to build the data.
The following table describes the advantages and disadvantages to this method.
Follow these steps to create a Scenario from a Request data:
Evaluate the following about the Request's data under consideration:
The Request's workflow has proceeded to contain relevant data for the Process Test.
The values in that Request's data are those that you want for your Process Test. If not, then editing that Request's data may be necessary after creating the Scenario.
Follow these steps to create a Scenario for a Process:
Click the Scenarios tab. Testing Scenarios display.
Click the +Scenario button. The Create Scenario window displays.
From the Name setting, enter the Scenario name for the Process. This is a required setting.
From the Description setting, enter the Scenario description for the Process.
Click Save.
Click the ellipses icon, and then select the Edit Scenario option. See Edit Scenarios for a Process.
Click the ellipses icon, and then select the Delete option. See Delete Scenarios in a Process.
Follow these guidelines to create a :
.
.
A method by which to is to provide only the specific JSON data model that contains the Process model object(s) to test. A test need not begin from the Start-type element to start a Request. Therefore, mock Request data is necessary only from the Process model object from which to begin the test.
Advantage | Disadvantage |
---|
. It is not necessary to select a Scenario.
Advantage | Disadvantage |
---|
Locate a or to verify that it contains the JSON data from which to create the Scenario.
Click the Create Scenario button from that Request or Task summary. .
See the permissions or ask your Administrator for assistance.
.
. The Configuration tab displays.
From the Data setting, enter the JSON data model for the Process Scenario that mocks the during Process Testing.
Does not require knowing JSON | Requires running real Requests from which to create the Scenario, thereby triggering logging events and data available to Saved Searches |
No need to build the JSON data model | Scenario contains the JSON data model only to the last triggered object in that Request, which may not contain |
Scenario may not contain exactly the mock Request data to test, so editing the Scenario may be required |
Do not need a Scenario to run a test |
Need only the specific mock Request data from which to test |
Search for a Scenario in a Process.
Your user account or group membership must have the following permissions to search for Scenarios for a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to search Scenarios for a Process:
Configure general settings for the Process. The Configuration tab displays.
Click the Scenarios tab. Testing scenarios display.
Enter in the Search setting the text to filter Scenarios.
As you enter text into the Search setting, Scenarios display that match your entered text.
If there are no search results, the following message displays: No Results.
Requires to know JSON to either build the JSON data model or copy from
Edit a Scenario used in a Process.
Your user account or group membership must have the following permissions to edit Scenarios for a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to edit a Scenario for a Process:
Configure general settings for the Process. The Configuration tab displays.
Click the Scenarios tab. Testing scenarios display.
Edit the following if necessary:
From the Name setting, edit the scenario name for the Process. This is a required setting.
From the Description setting, edit the Scenario description for the Process.
From the Data setting, edit the JSON data model for the Process Scenario that mocks the Request data during Process Testing.
Click Save.
Click the ellipses icon, and then select the Edit Scenario option for the Scenario to edit. The Edit Scenario window displays.
Delete a testing Scenario for a Process.
Your user account or group membership must have the following permissions to delete Scenarios for a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Delete Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to delete a Scenario for a Process:
Configure general settings for the Process. The Configuration tab displays.
Click the Scenarios tab. Testing Scenarios display.
Click Confirm.
Click the ellipses icon, and then select the Delete option for the Scenario. The Caution window displays to confirm the deletion of the Scenario.
View the Tests for a Process.
ProcessMaker Platform displays all Process Tests for completed and in-progress test runs.
Your user account or group membership must have the following permissions to view Tests for a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to view all Tests for a Process:
Configure general settings for the Process. The Configuration tab displays.
Click the Test Runs tab. Test for the Process display.
The Test Runs tab displays the following information in tabular format for the selected Process:
Test #: The Test # column displays the test number.
Status: The Status column displays if the test is active, canceled, or completed.
Created: The Created column displays the date and time when the test was created. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
Completed: The Completed column displays the date and time the test was completed. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
Use the Search setting to filter which test displays.
Click the +Test button. See Create a Test for a Process.
Click the Play icon for a selected test. See Track Tests for a Process.
Click the Clear button. See Clear Tests Data.
Search for a Test in a Process.
Your user account or group membership must have the following permissions to search for Tests for a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to search Tests in a Process:
Configure general settings for the Process. The Configuration tab displays.
Click the Test Runs tab. Tests display.
Enter in the Search setting the text to filter tests.
As you enter text into the Search setting, tests display that match your entered text.
If there are no search results, the following message displays: No Results.
Create Tests in a Process.
Your user account or group membership must have the following permissions to create Test Runs for a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to create a Test Run for a Process:
Configure general settings for the Process. The Configuration tab displays.
Click the Tests tab. Tests display.
Click the +Test button. The Run Test window displays.
From the Starting Step setting, select the Process model object from where to start the test.
Optionally from the Scenario setting, select a Scenario for the Process.
Optionally from the Additional Data setting, add a JSON structure for the test.
Click Run. The test displays in the Test Runs tab.
Track Tests in a Process.
Your user account or group membership must have the following permissions to track tests for a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to track tests for a Process:
Configure general settings for the Process. The Configuration tab displays.
Click the Test Runs tab. Tests display.
Click the Play icon for a selected test. The Process test displays as similarly when you are running a Request.
From the Form tab, complete Task Forms similarly to when running a Task.
From the Data tab, edit task data similarly to when running a Task.
From the Overview tab, track your test in a process map similarly to when running a Request.
From the Emails tab, check email data during the test.
From the Summary section, check the summary test. There is just an option to cancel the test similarly to when running a Request.
Clear all Tests for a Process.
Your user account or group membership must have the following permissions to clear all Tests for a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to clear all Tests for a Process:
Configure general settings for the Process. The Configuration tab displays.
Click the Tests tab. Tests for the Process display.
Click the Clear button. All Process tests are cleared.
Edit the set of changes in the process designing.
A version is a set of changes made to a Process at a particular time by a Process designer. Versioning maintains a record of all named and unnamed changes to that Process. Any of these versions may be viewed or retrieved, if needed. The Version History page displays all saved versions of the Process in a tabular format from where they can be edited and/or marked as the Current Version
according to your business needs. The current version of a Process is used in all new Requests of that Process. Version changes are not reflected in Requests which were in-progress or already completed when the version changed. See the Versioning package for more information.
The Versioning package must be installed to view or edit the version history for a Process.
Furthermore, your user account or group membership must have the following permissions unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Version History: Edit Version History
Version History: View Version History
See the Processes and Version History permissions or ask your Administrator for assistance.
Follow these steps to view or edit the version history of your Process:
Click on the Version History tab. The Version History page displays.
The Version History page organizes versions in a monthly format and displays the following information:
Date: The date and time of when a Process Designer saved this version in the Process Modeler.
Current Version: The most recent version of the Process is displayed at the top and is marked as the Current Version
. This version is used in all in-progress and new Requests.
Name: The name of this version as entered by a Process Designer when saving the Process in Process Modeler.
Description: A description of the changes in this version as entered by a Process Designer when saving the Process in Process Modeler.
Saved by: The name of the Process Designer who saved this version.
Toggle the Only show named versions toggle key to show only the versions with a name assigned to them.
Optionally, edit any of the following existing details about this named version:
In the Version Name setting, edit the name to this named version. If saving this named version with no name, this version does not display in the Version History page if the Only show named versions toggle key is enabled.
In the Additional Details (optional) setting, edit the details about this version. For example, describe the changes in this version for auditing, historical, or maintenance purposes.
Click Confirm and Save to save your changes. Otherwise, click Cancel.
Click Confirm and Save to set this version as the current version. Otherwise, click Cancel.
Click the ellipses icon, and then select the Configure option for your Process. The Configuration tab displays.
Click the Edit version Details iconto edit version details for this version. The Edit version details screen displays.
Click the Copy to latest iconto set a version as the current version. The Copy to latest screen displays.
The screen displays the warning This version will become the active version for this asset
,
indicating that this action will set this version as the current version.
Assign Vocabularies to a Process to validate Request data.
Assign Vocabularies that validate Request data complies with a specific JSON schema. This is often mandatory for many types of business sectors including banking and healthcare. Ensure the quality and compliance of Request data. For example, during a Loan Application process, ensure that personal information has been included in the Request to that moment in that in-progress Request. The Vocabularies package must be installed to make this configuration.
Each moment ProcessMaker Platform evaluates workflow routing for an in-progress Request, ProcessMaker Platform also evaluates the Request data's conformity to the Vocabularies applied to the Process and/or a specific BPMN 2.0 element in the Process model. The Request's JSON data model must conform to the Vocabulary's JSON schema.
During an in-progress Request, if ProcessMaker Platform evaluates that the Request data no longer complies with all Vocabularies to that moment, the Request status changes from In Progress to Error. The error displays in the Request summary. Vocabularies are cumulative in an in-progress Request: as the Request progresses, if Request data does not conform with any Vocabulary's JSON schema to that moment in the Request, the Request errors.
If no Vocabularies are assigned, ProcessMaker Platform does not validate Request data complies with a specific JSON schema prior to continuing workflow for that Request.
One or more Vocabularies must be created before assigning a Vocabulary. See Create a New Vocabulary. Multiple Vocabularies can be assigned to a Process.
The Vocabularies package must be installed to assign which Vocabularies validate Request data for a Process. Use the Vocabularies package to maintain uniform JSON schemas across all ProcessMaker assets in your organization. These assets include Processes, Screens, and Scripts.
A Vocabulary is a JSON schema. The JSON schema describes the data objects, types, and structure that you want in both a machine and human-readable format. Apply one or more Vocabularies to your Processes and/or specific BPMN 2.0 elements in your Process models to ensure the JSON data model in Request data complies with the data structure outlined in the JSON schema that you need to meet regulatory specifications or ensure Request data contains required information.
Your user account or group membership must have the following permissions to configure a Process unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
See the Processes permissions or ask your Administrator for assistance.
Follow these steps to assign Vocabularies that validate Request data from this Process:
Click the Vocabularies tab. If the Vocabularies package is not installed then the Vocabularies tab is not visible and this configuration cannot be performed.
From the Assign Process Vocabularies drop-down, select which Vocabularies are available for this Process.
If no Vocabularies are configured, then the following message displays: List is empty. Create at least one Vocabulary. See Create a New Vocabulary.
Click Save.
Click the ellipses icon, and then select the Configure option for your Process. The Configuration tab displays.
Type into the Type to search vocabularies setting to filter Vocabularies that display in that setting's drop-down menu. To remove a Vocabulary that is currently selected, click the icon for that selection or press Enter when the drop-down is visible.