Which projects require this sequence to run? What are the consequences of deleting this HTML screen class on my project? Is this transaction really useful? In this article, Elodie Eberhardt and Rahman Fatsal explain how the new Convertigo References view helps you answer these questions.
Which projects should I deploy to get my project work? Which transactions use this screen class in entry? What are the consequences on my projects if I delete this sequence? A series of questions among many that a Convertigo developer may ask every day. For large projects, answering these questions may quickly become a difficult and painful problem.
That’s why Convertigo introduces the new References view in Convertigo Studio!
The References view was created to allow Convertigo developers to easily and quickly see the links and interactions between a selected object and all projects of its workspace. You can access in one click to a transaction for example and see what objects are required to make this transaction work, and possibly in which sequences it is used.
References view description
The References view is available in Convertigo Studio since version 6.1.1. It is not displayed by default in Studio interface, you have to display it before using it.
To do so, you should open the Window > Show View > Other… menu, which opens the Show View wizard:
Expand the Convertigo category, and select the References view, then click OK to validate. The References view opens next to the Console view. You can move it where you want in the user interface; for this article, let’s place it next to the Projects view.
Using the References view
To use the References view, simply select an object in the Projects view: all its references are instantly displayed in References view.
For example, let’s open the sample projects created using the getting started with Convertigo Mashup Sequencer tutorial: sample_documentation_CMS. This project, as explained in the getting started tutorial, is based upon the two integrator projects sample_documentation_CLI and sample_documentation_CWI.
To open these projects, follow the procedure “To open the sample project from the Studio” available in the
Now, select in Project view any of the 3 projects, the Reference view automatically reacts and displays the information.
Two main nodes may be displayed in the References view in relation with the selected object:
- Requires: lists all the projects and objects of these projects that are needed for the selected object to be fully functional
- Is used by: lists all the projects and objects of these projects that need the selected object to be fully functional
A selected object can have the two pieces of information displayed in the References view, depending on projects structure and object types.
Depending on the type of the selected object, the information displayed by the References view will not be the same. For example, select a:
- Is used by displays the list of other project(s) that use this project, including the sequence(s) and the Call Transaction or Call Sequence step(s),
- Requires displays the list of other project(s) that are used by this project, including the called connector(s) and transaction(s) as well as sequence(s).
- Is used by displays the list of the Call Transaction step(s) pointing on this transaction, including the sequence(s) and project(s),
- Requires displays the list of screen classes the transaction uses.
- Screen class:
- Is used by displays the list of transaction(s) that define a handler on this screen class, including the precision about the type of handler (entry or exit).
Other objects that activate the References view are: connectors and sequences. Other objects do not interact with the references view.
Note that selecting a closed project in the Projects view will display its references in the References view as well.
Interactions between the References view and the Projects view
Another interesting functionality of the References view is that it automatically finds the referenced objects in the Projects view. You just have to click on a referenced object in the References view, and the tree of the Projects view automatically expends and selects the related object.