user-stories-updates

docs/changed-elements/comparison.md

@@ -4,6 +4,10 @@ Compare changes between two changesets in an iModel.
 
 ## Options
 
+- **`--iTwinId`**  
+  The ID of the iTwin associated with the iModel.  
+  **Type:** `string` **Required:** Yes
+
 - **`--iModelId`**  
   The ID of the iModel to compare changesets for.  
   **Type:** `string` **Required:** Yes
@@ -20,10 +24,10 @@ Compare changes between two changesets in an iModel.
 
 ```bash
 # Example 1: Compare two changesets in an iModel
-itp changed-elements comparison --iModelId "ad0ba809-9241-48ad-9eb0-c8038c1a1d51" --changesetId1 "2f3b4a8c92d747d5c8a8b2f9cde6742e5d74b3b5" --changesetId2 "4b8a5d9e8d534a71b02894f2a2b4e91d"
+itp changed-elements comparison --iTwinId "89337c07-ab59-4080-81cc-5e237be55369" --iModelId "ad0ba809-9241-48ad-9eb0-c8038c1a1d51" --changesetId1 "2f3b4a8c92d747d5c8a8b2f9cde6742e5d74b3b5" --changesetId2 "4b8a5d9e8d534a71b02894f2a2b4e91d"
 
 # Example 2: Comparing another set of changesets in the same iModel
-itp changed-elements comparison --iModelId "ad0ba809-9241-48ad-9eb0-c8038c1a1d51" --changesetId1 "5d9e8b2f6744a71b02894f1a2b4e91d7" --changesetId2 "6b8e4f7a7348a81b93754c2d5d8f7e12"
+itp changed-elements comparison --iTwinId "89337c07-ab59-4080-81cc-5e237be55369" --iModelId "ad0ba809-9241-48ad-9eb0-c8038c1a1d51" --changesetId1 "5d9e8b2f6744a71b02894f1a2b4e91d7" --changesetId2 "6b8e4f7a7348a81b93754c2d5d8f7e12"
 ```
 
 ## API Reference

docs/changed-elements/disable.md

@@ -4,14 +4,18 @@ Disable change tracking for a specified iModel.
 
 ## Options
 
+- **`--iTwinId`**  
+  The ID of the iTwin associated with the iModel.  
+  **Type:** `string` **Required:** Yes
+
 - **`--iModelId`**  
   The ID of the iModel where change tracking should be disabled.  
   **Type:** `string` **Required:** Yes
 
 ## Examples
 
 ```bash
-itp changed-elements disable --iModelId "ad0ba809-9241-48ad-9eb0-c8038c1a1d51"
+itp changed-elements disable --iTwinId "1a2b3c4d-5678-90ab-cdef-1234567890ab" --iModelId "ad0ba809-9241-48ad-9eb0-c8038c1a1d51"
 ```
 
 ## API Reference

docs/changed-elements/enable.md

@@ -4,14 +4,18 @@ Enable change tracking for a specified iModel.
 
 ## Options
 
+- **`--iTwinId`**  
+  The ID of the iTwin associated with the iModel.  
+  **Type:** `string` **Required:** Yes
+
 - **`--iModelId`**  
   The ID of the iModel where change tracking should be enabled.  
   **Type:** `string` **Required:** Yes
 
 ## Examples
 
 ```bash
-itp changed-elements enable --iModelId "ad0ba809-9241-48ad-9eb0-c8038c1a1d51"
+itp changed-elements enable --iTwinId "1a2b3c4d-5678-90ab-cdef-1234567890ab" --iModelId "ad0ba809-9241-48ad-9eb0-c8038c1a1d51"
 ```
 
 ## API Reference

docs/user-stories/imodel-automate-update.md

@@ -27,7 +27,7 @@ As a user, I want to automatically update an iModel with the latest design files
 
 **Step 1: Create an iTwin**
 ```bash
-itp itwin create --displayName "New Project" --description "Auto-updated design files"
+itp itwin create --class "Thing" --subClass "Asset" --displayName "New Infrastructure Project" --description "iTwin of new infrastructure project"
 ```
 
 **Step 2: Create an iModel**

