Skip to main content

Itential Product Essentials

This course teaches learners how to build Itential Automation Platform (IAP) products. IAP products are software programs that are built on top of IAP for adding new business logic and extending IAP's capabilities.

Enrollment in this course is by invitation only
  • Course Number

  • Classes Start

  • Classes End

About This Course

Estimated course duration: four to six hours.

You must successfully complete IAP101 Introduction to the Itential Automation Platform before you begin this course. IAP101 is the starting point for all Itential Academy training. It describes how to use the Itential Academy online training environment, introduces Itential, and introduces the Itential Automation Platform.

Welcome to IDEV110, Itential Product Essentials, part of the Itential Developer series of courses for software developers building applications and features on the Itential Automation Platform (IAP). This course teaches the basic essentials to build an IAP product. IAP products extend the platform's capabilities to meet customers' unique business requirements.

Every learner completes labs on individual IAP instances. Tiered labs begin by building a simple Node.js program and incrementally evolving the program into an IAP product. Course labs use a Git repository for code persistennce. Learners are introduced to the Node.js package management system, JSDoc for documenting APIs, JavaScript/Node.js asynchronous programming, callback functions, and specific requirements every IAP product must satisfy.

Labs are designed to be completed in sequence, include full testing, and demonstrate good programming design patterns.

Attendees Will Learn

  • The Itential Automation Platform's origins, architecture, primary components, and layered design.
  • The purpose of IAP products, brokers, and adapters.
  • How to write a product on the Itential Automation Platform (IAP).
  • How to link and load an IAP package.
  • How IAP discovers new, modified IAP packages.
  • How to:
    identify installed IAP brokers
    learn their purpose
    execute their APIs
  • How to:
    identify installed IAP adapters
    learn their purpose
    execute their APIs
  • How and where to build server-side business logic and expose via APIs.

Course lectures begin with foundational concepts and incrementally add topics for a broader understanding. Learners will test their understandings through quizzes.

Learners will build a simple IAP product to process IP addresses.

Course Outline

Welcome (Average time 15 minutes)

Course Learning Objectives
Syllabus and Grading
Course Timing
Course Progress and Completion
Discussion Guidelines
Learning Aids
Meet Your Instructor
Copyright and Trademark Notices

Chapter 1: Platform Logic Division (15 min)

Business Logic Division
Adapter Logic
Broker Logic
Product Logic
General Logic Placement

Chapter 2: Itential Product Packages (15 min)

Product's Purpose
IAP Product Requirements
IAP Product Recommendations

Chapter 3: npm (30 min)

Node.js Packages
npm and Scope
Semantic Versioning
The npm Command

Chapter 4: JSDoc (15 min)

Documenting with JSDoc
Recommended Documentation
JSDoc Optimizations

Chapter 5: Node.js Modules (90 min)

Modular Programming
Importing Modules
ip-cidr Public npm Module
Lab 1: Get Gateway IP
Private Functions
Lab 2: Private Function
Node.js Module System
Lab 3: Private Function Module

Chapter 6: Node.js Callbacks (15 min)

Synchronous Programming
Asynchronous Programming
Callback Functions
IAP Callbacks

Chapter 7: IAP Packages (75 min)

IAP Product Characteristics
File package.json
File pronghorn.json
JSON Schema
IAP Products Export an Object
Linking Projects into IAP
Package Discovery and Change Detection
Lab 4: IAP Product
Lab Exam

Chapter 8: IAP APIs (30 min)

Three IAP APIs
HTTP Overview
Internal API Flows
External API Flows
Task APIs
External Systems
IAP Brokers
Learning IAP's APIs

Chapter 9: Managing Runtime Problems (15 min)

Why Manage Runtime Problems?
Node.js Runtime Problems
HTTP Runtime Problems
Job Tasks and Runtime Problems


  • Learners are software developers
  • Experience with Node.js (JavaScript)

New to Node.js?

NodeSchool offers free workshops for learning JavaScript and Node.js. You might also try TutorialsTeacher, JavaScript is Sexy, w3schools, and Mozilla Web Docs.

Udemy, Coursera, Lynda, Udacity and other eLearning providers also offer Node.js training courses.

JSDoc is an API documentation generator for JavaScript and beneficial for documenting Node.js functions and methods.

Course Staff

Course Staff Image #1

Andrew Austin

Andrew has 20 years experience working in network engineering and systems administration. He is experienced designing, building, troubleshooting, and managing IP/MPLS networks.

Frequently Asked Questions

How can I access this course?

Open a ticket and request access using the service desk widget ( service desk widget icon ) in the page footer.

Click the widget to open a Help modal. For the summary, type "Request Access". Include the course in the description. Type your contact email, and click Send.

What web browser should I use?

The Open edX and Itential platforms work best with current versions of Chrome, Firefox, Internet Explorer version 11 and above, and Edge.

See the Open edX list of supported browsers for the most up-to-date information.

Do I need to install any software?

No software needs to be installed before course enrollment.

What is the lab environment?

Each learner will work in a container running IAP. All container access will be though browsers over secure connections.

Will there be an integrated development environment (IDE) in coding labs?

Learners will use a web-based IDE running on their container to write Node.js programs.