Bizagi JEE Console

<< Click to Display Table of Contents >>

Navigation:  Bizagi Engine > Bizagi system administration > Bizagi server configuration > Bizagi Engine JEE platform configuration >

Bizagi JEE Console

applies_JEE

Overview

Bizagi JEE Console is a tool provided by Bizagi Ltd to help you carry out the management tasks involved in Bizagi projects running on JEE platforms.

Bizagi JEE Console provides command line options which are mainly useful for your Test or Production environment projects, so that you can: build or manage the project's file structure, compile its entities and deploy the Work portal, or manage your licenses.

 

 

Prerequisites

Bizagi JEE Console does not require installation.

It has an executable file that runs in any operative system where your JEE Application server is running with Bizagi Engine.

 

Before using Bizagi JEE Console, make sure you do meet this requisites:

Have an installed JAVA SE's JDK on this server.

It is strongly recommended to use JDK 7.

Since it is designed to be run in the server where you have your JEE Application server hosting your Bizagi project, this server should already have the JAVA framework installed.

JAVA_HOME environment variable properly configured (it is recommended that this path contains no spaces).

Optionally you could add the JAVA_HOME environment variable to the PATH system variable.

 

note_pin

It is recommended that you place Bizagi JEE Console in a path (i.e inside of the installation path of your JEE Application server) where you can ensure it has proper read and write rights (especially when applying a license).

 

Command options

Once unzipped into a local folder at the Bizagi server, Bizagi JEE Console's executable files should be located at <INSTALLATION_PATH>\<Bizagi_Version>\BizagiJEE\BizagiConsoleManagerJEE\bin.

Use a Command Prompt with Administrator privileges in order to execute the available commands at its bin.

 

The table below lists the different options useful for Administration tasks and classified into and groups that share a common objective.

 

JEE CONSOLE COMMAND OPTIONS

Objective

Command

Description

Parameters

Syntax

Project management:  Handle the project's file structure for JEE components.

createproject

Creates projects that store the configuration information.

 

This method is used when you are Deploying the application into a JEE Application Server.

pathFile: full path of the XML file that contains the project's information.

-m: Indicates if the execution will print notifications codes and informative messages (Optional).

createproject <PathFile>

updateproject

Updates the configuration information for a project.

updateproject <PathFile>

deleteproject

Deletes an specified project.

-p <ProjectName>: Name of the project to be deleted.

-m: Indicates if the execution will print notifications codes and informative messages.

deleteproject -p <ProjectName>

Web application deployment:  Prepare and generate the .ear file for application deployment.

predeploy

Prepare the version of Bizagi (.EAR) that will be deployed on the server.

 

This method is used when you are Deploying the application into a JEE Application Server.

-u: Include PatchSet. To include the PatchSet (.jar) this parameter needs to be added. Default value is false.

-p <ProjectName>: Project Name (Mandatory).

-o <OutputPath>: Path where Bizagi's version will be generated. (Optional).

-c: Indicates whether the Project is in cluster or not.

-f <FilePath>: Full path where the EAR that will be used to generate Bizagi's version can be located. (Optional).

-m: Indicates if the execution will print notifications codes and informative messages (Optional).

predeploy -u -o <OutputPath> -f <FilePath> -p <ProjectName>

deploy

Copies the .EAR file in the JEE application server.

-u: Include PatchSet. to include the PatchSet (.jar), this parameter needs to be added. Default value is false.

-p <ProjectName>: Project Name (Mandatory).

-e: Indicates whether is required to regenerate the Entities.

-c: Indicates whether the Project is in cluster or not.

-f <FilePath>: Full path where the EAR that will be used to generate Bizagi's version can be located. (Optional).

-m: Indicates if the execution will print notifications codes and informative messages (Optional).

deploy –p <ProjectName> -f <FilePath> -e -c -u

undeploy

Deletes the .EAR file in the JEE application server.

-p <ProjectName>: Project Name (Mandatory).

-n <EarName>: Full name with extension of the deployed .ear file in JEE application server.

-m: Indicates if the execution will print notifications codes and informative messages (Optional).

undeploy –p <ProjectName> -n <EarName>

Troubleshooting options: Useful mostly for development environments.

publish

Publishes the .EAR file in the JEE application server.

-p <ProjectName>: Project Name (Mandatory).

-f <FilePath>: Full path where the EAR that will be used to generate Bizagi's version can be located. (Optional).

-u: Include PatchSet. To include the PatchSet (.jar), this parameter needs to be added. Default value is false.

-m: Indicates if the execution will print notifications codes and informative messages (Optional).

publish –p <ProjectName> -f <FilePath> -u

unpublish

Deletes the .EAR file in the JEE application server.

-p <ProjectName>: Project Name (Mandatory).

-m: Indicates if the execution will print notifications codes and informative messages (Optional).

unpublish –p <ProjectName>

startappserver

Starts the JEE application server.

startappserver –p <ProjectName>

stopappserver

Stops the JEE application server.

stopappserver –p <ProjectName>

cleancache

Clears the cache of the Bizagi web application  in a standalone environment for development.

 

This method is used when you are Deploying the application into a JEE Application Server.

-p <ProjectName>: Project Name.  (Mandatory).

-host <HostName>: Name or IP of the server on which you want to clean the internal cache Bizagi.  (Mandatory).

-port <Port>: Port which is listening Bizagi Web application and you want to clean the internal cache Bizagi. (Mandatory).

cleancache -p <ProjectName> -host <HostName> -port <Port>

Meta information: Miscellaneous options regarding Bizagi and this tool.

version

Shows the current Bizagi version

 

version

help

Shows the Command help and the parameters description.

 

help

License management:  Apply or remove licenses.

startconsoleservice

Starts the Bizagi JEE Console as a system service using port 5680.

 

startconsoleservice

stopconsoleservice

Stops the system services loaded with the command above.

 

stopconsoleservice

removelicense

Uninstalls the Bizagi JEE license.

 

removelicense

LDAP Management: check or synchronize the configured LDAP.

checkldap

Performs the test of the LDAP configuration defined by the user in Bizagi Studio.

 

-p <ProjectName>: Project Name.  (Mandatory).

-env <environment>: Id of the Environment where is required to test the LDAP Configuration. The possible values are: 1 for Development, 2 for Test, and 3 for Production. (Mandatory).

checkldap -p <projectName> -env <environment>

synclap

Performs synchronization of the LDAP users.

In order to execute this command. check if the variable SUPPORT_UTILITIES is active in the Bizagi extended properties file, this file is located in <INSTALLATION_PATH>\<Bizagi_Version>\BizagiJEE\bizagi-config\bizagi-extended.properties

-p <ProjectName>: Project Name.  (Mandatory).

syncldap -p <projectName>

SMTP Management: check the configured SMTP.

checkemail

Performs the test of the SMTP configuration by sending a test email to a test email address.

-p <ProjectName>: Project Name.  (Mandatory).

-env <environment>: Id of the Environment where is required to test the SMTP Configuration. The possible values are: 1 for Development, 2 for Test, and 3 for production. (Mandatory).

-emailTo <emailTo>: Email address to receive the email sent by the SMTP test. (Mandatory)

checkemail -p <projectName> -env <environment> -emailTo <emailTo>

 

note_pin

Before executing any of the LDAP or SMTP Management commands, configure the following variables in the Console configuration properties file, this file is located in <INSTALLATION_PATH>\<Bizagi_Version>\BizagiJEE\BizagiConsoleManagerJEE\config\console-configuration.properties:

bizagi_war_host: Server IP or name where your Web application is deployed.

bizagi_war_port: Server port where your Web application is deployed.