eAI Documentation

1. Introduction

• Overview
  eAI is an advanced, desktop-based application designed to streamline P&ID (Piping and Instrumentation Diagram) annotation and enrichment. Built as part of the PlantFCE suite, eAI helps users add meaningful data to engineering diagrams, integrate P&ID elements into cost estimation workflows, and streamline the creation of MTOs (Material Take-Offs) and requisitions. With tools for both standard and custom annotations, users can mark up P&IDs with details that support engineering, cost estimation, and procurement processes, all while maintaining an organized and auditable record of revisions and annotations.

• Key Features

  • Annotation Tools: Easily add shapes, symbols, and text to P&IDs, enhancing readability and detail.
  • Data Enrichment: Add dimensional data, part details, and per-piece costs directly onto diagram elements.
  • Revision Tracking and Change Management: Track revisions and manage updates across versions to maintain project accuracy.
  • Export Capabilities: Export associated data for use in PlantFCE’s suite, allowing direct integration into cost estimation and procurement workflows.
  • Multi-Platform Support: Available on both macOS® and Windows® platforms, facilitating access for a wide range of users.

• Supported Platforms
  eAI is available on:

  • macOS®: Download via the App Store.
  • Windows®: Download via the Microsoft Store.

  eAI requires no additional plug-ins or extensions to run on these platforms, ensuring smooth operation and compatibility with the desktop environment.

2. Getting Started

• Installation

  • Download and Install
    For each supported platform, follow the installation steps:

    • macOS®:
      1. Open the App Store® on your Mac®.
      2. Search for “eAI” and select the eAI app from the search results.
      3. Click “Get” or “Download” to install eAI on your Mac®.
      4. Once installed, open the app from your Applications folder.
    • Windows®:
      1. Open the Microsoft Store on your Windows® device.
      2. Search for “eAI” and select the app from the search results.
      3. Click “Get” to install eAI on your device.
      4. Launch eAI from the Start menu after installation.

  • System Requirements
    Minimum system requirements for eAI to run smoothly on each platform:

    • macOS®: macOS® 13 or later, 4 GB RAM, 500 MB disk space.
    • Windows®: Windows® 10 or later, 4 GB RAM, 500 MB disk space.

  • Activation and Licensing
    If the app has been downloaded from our website (using a free trial), users must activate eAI with a license.

    To activate eAI:

    1. Open the app and go to the Licensing section from the main menu.
    2. Enter your license key, which is provided via email.
    3. Click Activate to unlock eAI’s full features.

    If the license key is not recognized, contact support.

• Interface Overview
  eAI’s interface is designed to be user-friendly, with key functions readily accessible:

  • Menu Bar: Located at the top of the application (Windows®) or at the top of the screen (macOS®), the menu bar allows the user to open files, import markup data, export, cut/copy/paste, and zoom in/out.
  • Main Toolbar: Located at the top, overlaying the canvas, providing quick access to tools like annotations, navigation options, and zoom controls.
  • Sidebar: A vertical sidebar on the left contains thumbnails for multipage PDFs, and the properties panel (shown when an object is selected) for viewing and editing properties.
  • Canvas Area: The central area where P&IDs are displayed and annotations are applied.

3. Core Features

• Annotating P&IDs

  • Supported File Types
    eAI supports importing P&IDs in the PDF format, with built-in handling for multipage PDFs. Each page of a multipage document is displayed in the sidebar, and users can navigate to specific pages for individual annotation.

  • Annotation Tools
    eAI provides a versatile set of tools for marking up P&IDs:

    • Shapes and Lines: Draw lines, rectangles, circles, and arrows to highlight or connect elements.
    • Text Annotations: Add text labels to describe components or provide additional information.
    • Symbols: Use pre-loaded symbols for common P&ID elements (valves, pumps, pipes) to save time.
    • Notes: Attach notes to specific points on the diagram to add further context or instructions.

  • Data Enrichment
    Beyond visual annotations, eAI allows users to enrich elements with data:

    • Dimensional Data: Enter dimensions for pipes, distances, and areas to aid in material estimation.
    • Material Information: Specify material types, grades, or properties associated with annotated elements.
    • Cost Data: For cost estimation, assign per-piece or per-unit costs to items directly on the P&ID.
    • Custom Properties: Add any other relevant property to elements for specialized use cases.

  • Object Selection and Deletion
    eAI allows precise selection and deletion of annotations:

    • Selecting Objects: Click directly on an object to select it; hold Shift to select multiple objects.
    • Deleting Objects: Press the Delete key to remove selected objects.