docs/user-stories/imodel-changeset-compare.md

@@ -14,8 +14,8 @@ As a user, I want to compare two versions of an iModel to understand the changes
 
 - `itp changed-elements enable`  
   Enable change tracking for an iModel.
-- `itp imodel changeset list`  
-  Lists all changesets for the iModel, providing a version history.
+- `itp changed-elements changesets`  
+  Lists all changesets for the iModel, along with their processing statuses.
 - `itp changed-elements comparison`  
   Compares two changesets and returns a list of changes between them.
 
@@ -24,17 +24,17 @@ As a user, I want to compare two versions of an iModel to understand the changes
 Step 1: Enable change tracking for the iModel
 
 ```bash
-itp changed-elements enable --iModelId "your-imodel-id"
+itp changed-elements enable --iTwinId "your-itwin-id" --iModelId "your-imodel-id"
 ```
 
 Step 2: List available changesets to find versions for comparison
 ```bash
-itp imodel changeset list --iModelId "your-imodel-id"
+itp changed-elements changesets --iTwinId "your-itwin-id" --iModelId "your-imodel-id"
 ```
 
 Step 3: Compare two changesets (abc123 and def456)
 ```bash
-itp changed-elements comparison --iModelId "your-imodel-id" --from "abc123" --to "def456"
+itp changed-elements comparison --iTwinId "your-itwin-id" --iModelId "your-imodel-id" --changesetId1 "abc123" --changesetId2 "def456"
 ```
 
 ## Expected Outcome

docs/user-stories/imodel-create-named-version.md

@@ -32,7 +32,7 @@ As a user, I want to create a named version of an iModel at a specific changeset
 
 **Step 1: Create an iTwin**
 ```bash
-itp itwin create --displayName "New Project" --description "Project with named versions"
+itp itwin create --class "Thing" --subClass "Asset" --displayName "New Infrastructure Project" --description "iTwin of new infrastructure project"
 ```
 
 **Step 2: Create an iModel**
@@ -57,7 +57,7 @@ itp imodel changeset list --iModelId "your-imodel-id"
 
 **Step 6: Create a named version from a specific changeset**
 ```bash
-itp imodel named-version create --iModelId "your-imodel-id" --changesetId "your-changeset-id" --displayName "Version 1: Initial Design"
+itp imodel named-version create --iModelId "your-imodel-id" --changesetId "your-changeset-id" --name "Version 1: Initial Design"
 ```
 
 ## Expected Outcome

docs/user-stories/imodel-create.md

@@ -2,14 +2,14 @@
 
 ## Scenario
 
-As a user, I want to create an iModel for a new project, set its geographic extents, and later expand those extents as the project scope evolves. This allows me to adjust the iModel boundaries without needing to recreate it.
+As a user, I want to create an iModel inside a new iTwin, set its geographic extents, and later expand those extents as the model scope evolves. This allows me to adjust the iModel boundaries without needing to recreate it.
 
 *Note: Setting the extents is optional when creating an iModel. In this user story, we demonstrate how to adjust extents after the initial creation.*
 
 ## Steps
 
 1. **Create an iModel with initial extents**: Start by creating the iModel with basic details, including an initial geographic extent.
-2. **Refine the iModel by expanding the extents**: As the project scope becomes clearer, update the iModel’s extents to fully capture the project area.
+2. **Refine the iModel by expanding the extents**: As the model scope becomes clearer, update the iModel’s extents to fully capture the project area.
 
 ## Commands Used
 
@@ -22,7 +22,7 @@ As a user, I want to create an iModel for a new project, set its geographic exte
 ## Example
 
 **Step 1: Create an iModel with initial extents**
-~~~bash
+```bash
 itp imodel create --iTwinId "your-itwin-id" --name "New Infrastructure Project" --extent '{
   "southWest": {
     "latitude": 34.052235,
@@ -33,10 +33,10 @@ itp imodel create --iTwinId "your-itwin-id" --name "New Infrastructure Project"
     "longitude": -118.343683
   }
 }'
-~~~
+```
 
 **Step 2: Refine the iModel by expanding the extents**
