The Companion App is a powerful Interface Component for the ExMeX Framework.
At first - download the latest stable version of the companion app. You can find it here: https://tedamoh.com/de/download/category/28-tedamoh-exmex-companion-app
There is no installation process needed, you can directly open the app by executing the ExMeXCompanionApp.exe.
The first opened page in the app will be the dashboard, from where you can start the features of the app.
The ExMeX Dashboard is the starting screen of the Companion App:
On the left side you can use Quick Links, which will open in your standard browser.
The button Connect allows you to enter the database configuration.
And in the middle of the page there are several tiles, each opening an own feature page in the app. Each feature is described in an own section.
On the dashboard page click on the button "Connect" in the upper right corner.
A popup window will open, where you can define the connection to the database server. You can choose between "Windows Authentication" or "SQL Server Authentication".
After setting all information and clicking the connect button, the companion app will try to make a connection to the specified server with the connection parameters. If the connection is successful, the popup window will close and some server information will be stated at the top of the dashboard. If the connection is not possible, an error hint will be given at the bottom text field of the popup window.
The companion app will store your server connection from the last succesful connection (companion app version 0.5.0 or greater).
Within the ExMeX Configuration you are able to set global variables for the ExMeX Framework.
Further information on this topic: https://tedamoh.com/de/helpdesk/doc-faq/exmex-framework-book/getting-started-exmex/configuration
After you clicked on the dashboard tile for ExMeX configuration, all available variables on the database are getting collected.
At the top of the page, you can then choose the variable you want to configure.
When choosing a variable, the current value is shown in the input field with an additional description in the text field below.
There are variables, you can set with a string or a number:
But there are also variables, where you can only choose between on and off. Just use the switch for that:
You can click the "Save" Button to save the selected variable with the input field value. The text box at the bottom will show you the result of the save, or, in case of an error, the error message.
The Batch Orchestration is the implementation of a data pipeline within the data warehouse.
Further information of the ExMeX Framework on this topic: https://tedamoh.com/de/helpdesk/doc-faq/exmex-framework-book/data-logistic/batch-orchestration
A master batch is the highest functional batch you can create.
To create a new master batch, right-click on the RootBatch to open the context menu of the root batch and choose "Create new Master Batch":
In the following dialog you have to write the name of the new batch in the input field (Child Batchlabel) . Then click "Create" to add the new master batch.
With the companion app you are able to configure a dependency relation between batches, to orchestrate the load process of the batches. A dependency is always a structure like [successor -> predecessor]. This means, that all process steps of the successor have to be loaded after the predecessor process steps are finished.
In the app, select the batch which should be a successor of another batch and right-click on that batch to open his context menu and click on "Options" and "Dependencies".
In my example I want to start the load of the Batch Sub A.3 after the Batch Sub A.2 - so Sub A.3 has the predecessor Sub A.2:
The app presents all candidates for the successor (which are all sibling batches). Select all batches which should be predecessors of the current batch and click "Save":
The result is a visible dotted line between the batches to represent a dependency. If you hover over a batch, the dependency will animate in the direction of the dependency:
The Filter Configuration implements filter conditions for a specific load process step.
For information of the ExMeX Framework on this topic look here: https://tedamoh.com/de/helpdesk/doc-faq/exmex-framework-book/data-logistic/how-to-do/filtering
If you want to set a filter on a table to reduce the amount of data load, you can do this with the feature "Filter Configuration" of the companion app. Open the feature by clicking the card on the dashboard.
There are several steps you have to do now:
- Select a model
- Select an entity
- Select an attribute
After choosing these parameters from the possible list of models, entities and attributes, the Source attribute datatype is shown.
Now you can set one or two filter conditions on the selected attribute. Many options and combinations to filter are possible.
After implementing your filter condition click on the "Save" Button. The filter condition is saved on the connected database and the technical condition will be shown in the result field near the save button.
Warning: every combination of filter conditions is available for you, so you have to check the resulting filter condition yourself. Be aware to choose the correct filter to have your desired data flow.
A filter could exlude all data completely (e.g. [LieferantNummer] >= 1500 AND [LieferantNummer] <= 1200 )
Or a filter may contradict itself (e.g. [LieferantLand] = 'GER' AND [LieferantLand] NOT IN ('GB','USA','GER','ISL') )