Syndeia stores three main types of information for a given project.
- Repository information - This includes the hostname, encrypted credentials, and other information required for connecting to various repositories, e.g. product lifecycle management systems, databases, requirement management systems, and software configuration management systems. Repository information is typically shared across multiple SysML projects.
- Connection information - This includes the inter-model connections created between SysML model elements and various repository elements, such as Teamcenter items, Windchill parts, DOORS requirements, GitHub files, or JIRA issues. Connection information is specific to a SysML project.
- Settings - This includes the various settings that control Syndeia's behavior.
Syndeia 3.1 can be used in local mode or database mode, as described below. In contrast, all previous versions of Syndeia, including Syndeia 3.0 only support the local mode.
- Local mode - In this mode, Syndeia stores repository information in the .syndeia folder in the user directory (e.g. C:\Users\<YourAccount>\.syndeia on Windows or /Users/<YourAccount>/.syndeia on Mac) and the connection information in the SysML model. This allows sharing of repository information across multiple SysML models. If the SysML models are version controlled, then the connection information which is stored in the model, is also versioned with the model. The settings information is also stored in the .syndeia folder in the user directory. This mode is a preferred approach when you are starting to use Syndeia, or you are working on SysML projects alone or with very few participants.
- Database mode - In this mode, both the repository information and the connection information is stored in a shared database server. For repositories, only the URL information is persisted in the database. Other user-specific credential information is still stored locally. Syndeia creates a single database (keyspace) for repositories which are shared across multiple projects, and a separate database (keyspace) for each project to store connection information. This allows multiple Syndeia users to share the same set of repositories, and provides a scalable store for Syndeia connections. We have run scalability tests of the order of millions of connections with a single database server node in a cluster. The settings information is stored in the .syndeia folder in the user directory. This mode is a preferred approach when you have gained experience using Syndeia in the local mode, and will be working on SysML projects jointly with a larger team.
Follow the steps in the sections below to configure Syndeia to use in local or database mode.