IMS version 21.9
IMS Basics - User Guide
Introduction
Used with Training
Information Grid
Navigating the GUI
Naming Conventions
Main Objects and Features
Customer
Searching for a Customer
Create a New Customer
Customer Form Tabs
Customer Actions Button Bar
Customer Contact
Create a New Customer Contact
Contact Actions Button Bar
Relate a Contact or Customer
Site (Location)
Searching for a Site
Site Actions Button Bar
Create a New Site
Update Coordinates of the New Site
Moving the Site’s location in GeoMap
Create New Site as Sublocation
Country
City
Create a New City
Province (State, Region)
District
Site Template
Site Tips
Order/TT
Order Form Layout
Search for an Order
Relate Orders
Order Actions Button Bar
Create a New Order
Email Notification with Reports
Node
Search for a Node
Node Details
Equipment Actions Button Bar
Graphical Layout Area
Node Information Area
Creating a new Node
Adding Cards
Updating Card Status
Updating Node Status
Node - Tips
DDF/ODF, Patch Pannel, Splice Box
Searching for a DDF/ODF
DDF/ODF details
DDF/ODF Actions – button bar
Creating a DDF/ODF, Patch Panel, or Splice Box
Connect DDF/ODF to Equipment Port
DDF/ODF Definition
Rack
Searching for a Rack
Rack Actions – button bar
Create a New Rack
Add Equipment to a Rack
Floorplan
Searching for a Floorplan
Floorplan Actions – button bar
Create and Design a Floorplan
Network Map 1
Searching for a Network Map
Network Map Actions Button Bar
KMZ and KML
Network Map Feature Bar
Creating a Network Map
Templates – Site, Node, DDF/ODF
Searching for a Site Template
Site Template Form Actions button bar
Creating a Site Template
Relating a Node Template
Relating a DDF/ODF Template
Node Template
Searching for an existing Node Template
Create a Node Template
Add cards to a Node template
Network Map 2
Creating a new Location using the Network Map
Showing and hiding Network Map objects
Network Map - Geo Routing Connections
Circuit
Search for a Circuit
Circuit form information
Circuit Actions – button bar
Bi and Uni Directional Circuits
Bi-Directional Circuits – examples and information
Uni-Directional Circuits – examples and information
Adding a Uni Dir Circuit To Tx / Rx ports
Combining Uni and Bi Directional Circuits – examples and information
Creating a New Circuit
Manually adding Ports to an existing Circuit
Updating a Connection’s Status
Migrate a Circuit
Disconnect a Circuit in Planned Status
OLO Circuit
Search for an OLO
OLO Circuit Actions Button Bar
Creating a New OLO Circuit
Connect an OLO Circuit to a Circuit
Connect an OLO Circuit to A and Z sides
Bulk Loader
Accessing the BulkLoader Feature
Bulk Loader Example File
Required Fields Summary
Exercise 1 - Add Customer Data
Exercise 2 - Update IP Data
Bulkloading - Circuit - Add and Remove Ports
Contract
Finance & Revenue
IP Management
A brief introduction to Subnetting – IPv4
Accessing IP Management
IP Ranges
Accessing IP Ranges
IP Range Form Overview
IP Range Button Bar
Create a New IP Range
Create a Sub Range
Edit a Sub Range
Merge Sub Ranges
Delete a Sub Range
Assign an IP Address
IP Number Reservation
Add or Update IP data with the Bulk Loader
Planned Work & Impact Analysis
Planned Works
Planned Work Form
Planned Work Category
Planned Works Button Bar
Inform Customers
Inform Customers Form
Inform Customers Button Bar
Email Setup
Email Setup Form
Email Setup Button bar
Creating a New Planned Work
Products (Product Codes)
Telephone Number Management (TNM)
Access TNM
Tel. Number Ranges: USA & Canada
Create a new Telephone Number Range (USA&CAN)
Tel. Number Ranges: Standard
Telephone Number Range Type
Tel. Number Range Form Actions
Using Telephone Numbers
Bulk Loading Telephone Number Details
Accessing Bulk Loader
Bulk Loading TNM – Generate and Upload Template
Sub Node
Section 1 - Equipment Definitions
Section 2 - Associate Equipment Definitions
Section 3 - Associating Sub Nodes
Section 4 - Relating Nodes and Sub Nodes to Circuits
Section 5 - Summary
Key Words and Descriptions
Reconcile
1. Types of Interfaces
2. Network Reconciliation and Auto Discovery
3. IMS Reconcile Form
Equipment
Upper Tab pages
Nodes Tabs - Causes and Solutions
Shelves Tabs - Causes and Solutions
Cards Tabs - Causes and Solutions
Lower Tab pages - Details of a Selected Record
Circuits
Upper Tab pages
Circuit tabs - Causes and Solutions
Lower Tab pages - Causes and Solutions
Ports
Sites
DDF / ODF
Equipment Definitions
Reporting
Introduction
User Group Permission Settings
GUI Navigation
Getting Started
Example 1 - Creating a Document Report
Example 2 - Creating a Complex Document Report
Example 3 - Dashboard Report: Pivot and Pie Chart
Example 4 - Dashboard Report: Grid of Circuits
Example 5 - Dashboard Report: Stacked Bar Chart
Rings
Vendor
Warehouse
Warehouse Module Descriptions
Stock
Purchase Orders
Investment Number
Invoice
Material Type and Material Template
Cable Types
Material Bin
Test Equipment
Warehouse Processes
Getting Material Into Stock
Materials Leaving Stock
Defective Material
Selling / Disposing of Material
Cable Stock Handling
Different Stock Locations
IMS Admin - User Guide
User Access Control
Users
Searching for an existing User
User Forms Action Button Bar
User Form tabs
User Groups
Account Policy
Accessing the Accounts Policy Feature
User Account - Tips
Order / TT
Accessing the Order / TT feature
Order Form
Order Information Tabs
Order Type and Search
Order Type Form Description
Order Task Tab
WG Graphical Tab
Order Extra Fields
Create a new Order Type and Workflow
Creating New Order Tasks
Adding Order Task Dependencies
WF Graphical tab
The Order Task process flow
Equipment Definition - (Types)
Equipment Data Model
Opening the Equipment Definition feature
Searching for an Equipment Definition
Equipment Definition Actions Button Bar
Equipment Definition Form Information
Creating a New Equipment Definition
Cards and Ports
Opening the Card Definition or Card Code Definition
Search for a Card Definition or Card Code Definition
Card Definition Form
Create a Card Definition
Card Code Definition Form
Create a Card Code Definition
View Card Code Relations
Port and Internal Port Templates
Adding Ports to a Card Code Definition
Adding Internal Ports to a Card Code Definition
Add a Card Code Definition to a Card Definition
Add Sub Slots to a Card Definition or Card Code Definition
Adding a Card Definition to the Subslot
Create New Card per Slot Rule
Extra Fields
Accessing the Extrafields group feature
Extra Fields Group - GUI sections explained
Extrafields Group Actions Button Bar
Extrafield Group Details Area
Extra Fields Tab
SQL Check
ValueFromSql
Create a New Extra Field Group
Tips and Tricks with Extra Fields
External Validations
Speed and Layering
Speed Form Details
Used Sub Capacity
ShowSubCircuitMenu & ShowCircuitAddNewMenu
Validations
Circuit Type Option
Layer Rule
Layer Rule Examples
Accessing New Channel Alias
Channel Alias
Alarms
Combo Boxes
Management System
REST API
GET Commands
PUT Commands
POST Commands
DELETE Commands
Postman examples IMS REST API
SQL Form
Example Tab Queries
IMS version 22.6 & 22.9
IMS Basics - User Guide 22.6 & 22.9
Introduction
Used with Training
Information Grid and Tabs
Navigating the GUI
Naming Conventions
Miscellaneous Information
Main Objects and Features
Customer
Searching for a Customer
Create a New Customer
Customer Form Tabs
Customer Actions Button Bar
Customer Contact
Create a New Customer Contact
Contact Actions Button Bar
Relate a Contact or Customer
Site (Location)
Searching for a Site
Site Actions Button Bar
Create a New Site
Update Coordinates of the New Site
Moving the Site’s location in GeoMap
Create New Site as Sublocation
Country
City
Create a New City (2)
Province (State, Region)
District
Site Template
Site Tips
Order/TT
Order/TT
Access Order/TT
Order Form Layout
Search for an Order
Relate Order to other Orders
Relate Order to other Objects
Order Actions Button Bar
Create a New Order
Calendars and Tasks
Order Type
Access an Order Type
Search for an Order Type
Order Type Form Description
Order Tasks Tab Description
WF Graphical Tab
Order Extra Fields
Create a new Order Type and Workflow
Creating New Order Tasks
Adding Order Task Dependencies
Order Task process flow
Queue
Access Queue
Queue Form Layout
Queue Form Action Button Bar
Add User To Planner
Planning
Order Email Notification with Reports
Node
Search for a Node
Node Details
Equipment Actions Button Bar
Graphical Layout Area
Node Information Area
Creating a new Node
Adding Cards
Updating Card Status
Updating Node Status
Node - Tips
Sub Node
Section 1 - Equipment Definitions
Section 2 - Associate Equipment Definitions
Section 3 - Associating Sub Nodes
Section 4 - Relating Nodes and Sub Nodes to Circuits
Section 5 - Summary
Key Words and Descriptions
DDF/ODF, Patch Panel, Splice Box
Searching for a DDF/ODF
DDF/ODF details
DDF/ODF Actions – button bar
Creating a DDF/ODF, Patch Panel, or Splice Box
Connect DDF/ODF to Equipment Port
DDF/ODF Definition
Rack
Searching for a Rack
Rack Actions – button bar
Create a New Rack
Add Equipment to a Rack
Rack Frames
Floorplan
Searching for a Floorplan
Floorplan Actions – button bar
Create and Design a Floorplan
Floorplan Tips
Network Map 1
Access and Search Network Maps
Network Map Actions Button Bar
KMZ and KML
Network Map Feature Bar
Creating a Network Map
Node and DDF/ODF popups on Network Map
Polygon
Shapefile
Uploading Shapefiles
Shapefile Setup
Shapefile Import Setup
Shapefile Export Setup
Smart Comments
Splicing Diagram Layer
Network Map - Tips
Templates – Site, Node, DDF/ODF
Searching for a Site Template
Site Template Form Actions button bar
Creating a Site Template
Relating a Node Template
Relating a DDF/ODF Template
Node Template
Searching for an existing Node Template
Create a Node Template
Add cards to a Node template
Network Map 2
Creating a new Location using the Network Map
Showing and hiding Network Map objects
Geo Routing, Fiber Networks, and Outside Plant
Cable Entry Point
Manhole / Handhole
Transition Points
Poles
Circuit Line Following Geo Contours
Trenches
Ducts
Cables
Create Cables using the Cable Connect feature
Highlighting a Fiber Route
Cable Slack
Spliceboxes - Splice and Nosplice
Add an additional Splicebox or Nosplice to a Site
Creating and Dsiconnecting Splices
Open a Splicing Diagram
Icon Clusters
Circuit
Search for a Circuit
Circuit form information
Circuit Actions – button bar
Bi and Uni Directional Circuits
Bi-Directional Circuits – examples and information (2)
Uni-Directional Circuits – examples and information (2)
Adding a Uni Dir Circuit To Tx / Rx ports (2)
Combining Uni and Bi Directional Circuits – examples and information (2)
Creating a New Circuit
Manually adding Ports to an existing Circuit
Updating a Connection’s Status
Migrate a Circuit
Disconnect a Circuit in Planned Status
Circuit Tips
OLO Circuit
Search for an OLO
OLO Circuit Actions Button Bar
Creating a New OLO Circuit
Connect an OLO Circuit to a Circuit
Connect an OLO Circuit to A and Z sides
Bulk Actions
Bulk Loader
Accessing the Bulk Loader Feature
Bulk Loader Example File
Required Fields Summary
Bulkloading - Circuit - Add and Remove Ports
Dynamic Bulk Loader
Bulk Searcher
Contract
Finance & Revenue
IP Management
A brief introduction to Subnetting – IPv4
Accessing IP Management
IP Ranges
Accessing IP Ranges
IP Range Form Overview
IP Range Button Bar
Create a New IP Range
Create a Sub Range
Edit a Sub Range
Merge Sub Ranges
Delete a Sub Range
Assign an IP Address
IP Number Reservation
Add or Update IP data with the Bulk Loader
Planned Work & Impact Analysis
Planned Works
Planned Work Form
Planned Work Category
Planned Works Button Bar
Inform Customers
Inform Customers Form
Inform Customers Button Bar
Email Setup
Email Setup Form
Email Setup Button bar
Creating a New Planned Work
Products (Product Codes)
Telephone Number Management (TNM)
Access TNM
Tel. Number Ranges: USA & Canada
Create a new Telephone Number Range (USA&CAN)
Tel. Number Ranges: Standard (2)
Create a new Telephone Number Range (Standard)
Telephone Number Range Type - TNRT
Tel. Number Range Form Actions (2)
Using Telephone Numbers (2)
Bulk Loading Telephone Number Details (2)
Accessing Bulk Loader (2)
Bulk Loading TNM – Generate and Upload Template (2)
Reconcile
Types of Interfaces
Network Reconciliation and Auto Discovery
IMS Reconcile Form
Equipment
Upper Tab pages (2)
Nodes Tabs - Causes and Solutions (2)
Shelves Tabs - Causes and Solutions (2)
Cards Tabs - Causes and Solutions (2)
Lower Tab pages - Details of a Selected Record (2)
Circuits
Upper Tab pages (2)
Circuit tabs - Causes and Solutions (2)
Lower Tab pages - Causes and Solutions (2)
Ports
Sites
DDF / ODF
Equipment Definitions
Customers
Reporting
Introduction
User Group Permission Settings
GUI Navigation
Getting Started
Example 1 - Creating a Document Report
Example 2 - Creating a Complex Document Report
Example 3 - Dashboard Report: Pivot and Pie Chart
Example 4 - Dashboard Report: Grid of Circuits
Example 5 - Dashboard Report: Stacked Bar Chart
Reporting - Tips
Rings
Scheduler
Bulk Load Scheduling
Vendor
Warehouse
Warehouse Module Descriptions
Stock
Purchase Orders
Investment Number
Invoice
Material Type and Material Template
Cable Types
Material Bin
Test Equipment
Warehouse Processes
Getting Material Into Stock
Materials Leaving Stock
Defective Material
Selling / Disposing of Material
Cable Stock Handling
Different Stock Locations
IMS Admin - User Guide 22.6 & 22.9
Customize Datalayouts
User Access Control
Users
Searching for an existing User
User Forms Action Button Bar
User Form tabs
User Groups
Account Policy
IAM & 2FA
User Account - Tips
Equipment Definition - (Types)
Equipment Data Model
Opening the Equipment Definition feature
Searching for an Equipment Definition
Equipment Definition Actions Button Bar
Equipment Definition Form Information
Creating a New Equipment Definition
Butterfly View
Cards and Ports (2)
Opening the Card Definition or Card Code Definition
Search for a Card Definition or Card Code Definition
Card Definition Form
Create a Card Definition
Card Code Definition Form
Create a Card Code Definition (2)
View Card Code Relations (2)
Port and Internal Port Templates
Adding Ports to a Card Code Definition
Adding Internal Ports to a Card Code Definition
Add a Card Code Definition to a Card Definition
Add Sub Slots to a Card Definition or Card Code Definition
Adding a Card Definition to the Subslot
Create New Card per Slot Rule
Extra Fields
Accessing the Extrafields group feature
Extra Fields Group - GUI sections explained
Extrafields Group Actions Button Bar
Extrafield Group Details Area
Extra Fields Tab
SQL Check
ValueFromSql
Create a New Extra Field Group
Tips - Extra Fields
Combobox Data
External Validations
Example 01 - External Validation - Customer
Example 02 - External Validation - Customer
Speed and Layering
Speed Form Details
Used Sub Capacity
ShowSubCircuitMenu & ShowCircuitAddNewMenu
Validations
Circuit Type Option
Layer Rule
Layer Rule Examples
Accessing New Channel Alias
Channel Alias
Alarms
Management System
IMS version 23.1
IMS Basics - User Guide 23.
Introduction
Used with Training
Information Grid and Tabs
Navigating the GUI
Naming Conventions
Miscellaneous Information
Main Objects and Features
Customer
Searching for a Customer
Create a New Customer
Customer Form Tabs
Customer Actions Button Bar
Customer Contact
Create a New Customer Contact
Contact Actions Button Bar
Relate a Contact or Customer
Site (Location)
Searching for a Site
Site Actions Button Bar
Create a New Site
Update Coordinates of the New Site
Moving the Site’s location in GeoMap
Create New Site as Sublocation
Country
City
Create a New City
Province/State
District
Site Template
Site Tips
Order/TT
Order/TT
Access Order/TT
Order Form Layout
Search for an Order
Relate Order to other Orders
Relate Order to other Objects
Order Actions Button Bar
Create a New Order
Calendars and Tasks
Order Type
Access an Order Type
Search for an Order Type
Order Type Form Description
Order Tasks Tab Description
WF Graphical Tab
Order Extra Fields
Create a new Order Type and Workflow
Creating New Order Tasks
Adding Order Task Dependencies
Order Task process flow
Queue
Access Queue
Queue Form Layout
Queue Form Action Button Bar
Add User To Planner
Planning
Order Email Notification with Reports
Node
Search for a Node
Node Details
Equipment Actions Button Bar
Graphical Layout Area
Node Information Area
Creating a new Node
Adding Cards
Updating Card Status
Updating Node Status
Node - Tips
Sub Node
Section 1 - Equipment Definitions
Section 2 - Associate Equipment Definitions
Section 3 - Associating Sub Nodes
Section 4 - Relating Nodes and Sub Nodes to Circuits
Section 5 - Summary
Key Words and Descriptions
DDF/ODF, Patch Panel, Splice Box
Searching for a DDF/ODF
DDF/ODF details
DDF/ODF Actions – button bar
Creating a DDF/ODF, Patch Panel, or Splice Box
Connect DDF/ODF to Equipment Port
DDF/ODF Definition
Rack
Searching for a Rack
Rack Actions – button bar
Create a New Rack
Add Equipment to a Rack
Rack Frames
Floorplan
Searching for a Floorplan
Floorplan Actions – button bar
Create and Design a Floorplan
Floorplan Tips
Network Map 1
Access and Search Network Maps
Network Map Actions Button Bar
KMZ / KML
Export to KML or KMZ
Import from KML/KMZ Geo Points
Upload [and Deploy] KML/KMZ
Creating a Network Map
Node and DDF/ODF popups on Network Map
Multiple Tile Layered Map
Polygon
Accessing and Creating a Polygon
Opening a polygon
View and Edit Polygons and Polygon Types
Shapefile
Uploading Shapefiles
Shapefile Setup
Shapefile Import Setup
Shapefile Export Setup
Smart Comments
Splicing Diagram Layer
Network Map - Tips
Templates – Site, Node, DDF/ODF
Searching for a Site Template
Site Template Form Actions Button
Creating a Site Template
Relating a Node Template
Relating a DDF/ODF Template
Node Template
Searching for an existing Node Template
Create a Node Template
Add cards to a Node template
Network Map 2
Creating a new Location using the Network Map
Showing and hiding Network Map objects
Geo Routing, Fiber Networks, and Outside Plant
Cable Entry Point
Manhole / Handhole
Transition Points
Poles
Circuit Line Following Geo Contours
Trenches
Ducts
Cables
Create Cables using the Cable Connect feature
Highlighting a Fiber Route
Cable Slack
Spliceboxes - Splice and Nosplice
Add an additional Splicebox or Nosplice to a Site
Creating and Dsiconnecting Splices
Open a Splicing Diagram
Icon Clusters
Circuit
Search for a Circuit
Circuit form information
Circuit Actions – button bar
Bi and Uni Directional Circuits
Bi-Directional Circuits – examples and information
Uni-Directional Circuits – examples and information
Adding a Uni Dir Circuit To Tx / Rx ports
Combining Uni and Bi Directional Circuits – examples and information
Creating a New Circuit
Manually adding Ports to an existing Circuit
Updating a Connection’s Status
Migrate a Circuit
Disconnect a Circuit in Planned Status
Circuit Tips
OLO Circuit
Search for an OLO
OLO Circuit Actions Button Bar
Creating a New OLO Circuit
Connect an OLO Circuit to a Circuit
Connect an OLO Circuit to A and Z sides
Alarms
Bulk Actions
Bulk Loader
Accessing the Bulk Loader Feature
Bulk Loader Example File
Required Fields Summary
Bulkloading - Circuit - Add and Remove Ports
Dynamic Bulk Loader
Bulk Searcher
Contract
Finance & Revenue
IP Management
A brief introduction to Subnetting – IPv4
Accessing IP Management
IP Ranges
Accessing IP Ranges
IP Range Form Overview
IP Range Button Bar
Create a New IP Range
Create a Sub Range
Edit a Sub Range
Merge Sub Ranges
Delete a Sub Range
Assign an IP Address
Relate IP Range to an Order/TT
Relate IP Number to an Order/TT
IP Number Reservation
Add or Update IP data with the Bulk Loader
Planned Work & Impact Analysis
Planned Works
Planned Work Form
Planned Work Category
Planned Works Button Bar
Inform Customers
Inform Customers Form
Inform Customers Button Bar
Email Setup
Email Setup Form
Email Setup Button bar
Creating a New Planned Work
Products (Product Codes)
Reconcile
Types of Interfaces
Network Reconciliation and Auto Discovery
IMS Reconcile Form
Equipment
Upper Tab pages
Nodes Tabs - Causes and Solutions
Shelves Tabs - Causes and Solutions
Lower Tab pages - Details of a Selected Record
Circuits
Upper Tab pages
Circuit tabs - Causes and Solutions
Lower Tab pages - Causes and Solutions
Ports
Sites
DDF / ODF
Equipment Definitions
Customers
Reporting
Introduction
User Group Permission Settings
GUI Navigation
Getting Started
Example 1 - Creating a Document Report
Example 2 - Creating a Complex Document Report
Example 3 - Dashboard Report: Pivot and Pie Chart
Example 4 - Dashboard Report: Grid of Circuits
Example 5 - Dashboard Report: Stacked Bar Chart
Reporting - Tips
Rings
Scheduler
Bulk Load Scheduling
Telephone Number Management (TNM)
Access TNM
Telephone Number Range - TNR
Telephone Number Range Type - TNRT
LATA
Rate Center
Market
Operator Company Number
Create a TNR : USA & Canada
Create a TNR : Standard
Using Telephone Numbers
Bulk Loading Telephone Number Details
Accessing Bulk Loader
Bulk Loading TNM – Generate and Upload Template
Vendor
Warehouse
Warehouse Module Descriptions
Stock
Purchase Orders
Investment Number
Invoice
Material Type and Material Template
Cable Types
Material Bin
Test Equipment
Warehouse Processes
Getting Material Into Stock
Materials Leaving Stock
Defective Material
Selling / Disposing of Material
Cable Stock Handling
Different Stock Locations
IMS Admin - User Guide 23.
System
Customize Datalayouts
Users
Search for a User
User Forms Action Button Bar
User Form
Create a new User Account
User Groups
Account Policy
User Settings
GET_OCN_VENDOR_TYPES
SHOW_(APP and DB)_SERVER_TIME
SITEVALIDATOR_ZIPCODE_VALIDATION
STOCKITEM_BOOKOUT_SITE_REQUIRED
WEB_INACTIVITY_TIMEOUT
User Account - Tips
IAM & 2FA
Equipment Definition - (Types)
Equipment Data Model
Opening the Equipment Definition feature
Searching for an Equipment Definition
Equipment Definition Actions Button Bar
Equipment Definition Form Information
Creating a New Equipment Definition
Butterfly View
Cards and Ports
Opening the Card Definition or Card Code Definition
Search for a Card Definition or Card Code Definition
Card Definition Form
Create a Card Definition
Card Code Definition Form
Create a Card Code Definition
View Card Code Relations
Port and Internal Port Templates
Adding Ports to a Card Code Definition
Adding Internal Ports to a Card Code Definition
Add a Card Code Definition to a Card Definition
Add Sub Slots to a Card Definition or Card Code Definition
Adding a Card Definition to the Subslot
Create New Card per Slot Rule
Scale Slot Definitions - Resize feature
Extrafield Group
Accessing Extrafield Group
Extrafield Group sections
Extrafields Group Actions Button Bar
Extrafield Group Details Area
Extrafields Tab
Create a new Extra Field Group
Create New Extra Fields
Tips - Extrafields
Combobox Data
External Validations
Example 01 - External Validation - Customer
Example 02 - External Validation - Customer
Speed and Layering
Speed Form Details
Used Sub Capacity
ShowSubCircuitMenu & ShowCircuitAddNewMenu
Validations
Circuit Type Option
Layer Rule
Layer Rule Examples
Accessing New Channel Alias
Channel Alias
Management System