General Configuration

A wizard is defined using the wizard element, which accepts the following attributes:

  • wizardId (mandatory) to define the ID of the wizard, used when creating projects from the command line.

  • img (optional) to define the icon used in the web interface to display next to the wizard’s name and description.

  • versionPattern (optional) is the pattern to apply to define the version number when a new version is created.

    The versionPattern parameter allows specifying a pattern to create the version name automatically for every analysis. It supports the following syntax:

    • #N#: A number that is automatically incremented

    • #Nn#: A number that is automatically incremented using n digits

    • #Y2#: The current year in 2-digit format

    • #Y4#: The current year in 4-digit format

    • #M#: The current month in two digit format

    • #D#: The current day in two digit format

    • #H#: The current hour in 24-hour format

    • #MN#: The current minute in two digit format

    • #S#: The current second in two digit format

    Any character other than # is allowed in the pattern. As an example, if you want to produce versions labelled build-198.2013-07-28_13h07m (where 198 is an auto-incremented number and the date and time are the timestamp of the project creation), you would use the pattern: build-#N3#.#Y4#-#M#-#D#_#H#h#MN#m

  • autoBaseline (optional, default: true) defines whether versions created using this wizard are by default baselines (true) or drafts (false). More information about baselines and drafts can be found in the Getting Started Guide.

  • users (optional, no restriction if empty) is a semi-colon-separated list of users which are allowed to see the wizard.

  • groups (optional, no restriction if empty) is a semi-colon-separated list of Squore groups whose users are allowed to see the wizard.

  • group (optional, default: empty) defines a default display group for new projects. projects that belong to the same group are shown in a common subfolder in the Project Portfolio.

  • hideRulesEdition (optional, default: true) defines whether the Rules Edition step of the wizard is shown (false) or hidden (true) to users. This step allows users to modify the ruleset of the model to deactivate rules or change their default categories. More information about this feature can be found in the Getting Started Guide.

  • projectsSelection (optional, default: false) defines whether a wizard shows a list of projects so that users can create a meta-project (true) or shows the list of Repository Connectors and Data Providers to create a regular project (false). For more information about meta-projects, see Meta-Projects.

The users and groups attributes are only used to filter the list of wizards in the web interface. This does not prevent users from creating projects using the wizard from the command line.