Sparx Systems Pro Cloud Server

Overview

Models are a terrific way to communicate structure, behavior, and interactions. By creating them during requirements elicitation, one can communicate concepts that can be very difficult to convey using text alone.

Supported Extensions

Sparx Systems Enterprise Architect (Sparx EA)

The Sparx Pro Cloud Server connector allows users to access artifacts within Sparx Systems Enterprise Architect (Sparx EA). Users must have both Sparx EA and Sparx Pro Cloud Server in order to add artifacts to artifact sets using Planview Viz. When configuring your Tool Connection in Viz, you will connect using your Sparx EA credentials.

Supported Editions

Planview Viz only provides support for ‘Premium Editions’ of Sparx Systems Pro Cloud Server that allow unlimited tokens. Token Editions are not supported.

Connector Setup Details

This section describes the basic steps needed to prepare your Sparx Pro Cloud Server instance for use with Viz.

Minimal User Permissions & Viz User

We recommend that you create a new user within your external tool, to be used only for Viz. This is the user information you will enter when setting up your tool connection within Planview Viz. By creating a new user, you will ensure that the correct permissions are granted.

In general, your user account should have sufficient permissions to read artifacts in your tool.

Your user should have a secure password or token. Please be aware that Viz will not allow you to save a tool connection utilizing a weak password/token, such as 'tasktop.'

Connecting to the Sparx Systems Pro Cloud Server Repository

Standard Authentication

Required Fields:

URL for Sparx EA, with project name appended
- Example Format: https://server.com:805/ProjectName
Username for Sparx EA
Password for Sparx EA

Optional Fields:

OSLC Access Code
- Only required if the project is configured to require an OSLC Access Code.
Tag Names
- Names of tags to be made available as fields for integration. Names must be separated by spaces, and names with spaces in them must be surrounded by double quotes.

Sparx Systems Pro Cloud Server Tool Connection Screen

Tags

If tags are to be included in integrations, use the Tag Names field in the repository to specify the names of tags to be used. Tag names that have spaces must be surrounded by double quotes, and tag names must be specified by spaces. For example:

Grape "Wine Advisor Rating"

Specifies two tag names.

Tag names are dynamically made into String fields on the artifact schema. If tag names are changed, a schema refresh is triggered, and collection mappings will need to be updated based on changes.

Supported Artifacts

Supported Work Items

Supported Work Item Type	Applicable Repository Versions	Unique URL?
Requirement	Any supported repository version: Planview Viz	No
Use Case	Any supported repository version: Planview Viz	No
Actor	Any supported repository version: Planview Viz	No
Class	Any supported repository version: Planview Viz	No
Component	Any supported repository version: Planview Viz	No
Interface	Any supported repository version: Planview Viz	No
Diagram	Any supported repository version: Planview Viz	No

Supported Containers

Containers that can be modeled as Flow Items	Applicable Repository Versions	Unique URL?
N/A
Containers used to define the boundary of a collection (When clicking 'Manage Projects' on a Collection)
N/A (entire tool serves as container)	Any supported repository version: Planview Viz	N/A

Containers that can be modeled as Flow Items

Applicable Repository Versions

Unique URL?

N/A

Containers used to define the boundary of a collection

(When clicking 'Manage Projects' on a Collection)

N/A (entire tool serves as container)

Any supported repository version:

Planview Viz

N/A

Supported Field Types

Planview Viz supports configuring rule-based modeling (i.e., conditional modeling) using the field types shown below.

Note: If one field of a given type is supported, others that are also that type in theory should also work. However, sometimes there are instances in which this is not the case due to the repository. So, while we can claim support for fields at the type level, there is a chance that some specific fields of a given type will not function properly.

Standard Field Type	How is field type referenced in the repository?	Sample Repository Fields Supported	Particular Repository Fields NOT Supported
String	String	Subject Alias Creator
Single Select	Drop-Down List	Status	Difficulty Priority Stability
Multi Select
Boolean

Functional Limitations

Category	Limitation	Applicable Repository Versions
Third Party Functional Limitation	Projects Because Sparx Pro Cloud Server does not support the notion of ‘projects,' the following behaviors may be observed when using Viz: Users must select an artifact type rather than a project when creating an artifact set.	Any supported repository version: Planview Viz

Category

Limitation

Applicable Repository Versions

Third Party Functional Limitation

Projects

Because Sparx Pro Cloud Server does not support the notion of ‘projects,' the following behaviors may be observed when using Viz:

Users must select an artifact type rather than a project when creating an artifact set.

Any supported repository version:

Planview Viz