Skip to main content
Jump to: navigation, search

Difference between revisions of "Debug/Plan/Launch Configuration Templates"

Line 25: Line 25:
 
This menu will be updated with new entries:
 
This menu will be updated with new entries:
 
*New configuration: replace the existing ''New'' entry.
 
*New configuration: replace the existing ''New'' entry.
*New template: allows to create a new template in the containing category.
+
*New prototype: allows to create a new prototype in the containing category.
*Reset with template values: reset the fields of the selected configuration with the values from the template. This item will be grayed if no template has been set for the selected configuration.
+
*Reset with prototype values: reset the fields of the selected configuration with the values from the prototype. This item will be grayed if no prototype has been set for the selected configuration.
  
 
[[File:Configuration_Item_Menu_Before_After_v4.png]]
 
[[File:Configuration_Item_Menu_Before_After_v4.png]]
Line 34: Line 34:
 
This menu will be updated with new entries:
 
This menu will be updated with new entries:
 
*New configuration: replace the existing ''New'' entry.
 
*New configuration: replace the existing ''New'' entry.
*New template: allows to create a new template in the selected category.
+
*New prototype: allows to create a new prototype in the selected category.
  
 
[[File:Configuration_Category_Menu_Before_After_v4.png]]
 
[[File:Configuration_Category_Menu_Before_After_v4.png]]
  
  
The UI for a new template will be the same than the configurations for which the template is defined.
+
The UI for a new prototype will be the same than the configurations for which the template is defined.
  
 
The user sets all attributes he wants, like he did for a configuration.
 
The user sets all attributes he wants, like he did for a configuration.
  
The ''Run'' button is disabled because the user can't launch a template, only configurations.
+
The ''Run'' button is disabled because the user can't launch a prototype, only configurations.
  
 
[[File:New_Template_Main_Tab_v4.png]]
 
[[File:New_Template_Main_Tab_v4.png]]
Line 49: Line 49:
 
A new tab will be added at the end of the tabs list.
 
A new tab will be added at the end of the tabs list.
  
This tab lists the attributes of the launch configuration. The creator of the template have to set the ''shared'' state of each attribute.
+
This tab lists the attributes of the launch configuration. The creator of the template have to set the ''Visibility'' state of each attribute.
  
The ''shared'' state means that the attribute will be shared with the configurations based on this template or not.
+
The ''visibility'' state means that the attribute will be shared with the configurations based on this template or not.
  
For a new template, the default value of ''shared'' will be set to ''yes'' for all attributes.
+
For a new prototype, the default value of ''Visibility'' will be set to ''yes''(checked state) for all attributes.
  
 
Note that the Attribute column contains readable IDs for each attribute, not technical IDs. It means that the template developer will have to implement a label provider to properly display attributes to the end user.
 
Note that the Attribute column contains readable IDs for each attribute, not technical IDs. It means that the template developer will have to implement a label provider to properly display attributes to the end user.
Line 59: Line 59:
 
[[File:New_Template_Template_Tab_v4.png]]
 
[[File:New_Template_Template_Tab_v4.png]]
  
When a template is selected in the left panel, a right-click opens a menu.
+
When a prototype is selected in the left panel, a right-click opens a menu.
 
This new menu will be created with new entries:
 
This new menu will be created with new entries:
 
*New configuration: replace the existing ''New'' entry.
 
*New configuration: replace the existing ''New'' entry.
*New template: allows to create a new template in the selected category.
+
*New prototype: allows to create a new prototype in the selected category.
*Duplicate: duplicate the selected template.
+
*Duplicate: duplicate the selected prototype.
*Delete: delete the selected template.
+
*Delete: delete the selected prototype.
*Apply template to all configurations: apply the values of the selected template to all existing configuration of the containing category. This item will be grayed if no applicable configuration exists for the selected template.
+
  
 
[[File:Template_Item_Menu_Before_After_v4.png]]
 
[[File:Template_Item_Menu_Before_After_v4.png]]
  
  
A new tab named Template will be available for configurations. This tab allows to select an existing template for an existing configuration.
+
A new tab named Prototype will be available for configurations. This tab allows to select an existing prototype for an existing configuration.
  
When a template is selected, then the creator of the configuration can see which attributes are shared from the template or not.
+
When a prototype is selected, then the creator of the configuration can see which attributes are shared from the template or not.
  
 
[[File:Configuration_New_Template_Tab_v4.png]]
 
[[File:Configuration_New_Template_Tab_v4.png]]
  
  
When a configuration is associated to a template, then the UI indicates which attributes comes from the template and which attributes have been modified by the user.
+
When a configuration is associated to a prototype, then the UI indicates which attributes comes from the prototype and which attributes have been modified by the user.
  
 
It could be done by a specific color, but it also could be done with italic fields or any another graphical difference.
 
