05 // Company

Introduction

A Company Project handles the specific configuration for the company.

Note

See our Demo Company - Check out an Example, how to setup Orchescala for your Company - examples for all Engines.

Warning

Be aware that this is not tested.

Make sure you have init the company.

In this process many files are generated and some are replaced.

Only files with the comment DO NOT ADJUST will be replaced. So if you add custom code, make sure to remove this comment.

We recommend you make a comment what you have changed, so you can easily update the file from time to time. (just add the DO NOT ADJUST comment again)

If there is no DO NOT ADJUST comment, you need to delete it if you want the newest version of this file.

Normally these files have the comment: // This file was created with .. - to reset delete it and run the command..

The layout looks similar to a BPMN project:

myCompany-orchescala
            |  00-docs
            |  02-bpmn
            |  03-api
            |  03-dmn
            |  03-simulation
            |  03-worker
            |  04-helper
            |  project
            |  build.sbt
            |  helper.scala

To setup the Company Project, follow these steps:

  1. Open the mycompany-orchescala directory with your IDE (I use Intellij).

  2. Import the sbt project. The project should compile without errors.

  3. [sbt]

    The build tool (project, build.sbt).

  4. [00-docs]

    The company's documentation.

  5. [02-bpmn]

    General configurations and code for the BPMN DSL.

  6. [03-api]

    General configurations and code for the Api DSL.

  7. [03-dmn]

    General configurations and code for the DmnTester DSL.

  8. [03-simulation]

    General configurations and code for the Simulation DSL.

  9. [03-worker]

    General configurations and code for the Worker DSL.

  10. [04-helper]

    General configurations and code for the development process of the projects, Including the Company project.

  11. [Development]

    The helper.scala script supports the development process.