Skip to content

My first interface - explained in detail

My first interface - explained in detail

If you want to create an interface between a source application (i.e. a database table) and a destination application (i.e. an excel sheet) you can do this by creating a new ADIB "step". In the previous chapter we explained the main concepts of ADIB. Just click here if you are not sufficiently familar with these concepts.

In this chapter we will explain the different tasks to perform in order to create such a new interface.

Create new step

Just click on "New" to create a new step. Create new step

  • You will then see the different step-types that exist - and the modules you are licenced to.
  • Here you can just click on "Confirm".

Create new step

  • On the next screen you will define the following elements
    • Name of the step (mandatory)
    • Description (optional)
    • Instances for which the step should be active
      • Usually you will first create it for the DEV or TEST instance - and activate it for PROD as soon as it runs correctly
    • The job to which the new step should be assigned

Create new step

  • After clicking on "Next" you can choose modules the different processes
    • srcModule
      • Here you will define the source of the interface
      • Click on the selection and you will see the source-modules that you licenced
      • After the selection small rectangles will appear that correspond to the "instances" you selected before
        • Within these rectangles you define the parameters - or parameter groups - for the new step

ADIB facilitates the creation of "parameter groups". This will make life easier - as you could for example create a parameter group with the database credentials - that you can re-use on several steps. Click here to see how to create such a parameter group.

Create new step

If you haven't created a parameter group yet you can create one within this process - otherwise just select a group that you previously created.

Parameter and parameter groups

"Parameters" have a very important role within ADIB. They are used for different things such as

  • Define credentials - i.e. of a database connection (host, port, user, password, database name)
  • Define functional aspects (i.e. if buttons or views are shown or not)
  • Define layout aspects of ADIB portal (i.e. if buttons or views are shown or not)
  • Define logging

Parameters are module specific. This means that depending on the modules you use as your source (i.e. database) and destination (i.e. ADIB Portal) the parameters will be specific for these modules.

During the process of creating a new interface (via a "step") you will be guided by a "wizard" through all tasks - including the definition of the parameters.

Create new parameter group

The creation of a new parameter group is often triggered by the creation of new step. It is always advisable to create a parameter group - as it can be reused for other steps. And of course - you can overwrite specific parameters of a parameter group when used for a new step ...

Within the process of creating a new step - you will create a new parameter group as seen on the next screenshot. Here you will define

  • Name of the parameter group (mandatory)
  • Description (optional)
  • Instance
    • The instance is normally pre-set when the process is triggered by the creation of a step.

NOTE: You can use a parameter group that was originally defined for a different instance! You will just be informed "to take care"..

  • When you click on next you will see the parameters that correspond to the module that you chose to define the step
    • The parameters you see on screen correspond to a MySQL connection. They will be completely different if you habe i.e. a webservice connection...
  • Within the screen you will enter the correct values for each parameter.
  • You can decide whether a parameter value should be encrypted (strongly advised for username / password)!
  • Espacially in case of creation of a new ADIB portal you will see a lot of parameters
    • You can always filter the "Param class" to not lose yourself because of the number of lines to be filled in.
    • In general most of the "ADIB portal parameters" have default values - so that there is no need to set up values for everything!

Parameter group

  • After filling in all relevant parameters click on "Next" you will see a confirmation page

Parameter group