- Using the
processmaker
command - List of options
- Help for an option
- ProcessMaker Commands
- browser-cache-files-upgrade
- build-js
- cacheview-repair
- change-password-hash-method (Enterprise only)
- check-workspace-disabled-code (Enterprise only)
- database-generate-self-service-by-value
- database-upgrade
- database-verify-consistency
- database-verify-migration-consistency
- flush-cache
- hotfix-install
- info
- mafe-translation
- migrate-cases-folders
- migrate-content
- migrate-indexing-acv
- migrate-itee-to-dummytask
- migrate-list-unassigned (Enterprise only)
- migrate-new-cases-lists (Enterprise only)
- migrate-plugins-singleton-information
- plugins-database-upgrade
- plugins-translation-create
- plugins-translation-update
- translation-repair
- unify-database (Enterprise only)
- upgrade
- upgrade-content
- workspace-backup
- workspace-restore
- workspace-upgrade
The processmaker
command is used to perform maintenance tasks in ProcessMaker. Because some of these tasks involving altering the file structure, it is required to have root or administrator access in order to run the processmaker
command.
Using the processmaker
command
In the server where ProcessMaker is installed, login as the root user or administrator. On Windows systems, start the command prompt as the administrator. On Linux/UNIX systems, open a terminal and login as root user or use the sudo
command to gain root privileges:
To avoid permission problems when running processmaker command in Linux, run the processmaker command using the Apache/NGINX user permissions. As of ProcessMaker 3.2.2, NGINX is also available. To do so, ownership of the ProcessMaker directory must belong to apache or nginx, so that Apache/NGINX can read and write data. The -R makes the ownership changes recursive (apply to all files and directories within /opt/processmaker).
- Apache:
chown -R apache:apache /opt/processmaker - NGINX:
chown -R nginx:nginx /opt/processmaker
Then, use the cd
command to switch the directory where ProcessMaker is installed. The location may vary depending on your system:
Linux/UNIX:
Windows:
Bitnami Installer in version 3.0.1.8 and later:
Automatic Installer in version 3.0.1.7 or earlier in Windows XP/Server 2003:
Automatic Installer in version 3.0.1.7 or earlier in Windows Vista/Server 2008 or later:
Note: The AppData directory is a hidden directory, but the File Explorer can be configured to show hidden files.
The processmaker
command can be issued from the base directory of the processmaker installation:
For Windows system, it may be necessary to specify the path to the php.exe file:
Bitnami Installer for ProcessMaker 3.0.1.8 and later:
Automatic Installer in ProcessMaker 3.0.1.7 or earlier in Windows XP/2003:
Automatic Installer in ProcessMaker 3.0.1.7 or earlier in Windows Vista/7/8/10/2008/2012:
Note: To avoid writing out the path to php.exe, add the PHP directory to the PATH
system variable.
List of options
To see the list of options available for the processmaker
command, issue the command with the help
option.
For example, on a Linux/UNIX system:
Help for an option
To display help for an option of the processmaker command, issue the command in this way:
For example to get help for the database-upgrade
option:
ProcessMaker Commands
The following sections describe all ProcessMaker commands.
browser-cache-files-upgrade
Safe upgrade for files cached by the browser. This command should be run after any upgrade/modification of files cached by the browser.
Example:
build-js
Regenerate ProcessMaker's JavaScript files. This command should be run after any modification of JavaScript files in the gulliver/js/ directory.
Usage:
Options:
-lLANG, --lang=LANG
Set the language, such ases
(Spanish) orpt-BR
(Brazilian Portuguese), to be used when regenerating the JavaScript file. Note that this option currently does not work.
Example:
cacheview-repair
Create and populate the APP_CACHE_VIEW table. In order to improve performance, ProcessMaker includes a cache of cases in the APP_CACHE_VIEW table. This table must be in sync with the list of cases in the APPLICATION and APP_DELEGATION tables to present updated information in the cases list. This command will recreate the table and populate it with the updated information. This only needs to be used after upgrading ProcessMaker or if the cases inbox is out of sync.
Usage:
Options:
-lLANG
or--lang=LANG
Specify the language to rebuild the case cache list. If not specified, then 'en' (English) will be used by default.
Ex:-lfr
(French)
Ex:--lang=zh-CN
(Mainland Chinese)WORKSPACES
Specify the workspaces whose cases cache should be repaired. If no workspace is specified, then the cases will be repaired on all available workspaces.
Example:
change-password-hash-method (Enterprise only)
Set the passwords to use SHA256 or MD5 hashes. See Password Encryption SHA-256.
Usage:
check-workspace-disabled-code (Enterprise only)
Checks any disabled code in the specified workspace(s).
Usage:
If no workspace is specified, the command will be run in all workspaces. More than one workspace can be specified.
Example:
database-generate-self-service-by-value
Generate or update the "self-service by value" table (APP_ASSIGN_SELF_SERVICE_VALUE) for cases whose tasks use Self Service Value Based Assignment for their Assignment Rule.
Note: This command will ONLY be used if you are migrating from a version 2.x and NOT from the versions 2.8, 2.5.2.4 to versions 3.0.x, 3.1.x or 3.2.x. It is not recommended to use this command for other versions as the data is already migrated and for version 3.3.x is deprecated.
Usage:
If no workspace is specified, the command will be run in all workspaces. More than one workspace can be specified.
Example:
database-upgrade
Upgrade or repair the database schema to match the installed version of ProcessMaker. This command updates the database to match the schema specified in the files workflow/engine/config/schema.xml and rbac/engine/config/schema.xml.
Use this command to fix databases whose structure has become corrupted or after ProcessMaker has been upgraded, so the database schemas will be changed to match the new ProcessMaker code. This command is executed automatically by processmaker upgrade, but it can be executed separately.
Usage:
Specify the workspaces whose database schema should be upgraded or repaired. Is a known issue if no workspace is specified, then the workspace must be specified.
Example:
database-verify-consistency
Verify that the database data is consistent with the schema, which is specified in the files workflow/engine/config/schema.xml and rbac/engine/config/schema.xml. Use this command to verify the database integrity. Use this command to check the database data consistency before issuing the processmaker database-upgrade
or processmaker upgrade
commands.
Usage:
Specify the workspace(s) whose database schema should be verified. If no workspace is specified, then all available workspaces will be verified.
Example:
database-verify-migration-consistency
Verify that the migrated case data is consistent and there was no data loss of any kind.
Usage:
Specify the workspace(s) whose case data should be verified for consistency. If no workspace is specified, then all available workspaces will be verified.
This command will check for any missing cases which are Cancelled, Completed, in Inbox and My Inbox (To Do and Draft), Participated, and Unassigned. It is recommended to execute this command if problems occur after importing a workspace or upgrading ProcessMaker.
Example:
flush-cache
Flush the cache files for the specified workspace(s).
Usage:
If no workspace is specified, then the cache will be flushed in all available workspaces.
This command deletes the system cache files located in the shared/compiled directory. It also deletes the workspace cache files located in the shared/sites/WORKSPACE/cache/ and shared/sites/WORKSPACE/cachefiles/ directories. Any deleted cache files will be regenerated when needed by ProcessMaker. This command is useful after installing or updating a new PO translation file or when the cache copy of forms gets corrupted.
Note: If the flush-cache command is executed after creating an endpoint, the new endpoint is automatically regenerated.
Example:
hotfix-install
Install a hotfix or patch in the ProcessMaker code.
Usage:
This command installs a hotfix or patch, which updates ProcessMaker in order to add improvements, fix bugs and security holes and change the database schema. Hotfixes are generally only available for the Enterprise Edition. See: How to install a Hotfix or a Patch.
info
Print information about the current system and any specified workspaces.
Usage:
If no workspace is specified, show information about all available workspaces
Example:
mafe-translation
Creates translation labels in the Michealangelo Font End (MAFE) which are inserted in the database. This command should be run after adding or deleting translation labels in ProcessMaker's JavaScript code.
Usage:
If no workspace is specified, then the translation labels will be created in all available workspaces.
Options:
-lLANG, --lang=LANG
Specify the language to create the translation labels. If not specified then the language will be 'en' (English) by default.
Ex:-lfr
(French)
Ex:--lang=zh-CN
(Mainland Chinese)
Example:
migrate-cases-folders
Migrates case folders of the workspace to split the directory for each case into multiple subdirectories, to avoid problems with Ext3 file systems which are limited to 32K subdirectories. See: Managing 32K Folders.
Usage:
Options:
-
WORKSPACE
Select the WORKSPACE in wich its case folders will be migrated, if multiple workspaces are present in the server.
Ex:workflow
Note: When migrating ProcessMaker from version 2 to version 3, will NOT split automatically the case directories. From Processmaker version 3 and on, case directories are already splited into multiple subdirectories.
Example:
migrate-content
Most of the names/titles of objects are currently stored in the CONTENT table in the database. In order to speed up accessing the names of groups, departments, processes, tasks and Input Documents, fields were added to a number of database tables in version 3.1, so it was no longer necessary to do separate queries in the CONTENT. If necessary, the migrate-content
option adds new fields to the various tables to hold the names/titles from the CONTENT table. It also copies the names/titles from the CONTENT table to the many different tables. Use this command if upgrading ProcessMaker 3.1 or later from a previous version of ProcessMaker or if the content gets out of sync.
Usage:
Specify the workspace(s) where the content should be migrated. If no workspace is specified, then the content will be migrated on all available workspaces.
Example:
migrate-content Options:
The options to run the migrate-content
command in a console are the following:
- --lang
Specify a language to migrate content. If no language is specified, then the content will be migrated using the default language.
Ex../processmaker migrate-content --lang=en This command migrates content on all available workspaces, in English. - WORKSPACE
Specify the WORKSPACE where the content will be migrated. If no workspace is specified, then the content will be migrated on all available workspaces.
Ex../processmaker migrate-content WORKSPACE This command migrates content to default language on this WORKSPACE - --lang + WORKSPACE
It is possible to combine previous parameters, first specify the language to migrate the content, then specify the workspace where the content will be migrated.
Ex../processmaker migrate-content --lang=en WORKSPACE This command migrates content on this WORKSPACE, in English.
migrate-indexing-acv
Increases the performance populating with integer values the new columns created in APP_* tables by the migrate-new-cases-lists command. This command must be run after migrate-new-cases-lists.
migrate-itee-to-dummytask
Migrates the Intermediate throw Email Event to Dummy task.
Usage:
Specify the workspaces where the processes will be updated. If no workspace is specified, then all available workspaces will be updated.
Example:
migrate-list-unassigned (Enterprise only)
Migrates information in the APP_CACHE_VIEW table in the database to the LIST_UNASSIGNED table, so that the "Unassigned" list of cases under the Home menu can be loaded more quickly. Use this command if upgrading the Enterprise Edition to version 3.1 or later.
Usage:
Specify the workspace(s) where the APP_CACHE_VIEW table will be updated. If no workspace is specified, then all available workspaces will be processed.
Example:
migrate-new-cases-lists (Enterprise only)
Migrate the case list information found in the APPLICATION and APP_DELEGATION tables to the new LIST_* tables found in version 3.1 and later, so that case lists under the Home menu can be loaded faster in the Enterprise Edition.
Usage:
Specify the WORKSPACE where the case information will be migrated to the LIST_* tables. More than one workspace can be specified. If no workspace is specified, then case information in all available workspaces will be migrated to the LIST_* tables.
migrate-plugins-singleton-information
Available Version: The following command is available as of ProcessMaker version 3.2.2.
Migrate the singleton information file to the PLUGINS_REGISTRY table found in version 3.2.2 and later, so that the information about plugins can be loaded faster.
Usage:
plugins-database-upgrade
Upgrade or repair the database schema to match the latest version of a plugin. Run this command after upgrading the source code for a plugin. The database schema file for a plugin is found at the location plugins/pluginName/pluginName/config/schema.xml.l
Usage:
Specify the workspaces whose database should be upgraded or repaired to match the schema files of all its available plugin(s). If no workspace is specified, then the database schema will be upgraded or repaired on all available workspaces.
This is the same as the database-upgrade command, but it works with the schema files provided by plugins. This is useful if plugins are installed that include database schemas.
plugins-translation-create
Create a .po translation file for a specified plugin. After the .po file is generated, it can be translated into another language and then imported into ProcessMaker so that the plugin is available in another language.
Usage:
PLUGIN is the name of the plugin directory. If not specified, then translation files will be created for all available plugins.
LANG is the language for which the .po file will be generated, such as fr
(French) or zh-CN
(mainland Chinese). If the language is not specified, then it is en
(English) by default.
plugins-translation-update
Update plugin translations
Usage:
PLUGIN is the name of the plugin directory.
LANG is the language, such as fr
(French) or zh-CN
(mainland Chinese).
translation-repair
Upgrade or repair translations for the specified workspace(s).
Usage:
If no workspace is specified, the command will be run in all workspaces. More than one workspace can be specified.
This command will go through each language installed in ProcessMaker and update the translations for the workspace(s) to match the current version of ProcessMaker.
unify-database (Enterprise only)
Unify the RBAC, Reports and Workflow databases into one database.
Usage:
Specify the workspaces whose databases schemas should be unified. If no workspace is specified, then the database schema will be upgraded or repaired on all available workspaces.
This command will read the system schema and attempt to modify the workspaces' tables to match this new schema. In version 2.8 and later, it will merge the 3 databases used in previous versions of ProcessMaker into one database. This command may be used after upgrading from ProcessMaker 2.5 to a later version of ProcessMaker.
upgrade
Upgrade workspaces.
Usage:
This command should be run after upgrading ProcessMaker to a new version so that all workspaces are also upgraded to the new version.
Options:
-ACV
,--buildACV
If this option is enabled, the Cache View in the APP_CACHE_VIEW table is built.-NoXml
,--no-xml
If this option is enabled, the XML files translation is not built.
upgrade-content
Upgrade the Content table of specified workspace(s).
Usage:
If no workspace is specified, the command will be run in all workspaces. More than one workspace can be specified.
Note: As of ProcessMaker 3.2.2, this command is executed only if all labels of the corresponding tables are migrated.
workspace-backup
Backup the specified workspace to a file. For more information, see Backing up ProcessMaker.
Usage:
WORKSPACE is the name of the workspace to backup, which by default is named workspace
.
BACKUP-FILE is the backup filename which will be created. If it contains slashes, it will be treated as a path and filename, either absolute or relative. Otherwise, it will be treated as a filename located inside the shared/backups directory. If no BACKUP-FILE is specified, it will use the workspace name as the filename.
A backup archive will contain all information about the specified workspace so that it can be restored later. The archive includes a database dump and all the workspace files.
Options:
-s[MAX-SIZE]
,--filesize=[MAX-SIZE]
Split the backup file in multiple files which are compressed. The maximum size of these files is set to MAX-SIZE in megabytes. If MAX-SIZE is not set, then it is 1000 megabytes by default. It may be necessary to use this option if using a 32 bit Linux/UNIX system which limits its maximum file size to 2GB. This option does not work on Windows systems.
workspace-restore
Restore a workspace from a backup file. For more information, see Restoring Workspaces.
Usage:
BACKUP-FILE is the backup filename. If it contains slashes, it will be treated as a path and filename, either absolute or relative. Otherwise, it will be treated as a filename located inside the shared/backups directory.
Specify the WORKSPACE to restore to a different workspace name. Otherwise, it will restore to the same workspace name as the original backup.
Options:
-o
,--overwrite
If a workspace already exists, then overwrite it.-i
Show information about backup file, but do not restore any workspaces.-m
Restore from multiple compressed backup files which are numbered. This is an option for Linux/UNIX systems which limit files to a maximum of 2 GB in size.-wWORKSPACE
,--workspace=WORKSPACE
Specify which workspace to restore if multiple workspaces are present in the backup file.
Ex:-wworkflow
-lLANG
,--lang=LANG
Specify the language which will be used to rebuild the case cache list. If this option isn't included, thenen
(English) will be used by default.-pPORT
Specify the port number used by MySQL. If not specified, then the port 3306 will be used by default.
Ex:-p3882
Warning: To correctly run the workspace-restore command, all folders and files of the restored workspace must have the same permissions as in the shared folder.
workspace-upgrade
Upgrade the specified workspace(s). Use this command after upgrading the source code of ProcessMaker.
Usage:
If no workspace is specified, the command will be run in all workspaces. More than one workspace can be specified.
This command is a shortcut to execute all the upgrade commands for workspaces. Upgrading a workspace will make the database and files correspond to the current source code of ProcessMaker.
Options:
-ACV
,--buildACV
If this option is enabled, the APP_CACHE_VIEW table will be built, which allows ProcessMaker to load case lists more quickly.-NoXml
,--no-xml
If this option is enabled, then the XML files translation is not built.