Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Tigerstripe Buckminster Actions"
(→CSPEC Definition) |
|||
| (43 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
==Prerequisites== | ==Prerequisites== | ||
| − | + | *Working knowledge and installation of the Tigerstripe Workbench [http://www.eclipse.org/tigerstripe] | |
| − | + | *Working knowlege and installation of the Buckminster [http://www.eclipse.org/buckminster] Eclipse plug-ins. | |
| − | + | *Working knowlege of Buckminster Actions (See [[Introduction_to_Buckminster#Component_Specifications_.28CSPECs.29|Component Specifications]] and other Buckminster documentation). | |
| + | * Completion of the [[Tigerstripe_Buckminster_Integration_Tutorial | Tigerstripe Buckminster Integration Tutorial]] | ||
==Overview== | ==Overview== | ||
| + | Buckminster Actions may be used to add functionality to the Buckminster materialization process. For example, Tigerstripe supplies an action to automate the installation of Tigerstripe Generators. For more information on Buckminster Actions please see the [[Introduction_to_Buckminster#Component_Specifications_.28CSPECs.29|Component Specifications]] section of the Buckminster Introduction. | ||
| + | |||
| + | ==Action Definitions== | ||
| + | ====tigerstripe.installGenerator==== | ||
| + | This action will trigger the automated installation of a Tigerstripe Generator.<br><br> | ||
| + | '''Parameters''' | ||
| + | *projectname - The project name of the Tigerstripe Generator to be installed. | ||
| + | |||
| + | ==Example== | ||
| + | This section will show you how to configure and trigger a Generator installation using the tigerstripe.installGenerator Buckminster Action. | ||
| + | ====CSPEC Definition==== | ||
| + | #Open Eclipse to the workspace that was materialized in the [[Tigerstripe_Buckminster_Integration_Tutorial | Tigerstripe Buckminster Integration]] tutorial. | ||
| + | #Open the '''Equipment-model''' project and look over the included buckminster.cspec file. | ||
| + | #:<source lang="xml"> | ||
| + | <?xml version="1.0" encoding="UTF-8"?> | ||
| + | #:<cs:cspec xmlns:cs="http://www.eclipse.org/buckminster/CSpec-1.0" name="Equipment-model" componentType="tigerstripe"> | ||
| + | #: <cs:artifacts> | ||
| + | #: <cs:private name="classlevel-generator" path="ClassLevel-Generator/" type="tigerstripe.generator"/> | ||
| + | #: </cs:artifacts> | ||
| + | #: <cs:actions> | ||
| + | #: <cs:public name="tigerstripe.installGenerator" actor="tigerstripe.installGenerator"> | ||
| + | #: <cs:actorProperties> | ||
| + | #: <cs:property key="projectname" value="ClassLevel-Generator"/> | ||
| + | #: </cs:actorProperties> | ||
| + | #: <cs:prerequisites> | ||
| + | #: <cs:attribute name="classlevel-generator"/> | ||
| + | #: </cs:prerequisites> | ||
| + | #: </cs:public> | ||
| + | #: </cs:actions> | ||
| + | #:</cs:cspec> | ||
| + | #:</source> | ||
| + | #*The first two lines declare that this is XML; it follows the CSPEC format, and it describes a component called Equipment-model. | ||
| + | #*The next section defines an artifact. This artifact has a local alias of classlevel-generator, and is referencing the directory path ''./ClassLevel-Generator''. It is also defined as a ''tigerstripe-generator'' type. | ||
| + | #*The next section defines the Tigerstripe Action named ''tigerstripe.installGenerator''. Note that the actor type is also defined to be ''tigerstripe.installGenerator''. | ||
| + | #*This action has one property defined as a key/value pair. In the example above, the Actor property is ''projectname'' and the value is the Generator project name (''ClassLevel-Generator''). | ||
| + | #*Lastly, this Action has one prerequisite. This section simply states that the ''classlevel-generator'' artifact defined above must be available before this action may be triggered. | ||
| + | |||
| + | ====Triggering the Action==== | ||
| + | # Select the '''Equipment-model''' project and right click to bring up the context-menu. | ||
| + | # Select '''Buckminster -> Invoke Action...''' | ||
| + | # From the "Actions of Equipment-model" dialog, select '''tigerstripe.installGenerator''', and click "OK". | ||
| + | # Verify that the generator was installed by selecting the '''Tigerstripe -> Plugins...''' menu item. The "ClassLevel-Generator" should be listed in the "Deployed Tigerstripe Plug-ins" table. | ||
Latest revision as of 15:27, 12 November 2008
< To: Tigerstripe_Tutorials
Contents
Prerequisites
- Working knowledge and installation of the Tigerstripe Workbench [1]
- Working knowlege and installation of the Buckminster [2] Eclipse plug-ins.
- Working knowlege of Buckminster Actions (See Component Specifications and other Buckminster documentation).
- Completion of the Tigerstripe Buckminster Integration Tutorial
Overview
Buckminster Actions may be used to add functionality to the Buckminster materialization process. For example, Tigerstripe supplies an action to automate the installation of Tigerstripe Generators. For more information on Buckminster Actions please see the Component Specifications section of the Buckminster Introduction.
Action Definitions
tigerstripe.installGenerator
This action will trigger the automated installation of a Tigerstripe Generator.
Parameters
- projectname - The project name of the Tigerstripe Generator to be installed.
Example
This section will show you how to configure and trigger a Generator installation using the tigerstripe.installGenerator Buckminster Action.
CSPEC Definition
- Open Eclipse to the workspace that was materialized in the Tigerstripe Buckminster Integration tutorial.
- Open the Equipment-model project and look over the included buckminster.cspec file.
<?xml version="1.0" encoding="UTF-8"?>- <cs:cspec xmlns:cs="http://www.eclipse.org/buckminster/CSpec-1.0" name="Equipment-model" componentType="tigerstripe">
- <cs:artifacts>
- <cs:private name="classlevel-generator" path="ClassLevel-Generator/" type="tigerstripe.generator"/>
- </cs:artifacts>
- <cs:actions>
- <cs:public name="tigerstripe.installGenerator" actor="tigerstripe.installGenerator">
- <cs:actorProperties>
- <cs:property key="projectname" value="ClassLevel-Generator"/>
- </cs:actorProperties>
- <cs:prerequisites>
- <cs:attribute name="classlevel-generator"/>
- </cs:prerequisites>
- </cs:public>
- </cs:actions>
- </cs:cspec>
- The first two lines declare that this is XML; it follows the CSPEC format, and it describes a component called Equipment-model.
- The next section defines an artifact. This artifact has a local alias of classlevel-generator, and is referencing the directory path ./ClassLevel-Generator. It is also defined as a tigerstripe-generator type.
- The next section defines the Tigerstripe Action named tigerstripe.installGenerator. Note that the actor type is also defined to be tigerstripe.installGenerator.
- This action has one property defined as a key/value pair. In the example above, the Actor property is projectname and the value is the Generator project name (ClassLevel-Generator).
- Lastly, this Action has one prerequisite. This section simply states that the classlevel-generator artifact defined above must be available before this action may be triggered.
Triggering the Action
- Select the Equipment-model project and right click to bring up the context-menu.
- Select Buckminster -> Invoke Action...
- From the "Actions of Equipment-model" dialog, select tigerstripe.installGenerator, and click "OK".
- Verify that the generator was installed by selecting the Tigerstripe -> Plugins... menu item. The "ClassLevel-Generator" should be listed in the "Deployed Tigerstripe Plug-ins" table.