Technical Factsheet

Smartfacts Platform

The Smartfacts platform is deployed in containers only. We strongly recommend to use Kubernetes to deploy Smartfacts on premises. MID provides helm charts for Kubernetes instances:

• Helm chart for instances that have a connection to the internet and can download containers from MID’s container repository

• Helm chart for air-gapped scenarios where containers have to be downloaded manually from the Smartfacts customer portal

This picture shows a typical deployment of Smartfacts for connecting a modeling tool with a requirements management tool leveraging the OSLC standard:

Smartfacts Server Details

1. Smartfacts platform with REST API

2. Smartfacts frontend SPA (single-page application) and plug-in SPA

3. genOSLC (MID’s geenric OSLC framework) consisting of one frontend and one backend container, running in one POD

4. MID CAMP 2020.03 - MID’s customer account management frontend, consisting of one frontend and one backend container, running in one POD

5. MongoDB 5.x, primary database for Smartfacts, including search index, link index, model index

6. MID’s Mail Service 2020.02, optional for sending notification e-mails via SMTP or AWS mail

7. Optional: MID’s Maintenance Service 2020.02 for automatic backup and restore

8. Optional: Kafka 2.4. for synchronizing users via CAMP and for connecting to the Mail Service

9. Optional: For PoCs without connection to enterprise identity management, we use Keycloak to provide user ID management for SAML2, OAuth2, OIDC, LDAP, SCIM

10. Optional: Zookeeper

genOSLC Server Details

The genOSLC framework is a generic OSLC connector that is used with tools like Codebeamer, Jama Connect, Eclipse, Visual Studio Code and more to make them OSLC compliant. The genOSLC framework usually connects to the server side of an authoring tool and it serves a web application that runs inside the client of the authoring tool - e.g. in an iFrame.

The physical genOSLC server can be the same server as the Smartfacts server or one of the authoring tool servers, or it can be a separate server. The genOSLC server must also be able to run containers as genOSLC consists of two, in the case of Codebeamer of three containers.

Smartfacts Single Page Application

• AngularJS 1.6.2 used with TypeScript

• D3.js v4, used for diagram manipulation

• Websockets, used for live comments/conversations and for event notifications

List of Pods and Containers

This section contains a list of the pods and containers used in a Smartfacts productive installation.

Port Diagram

Tool Plug-Ins

• Java-based tools: Cameo, MagicDraw, Matlab Simulink, Rhapsody

• .NET-based tools: Innovator, Enterprise Architect

• Other formats via file transfer: ARIS, BPMN, ReqIF(z)

• OSLC bindings for

  • Asciidoc

  • Atlassian Confluence

  • Atlassian Jira

  • Eclipse

  • GIT

  • IBM, Engineering Lifecycle Management / Jazz

  • IBM, DOORS Next

  • IBM, Engineering Workflow Management

  • IBM, Engineering Test Management

  • Jama Software, Jama Connect

  • Microsoft, Visual Studio Code

  • PTC, Codebeamer

  • Smartfacts including all modeling tools supported

    • Dassault Systèmes, Cameo Systems Modeler

    • Dassault Systèmes, CATIA Magic Cyber-Systems Engineer

    • Dassault Systèmes, MagicDraw

    • IBM, Rhapsody

    • MID, Innovator

    • Sparx, Enterprise Architect

    • The Mathworks, Matlab Simulink