Administrators have the flexibility to customize FlowGenie configuration to suit specific requirements and adjust the generated responses as needed.
Follow these steps to view and edit FlowGenie settings:
Ensure that you are logged on to ProcessMaker.
Click the Admin option from the top menu. The Users page will display.
From the Settings panel on the left, expand the Integrations section, and then select AI settings.
Text Model: This setting is used to determine the OpenAI model utilized when no file is included as part of the input.
Vision Model: This setting specifies the OpenAI model used when an image is provided as input.
Text System Prompt: This setting defines the system prompt utilized when no file is included as part of the input. Refer to OpenAI's guide for more details.
Vision System Prompt: This setting defines the system prompt utilized when an image is provided as part of the input. Refer to OpenAI's guide for more details.
Text JSON Prompt Suffix: This setting is used to append text to the Text System Prompt when the response format is set to JSON.
Vision JSON Prompt Suffix: This setting is used to append text to the Vision System Prompt when the response format is set to JSON.
Table Prompt Suffix: This setting is used to append text to the system prompt when the response format is set to Table.
Text Model Temperature: This setting specifies the temperature parameter used with the Vision Model. Refer to OpenAI's guide for more details.
Vision Model Temperature: This setting specifies the temperature parameter used with the Text Model. Refer to OpenAI's guide for more details.
Click the Settings icon from the left sidebar to view all settings.
Click the Search icon or press enter to view AI settings display that match your entered text.
Click the Edit icon to change a setting. For more information on different AI configurations, see Explanation of AI Settings.
Click the Copy to Clipboard icon to copy the value of a setting.
Click the Clear icon to clear the value of a setting.
Configure settings to connect to your ProcessMaker IDP server.
The intelligent document processing (IDP) settings allows a ProcessMaker Administrator to configure authentication to a ProcessMaker IDP instance. ProcessMaker Platform must be authenticated to a ProcessMaker IDP instance so IDP connectors configured in business processes may process documents during Requests.
Follow these steps to view the IDP settings:
Ensure that you are logged on to ProcessMaker.
Click the Admin option from the top menu. The Users page displays.
From the Settings panel on the left, expand the Integrations section.
Select IDP to view the following details:
Setting: The Setting column displays the IDP Setting name.
Configuration: The Configuration column displays the value of the setting and how it is configured.
The following information is required to authenticate with ProcessMaker IDP:
Client ID: The client ID is the unique key for your ProcessMaker Platform instance to authenticate IDP connectors implemented in your ProcessMaker IDP instance.
Client secret: The client secret is the time-sensitive and private code that your ProcessMaker IDP instance acknowledges to authenticate IDP connectors when connecting.
Token URL: The token URL references the valid authentication token that authenticates IDP connectors when during authentication.
To locate the client ID and client secret, both of which are private to your organization, contact your Customer Success Manager. Since the IDP package is part of the ProcessMaker Platform Enterprise edition, this functionality is not available in in the Open Source edition.
As part of this configuration, determine to which folders within your organization that Process designers using the IDP connector can reference to store documents for intelligent document processing. Note that until your ProcessMaker IDP instance authenticates with ProcessMaker Platform, the indicator Unauthorized displays beside the setting from which to select those folders. The indicator Authorized displays after authentication.
Follow these steps to authenticate with ProcessMaker IDP prior to selecting which folders to store documents for intelligent document processing:
Enter the integration key for your ProcessMaker IDP instance, and then click Save.
Enter the client secret for your ProcessMaker IDP instance, and then click Save.
Enter the URL that references the valid authentication token to your ProcessMaker IDP instance, and then click Save.
Click the Authorize Account button.
Prior to selecting the folders to store documents for intelligent document processing (IDP), ensure the following:
Folders exist in your ProcessMaker IDP instance. If they do not exist, you can create them through a request variable in the IDP Connector.
You have authenticated with your ProcessMaker IDP instance. Note that until your ProcessMaker IDP instance authenticates with the ProcessMaker Platform, the indicator Unauthorized will display beside the setting for selecting those folders. Once authentication occurs, the indicator Authorized will be shown.
Follow these steps to select IDP folders for storing documents uploaded in a Process:
Click Save.
Understand what external integrations to CDATA drivers are and how add them to your server environment.
CDATA integrates with a large library of third-party applications and services, including the following:
BambooHR
DocuSign
GitHub
Gmail
Microsoft Excel
Slack
ProcessMaker Platform simplifies integration with CDATA's drivers that seamlessly synchronize real-time data and streamline integration management.
ProcessMaker Platform integrates with CDATA's drivers in the following manner:
Administrators add a supported CDATA driver from Settings. Thereafter, configure authentication for that external integration.
Process Designers see the CDATA External Integration like any other Process model object. They add the external integration to their Process model, and then configure it for that object.
Display all CDATA External Integration settings in one location. This makes it easy to manage these settings.
Follow these steps to view all CDATA External Integration settings to synchronize users in your organization:
Ensure that you are logged on to ProcessMaker Platform.
Click the Admin option from the top menu. The Users page displays.
From the Settings panel on the left, expand the Integrations section.
Select External Integrations to view the following details:
Setting: The Setting column displays the External Integrations setting name.
Configuration: The Configuration column displays the value of the setting and how it is configured.
Follow the next steps to search for an External Integration setting:
In the Search setting, enter the Setting name to filter settings in that External Integration's configuration.
Click the +Driver button to add a CDATA driver. For more information on how to add an External Integration Driver, see Add a CDATA Driver.
Use the +Driver button to add a driver of a CDATA External Registration.
Follow these steps to add a CDATA driver for an External Registration:
​View your External Integrations. The External Registrations tab displays.
From the Select a Driver dropdown, select one of the following CDATA drivers:
BambooHR
DocuSign
GitHub
Gmail
Microsoft Excel
Slack
Click Add Driver.
Check each tab below to configure general information about CDATA External Integrations.
Before proceeding, ensure that you have the API Key from your registered BambooHR server. For information on how to obtain this key, see BamboHR's Getting Started with the API guide.
Follow these steps to connect to the BambooHR server:
​View your External Integrations. The External Integrations tab displays.
In the API Key setting, enter the API Key from your registered BambooHR account. For more information on how to get the API Key, see Authentication.
In the Domain setting, enter the domain from your registered BambooHR account. The domain is the text just before .bamboohr.com
for your domain.
Click Authorize. If authorization is successful, BambooHR will be listed as authorized on the External Integrations page.
Before proceeding, ensure that you have the client ID and client secret from your registered DocuSign driver.
Follow these steps to connect to the DocuSign server:
​View your External Integrations. The External Integrations tab displays.
In the Client ID setting, enter the client ID from your registered DocuSign driver. If testing DocuSign to get the client ID, see Enable OAuth for Connect.
In the Client Secret setting, enter the client secret from your registered DocuSign driver. If testing DocuSign to get client secret, see Enable OAuth for Connect.
Enable Use Sandbox if you are using a sandbox account.
Click Authorize. If authorization is successful, the External Integrations page lists DocuSign as authorized.
Before proceeding, ensure that you have the client ID and client secret from your registered GitHub driver.
Follow these steps to connect to the GitHub server:
​View your External Integrations. The External Integrations tab displays.
In the Client ID setting, enter the client ID from your registered GitHub driver. If testing GitHub to get the client ID, see Creating an OAuth app.
In the Client Secret setting, enter the client secret from your registered GitHub driver. If testing GitHub to get the client secret, see Creating an OAuth app.
In the Repository Name setting, enter the GitHub repository name to restrict query results.
In the User Login setting, enter the GitHub user name to restrict query results.
Click Authorize. If authorization is successful, the External Integrations page lists GitHub as authorized.
Before proceeding, ensure that you have the client ID and client secret from your registered Gmail driver. For information on getting the client ID and secret, see Google's Authentication API guide.
Follow these steps to connect to the Gmail server:
​View your External Integrations. The External Integrations tab displays.
In the Client ID setting, enter the client ID from your registered Gmail driver. For more information about how to get the client ID, see Obtain OAuth 2.0 credentials from the Google API Console.
In the Client Secret setting, enter the client secret from your registered Gmail driver. For more information about how to get the client secret, see Obtain OAuth 2.0 credentials from the Google API Console.
Click Authorize. If authorization is successful, the External Integrations page lists Gmail as authorized.
Before proceeding, ensure that you have the client ID and client secret from your registered Microsoft Excel driver.
Follow these steps to connect to the Microsoft Excel server:
​View your External Integrations. The External Integrations tab displays.
In the Client ID setting, enter the client ID from your registered Microsoft Excel driver. If testing Microsoft Excel to get the client ID, see Add a client ID and client secret.
In the Client Secret setting, enter the client secret from your registered Microsoft Excel driver. If testing Microsoft Excel to get the client secret, see Add a client ID and client secret.
From the Connection Type dropdown, select the service for storing and retrieving Microsoft Excel files such as Amazon S3, Azure Blog Store, Box, Dropbox, Google Cloud Storage, Google Drive, OneDrive, or SharePoint REST.
In the URI setting, enter the Uniform Resource Identifier (URI) for the Microsoft Excel resource location.
Click Authorize. If authorization is successful, the External Integrations page lists Microsoft Excel as authorized.
Before proceeding, ensure that you have the client ID and client secret from your registered Slack driver.
Follow these steps to connect to the Slack server:
​View your External Integrations. The External Integrations tab displays.
In the Client ID setting, enter the client ID from your registered Slack driver. If testing Slack to get the client ID, see Creating a Slack App.
In the Client Secret setting, enter the client secret from your registered Slack driver. If testing Slack to get the client secret, see Creating a Slack App.
Click Authorize. If authorization is successful, the External Integrations page lists Slack as authorized.
Click the Settings icon from the left sidebar to view all settings.
Click the Edit icon to change a setting. For more information on different IDP configurations, see Configure IDP Settings.
Click the Copy to Clipboard icon to copy the value of a setting.
Click the Clear icon to clear the value of a setting.
From the Client ID setting, click the Edit icon. The Client ID setting displays. This is a required setting.
From the Client Secret setting, click the Edit icon. The Client Secret setting displays. This is a required setting.
From the Host URL setting, click the Edit icon. The Host URL setting displays. This is a required setting.
From the Token URL setting, click the Edit icon. The Token URL setting displays. This is a required setting.
From the Select Available Folders setting, click the Edit icon. The Select available folders setting displays.
Click the drop-down menu to select one or more existing folders from which to store documents for processing. Click the Remove icon to remove an added folder.
Click the Settings icon from the left sidebar to view all settings.
Click the Search icon or press enter to view External Integration settings display that match your entered text.
Click the Edit icon to change a setting. For more information on different External Integration configurations, see Configure a CDATA External Integration.
Click the Delete icon to delete a CDATA External Integration.
The Copy to Clipboard icon is deactivated in External Integrations.
Click the +Driver button. The Add Driver window displays.
Click the Edit icon next to BambooHR to view its settings. If you do not see BamboHR in the list, see instructions on how to dd the driver.
Click the Edit icon for the DocuSign setting. The DocuSign screen displays.
Use the copy icon to copy the URL from the Redirect URL setting, and then provide it to your OAuth identity provider.
Click the Edit icon for the GitHub setting. The GitHub screen displays.
Use the copy icon to copy the URL from the Redirect URL setting, and then provide it to your OAuth identity provider.
Click the Edit icon next to Gmail to view its settings. If you do not see Gmail in the list, see instructions on how to add the driver.
Use the copy icon to copy the URL from the Redirect URL setting, and then provide it to your OAuth identity provider.
Click the Edit icon for the Microsoft Excel setting. The Microsoft Excel screen displays.
Use the copy icon to copy the URL from the Redirect URL setting, and then provide it to your OAuth identity provider.
Click the Edit icon for the Slack setting. The Slack screen displays.
Use the copy icon to copy the URL from the Redirect URL setting, and then provide it to your OAuth identity provider.
Understand what DocuSign is and how you can integrate it in your server environment.
DocuSign is a document management software that offers solutions for preparing, signing, and managing documents electronically. ProcessMaker Platform uses DocuSign's API to allow Process designers to seamlessly integrate DocuSign's eSignature functionality in a Process.
After the DocuSign package is installed, the DocuSign connector integrates into Process Modeler. Use the DocuSign connector in your Process models as a BPMN element: drag and place the DocuSign connector into your Process model, configure its settings, and then add its incoming and outgoing Sequence Flow elements.
The DocuSign connector uses DocuSign templates and recipient roles to send documents for eSignatures. Documents are sent through email to internal and external users as part of a Process. During a Request, when the DocuSign connector triggers, workflow routing can be configured in one of the following ways:
The Request pauses until the assigned user signs the document.
The Request's workflow resumes independently of the document's signing status.
For information on DocuSign templates and recipient roles, refer to Working with Templates - DocuSign eSignature User Guide.
Using the DocuSign package is a multi-step process involving these user roles:
System Administrators: An Administrator configures DocuSign server settings to ensure access to your DocuSign server.
Process designers: A Process designer configures the DocuSign connector in a Process to email documents for eSignatures to the intended recipients.
Recipients or document signers: The recipients access the documents through an email sent by DocuSign and sign them. The documents can be signed by both ProcessMaker Platform or external users.
Follow these guidelines to use the DocuSign package:
Display all DocuSign settings in one location. This makes it easy to manage these settings.
Follow these steps to view all DocuSign settings in your organization:
Ensure that you are logged on to ProcessMaker.
Click the Admin option from the top menu. The Users page displays.
From the Settings panel on the left, expand the Integrations section.
Select DocuSign to view the following details:
Setting: The Setting column displays the DocuSign Setting name.
Configuration: The Configuration column displays the value of the setting and how it is configured.
To allow access to your DocuSign server, the following information is needed:
DocuSign integration key
DocuSign secret key
DocuSign server address
To generate or locate this information for your DocuSign server, refer to Apps and Keys - DocuSign eSignature Admin Guide.
Configure the following DocuSign settings as necessary:
​View your DocuSign settings. The DocuSign tab displays.
Enter your DocuSign Integration key, and then click Save.
Enter your DocuSign Secret Key, and then click Save.
Enter your DocuSign server name, such as https://account-d.docusign.com
, and then click Save.
Click the Grant DocuSign Access button. The Task called DocuSign Authorization displays.
Click the Authorize Access button to grant the DocuSign eSignature platform access to your ProcessMaker Platform instance after it authenticates your DocuSign credentials. The DocuSign login page displays.
Enter your DocuSign account information to complete the authorization procedure.
Click the Settings icon from the left sidebar to view all settings.
Click the Edit icon to change a setting. For more information on different DocuSign configurations, see Configure DocuSign Settings.
Click the Copy to Clipboard icon to copy the value of a setting.
Click the Clear icon to clear the value of a setting.
Click the Edit icon for the Integration Key setting. The Integration Key screen displays.
Click the Edit icon for the Secret setting. The Secret screen displays.
Click the Edit icon for the Server setting. The Server screen displays.