Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Asset Information Management

TABLE OF CONTENTS

Import Controller Tool

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedJul 31, 2025
  • 6 minute read

This section explains how to use the Import Controller.

Using the Import Controller you can:

  • Register Import Servers and databases.

  • Add Class Library structure and content to a database.

  • Create packages to import data.

  • Update the database with new data.

The Import Controller Console is a command-line version of the Import Controller. You can control the Import Server from scripts, such as:

  • Add, modify or delete Import Databases.

  • Add, modify or delete Import Packages.

  • Start data load process for Import Packages.

  • Start and return, or start and wait for completion.

For more information, see Use the Import Controller from the Command Line.

Registering the Import Server

To register the Import Server:

  1. Open Import Controller.

  2. Right-click Import Servers, select Register Import Servers….

  3. Either:

    • Select the Import Server that you want to use, and then select Add >>, or

    • In the Host box, type the server's hostname or IP address, and then select Add.

  4. Select OK.

    Note: The Import Controller broadcasts out on UDP port 7001, which the Import Server listens to, and the Import Server in turn sends responses back on UDP port 7002, which the Import Controller listens to. If the Import Controller is broadcasting service discovery, while using the UDP port 7001 for registering the Import Server, you must firewall this port to disable it.

Registering the AVEVA Asset Information Management Workhub Database

To register the AIM Workhub Database:

  1. Open Import Controller.

  2. Expand the Import Servers node.

  3. Right-click the server where the database is located.

  4. Select Register Database.

  5. For Name, type a unique name for the database.

  6. For Description, type a description of the database.

  7. For Server, type the name of the server where the database is located.

  8. For Provider, select SQL server.

  9. If you want to connect to the database using your Windows credentials:

    1. Select the Windows Authentication check box.

    2. Type the Database and Schema you want to use in the SQL server.

  10. If you do not want to use your Windows credentials to connect to the database:

    1. Clear the Windows Security check box.

    2. Type the User Account (username) and Account Password (password) of the SQL database.

  11. If Windows Authentication is not selected, and you want to use an encrypted password in the web.config file, select Show Encrypted Password.

    Note: If Windows Authentication is not selected, the database username and password are also used in the web.config file. By default, the password is unencrypted. For enhanced security, you can use an encrypted password by selecting Show Encrypted Password. After encrypting, you must copy and paste the encrypted password to the web.config file.

  12. Make sure SQL Server is selected.

  13. Leave Bootstrap Folder empty.

  14. Select OK.

    Bootstrap the AVEVA Asset Information Management Workhub Database

    Bootstrapping populates the database with Class Library information that is required before the rest of the data can be uploaded.

    See Change the Out-of-the-box Installation for more information and for details on how to create your own bootstrap files.

    To bootstrap the database:

    1. Open Import Controller.

    2. Expand Import Servers.

    3. Expand the server where the database is located.

    4. Expand the database - see the Registering the AVEVA Asset Information Management Workhub Database section. if the database has not already been registered.

    5. Right-click on BootStrap.

    6. Select Update.

      Bootstrapping is complete when the Status of the XML files changes to Existing.

      Creating an Import Package

      An Import Package stores the information required to import data from a Staging Area into the AIM Workhub database. See Import Data for more details.

      To add a Package to a database:

      1. Open Import Controller.

      2. Expand Import Servers.

      3. Expand the server where the database is located – if the server has not already been added, see Registering the Import Server section.

      4. Right-click on the database – if the database has not already been registered, see Registering the AVEVA Asset Information Management Workhub Database section.

      5. Select Create Package…

      6. Enter the package information (see the following table).

      7. Select OK.

        Add/Edit Import Database Parameters

        Field

        Type

        Package Name

        The name of the Package. This ID is stored in the database, so it is important to choose a unique ID that will not clash with any other identifiers in the database.

        Note: Take particular care to avoid a name clash with a Root Object ID.

        Dashboard Browse Root Details

        ID

        The ID of the Root Object for the AIM Dashboard Browse panel, under which all the information imported by this Package is located. During processing the Import Server also uses this ID as the Context ID for the information in this Package. It is possible to have several Import Packages contributing information to one Root Object, so this ID could appear in more than one Package.

        Class

        The class of the Root Object, typically something like PLANT or PROJECT. This must be a class in the AIM Workhub Class Library.

        Description

        Defines the tool-tip that is displayed for this Root Object in the Browse panel.

        3D Model drop folder

        You need to create the Drop Folder before running an update, use a single or separate Drop Folder for each package.

        Example C:\PopMeshData.

        The drop folder path can be on different machine (with read/write and modify access for dashboard server to that folder and this pathname must be explicitly visible with read/write permissions to the Import Server.)

        Example \\computer1\data\PopMData

        This path acts as a 3DVis OnPrem file server where the converted 3D models in Import Controller are stored as PopMesh files. These PopMesh files are then used for visualization within the AIM dashboard. It is important to ensure that the path remains accessible and that appropriate permissions are set for reading and writing files.

        Package Folders

        Staging Area

        The pathname of the folder containing the information to be imported by this Package. If the Staging Area is not on the computer where the Import Server is running, you will need to use a UNC or a mapped drive. Before files can be uploaded you must arrange the files in the Staging Area into a specific hierarchical order.

        Temporary Area

        You need to use a separate Temporary Area for each Package to avoid the risk of clashing filenames. You need to create this folder before running an update. If the Temporary Area is not on the computer where the Import Server is running, you will need to use a UNC or a mapped drive.

        Miscellaneous

        Callout Folder

        The pathname of a folder that the Import Server will search for user-defined plug-ins to be invoked during import processing. If you do not have any callout code, leave blank.

        Discard Previous Template

        Applies when the Import Server encounters an Import Template with the same name as one already imported.

        Select to delete the existing Template.

        Clear to retain the existing Template as a predecessor to the new Template.

        Check Classification

        Select to check whether the classes used when an object has multiple classifications are in the same Class Library.

        Allow Merging Objects

        Checked (default): If two objects have the same alias, then those two objects will be merged.

        Unchecked: If two objects have the same alias, the first will be identified by the alias, the second will raise a warning.

        Create Content Folders

        Select to create content folders.

        Allow Change Parent

        Select to allow existing classes to be moved in the Class Library.

        Force Change Parent

        Active when Allow Change Parent is selected. The change of parent will happen even if the class has existing instances.

        Allow Merging of Unknown Objects

        This option allows for tags and its aliases to be merged, even when they are unknown.

        If two unknown objects have the same alias, then they will be merged. Both of the objects will be identified by the alias.

        Error Control

        Use Default settings

        Select to use the default settings

        Clear to enter settings for Error Level and Max Errors manually.

        Error Level

        Select the least serious type of error that you want to cause an import to abort.

        Max Errors

        Enter the number of errors that are allowed before the import is aborted.

        TitleResults for “How to create a CRG?”Also Available in