-~~~bash
+```bash
 itp imodel update --id "your-imodel-id" --extent '{
   "southWest": {
     "latitude": 34.052235,
@@ -47,7 +47,7 @@ itp imodel update --id "your-imodel-id" --extent '{
     "longitude": -118.443683
   }
 }'
-~~~
+```
 
 ## Expected Outcome
 

docs/user-stories/imodel-populate-data.md

@@ -2,13 +2,13 @@
 
 ## Scenario
 
-As a user, I want to populate an iModel with design data to manage and synchronize project files.
+As a user, I want to populate an iModel with design data.
 
 ## Steps
 
 1. **Create an iTwin**: Start by creating a new iTwin.
 2. **Create an iModel**: Create an iModel within the iTwin.
-3. **Populate the iModel**: Synchronize design files into the iModel to start managing the project.
+3. **Populate the iModel**: Synchronize design files into the iModel to start visualizing data.
 
 ## Commands Used
 
@@ -25,7 +25,7 @@ As a user, I want to populate an iModel with design data to manage and synchroni
 
 Step 1: Create an iTwin
 ```bash
-itp itwin create --displayName "New Construction Project" --description "Managing construction designs"
+itp itwin create --class "Thing" --subClass "Asset" --displayName "New Infrastructure Project" --description "iTwin of new infrastructure project"
 ```
 
 Step 2: Create an iModel

docs/user-stories/itwin-add-multiple-owners.md

@@ -2,7 +2,7 @@
 
 ## Scenario
 
-As a user, I want to add multiple owners to an iTwin so that different team members can have full access to manage the project.
+As a user, I want to add multiple owners to an iTwin so that different team members can have full iTwin access.
 
 ## Steps
 
@@ -23,7 +23,7 @@ As a user, I want to add multiple owners to an iTwin so that different team memb
 
 Step 1: Create an iTwin
 ```bash
-itp itwin create --displayName "New Infrastructure Project" --description "iTwin for managing infrastructure project"
+itp itwin create --class "Thing" --subClass "Asset" --displayName "New Infrastructure Project" --description "iTwin of new infrastructure project"
 ```
 
 Step 2: Add owner 1 to the iTwin

docs/user-stories/itwin-add-repositories.md

