Installation & Deployment

The latest version of the Imixs Admin Client can be download form the Download Center. The client is supported as a single web module (.war file) so the client can be easily installed on a Applicaition Server like Glassfish into any web container.

After the deployment of the Imixs Admin Client the Web module is access able using the following url:

http://localhost:8080/adminclient

Note:

You can manage multiple instances of Workflow Applications with the same Admin Client on one machine! So on each JEE Server instance the Imixix Admin Client needs to be deployed only once.

The Imixs Admin Client requires the user to authenticate and also the authenticated user (Administrator) needs at least the the Role "IMIXS-WORKFLOW-Manager". To authenticate the users the Imixs Admin Client uses the default Realm "imixsrealm" which need to be configured on the Server.

After you have logged into the Imixs Admin client you will see the JNDI Name Page. On this page you can specify the remote connection to an existing Imixs JEE Workflow Instance on your JEE Server. Therefore it is necessary to enter the JNDI Name defined by the specific workflow application which you want to administrate.

The JNDI Name typical looks something like "ejb/MyappEntityServiceBean" Each Imixs JEE Workflow Instance supports a unique JNDI Name for the EntityService. If you did not know the JNDI Name you can use a jndi browser to search for valid EntityService Implementations.

In Glassfish Application Server use the "JNDI Browsing" function of the Application Server dmin Console:

In the JNDI Browser you can search for any deployed EJB JNDI Name.

For the Imixs JEE Admin Client you need to name an Instance of the EntityServiceBean. After you enter a valid JNDI Name and click on the refresh symbol behind the input field or press "Return" a green button in front of the jndi name field will indicate a valid connection. If the green button will not appear the JNDI Name is invalid or the user did not have access to that workflow instance. In this case see your server.log file for more details.

After connecting you can use the different function of the Admin client.

Manage IndexProperties

The Index management can be use to verify existing IndexProperties inside a Workflow Instance. An IndexProperty is necessary to query workitems by a JPQL statement. Each workflow instanceis adding indexes automatically after deployment. So you will see a pre defined List of IndexProperties:

The Index Management allows you to delete an existing Index or add a new index one.

Note:

adding or deleting can take a long time if a lot of workitems need to be updated. Adding or deleting a index will not loose data.

Search Workitems

The IX JEE Admin client supports a function to search Workitems using JPQL Statements. This gives you a powerful feature to query workitems in a existing Workflow Instance. So a Adminstrator is able to control or verify the content of workitems. As the Administrator is granted to the Role "IMIXS-WORKFLOW-Manager" it is possible to read any dataset indpended form the individual read access of a singel workitem!

Also this feature gives you the possibility to test a JPQL statement before implementing a statement into a business logic.

Read more about using Queries based on JPQL here. The search function also allows you to delete one or a set of worktiems.

Note:

Be careful to use the delete/remove function!

View Model Versions

Using the function "Models" allows you to inspect all deployed workflow models on a running Imixs JEE Workflow Instnace.

For each deployed model you can see the creation date and the version number of the model. To delete a model version you can call the "delete" function for a specific model version.

Import & Export

With the Import and Export feature you can export Entities into a filesytem and later re-import them into a exiting Workflow Instance

To export a Collection of Workitems you need to specify a JPQL Statement. You can test the statement before a export using the search function. The export will be stored into a binary file specified by the export page.

With the import function you can import / re-import an existing export file into a workflow Instance. The import function will override existing Workitems with the same $uniqueID. So be careful if you import a subset of data.