Skip to content

Commit

Permalink
iTwin Snapshot documentation
Browse files Browse the repository at this point in the history
iTwin Snapshot documentation
  • Loading branch information
williamkbentley committed Oct 23, 2020
1 parent 266604e commit 4bb9131
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 9 deletions.
6 changes: 5 additions & 1 deletion docs/learning/backend/AccessingIModels.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,14 @@ The iModel.js api has two ways to create a Snapshot iModel. Both are methods on
1. [SnapshotDb.createFrom]($backend)
2. [SnapshotDb.createEmpty]($backend)

The first method creates a SnapShot iModel from an existing iModel into the supplied filename. This requires permission from the owner of the original iModel (which obviously must have been previously obtained to open the source iModel.) The `SnapshotDb` may be used to modify and/or extend the copy of the original iModel, but once closed it becomes immutable.
The first method creates a Snapshot iModel from an existing iModel into the supplied filename. This requires permission from the owner of the original iModel (which obviously must have been previously obtained to open the source iModel.) The `SnapshotDb` may be used to modify and/or extend the copy of the original iModel, but once closed it becomes immutable.

The second method creates an *empty* Snapshot iModel given a filename. This is useful for applications that wish to create static iModels from external data sources. The `SnapshotDb` may be used to populate the Snapshot, but once closed it becomes immutable.

#### Create Snapshots with *iTwin Snapshot*

[iTwin Snapshot]($docs/learning/tutorials/create-test-imodel-offline.md), is a free tool for creating snapshots. iTwin Snapshot was designed for developers to quickly generate snapshots for use in iModel.js development.

### Important properties of Snapshot iModels

- They are "real" iModels. There are no limitations on size or content of Snapshot iModels.
Expand Down
16 changes: 8 additions & 8 deletions docs/learning/tutorials/create-test-imodel-offline.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,26 @@ Get started with iModel.js in your local environment. It is free, with no iTwin
[Snapshot iModels]($docs/learning/backend/accessingimodels.md/#snapshot-imodels) are a static but intelligent format representing the state of an iModel at a point in time. Once created, they can not be modified. And do not have a connection with iModelHub.


## Download iTwin synchronizer
## Download iTwin Snapshot

[Download](https://www.bentley.com/en/resources/software/itwin-synchronizer) and familiarize yourself with the [iTwin Synchronizer](https://www.bentley.com/en/Products/Product-Line/Digital-Twins/iTwin-Synchronizer), a free tool for synchronizing data in CAD/BIM files on your desktop and an iModel.
Download and familiarize yourself with the [iTwin Snapshot]($docs/learning/tutorials/itwin-snapshot-app.md), a free tool for creating snapshots.

## Create a snapshot iModel
1. Launch iTwin Synchronizer
1. Click the gear in the upper right
1. Select "Generate snapshots"
1. Launch Snapshot App
1. Sign In (Optional)
1. Select "Create snapshot"
1. Provide a name for the snapshot
1. Choose where to save the snapshot on your local drive
1. Select local files by clicking "+"
1. Click "Generate"
1. Click "Create"
1. Enable any required bridges

The iTwin Synchronizer will download and extract the needed bridges, run the bridges on the selected files, and generate the snapshot to the chosen location.
The iTwin Snapshot will download and extract the needed bridges, run the bridges on the selected files, and generate the snapshot to the chosen location.

---

<style>
a#getting-started---explore-imodel {
display: none;
}
</style>
</style>
14 changes: 14 additions & 0 deletions docs/learning/tutorials/itwin-snapshot-app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# iTwin Snapshot

[Snapshot iModels]($docs/learning/backend/accessingimodels.md/#snapshot-imodels) are a static format representing the state of an iModel at a point in time. Once created, they can not be modified. And do not have a connection with iModelHub. Developers writing iModel.js applications should enjoy several features of Snapshot iModels:

- No connection to iModelHub removes authentication and authorization obstacles
- Their offline nature allows all development to be done locally, with no network latency
- It is not required to have an iTwin Subscription to develop using them

Snapshot iModels should not be used in any production workflows as they do not provide security, change history, and other benefits of an iTwin Subscription.

The iTwin Snapshot app was designed with developers in mind. The free tool allows developers to create snapshots and after the snapshot has been created, it guides you to a viewer to visualize the snapshot. It also contains links to iModel.js documentation and blogs.

[!bwc tile heading="Download iTwin Snapshot" link="https://autoupdatecdn.bentley.com/itsnp/client/iTwinSnapshot.exe" contents=" " icon="download.svg" step="13" width="20%"]

0 comments on commit 4bb9131

Please sign in to comment.