AngularJS

PI Web API AngularJS Sample

Version: 1.0.1

The sample code in this folder demonstrates how to utilize the PI Web API in AngularJS. You must have already downloaded AngularJS to run this sample application.

WARNING: The web server used in this sample is intended for use in testing or debugging sample applications locally. It has not been reviewed for security issues.

Prerequisites

• This application by default will use Port 8000

Note: This application is hosted on HTTP.  This is not secure.  You should use a certificate and HTTPS.

Getting Started

To run the sample code:

• Clone the GitHub repository
• Open the AngularJS folder with your IDE
• Install the required modules by running the following command in the terminal: npm ci
• Run the application using the following command in the terminal: npm start
• By default, you can open the AngularJS app by using the following URL in a browser: localhost:8000

Getting Started with Tests

To run the sample tests:

• Open the test config file: AngularJS\test-config.js
• Replace the values with your system configuration.

For example:

var testConfig = {
  piWebApiUrl: 'https://mydomain.com/piwebapi',
  assetServer: 'AssetServerName',
  piServer: 'PIServerName',
  userName: 'MyUserName', // Or, 'domain\\userName'
  userPassword: 'MyUserPassword',
  authType: 'Basic', // Basic or Kerberos
  DEFAULT_TIMEOUT_INTERVAL: null
};

• In the terminal, use the following command to run the tests: npx karma start
• If you run into any issues with the Jasmine tests timing out, use the DEFAULT_TIMEOUT_INTERVAL setting in test-config.js and set it to a higher value. For example:

DEFAULT_TIMEOUT_INTERVAL: 10000

System Configuration

In order to run this sample, you must configure PI Web API with the proper security to:

• Create an AF database
• Create AF categories
• Create AF templates
• Create AF elements with attributes
• Create PI Points associated with element attributes
• Write and read element attributes
• Delete all the above AF/PI Data Archive objects

In addition, PI Web API must be configured to allow CORS as follows:

Attribute	Value	Type
CorsExposedHeaders	Allow,Content-Encoding,Content-Length,Date,Location	String
CorsHeaders	*	String
CorsMethods	*	String
CorsOrigins	https://localhost:9876	String
CorsSupportsCredentials	True	Boolean
DisableWrites	False	Boolean

On your client machine running this code, it is assumed that you have configured the system to trust the certficate used by PI Web API.

If you don't you will see an error similar to this in the Result box on the webpage:

An error occurred.

Functionality

This sample shows basic functionality of the PI Web API, not every feature. The sample is meant to show a basic sample application that uses the PI Web API to read and write data to a PI Data Archive and AF. Tests are also included to verify that the code is functioning as expected.

The functionality included with this sample includes(recommended order of execution):

• Create an AF database named sampleWeb API
• Create the Equipment Assets category
• Create the Machine element template
• Create the sampleEquipment element and associate the element's attributes with PI tags where appropriate
• Write a single value to the SampleTag attribute
• Write 100 values to the SampleTag attribute
• Perform a Batch (6 steps in 1 call) operation which includes:
  • Get the sample tag
  • Read the sample tag's snapshot value
  • Read the sample tag's last 10 recorded values
  • Write a value to the sample tag
  • Write 3 values to the sample tag
  • Read the last 10 recorded values from the sample tag only returning the value and timestamp
• Return all the values over the last 2 days
• Return timestamp and values over the last 2 days
• Delete the Machine element template
• Delete the sampleWeb API database

---

For the main PI Web API page ReadMe
For the main landing page on master ReadMe