• Data Export and Integration

  • Export Options
    After annotation, eAI allows users to export enriched P&IDs along with the associated data for further processing.

    • Image Export: Export the current view of an annotated P&ID as an image, suitable for review.
    • Data Export: Export annotation data in formats compatible with PlantFCE or other applications, aiding in workflows for cost estimation, procurement, and documentation.

  • Supported Formats

    • Image: Export the current view as PNG or JPEG for easy viewing and sharing.
    • CSV: Export enriched data in CSV for integration with spreadsheets, databases, and PlantFCE’s cost estimation tools.

4. Advanced Features

• Revision and Change Management

  • Version Tracking
    Version tracking allows users to maintain a record of changes, facilitating accuracy across project phases.

    • Creating Revisions: Each time a user saves or exports, eAI can prompt the user to save a version, maintaining a history of annotated versions.
    • Viewing Revision History: Access the history panel to view all saved versions, see timestamps, and compare differences.

  • Exporting Change Logs
    eAI can generate a detailed change log that records every annotation, update, and revision, providing an auditable record for compliance and documentation.

    • Creating a Change Log:
      1. Go to the Export section.
      2. Select Export Change Log to download a CSV or PDF file listing all updates by timestamp, user, and annotation type.

• Settings and Preferences

  • Customization Options
    eAI offers customization options to tailor the interface to user preferences:
    • UI Theme: The app respects your system theme (light or dark).
    • Annotation Colors: The annotation color can be set using the color picker in the toolbar.

5. User Guide

• Step-by-Step Tutorials

  • Basic Annotation Walkthrough
    This tutorial walks users through their first annotation on a sample P&ID, covering basic annotation tools.

    1. Open a sample P&ID file in eAI.
    2. Use the Line Tool to draw a line connecting two points.
    3. Select the Text Tool to add a label to an element (e.g., “Pressure Valve”).
    4. Properties can be added to shapes using the Properties panel in the Sidebar.
    5. Save the file to create your first annotated P&ID.

  • Using the Sidebar and Multi-Page PDFs
    Learn to navigate multi-page PDFs, using the sidebar to switch between pages.

    1. Import a multi-page PDF.
    2. View the list of pages in the Sidebar.
    3. Click any page thumbnail to load it into the canvas for annotation.
    4. Annotate each page as needed.

• Frequently Asked Questions (FAQ)

  • What file types does eAI support?
    eAI supports PDF file types, including multipage PDFs.

  • How do I export annotated files?
    Select File > Export menu to save your current view as an image or CSV for data integration.

6. Troubleshooting

• Common Issues

  • Import Errors
    • Symptom: A PDF file fails to import or displays an error message.
    • Solution: Ensure the file format is PDF and is not corrupted. For multipage PDFs, verify that each page meets file size requirements.

• Contact Support
  If troubleshooting steps do not resolve an issue, reach out to our support team via email: [email protected]

7. Terms of Service, Privacy Policy, and Licensing Agreement

• Terms of Service Refer to the Terms of Service at /tos/.

• Privacy Policy Refer to the Privacy Policy at /privacy/.

• Licensing Agreement Refer to the Licensing Agreement at /licensing/.

8. Appendices

• Glossary

  • P&ID (Piping and Instrumentation Diagram): A detailed diagram showing the layout of piping, instruments, and other elements in an industrial process.
  • MTO (Material Take-Off): A document listing materials required for a project, generated from P&ID annotations.
  • Revision Tracking: A feature that logs changes and updates to annotations, allowing users to manage project versions.
  • Export Formats: File types supported for export, including images (PNG, JPEG) and data files (CSV).

• Changelog
  The changelog keeps users updated on software improvements, bug fixes, and new features. Check it regularly to stay informed of recent changes.

  • Version 1.0: Initial release with basic annotation, data enrichment, export capabilities.