@@ -27,7 +27,7 @@ As a user, I want to create multiple types of repositories (GIS, Subsurface, Con
 
 Step 1: Create an iTwin
 ```bash
-itp itwin create --displayName "Infrastructure Project" --description "iTwin for managing multiple repositories"
+itp itwin create --class "Thing" --subClass "Asset" --displayName "New Infrastructure Project" --description "iTwin of new infrastructure project"
 ```
 
 Step 2: Create a GIS repository

docs/user-stories/itwin-create.md

@@ -2,7 +2,7 @@
 
 ## Scenario
 
-As a user, I want to quickly create an iTwin and start working on my project, even if I don’t have all the details immediately. Over time, as I gather more information about the project’s class, subclass, location, and time zone, I can refine the iTwin by updating its properties, ensuring it better reflects the project's scope and needs.
+As a user, I want to quickly create an iTwin, even if I don’t have all the details immediately. Over time, as I gather more information about the iTwin's class, subclass, location, and time zone, I can refine the iTwin by updating its properties.
 
 ## Steps
 

docs/user-stories/itwin-group-access.md

@@ -2,7 +2,7 @@
 
 ## Scenario
 
-As a user, I want to create a group of users, assign roles and permissions, and provide them access to an iTwin to manage and collaborate on the project effectively.
+As a user, I want to create a group of users, assign roles and permissions, and provide them access to an iTwin for effective collaboration.
 
 ## Steps
 
@@ -38,7 +38,7 @@ itp access-control group create --iTwinId "your-itwin-id" --name "Project Team"
 
 Step 2: Add members to the group
 ```bash
-itp access-control group update --iTwinId "your-itwin-id" --groupId "your-group-id" --addMembers "user1@example.com,user2@example.com"
+itp access-control group update --iTwinId "your-itwin-id" --groupId "your-group-id" --members '["user1@example.com", "user2@example.com"]'
 ```
 
 Step 3: Create a role
@@ -48,7 +48,7 @@ itp access-control role create --iTwinId "your-itwin-id" --displayName "Project
 
 Step 4: Add permissions to the role
 ```bash
-itp access-control role update --iTwinId "your-itwin-id" --roleId "your-role-id" --addPermissions "ViewModel,EditModel"
+itp access-control role update --iTwinId "your-itwin-id" --roleId "your-role-id" --permissions '["Permission1", "Permission2", "Permission3"]'
 ```
 
 Step 5: Add the group and role to the iTwin as members

docs/user-stories/itwin-script-progress-tracker.md

@@ -2,7 +2,7 @@
 
 ## Scenario
 
-As a user, I want to monitor key aspects of my iTwin project at a glance. This includes tracking repositories, iModels, connections, synchronized files, user roles, changesets, and named versions in an iModel.
+As a user, I want to monitor key aspects of my iTwin at a glance. This includes tracking repositories, iModels, connections, synchronized files, user roles, changesets, and named versions in an iModel.
 
 ## Steps
 
@@ -53,6 +53,7 @@ As a user, I want to monitor key aspects of my iTwin project at a glance. This i
 
 # iTwin and iModel IDs
 ITWIN_ID="your-itwin-id"
+IMODEL_ID="your-imodel-id"
 
 # List all repositories in the iTwin
 echo "Listing Repositories:"
@@ -116,6 +117,7 @@ itp access-control member owner list --iTwinId $ITWIN_ID
 
 :: iTwin and iModel IDs
 set ITWIN_ID=your-itwin-id
+set IMODEL_ID="your-imodel-id"
 
 :: List all repositories in the iTwin
 echo Listing Repositories:

docs/user-stories/itwin-upload-files-storage.md

@@ -1,12 +1,12 @@
-# Uploading project PDFs to iTwin storage
+# Uploading PDFs to iTwin storage
 
 ## Scenario
 
-As a user, I want to upload project-related PDFs, like floor plans, to iTwin storage by accessing the root folder, setting up a dedicated "floor plans" folder, uploading the PDF in multiple steps, and then confirming that it’s successfully stored by checking the folder contents.
+As a user, I want to upload construction-related PDFs, like floor plans, to iTwin storage by accessing the root folder, setting up a dedicated "floor plans" folder, uploading the PDF in multiple steps, and then confirming that it’s successfully stored by checking the folder contents.
 
 ## Steps
 
-1. **Create an iTwin**: Start by creating a new iTwin for managing the project.
+1. **Create an iTwin**: Start by creating a new iTwin.
 2. **Get the root folder**: Retrieve the root folder of the iTwin storage where you will create the new folder.
 3. **Create a folder called “floor plans”**: Add a new folder specifically for storing floor plan PDFs.
 4. **Create the file record**: Set up a record for the new file in the "floor plans" folder in iTwin storage.
@@ -41,7 +41,7 @@ As a user, I want to upload project-related PDFs, like floor plans, to iTwin sto
 
 **Step 1: Create an iTwin**
 ```bash
-itp itwin create --displayName "New Project" --description "iTwin for uploading floor plans"
+itp itwin create --class "Thing" --subClass "Asset" --displayName "New Infrastructure Project" --description "iTwin of new infrastructure project"
 ```
 
 **Step 2: Get the root folder**

docs/user-stories/overview.md

@@ -20,5 +20,5 @@
 - [Track iTwin project progress](docs/user-stories/itwin-script-progress-tracker.md)
 
 **Storage and Versioning**
-- [Upload project PDFs to iTwin storage](docs/user-stories/itwin-upload-files-storage.md)
+- [Upload PDFs to iTwin storage](docs/user-stories/itwin-upload-files-storage.md)
 - [Create an iModel named version](docs/user-stories/imodel-create-named-version.md)