System Integrations

Overview

The System Integration module is designed to define and manage the relationships between functional systems and technical systems within a project. It enables users to map how functional systems (or their types) are integrated with technical system types, supporting classification, reporting, and downstream processes such as checklists.

Key Concepts

• System Integration: A record that links a functional system or functional system type to a technical system type, capturing classification and descriptive information.

• Type: Specifies whether the integration is for a "Functional System Type" or a "Functional System".

• Parent Code: The code of the parent system (either a functional system type or a functional system).

• Technical System Type Code: The code of the technical system type being integrated.

• Classification Term Lookup: The classification term associated with the technical system type.

• Translation: A translated description for localization or multilingual projects.

Main Pages

1. System Integrations List

• Purpose: View, filter, and manage all system integration records.

• Key Fields:

  • Type: Indicates if the integration is for a functional system type or a functional system.

  • Code: Unique identifier for the system integration.

  • Parent Code: Code of the parent system.

  • Technical System Type Code: Linked technical system type.

  • Description: Description of the technical system type.

  • Classification Term Lookup: Classification term for the integration.

  • Level 2: Level 2 classification value (read-only).

  • Serial No.: Serial number of the technical system type (read-only).

  • Translation: Translated description.

2. System Integration Subform

• Purpose: Used as a subpage to display and manage system integrations related to a specific parent (functional system or type).

• Features:

  • Add/Edit Integrations: Add new integrations or edit existing ones for the selected parent.

  • Checklist Action: Open checklists related to the selected system integration.

  • Auto-fill: When creating a new record, filters and parent codes are auto-filled based on the context.

How to Use

Creating a System Integration

1. Open the System Integrations list or the subform from a functional system or type card.

2. Select the Type (Functional System Type or Functional System).

3. Enter or select the Parent Code (the code of the functional system or type).

4. Use the lookup on Classification Term Lookup to select a technical system type. The description, serial number, and classification entry number will be filled automatically.

5. Optionally, enter a Translation for the integration.

6. Save the record.

Using the Checklist Action

• In the subform, use the Checklists action to open or create checklists related to the selected system integration.

Batch Copying Integrations

• Use the InsertSystemIntegrationForParent procedure (typically called from code or an action) to copy integrations from one parent to another, supporting efficient setup for similar systems.

Field Descriptions

Tips

• Use the Classification Term Lookup field’s lookup to ensure correct and consistent classification.

• Use the Checklist action to quickly access or create checklists for each integration.

• Use the batch copy procedure to efficiently replicate integrations across similar systems or types.

Security & Permissions

• Only users with appropriate permissions can create, edit, or assign system integrations.

• Security filter IDs are managed automatically for permission-based filtering.

Troubleshooting

• If you cannot see or edit a system integration, check your permissions and assignment.

• If lookups do not return expected results, ensure the parent code and type are set correctly.

• If fields are not auto-filled, verify that the technical system type exists and is properly classified.