Topic outline

• Node.js QuickStart

  Node.js QuickStart

  Content Type
  Exercise

  Duration
  5m

  Level
  Introductory

  Node.js is one of the most commonly used programming languages due to its strong performance and scalability.

  The InterSystems IRIS® data platform Native API for Node.js lets your application directly access the underlying data structure within InterSystems IRIS (known as globals) as well as call InterSystems ObjectScript methods and routines.

  To review ways to connect your application to InterSystems IRIS, watch the video. Then follow the exercise below to practice using Node.js to connect to InterSystems IRIS.

  Note: Node.js is only available on InterSystems IRIS versions 2019.2 and later.

  Learning Objectives

  • Explain how the InterSystems IRIS Native API for Node.js enables direct data access and method execution.
  • Store data in a custom structure with the Native API.
  • Connect a Node.js application to InterSystems IRIS using the Native API.
  • Call InterSystems IRIS methods from Node.js.

  
  

  Prerequisites

  • Basic knowledge of node.js

  
  
  

  Watch the video and try the exercise below!

  • Mark me "complete" for this exercise.

    Not available unless: Your ID number is not empty
• Start the Exercise

  Start the Exercise
  • Launch Your Lab

    Use the online lab provided to complete this exercise.

    
    

  • You must be logged in to launch an InterSystems IRIS instance.

    • Log in with your existing account.
    • Don't have an InterSystems account? Create a new account.
  • Note:

    If you prefer to run the sample code on your own system instead of using the provided lab, visit github repository quickstarts-nodejs. Once you have deployed the code on your system, return here to follow along with the tasks. You will need to adjust some steps according to your system.
  • View the code

    1. Open Visual Studio Code using the icon on the desktop.
    2. Open connections.config within the quickstarts-nodejs folder.
       Note that the IP, port, username, and password are set to the values for the InterSystems IRIS instance in your lab. The information in this file will be used to create connections to InterSystems IRIS from the Node.js files.

    Several Node.js classes are in the quickstarts-nodejs folder that use the Native API. You will run one of these classes in the next task.

  • Use the Native API to store to a custom structure and call InterSystems IRIS methods or routines

    1. Open nodeplaystockTask5.js to view the Native API code.
       Notice the connection string uses these variables to connect: Begin code.

       const connection = irisnative.createConnection({host: ip, port: port, ns: namespace, user: username, pwd: password})

       End code.
    2. Using the Terminal menu in VS Code, select New Terminal and run the following command:

       cd quickstarts-nodejs

    3. Run nodeplaystockTask5.js.
       This code stores stock data in a custom data structure.
    4. Use the command node nodeplaystocksTask5.js to run this file.
       Notice there are multiple options. Enter a number and press Enter to run an option.
       • Option 2: Store the stock data in a custom structure.
       • Option 3: Retrieve and view the stock data from this custom structure.
       • Option 4: Call population methods within InterSystems IRIS to generate better information for trades.
       • Option 6: Quit

    With the Native API, you can efficiently store data in your own custom data structure. Additionally, you can call class methods and routines from within InterSystems IRIS using the Native API.

• What's Next?

  What's Next?
  • Connect your Node.js applications to InterSystems products (learning path, 1h).
  • Learn about using the InterSystems IRIS Native SDK for Node.js (documentation, 30m).
    

  • Share Your Feedback!