Manage Projects throughout your organization.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Manage your Project Categories.
View the Project Categories in your organization.
Your user account or group membership must have the following permissions to view Project Categories unless your user account has the Make this user a Super Admin setting selected:
Projects: View Project Categories
Projects: View Projects
See the Projects permissions or ask your Administrator for assistance.
Follow these steps to view Project Categories:
Log on to ProcessMaker Platform.
Click the Designer option from the top menu. The Designer page displays.
Click the Categories tab. The Projects Categories display.
The Categories tab displays the following information in tabular format about Project Categories:
Name: The Name column displays the name of the Project Category. The Project Category named Uncategorized is the default Category.
Status: The Status column displays the status of the Project Category. Below is a description of each status:
Active: Active Project Categories can have Projects assigned to them. The Project Category named Uncategorized is active by default.
Inactive: Inactive Project Categories cannot have Projects assigned to them.
Projects: The # Projects column displays how many Projects in your organization have been assigned to that Project Category.
Modified: The Modified column displays the date and time the Project Category 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.
Created: The Created column displays the date and time the Project Category 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.
If no Project Categories exist, the following message displays: No Results.
Use the Search setting to filter Project Categories by their names.
​Control how tabular information displays, including how to sort columns or how many items display per page.
Understand what Project Categories are and how they can help organize your Projects.
Use Project Categories to organize your Projects. Organizing your Projects into Categories makes it easier to search for a Project based on its assigned Category. Assign multiple Project Categories to a Project if necessary. For example, assign a Project named "Photo Capture and Intelligent Document Processing (IDP)" to the "Banking" and "Human Resources" Project Categories.
Project Categories can be in active or inactive status. Following is a description of each status:
Active: Active Project Categories can have Projects assigned to them.
Inactive: Inactive Project Categories cannot have Projects assigned to them.
ProcessMaker Platform has multiple Category types for different types of assets. Each Category type is distinct from the others and can only be used for its type of ProcessMaker Platform asset. Following is a description of each Category type:
Project Categories: Organize your Projects.
Process Categories: Organize your Processes.
PM Block Categories: Organize your PM Blocks.
Script Categories: Organize your Scripts.
Screen Categories: Organize your Screens.
Data Connector Categories: Organize your Data Connectors.
Decision Table Categories: Organize your Decision Tables.
Click the Projects icon from the left sidebar. The Projects tab displays all Projects in the Projects page.
Search for a Project Category.
Your user account or group membership must have the following permissions to search for a Project Category unless your user account has the Make this user a Super Admin setting selected:
Projects: View Project Categories
Projects: View Projects
See the Projects permissions or ask your Administrator for assistance.
Follow these steps to search for Project Categories:
Enter in the Search setting the text to filter Project Categories by name.
As you enter text into the Search setting, Project Categories display that match your entered text.
If there are no search results, the following message displays: No Results.
Edit the name and/or status of a Project Category.
Edit the following information about the Project Category as necessary:
In the Category Name setting, edit the name of the Project Category if necessary. The Project Category name must be unique from all other Project Category names in your organization. This is a required setting.
From the Status drop-down menu, change the status of the Project Category, if necessary, from the following options:
Active: Active Project Categories can have Projects assigned to them.
Inactive: Inactive Project Categories cannot have Projects assigned to them.
This is a required setting.
Click Save.
See the permissions or ask your Administrator for assistance.
Follow these steps to edit a :
.
Click the ellipses icon, and then select the Edit Category option for the Project Category to edit. The Edit Category page displays.
Delete a Project Category when it is no longer needed.
Your user account or group membership must have the following permissions to delete a Project Category unless your user account has the Make this user a Super Admin setting selected:
Projects: Delete Project Categories
Projects: View Project Categories
Projects: View Projects
See the Projects permissions or ask your Administrator for assistance.
To delete a Project Category, no Projects can be assigned to it. If any Projects are assigned to the Project Category, its Delete Category option does not display. Reassign those PM Blocks to another PM Block Category.
Deleting a Project Category cannot be undone.
Follow these steps to delete a Project Category:
Click Confirm. The following message displays: The category was deleted.
Create a new Project, which is a way to group assets under the same goal. Projects makes it easier and more efficiently organize assets to develop the same business solution.
Follow these steps to create a new Project:
Do one of the following from any of these locations in ProcessMaker Platform:
Projects page
Click the +Add Project button.
Designer welcome page (when the Projects Screen displays, which is the default)
Click the Designer top menu. The Designer welcome page displays.
Locate the My Projects section in the Designer page.
Click the Create a Project link.
The Add New Project page displays. SCREENSHOT
In the Name setting, enter the unique name for the Project. Project names must be unique in your organization, and can only use apostrophe characters ('
) and spaces. This is a required setting.
In the Description setting, enter a description of the Project. This is a required setting.
Click Add.
Your new Project displays in the Projects page.
Click the ellipses icon, and then select the Delete Category option for the Project Category to delete. A message displays to confirm deletion of the Project Category.
Both of these permissions are enabled by default for all user accounts. If you cannot create a Project, see the permissions or ask your Administrator for assistance.
. The Projects page displays.
From the Category drop-down menu, select one or more to associate with this Project. In doing so, Project Categories may be sorted from the . To remove a Project Category that is currently selected, click theicon for that selection or press Enter
when the drop-down is visible. This is a required setting.
Collaborate with others to work with you on your Project.
Optionally invite new members to a Project. A Project member may be a user or a group. When inviting a group to a Project, all members in that group become Project members.
All members in a Project may use the assets within it. Project membership does not grant viewing assets not within the Project unless that user has user or group permissions for individual asset types.
Your user account or group membership must have the "Projects: View Projects" permission to invite new members to a Project unless your user account has the Make this user a Super Admin setting selected.
This permission is enabled by default for all user accounts. Note that you can only invite users to Projects in which you are a member or which you created. If you cannot do so, see the Projects permissions or ask your Administrator for assistance.
Follow these steps to invite new members to a Project:
From the Members setting, select which user(s) or groups to invite to this Project. When inviting a group, all members of that group are invited to that Project, and a notification send.
Optionally, remove members from a Project. A Project member may be a user or a group.
A user in the following circumstances can no longer view any assets of any type when removed from a Project:
The Project from which that user was removed was the only Project that user was a member. Likewise, this user is not a group member that is a Project member. To address this, that user must be added to at least one Project to view its assets.
That user does not have user or group permissions to work with individual types of assets. To address this, that user must be assigned user and/or group permissions for individual asset types or all permissions.
Your user account or group membership must have the "Projects: View Projects" permission to remove members from a Project unless your user account has the Make this user a Super Admin setting selected.
This permission is enabled by default for all user accounts. Note that you can only invite users to Projects in which you are a member or which you created. If you cannot do so, see the Projects permissions or ask your Administrator for assistance.
Follow these steps to remove a member from a Project:
Locate the Project member to remove. This may be a user or a group.
Click Confirm.
Click the Remove icon .
A message displays to confirm removal of this Project member.
Import a Project that has previously been exported.
Importing and exporting Projects and their related assets into your ProcessMaker Platform instance makes it easy to share complete Projects with others in your organization. Import Projects from ProcessMaker Platform or later versions.
Any user may import a Project. If you cannot import a Project, your user account permission(s) may be disabled.
See the Projects permissions or ask your Administrator for assistance.
Follow these steps to import a Project:
Click the Select file from computer link to locate the Project to import. Projects have the .json
file extension.
ProcessMaker Platform evaluates the file to import. If the Project was not exported from a ProcessMaker Platform Fall 2023 version or later instance, that Project may not be imported properly.
The Import Project screen displays. Only the Basic import option is available for Projects and all assets within the Project will be imported.
Click the Import button to complete the import procedure. The Project appears in the Projects tab.
Click the ellipses icon for the Project to export, and then select the Import option. The Import page displays.
View the Projects in which you are a member.
ProcessMaker Platform displays those Projects in which you are a member in one table. This makes it easy to manage your Projects.
Your user account or group membership must have the "Projects: View Projects" permission to view the list of Projects unless your user account has the Make this user a Super Admin setting selected.
This permission is enabled by default for all user accounts. Note that you can only view Projects in which you are a member or which you created. If you cannot view your Projects, see the Projects permissions or ask your Administrator for assistance.
Follow these steps to view all Projects in which you are a member:
Log on to ProcessMaker Platform.
Click the Designer option from the top menu. The Designer Welcome Screen displays.
Do one of the following:
From the My Projects pane in the Designer Welcome Screen, click the Project name to open from the Name column.
In the Projects page, the Projects tab displays those Projects in which you are a member.
The Projects page displays the following information in tabular format about your Projects:
Name: The Name column displays the name of the Project.
Category: The Category column displays to which Project Category the Project is assigned.
Members: The Members column displays the avatar for each user that is a member of the Project.
Modified: The Modified column displays the date and time any new asset is added or any of its assets 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.
Created: The Created column displays the date and time the Project 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.
Filter by any of the following:
Title: Filter by Project names.
Members: Filter by Project membership.
Categories: Filter by Project categories.
Use the Search setting to filter Projects that display.
See Create a New Project.
Click the Import button. See Import a Project.
If no Projects exist, the following message displays: No Data Available
Control how tabular information displays, including how to sort columns or how many items display per page.
Click the Projects icon from the left sidebar.
Click the Filter button.
Click the ellipses icon, and then select the Open option. See Open a Project.
Click the ellipses icon, and then select the Configure option. See Configure a Project.
Click the ellipses icon, and then select the Export option. See Export a Project.
Click the ellipses icon, and then select the Delete option. See Delete a Project.
Click the Home breadcrumb icon to go to the Request Participant Home Screen.
Add or create an asset to a Project. Any Project member may then use that asset.
Any of the following asset types may be added to a Project:
An asset may also be created from within the current Project.
Follow these steps to add or create an asset from within the current Project:
Open the Project in which to add or create an asset.
Do one of the following:
Do one of the following:
Create a new asset to add to the Project: Click the button labeled to create a new asset. The screen to create that asset type displays. See one of the following topics for the asset type you are creating:
Do the following:
While creating the asset, ensure to add this Project in the Project setting as amongst those to which you assign the new asset. This is not set automatically.
Create the asset. The design environment for that asset type displays.
Optionally, design the asset at this time. This is not required to add the asset to the Project.
Return to the Project for which you created this asset. It displays in the list of assets for the current Project.
Collapse the +Asset button: Click the +Asset button. The +Asset button collapses.
However, there are options available from the ellipses menu specific for use within a Project:
Use caution when deleting an asset from a Project. As is the case with each asset type, deleting an asset affects other Projects and/or Processes that use that asset. As a best practice, remove the asset from the Project when necessary to not affect other Process Designers.
Copy an asset to another Project to which you are a member. By copying an asset from the current Project to another that needs the copied asset saves you time from adding this asset from within the other Project or from the asset itself. You may only copy an asset to Projects of which you are a member.
Follow these steps to copy an asset to a Project:
Open the Project from which to copy one of it assets. The Project displays.
Revise the asset configuration as you would that asset type. See one of the following topics for the asset type you are copying:
Do the following:
While copying the asset, select to which Project(s) in the Project setting to assign this asset. Projects selected when saving the copy of this asset display there.
Save the copy of the asset. The design environment for that asset type displays.
Optionally, revise the design from the original asset at this time. This is not required to add the asset to the other Project(s).
Open each Project to which you copied the original asset. The copied asset with your revisions displays in the list of assets for the other Project(s).
Removing an asset from a Project makes that asset no longer available to that Project. Removing the asset does not delete it. You may only remove an asset in Projects of which you are a member.
Follow these steps to remove an asset to a Project:
Open the Project from which to copy one of it assets. The Project displays.
Click Remove.
Open a Project to import a Project, add assets, or access its assets.
Your user account or group membership must have the "Projects: View Projects" permission to open a Project unless your user account has the Make this user a Super Admin setting selected.
This permission is enabled by default for all user accounts. Note that you can only open Projects in which you are a member or which you created. If you cannot open any of your Projects, see the Projects permissions or ask your Administrator for assistance.
Follow these steps to open a Project in which you are a member:
View your Projects. The Projects page displays.
Do one of the following:
Click the Project's name from the Name column.
The following displays regarding the Project:
Project assets are available to all members of that Project.
The following displays regarding each asset within a Project:
Type: The Type column displays the asset type. A Project may use any of the following assets:
Name: The Name column displays the asset's name. Click on the asset's name to open it.
Modified: The Modified column displays the date and time the Process 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.
The following details display regarding a Project:
Modified: The Modified section displays the date and time any new asset is added or any of its assets 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.
Owner: The Owner section displays the user's avatar and full name that created the Project.
Configure a Project, including its name, to which Project Category it belongs, and its members.
Follow these steps to configure a Project:
Edit any of the following settings as necessary:
In the Name setting, enter the unique name for the Project. Project names must be unique in your organization, and can only use apostrophe characters ('
) and spaces. This is a required setting.
From the Members drop-down menu, select which user(s) or groups to invite to this Project. When inviting a group, all members of that group are invited to that Project.
Click Update.
Filter all Projects in your organization to find that one you need.
Use the Search function to filter all Projects from the Projects page based on your entered text. You may only view and search for Projects in which you are a member.
Follow these steps to search for a Project:
Enter in the Search setting the Project name to filter Projects.
As you enter text into the Search setting, Projects display that match your entered text.
If there are no search results, the following message displays: No Results.
Click the +Asset button. The +Asset button expands to select which asset type to add to this Project.
Add or create a Process to this Project: Click the Processes option. The +Asset button drop-down changes to add a Process. The New Process button displays to create a new Process.
Add or create a Screen to this Project: Click the Screens option. The +Asset button drop-down changes to add a Screen. The New Screen button displays to create a new Screen.
Add or create a Script to this Project: Click the Scripts option. The +Asset button drop-down changes to add a Script. The New Script button displays to create a new Script.
Add or create a Data Connector to this Project: Click the Data Connectors option. The +Asset button drop-down changes to add a Data Connector. The New Data Connector button displays to create a new Data Connector.
Add or create a Decision Table to this Project: Click the Decision Tables option. The +Asset button drop-down changes to add a Decision Table. The New Decision Table button displays to create a new Decision Table.
Search for and select the asset to add to the Project: Click in the search field and enter the partial or complete name of the asset in which to filter results. Filtered results display the name and description of each asset. After selecting the asset, a message displays to confirm assigning this asset to the current Project. Click Confirm. The asset displays in the list of assets for the current Project. Optionally continue searching for other assets of that type to add to this Project.
Go back to add a different asset type to this Project: Click the Back icon .
After an asset is added to a Project, any member in that Project may use it. Clicking on the asset's name opens that asset. Furthermore, clicking on the ellipses icon displays options that are intrinsic to that asset type.
Click on the ellipses icon, and then select the Copy to Project option. The Copy of Asset screen displays. The original name of the asset displays in the Name setting with the word Copy
appended to it.
Click on the ellipses icon, and then select the Remove from Project option. The Copy of Asset screen displays. A message displays confirmation to remove that asset from the Project.
Click the ellipses icon, and then select the Open option for the Project to open. The Project opens.
Below is an example of a Project's details.
Members: The Members section displays the avatar and full name for each user that is a member of the Project. Below the list of Project members, optionally invite new members. Optionally, remove a member from the current Project by mouse-hovering over the Project member to remove, and then click the Remove icon .
This permission is enabled by default for all user accounts. Note that you can only configure Projects in which you are a member or which . If you cannot configure your Projects, see the permissions or ask your Administrator for assistance.
. The Projects page displays.
Click the ellipses icon, and then select the Configure option for the Project to configure. The Configure Project screen displays.
From the Category drop-down menu, select one or more to associate with this Project. In doing so, Project Categories may be sorted from the . To remove a Project Category that is currently selected, click theicon for that selection or press Enter
when the drop-down is visible. This is a required setting.
This permission is enabled by default for all user accounts. Note that you can only view Projects in which you are a member or which . If you cannot view your Projects, see the permissions or ask your Administrator for assistance.
.
Export a complete Project that has previously been imported.
Export Projects, along with their related assets, from your ProcessMaker Platform instance. By exporting a Project with its related assets, the complete Project can quickly be shared with other ProcessMaker Platform instances by importing them. An exported Project and its assets are stored in a JSON file, which may be imported to another ProcessMaker Platform version the same or later version as that of the ProcessMaker Platform version.
Any member of a Project may export that Project. Projects may be exported from the following locations:
Any user may export a Project of which that user is a member. If you cannot export a Project of which you are a member, your user account permission(s) may be disabled.
See the Projects permissions or ask your Administrator for assistance.
Follow these steps to export a Project in which you are a member:
Click Export. The Project exports as a .json
file to your local computer or network. The following message displays when the Project exports successfully: The project was exported.
Delete a Project. Deleting a Project does not delete the assets within it.
Deleting a Project does not delete the assets within it.
Follow these steps to delete a Project:
Click Confirm.
Click the ellipses icon for the Project to export, and then select the Export option. The Export page displays. The Basic option is selected, which is the only option to export a Project.
This permission is enabled by default for all user accounts. Note that you can only delete Projects in which you are a member or which . If you cannot delete a Project, see the permissions or ask your Administrator for assistance.
. The Projects page displays.
Click the ellipses icon, and then select the Delete option for the Project to delete. The Caution screen displays to confirm the deletion of the Project.
Import an asset to a Project. Any Project member may then use that asset.
Import an asset into a Project when that asset is not already within your ProcessMaker Platform instance. Otherwise, add the asset to your Project.
Any of the following may be imported into a Project:
The asset to be imported must have previously been exported from the same ProcessMaker Platform version or later. ProcessMaker Platform ignores any other Projects it might be assigned, and only becomes an asset in the current Project.
Follow these steps to import an asset to a Project:
Open the Project in which to import an asset into it.
Click the Import button. The Import Asset page displays.
Click the Select file from computer link to locate the asset to import. Assets have the .json
file extension.
ProcessMaker Platform evaluates the file to import. If the asset was not exported from the same ProcessMaker Platform version, that asset may not be imported properly.
The Import Asset screen displays. Only the Basic import option is available for assets.
Click the Import button to complete the import procedure. The asset appears in the Project.
Improve your Project organization by creating Categories to which to assign them.
Your user account or group membership must have the following permissions to create a new Project Category unless your user account has the Make this user a Super Admin setting selected:
Projects: Create Project Categories
Projects: View Project Categories
Projects: View Projects
See the Projects permissions or ask your Administrator for assistance.
Follow these steps to create a new Project Category:
Click the +Category button. The Create Category screen displays.
In the Category Name setting, enter the name of the new Project Category. The Project Category name must be unique from all other Project Category names in your organization and can only use apostrophe characters ('
) and spaces. This is a required setting.
From the Status drop-down menu, select one of the following options for the Project Category's status:
Active: Active Project Categories can have Projects assigned to them.
Inactive: Inactive PM Block Categories cannot have Projects assigned to them.
The Active option is selected by default. This is a required setting.
Click Save.