Skip to content

Commit 4bbbe3c

Browse files
authored
Update README.md
Updating README.md file to explain the normal flow for a single instance export and the new flow for multiple instances export flow
1 parent 3411cc1 commit 4bbbe3c

1 file changed

Lines changed: 38 additions & 12 deletions

File tree

InstanceExport/PowerShell/README.md

Lines changed: 38 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,9 @@ In order to use it, you should:
1010

1111
3. Save the `InstanceExport.ps1` file in a directory in your machine like `C:\Users\MyUser\InstanceExport`.
1212

13-
4. Inside the folder created on step 3. create a `manifest` folder.
13+
4. Save the `manifest` file we have provided you inside the same directory of step 3. The manifest file should be always in the `JSON` format in order to script be able to read it.
1414

15-
5. Save your manifest file(s) inside the `manifest` folder. The manifest files come in the JSON format and they are necessary to be that way to be read by the script. In this tutorial consider that your file(s) will be named in the pattern yourInstanceName_manifest.json_.
16-
17-
4. Open a new command line interface (CLI) prompt that supports PowerShell commands (depending on your organizational IT policies, you may need to open an elevated/administrator prompt, e.g. by right clicking on the Powershell icon and choosing "Run as administrator"). If you don't have PowerShell installed you can follow instructions at [Installing Power Shell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5).
15+
5. Open a new command line interface (CLI) prompt that supports PowerShell commands (depending on your organizational IT policies, you may need to open an elevated/administrator prompt, e.g. by right clicking on the Powershell icon and choosing "Run as administrator"). If you don't have PowerShell installed you can follow instructions at [Installing Power Shell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5).
1816

1917
Please note that there will be subtle differences between `Windows PowerShell` and `PowerShell 7` command prompts:
2018

@@ -30,12 +28,39 @@ Please note that there will be subtle differences between `Windows PowerShell` a
3028

3129
e.g.: `cd C:\Users\MyUser\InstanceExport`
3230

33-
6. In the cli prompt, type the following command. **Be very careful not to click inside the cli prompt while it's running, or it may go into "select mode" and pause.**
31+
7. In the cli prompt, type the following command. **Be very careful not to click inside the cli prompt while it's running, or it may go into "select mode" and pause.**
3432

3533
`.\InstanceExport`
3634

3735
The process will prompt you to enter the required fields: `$manifestFilePath`, `$exportFilePath`, `$userName` and `$password`. Because you navigated to the directory/folder in step 5, you do not need to enter the full path, just the file names (see example below).
3836

37+
![image](https://github.com/user-attachments/assets/ae36ca77-66f9-4377-84dd-e9fd78417309)
38+
39+
### Alternative scenario
40+
We also allow to export multiple instances at once using the same `InstanceExport` script. In order to do that possible you should follow almost the same set of instructions:
41+
42+
1. Download the [InstanceExport.ps1](https://github.com/DevResults/DevResultsTools/releases/download/1.0.3/InstanceExport.ps1) PowerShell script.
43+
44+
2. Reach out to us at help@devresults.com to request an Instance Export Manifest. Or Manifests in case you need to export more than one instance you own.
45+
46+
3. Save the `InstanceExport.ps1` file in a directory in your machine like `C:\Users\MyUser\InstanceExport`.
47+
48+
4. Create a `manifest` folder inside the directory of step 3.
49+
50+
5. Save all `manifest` files we have provided you inside the directory of step 4. All manifest files should be always in the `JSON` format in order to script be able to read it.
51+
52+
6. Open a new command line interface (CLI) prompt that supports PowerShell commands (depending on your organizational IT policies, you may need to open an elevated/administrator prompt, e.g. by right clicking on the Powershell icon and choosing "Run as administrator").
53+
54+
7. Navigate to the directory where you have saved the `InstanceExport.ps1` and that has also the `manifest` folder.
55+
56+
e.g.: `cd C:\Users\MyUser\InstanceExport`
57+
58+
8. In the cli prompt, type the following command. **Be very careful not to click inside the cli prompt while it's running, or it may go into "select mode" and pause.**
59+
60+
`.\InstanceExport`
61+
62+
The process will prompt you to enter the required fields: `$manifestFilePath`, `$exportFilePath`, `$userName` and `$password`. Because you navigated to the directory/folder in step 7, you do not need to enter the full path, just the folder names (see example below).
63+
3964
![image](https://github.com/user-attachments/assets/eca84717-d4b1-40a6-a8ef-415f11bdc546)
4065

4166
It will run automatically after you enter all required fields. The progress of your data export will be logged by each available category. When all is finished you should see the message "Exporting Instance finished".
@@ -55,20 +80,21 @@ Please note that if you use `.\InstanceExport.ps1` without passing any parameter
5580
### Output
5681
We expect that things will go smoothly while you are using the DevResults InstanceExport script and that you get a result similar to the following image:
5782

58-
![image](https://github.com/user-attachments/assets/0af5a12c-4c5e-4fc2-b737-1901d2d5739f)
83+
For single instance Export:
5984

60-
In the folder you've saved the `InstanceExport` script you will noticed that a new folder `export` (or other name you've provided in the $exportFilePath parameter) and inside that folder you will have a folder with the name of the exported instance. You should expect that your data exported will be there in subfolders and a log file will be generated with the pattern `yourInstance_InstanceExport_MM_dd_yyyy_HH_mm_ss_log.txt`
85+
![image](https://github.com/user-attachments/assets/3376daf2-9950-48df-ad54-7f3d1c7ea677)
6186

62-
![image](https://github.com/user-attachments/assets/2078418b-77ea-4131-9f4a-3f075cc3b300)
63-
64-
In case you are exporting more than one instance you will have a similar output but with more log information like the following image:
87+
For multiple instances Export
6588

6689
![image](https://github.com/user-attachments/assets/9f425cd6-34b2-449a-af71-bdc2de9bae6d)
6790

68-
And similarly you will have as many folders as manifests files you have inside your `manifest` folder. You will notice that the script would be generating one folder for each instance you've own.
91+
In the folder you've saved the `InstanceExport` script you will noticed that a new folder `export` (or other name you've provided in the $exportFilePath parameter) and inside that folder you will have a folder with the name of the exported instance. You should expect that your data exported will be there in subfolders and a log file will be generated with the pattern `InstanceExport_MM_dd_yyyy_HH_mm_ss_log.txt`
92+
93+
![image](https://github.com/user-attachments/assets/72e839f5-19ce-4cf0-8359-65254245754d)
6994

70-
![image](https://github.com/user-attachments/assets/be64f831-f668-45e0-aceb-7bb1d153e0b4)
95+
And similarly if you followed the process to export more than one instance you will notice in the same folder a folder for each `instance` exported.
7196

97+
![image](https://github.com/user-attachments/assets/e4546e4b-5240-4023-a1fc-b00ad1f33488)
7298

7399
### Troubleshooting
74100

0 commit comments

Comments
 (0)