Preparation

This section contains the preparation steps for packaging your modelling tool:

• If you are starting from scratch and want to implement and/or package your tool, please go to: Preparation from Scratch
• If you already have a modelling tool, which is based on ADOxx 1.5 and want to migrate to ADOxx 1.8, please use: Preparation Migration

Preparation from Scratch

This section guides you to package and publish your modelling tool. It does not contain information on how to implement with ADOxx. For further information on the implementation please refer to the ADOxx documentation or join one of the upcoming ADOxx Crash Courses.

Access to code.omilab.org

To use the packaging procedure you need access to our GitLab repository: code.omilab.org

1. Please register at: https://code.omilab.org/users/sign_up

2. Request access to the GitLab group for the modelling tools: https://code.omilab.org/resources/modelling_tools

Register to code.omilab.org and request access to the modelling_tools group

3. Create your blank modelling tool project within the modelling_tools group (https://code.omilab.org/resources/modelling_tools)
   1. Click New project
   2. Click Create blank project

Create a blank GitLab project in the modelling_tools group

1. Enter the name of your modelling tool, as your project name
   1a.Check if the Project slug was automatically set, if not provide it
2. Set the project to public
3. Uncheck the box for Initialize repository with a README

Provide the name for the new project

4. Set Up the project structure
   • Download the gitlab-ci.zip: gitlab-ci.zip and unzip the file
   • Open the GitLab repository of your newly created project in the browser
   1. Click on Upload File
   2. Upload the unzipped .gitlab-ci.yml
   3. Click Upload file

Upload the .gitlab-ci.yml file

5. Create the project structure

   ^{Attention: the load_template button is only available, if (part of) the structure is not yet available!}

   1. Click Build
      1a. Click Pipeline
   • There should be a job with status Blocked
   2. Click on Blocked
      2a. Start load_template (by clicking on the play symbol next to it)

Trigger the creation of the project structure

• Wait till the structure is created

Wait till the project structure is created

6. Open the CI/CD pipeline interface
   1. Click on Build
      1a. Click on Pipelines

GitLab interface for opening the CI/CD pipeline interface

7. Start loading the project structure
   2. Click on the Blocked job
   3. Start the load_package_src job

GitLab interface for starting the job to loading the project structure

8. Wait till the template is loaded

GitLab interface of the finished GitLab CI/CD job for creating the project structure

When this is finished, the webpage for your modelling tool has also been created on OMiLAB's community tools page. You can find more details on how you can update the default information at publish your new modelling tool documentation.

To create the installation files for your modelling tool, continue with the documentation on package your modelling tool.

Preparation Migrating from ADOxx 1.5 to ADOxx 1.8

You can import your ADOxx 1.5 library file into ADOxx 1.8, develop and use it as with ADOxx 1.5.

More information on the changes from 1.5 to 1.8 can be found in the downloaded installation folder of ADOxx 1.8:

• <SourceFolder>/doc --> for general information about the changes and the platform
• <SourceFolder>/doc/ADOxx CHANGELOG excerpt --> for overview of the changes

Adapt your modelling tool and all the needed functionality so that they work with ADOxx 1.8 and then export the new ADOxx library (.abl) file. If you want to provide example models with installation package of your modelling tool, please create these with ADOxx 1.8 and export them as .adl files. If there are any open questions, please do not hesitate to contact us at info@adoxx.org

1. Login into your modelling tool repository at code.omilab.org

Login and open your modelling tool project page

2. Preparation for adapting the project structure
   • Download the gitlab-ci.zip: gitlab-ci.zip and unzip the file
   • Open your modelling tool project in the browser
   • Upload the .gitlab-ci.yml file to the root of your project (see figure below)

Uploading the .gitlab-ci.yml file to your modelling tool repository

3. Open the CI/CD pipeline interface
   1. Click on Build
      1a. Click on Pipelines

GitLab interface for opening the CI/CD pipeline interface

4. Start loading the project structure
   2. Click on the Blocked job
   3. Start the load_package_src job

GitLab interface for starting the job to loading the project structure

5. Wait till the template is loaded

GitLab interface of the finished GitLab CI/CD job for creating the project structure