Imixs-Script

Imixs-Script is a JavaScript Framework to build business applications using the Imixs-Workflow technology. The framework provides an easy to use interface and a height flexibility to develop powerful workflow applications.

##Get started….

Imixs-Script is a JavaScritp library based on jQuery, which interacts through the Imixs Rest API with the Imixs-Workflow engine. Imixs script can be used together with any other JavaScript library to build Single-Page-Applications based on the Imixs-Workflow einge (e.g. Ben.JS, EmberJS, Angular or React).

Imixs-Script is hosted on GitHub. The project contains a deployable for Java EE web containers.

As you can see Imixs-Script consists of separate modules which can be loaded also on demand.

  • imixs-core.js - provides the general data model used to map the properties of an imixs workitem into a convenience JavaScript object

  • imixs-xml.js - provides methods to convert a XML result from the Imixs REST API into a JSON format.

  • imixs-workflow.js - provides methods to access the Imixs-Workflow engine through the REST API

  • imixs-ui.js_ - provides UI methods

See also the following sections for details and examples:

##How To Install

To embed Imixs-Script into a JavaScript application the following libraries need to be added:

...
<script type="text/javascript" src="./js/jquery-2.1.4.min.js"></script>
<script type="text/javascript" src="./js/jquery-ui.min.js"></script>
<script type="text/javascript" src="./js/imixs-core.js"></script>
<script type="text/javascript" src="./js/imixs-xml.js"></script>
<script type="text/javascript" src="./js/imixs-workflow.js"></script>
<script type="text/javascript" src="./js/imixs-ui.js"></script>
...
</body>

Imixs-Script use namespaces to isolate the framework from other libraries used in the same project. The namespaces can be mapped to local variables to access the libraries:

var imixs = IMIXS.org.imixs.core, 
    imixsXML = IMIXS.org.imixs.xml,
    imixsWorkflow = IMIXS.org.imixs.workflow, 
    imixsUI = IMIXS.org.imixs.ui;
...
var myDocument=new imixs.ItemCollection();

Downloads

Imixs-Script can be downloaded from GitHub. The download contains the libraries and also a JEE sample application.

###The Sample application The Imixs-Script sample application provides an instance of the Imixs-Workflow engine and can be used as a template for custom project.