Access to IMMS tools and features is controlled by User Permissions. All features may not be accessible by all Users. Contact your Instance Administrator regarding User Permissions.
Introduction
IMMS allows flexibility in representing a System’s complex topologies where various types of links and connections may exist between System Elements.
For each type of link, the Administrator may specify whether the link itself will be tracked as a System Element. When tracked as a System Element, the link/connection can be subject to various workflows. For example, a User could open an install or Issue Case against the link itself or schedule a Preventive Maintenance inspection of the link. That is useful for critical connections, such as power feeders, network trunks, etc.
Links and connections can be populated or updated via bulk-data entry using the IMMS Import feature. This document will serve as a guide for the bulk creation or bulk update of connections in IMMS.
Data File for Connections Creation
For the bulk creation of Links and Connections (“Connections”) in IMMS, the data to be imported must be contained in a properly formatted CSV file.
The following data columns (i.e., column headers) are required and must be populated for each line when creating Connections:
Logical Connections | Physical Connections |
---|---|
|
|
Optional Connections data columns may include:
From Termination ID
From Termination Status
Link Criticality
Link Description
Link Location Path
Link Status
To Termination ID
To Termination Status
Top Level From System
Top Level To System
Note: Optional data columns may also include one or more columns for Custom Field values, with the column header reflecting the appropriate Custom Field name.
Data File for Connections Update
For the bulk update of Connections in IMMS, the data to be imported must be contained in a properly formatted CSV file. The following data columns are required when updating Connections:
Logical Connections | Physical Connections |
---|---|
|
|
Optional Connections data columns may include:
Connection Type
From Termination ID
From Termination Status
Link Criticality
Link Description
Link ID
Link Location Path
Link Parent ID
Link Status
Link Type
To Termination ID
To Termination Status
Top Level From System
Top Level To System
Note: Optional data columns may also include one or more columns for Custom Field values, with the column header reflecting the appropriate Custom Field name.
When updating bulk records via the Import feature, Users typically start the process by exporting the applicable records from IMMS. See the Exporting Data for Update section for more information.
Importing Connections Data
Whether you are creating new Connections or updating existing Connections in IMMS, you will follow these steps for importing the bulk data.
Click on the Main Menu button at the top of the screen. From the Configuration Baseline section of the Main Menu, select “Links and Connections”. This will open the Links and Connections view.
Click on the button at the top of the view.
From the Import drop-down menu, select the “Connections” option. An “Import System Elements/Assets” form will pop up. From the Import System Elements/Assets form, you will:
- Use the Choose File button to select the properly formatted CSV file that you have prepared for your bulk data import.
- Select Contracts that the newly created Connections should be associated with.
- Select the existing Top Level System to which all imported Connections belong.
- Select the Base Location when creating new Connections. This is a single existing Location, selected from the Location lookup, that is shared by all new Connections
- Select the Default SE (Connection) Status.
- Set the Creation EffectiveTime for the Connections.
- Name the Import, entering a name that describes the Import action and purpose.
- Once all form fields are populated, click the OK button at the bottom of the form.
Importing Custom Field Files
Custom Fields associated with a System Element can support a number of different data types, such as text, numeric, date/time, image files, etc. Custom Field values that require a file upload can be populated via bulk-data entry using the Import-Files feature for System Elements.
Custom Field Files to Upload
First, create a single ZIP file that contains all the files you wish to upload. The ZIP file can contain folders and subfolders. IMMS will extract and process all files.
The ZIP file may also contain a mapping file. A mapping file is a CSV file that includes instruction for the files being uploaded. If you are using a mapping file, the file should be named “Import File List.csv”. The mapping file will include three data columns and a line entry for each file being uploaded. The column headers include:
- SE ID – field value will be the System Element name
- CF ID – field value will be the Custom Field name
- File – field value will be the file name, including extension (e.g., "Camera3.jpg"). Note: If your ZIP file contains directories, the file name would be the file path ("CCTV/HDcameras/Camera3.jpg")
Note: The zipped Custom Field(s) file must have the Import File List.cvs file in its root folder. To create ZIP file do not compress folder containing Import File List.cvs file. Instead, select the Import File List.cvs file and applicable files/folders and compress them.
Importing Custom Field Files
From the Links and Connections view, click on the button at the top of the page. Select “Files” from the drop-down menu.
This will open the Import Files form. From this form, you will:
- Choose the ZIP file which includes all Custom Field files to be imported.
- Select the Top Level System for the System Elements being updated. All System Elements included in the import must belong to the same Top-Level System. If you wish to update System Elements under multiple Top-Level Systems, you must perform a separate Import for each.
- Indicate the Custom Field to be updated or check the “Use mapping file instead” box if your ZIP file contains a mapping file for the files being imported.
- Select an Update behavior that is appropriate for your file import:
- Append to existing files
- Replace existing files
- Skip if there are existing files
- Enter an Update comment, which is text that describes your file import.
- Utilize Advanced Settings if you wish for IMMS to apply certain file name rules when processing the imported files:
- Skip prefix in file name
- Skip suffix in file name
- Add prefix to file name
- Add suffix to file name
- Once all form fields are populated, click the OK button at the bottom of the form.
Data File Exceptions and Successful Import
If there are any errors in the Import data file, IMMS will alert you of these exceptions and reject the entire Import. That is, IMMS will not partially process an Import.
All exceptions must be corrected in the data file before it can be imported. Correct exceptions in all specified line items and then repeat the Import steps listed above.
If IMMS identifies no exceptions within the data file, your bulk data will be successfully imported, and IMMS will return you to the view where you initiated your Import. The view should then include your new or updated records. The Import will also be listed in the Successfully Completed Imports list accessible via the "Show Completed" option under the Import button drop-down menu.