It could be done by a specific color, but it also could be done with italic fields or any another graphical difference.

Revision as of 11:24, 27 February 2017

Purpose

In the context of the FEEP, a development effort has been proposed for a launch configuration template mechanism.

Currently there is no share parameters between launch configurations or to change several parameters at once. The idea is to let the user define Launch Configuration Templates that behave like cookie cutters. A configuration can be based on a template, which seeds attributes in the configuration with the settings specified in the template. Once a configuration has been created, the user can override any initial settings from the template. The user can also modify the template and push changes out to the configurations based on it. A configuration maintains a backpointer to its template, but is a complete standalone configuration than can be launched, exported, shared, etc.

Initial work and analysis has already been documented on the wiki and in bug 41353.

The goal of this page is to share propositions with the community about the launch configuration template mechanism.

Proposition [WIP]

Based on the already existing analysis on the wiki and in the bug 41353, the proposition is the following:

UI [WIP]

Template doesn't seem to be the appropriate term for this mechanism. Prototype is the term used in the following sketches. The community should agree on a definitive term.

A new icon will be available in the action bar on the left side of the window. It will allow to create a new template in the selected category.

Run Configurations New Template Icon v4.png


When a configuration is selected in the left panel, a right-click opens a menu. This menu will be updated with new entries:

  • New configuration: replace the existing New entry.
  • New prototype: allows to create a new prototype in the containing category.
  • Reset with prototype values: reset the fields of the selected configuration with the values from the prototype. This item will be grayed if no prototype has been set for the selected configuration.

Configuration Item Menu Before After v4.png


When a category is selected in the left panel, a right-click opens a menu. This menu will be updated with new entries:

  • New configuration: replace the existing New entry.
  • New prototype: allows to create a new prototype in the selected category.

Configuration Category Menu Before After v4.png


The UI for a new prototype will be the same than the configurations for which the template is defined.

The user sets all attributes he wants, like he did for a configuration.

The Run button is disabled because the user can't launch a prototype, only configurations.

New Template Main Tab v4.png

A new tab will be added at the end of the tabs list.

This tab lists the attributes of the launch configuration. The creator of the template have to set the Visibility state of each attribute.

The visibility state means that the attribute will be shared with the configurations based on this template or not.

For a new prototype, the default value of Visibility will be set to yes(checked state) for all attributes.

Note that the Attribute column contains readable IDs for each attribute, not technical IDs. It means that the template developer will have to implement a label provider to properly display attributes to the end user.

New Template Template Tab v4.png

When a prototype is selected in the left panel, a right-click opens a menu. This new menu will be created with new entries:

  • New configuration: replace the existing New entry.
  • New prototype: allows to create a new prototype in the selected category.
  • Duplicate: duplicate the selected prototype.
  • Delete: delete the selected prototype.

Template Item Menu Before After v4.png


A new tab named Prototype will be available for configurations. This tab allows to select an existing prototype for an existing configuration.

When a prototype is selected, then the creator of the configuration can see which attributes are shared from the template or not.

Configuration New Template Tab v4.png


When a configuration is associated to a prototype, then the UI indicates which attributes comes from the prototype and which attributes have been modified by the user.

It could be done by a specific color, but it also could be done with italic fields or any another graphical difference.

For the following example, the specific color has been chosen, but it is only for the example.

Here is a configuration with no attributes modified:

Configuration With Template v4.png

Then, the same configuration with modified attributes:

Configuration With Template Modified v4.png

API [WIP]

API will added to the following interfaces to support launch configuration templates (API comes from here)

ILaunchConfigurationType

  • Get all templates of this type
  • Create a new working copy based on a given template

ILaunchConfigurationWorkingCopy

  • Set whether a configuration is a template
  • Set the template a configuration is based on (backpointer)
  • Copy attributes from a configuration into the working copy

ILaunchConfiguration

  • Return whether a configuration is a template
  • Get the template a configuration is based on (backpointer, may be null)
  • Get all configurations a template is associated with
  • Return whether an attribute of the configuration has been modified or comes from the template

AbstractLaunchConfigurationTab

  • A new method to validate templates. The default implementation will not validate templates (as they will usually have sparse/incomplete information that would be invalid). Clients can provide an implementation of the new method to perform template validation as needed.

ITemplateAttributeLabelProvider

  • Return a readable label for an attribute of a template.

Misc

  • Default color to associate to widgets linked with attributes with values from the template

Back to the top