Skip to content

Latest commit

 

History

History
211 lines (121 loc) · 11.6 KB

README.md

File metadata and controls

211 lines (121 loc) · 11.6 KB
Raw

iModel.js Samples

Copyright © Bentley Systems, Incorporated. All rights reserved.

The iModel.js library is an open source platform for creating, querying, modifying, and displaying iModels. This repository contains sample code walking through the iModel.js API.

If you have questions, or wish to contribute to the iModel.js samples, see our Contributing guide.

Overview of Repo

Build Status

This GitHub repo contains a (growing) collection of sample apps that demonstrate various implementations using iModel.js. To handle managing and building all of the samples, it is built using Rush.

Each of the samples are self-contained and, as such, can be copied out of the cloned source tree and built independently. These samples are intended to serve as training material and all submissions are welcome and encouraged. The samples are organized in sub-folders according to the type of app:

  1. agent-app

    Start here to create a new agent. This folder contains a collection of backend agent apps. These are suitable to be copied and used as a template to produce a new agent application.

  2. interactive-app

    Start here to create a new web, desktop, or mobile app. This folder contains a collection of sample apps which include both the frontend and backend. These are suitable to be copied and used as a template to produce a new interactive application.

  3. frontend-samples

    Explore these samples to learn how to use specific APIs. This folder contains a collection of small apps that each demonstrate a single frontend feature. These are intended to isolate the relevant API calls. Do not use as a template for a new application.

  4. tools

    A collection of tools.

To run these samples, you need to first get the required tools and ensure you have Node.js 10.x LTS installed on your machine.

Prerequisites

  • Git
  • Node: an installation of the latest security patch of Node 10 or 12. The Node installation also includes the npm package manager.
  • Rush: to install npm install -g @microsoft/rush
  • TypeScript: this is listed as a devDependency, so if you're building it from source, you will get it with rush install.
  • Visual Studio Code: an optional dependency, but the repository structure is optimized for its use

See supported platforms for further information.

Sample Agent Apps

  1. Query Agent

    Provides an example of an agent that illustrates use of the iModel.js API to listen and query changes made to iModels on the iModelHub. A separate optional imodel-changeset-test-utility can be used to generate sample change sets that can then be consumed by this sample.

Agent Development Setup

  1. (Optional) Create a sample project using the procedure at Developer Registration. This step is not needed if you already have a project to test with.

  2. (Required) Register your application at Developer Registration. Select "Agent" from the app type dropdown. For more information, see the section on authorization.

  3. (Required) Add your agent's identity email as a project participant on your project. Edit your sample project and add {client_id}@apps.imsoidc.bentley.com as a project particpant. If adding the user does not work at first, please wait a few minutes. The identity user is being created in the background, this can take up to ten minutes.

  4. Configure your app using the values you obtained from the registration process. In the agent-app subfolder, edit the configuration values in src/QueryAgentConfig.ts.

  5. Follow the steps to build the samples.

  6. Start the agent with npm start. See the Agent-specific README file for additional details.

Sample Interactive Apps

  1. Basic Viewport App

    Demonstrates the minimum setup for opening an iModel and viewing its graphics in a viewport with basic viewing tools.

  2. Simple Viewer App

    Demonstrates opening an iModel and viewing its data using unified selection and is presented using a viewport, tree control, property grid, and table.

  3. Ninezone Sample App

    Demonstrates the Bentley 9-Zone UI layout pattern and opening an iModel and viewing its data.

Interactive App Development Setup

  1. (Optional) Create a sample project using the procedure at Developer Registration. This step is not needed if you already have a project to test with.

  2. (Recommended) Register your application at Developer Registration.

    For the purpose of running a sample on localhost, ensure your SPA app registration includes http://localhost:3000/signin-callback as a valid redirect URI. The client ID should start with spa-.

    If you would like to run a sample in Electron, create a Desktop app registration with http://localhost:3000/signin-callback as a valid redirect URI. The client ID should start with native-.

    Note: If you are just testing on localhost you can use the default registration included in the sample. However, it's recommended that you complete the registration, especially since registration is a requirement before the application can be deployed. For more information, see the section on authorization.

  3. Configure your app using the values you obtained from the registration process. In the interactive-app subfolder, edit src/common/config.json and src/common/configuration.ts.

  4. Follow the steps to build the samples.

  5. a. Web App - There are two servers, a web server that delivers the static web resources (the frontend Javascript, localizable strings, fonts, cursors, etc.), and the backend RPC server that opens the iModel on behalf of the application. Start them both running locally:

    cd [sample app subfolder]
npm run start:servers

    b. Electron App

    npm run start:electron

  6. Open a web browser (e.g., Chrome or Edge), and browse to localhost:3000.

Frontend Samples

  1. Viewer Only

    Stub to be used as a template for building feature specific samples.

  2. Emphasize Elements

    Demonstrates emphasizing, hiding, isolating, and colorizing the display of element graphics.

  3. Heatmap Decorator

    Demonstrates how to display heatmap graphics that overlay the iModel.

  4. Tooltip Customize

    Demonstrates how to change the contents of the element hover tooltip.

  5. Zoom To Elements

    Demonstrates how to simply change the viewport to focus on a set of elements.

Frontend Sample Development Setup

  1. (Optional) Create a sample project using the procedure at Developer Registration. This step is not needed if you already have a project to test with.

  2. Configure your app using the values you obtained from the registration process. In the specific sample subfolder, edit src/config.json to refer to the project and iModel.

  3. Follow the steps to build the samples.

  4. Start the webserver for the app locally:

    cd [sample app subfolder]
npm run start

  5. Open a web browser (e.g., Chrome or Edge), and browse to localhost:3000.

Sample Tools

  1. iModel Changeset Test Utility

    Test utility for generating and pushing change sets to an iModel in the iModelHub. The utility creates change sets by inserting and updating geometric elements, and periodically pushes them to the iModelHub.

    This utility is meant to be used for testing sample applications like the query-agent.

Tools Development Setup

Follow the steps to build the samples.

Building Samples

  1. Install the dependencies

    node ./common/scripts/install-run-rush update

  2. Build all sample applications

    node ./common/scripts/install-run-rush build

    or to build a single application (replace app-name):

    node ./common/scripts/install-run-rush build --to app-name

Unit tests

Run with node ./common/scripts/install-run-rush test

Integration tests

Run with node ./common/scripts/install-run-rush test:integration

The integration tests require all configuration variables to be set either in each app's Config.App object or as environment variables. The full list of variables required by the integration test are:

Interactive Apps

Variable Description
imjs_test_regular_user_name The user who should sign in during the test
imjs_test_regular_user_password The user's password
imjs_browser_test_client_id The OIDC client id of the registered app. Used for Simple Viewer App tests
imjs_test_project A CONNECT Project that the user is member of
imjs_test_imodel The iModel in the above Project to use for tests.

Agent Apps

Variable Description
imjs_agent_client_id The OIDC client id for an agent. Used for the iModel Changeset Utility
imjs_agent_client_secret The OIDC client secret for the above agent_client_id. Used for the iModel Changeset Utility
imjs_agent_project_name A CONNECT Project the above client ID is member of.
imjs_agent_imodel_name The iModel in the above Project to use for tests.

All of the above variables can be setup on the registration pages on the Getting Started page.

NOTE: The imjs_agent_client_id has to be added to the Project with the following email format, {Client Id}@apps.imsoidc.bentley.com. This new user to the project can be added through the Project registration dashboard