Tigerstripe Profile Tutorial

From Eclipsepedia

Jump to: navigation, search

< To: Tigerstripe_Tutorials

Tigerstripe Profiles help you to configure your Tigerstripe Workbench and allows you to enable or disable information from displaying on the Tigerstripe palette. The information that you hide may be information that is not utilized within your organization.

Contents

Creating a Tigerstripe Profile

To create a new Tigerstripe Profile:

  1. Click New and select Other (alternatively you can right-click on your project in the Tigerstripe Explorer, click New and select Other).
  2. Select Workbench Profile and click Next'.
    • For this tutorial, name your Tigerstripe Profile (simpleProfile), enter the version information (1.0), and a short description.
  3. Click Next. Your Tigerstripe Profile appears in the Tigerstripe Explorer with your default name and an extension of .wbp.
  4. The Profile editor will automatically open.
    File:Workbench Profile.gif


A Tigerstripe Profile contains multiple sources of information that display on individual tabs including:

  • The General tab which allows you to control a number of legacy settings. This is where you can enable some OSS/J Legacy behaviour that was provide with earlier version of Tigerstripe Workbench. For more information, refer to #General Settings.
  • The Stereotypes tab which allows you to include additional information with your Tigerstripe model. Project stereotypes are useful for triggering different behaviors at project generation. For more information, refer to #Stereotypes.
  • The Primitive Types tab which allows you to include additional primitive types with your project. Tigerstripe Worbench is delivered with default primitive types. The project specific primitive types you define become available after you deploy your project. For more information, refer to #Primitive Types.
  • The Artifacts tab which allows you to control the artifacts available with the Tigerstripe Artifacts palette. For example, if you know that users of the model will not be utilizing queries, you can disable the query artifact from the Tigerstripe palette. These changes will become active after you deploy your project. For more information, refer to #Artifacts.

General Settings

Complete the following procedure to enable the various features.

To disable features:

  1. Click the General tab in your Project Profile Perspective. By default all options are disabled.
  2. Enable the Settings as required and save your Profile to save your changes.

If you wish to use OSS/J, you will need to enable a number of legacy setting. Note that in previous version of Tigerstripe the default profile had these features enabled by default. They are now disabled by default.

Stereotypes

As your Tigerstripe projects (or models) start to expand, you may want to specify profile specific stereotypes. This may be useful if you want to call a specific behavior upon project generation. For detailed information about Tigerstripe Stereotypes , refer to the Tigerstripe Stereotypes Tutorial.

To add an Stereotype to your profile:

  1. Navigate to the Stereotypes tab.
  2. Click Add.
  3. Name your stereotype, assign a version number, and enter a short description.
  4. Select the scope for your stereotype. This determines whether your stereotype is available with the listed Artifact types.
  5. In the appropriate sections, enter Attributes for your stereotype and Required Stereotypes or Excluded Stereotypes, if any.
  6. Save your Profile.

Primitive Types

For your specific organization, you may want to create some Primitive Types to be used with all projects utilizing Tigerstripe Workbench. A number of basic types are delivered by default with Tigerstripe Workbench, some of which include:

  • Integer
  • Boolean
  • Float
  • Void

To create a new primitive type:

  1. Navigate to the Primitive Types tab.
  2. Click Add.
  3. Name your Primitive Type and enter a short description.
  4. Save your Profile.

"Custom" primitive types are used in the model in the same way as the built-ins.

Artifacts

Through the Artifact Settings you can restrict the types of Artifact that users can see. This may be because the specific Artifact types make no sense in your scenario, and are ignored by any plugins that you have developed. For example, you may not want users to have access to Query Artifacts or Notification Artifacts. In this instance, you would want to disable these options from the palette that displays with Tigerstripe Workbench.

To define Artifact settings:

  1. Navigate to the Artifacts tab.
  2. Select the Artifact type(s) you want to disable. By default, all Artifact types are enabled.
  3. Save your Profile.

When an artifact type is disabled, the users cannot create any new instances, and any existing instances are hidden from the display. Note that instances of the Artifact type *may* still exist, so it is important to make sure these settings are correctly set up from the outset of any model develoment.

Deploying your Profile

Before your changes become available with your Tigerstripe project, you must deploy your Tigerstripe Profile. For more information about deploying your Tigerstripe Profile, refer to Deploying your Profile.

The Profile Editor allows you to:

  • Save the current profile as the active profile.
  • Roll back to a previous active profile
    • Note: You can only roll back one profile.
  • Reload the factory default profile settings.

The above deployment options are available from the Overview tab in your Profile Editor and are highlighted in red in the following image.

File:Deploy Profile/gif

To make the current profile active:

  1. Select the Save as active profile and reload link (#1 above). The "Save as Active Profile" dialog box opens.
  2. Click OK. The Progress Information dialog box appears showing the progress of your deployment.
  3. When complete, the Success dialog box opens. Click OK.

The current Tigerstripe Profile is now the active profile for all Tigerstripe Workbench projects in this eclipse installation. Note that the same profile is applied for all workspaces.

To roll back to the previous profile:

  1. Select the Roll back to the previous active profile link (#2 in the image above). The Rollback to previous Active Profile dialog box displays.
  2. Click OK. The Progress Information dialog box appears showing the progress of the rollback action.
  3. When complete, the Active Profile Rollback dialog box displays. Click OK.

To load factory default settings:

  1. Select the here link (#3 in the image above). The Reset Active profile to Factory Defaults? dialog box displays.
  2. Click OK to continue or click Cancel to return to the Profile Perspective. The Progress Information dialog box appears showing the progress.
  3. When complete, the Active Profile Rollback dialog box displays. Click OK.

This will return the settings to those that are present when Tigerstripe Workbench is first installed.

Viewing Active Profile Details

At any time, you can view the details of your active profile by selecting the Tigerstripe menu and clicking Active Profile Details. The Active Profile Details dialog box displays.

This dialog box includes the following information:

From the Active Profile Details dialog box, you can reset your profile to the factory default settings, or deploy a different profile.

To reset your profile:

  1. Click Reset Profile. The Reset Active profile to Factory Defaults? dialog box displays.
  2. Click OK. The Progress Information dialog box displays.
  3. Click OK when the Active Profile Rollback dialog box displays.

You have successfully reset your profile to the factory default settings.

To deploy a different profile:

  1. Click Deploy Profile. The Select Profile dialog box opens.
  2. Navigate to the location of your profile and click Open. The Save as Active Profile dialog box displays.
  3. Click OK. The Progress Information dialog box displays.
  4. Click OK when the Active Profile Rollback dialog box displays.

You have successfully deployed a new profile.