Learn about the Splitter Tool for Documents, powered by Regular Expressions (Regex)
The Splitter Tool in v4.11 is an invaluable asset for engineers looking to organization and parse complex documents. This tool allows users to break down combined statements into smaller, more manageable entities while maintaining document structure and traceability.
Combined statements often complicate successful communication process, as they can obscure granular details needed for analysis and traceability. The Splitter Tool solves this by enabling users to parse entities into distinct sentences or paragraphs, creating structured and traceable outputs that integrate seamlessly into the existing hierarchy using Regex.
The Splitter Tool has the capability to:
- Parse combined statements into manageable entities for better granularity.
- Provide flexible options to organize split by sentences/paragraph into children or sibling entities.
- Maintain consistent numbering schemes tied to the original entity for seamless integration.
In the following sections, we’ll explore the Splitter Tool functionality step by step, highlighting its role in optimizing documentation workflows for systems engineers.
Choosing the Combined Statement
Before initiating the Splitter Tool, select the entity containing the combined statement you want to parse. This entity could consist of multiple sentences or paragraphs that need to be split into smaller entities.
Figure 1: Combined Entity Statement before Parse
Accessing the Splitter Tool
Navigate to the Documents View, select the desired entity, and click on the “More” dropdown menu. From the list, choose “Splitter”.
Note: This feature only becomes available when an entity is selected.
Figure 2: Splitter Button in "More" drop-down
Split Configuration
In the Split stage:
- Choose whether to split the entity by sentences or by paragraphs, depending on the level of granularity you require.
- Select how the split entities should be added:
- Add as Children: Place the new entities under the original entity in the document hierarchy.
- Add as Siblings: Position the new entities at the same hierarchical level as the original.
Figure 3: Split Modal Phase
These options ensure flexibility in organizing your parsed entities based on project requirements.
Preview Split Entities
In the Preview stage:
- Review the split entities displayed in a structured, editable table.
- Make any necessary refinements, including editing the content of split entities, edit/remove the row, or de-selecting items that should not be included in the final split.
- The first entity in the preview will overwrite the original combined entity.
Figure 4: Preview Modal Phase
Once satisfied, click Apply to finalize the split.
Final Embedded Output
After applying the Splitter Tool:
- The document updates to display the split entities in the desired sequence.
- The numbering scheme for the new entities automatically inherits the prefix and numbering of the original entity, to stay consistent. The split outputs integrate into the existing hierarchy.
Figure 5: Final Output of Split Entity
The Splitter Tool empowers engineers to break down complex statements into manageable components, enhancing traceability and communication across projects. By leveraging Regex technology and offering flexible organizational options, it ensures that documentation remains structured, detailed, and easy to navigate.
Tutorial Video