Merge branch 'main' of https://github.com/swhitley/CLARiNET

Author: swhitley

README.md

@@ -9,6 +9,10 @@ Windows or Mac
 - Upload files in bulk to Workday Drive. Load files for different Workday user accounts.
 - Send files to the Workday Drive Trash.
 
+## CLAR Backup and Versioning
+- Quickly download and backup a unique version of a CLAR file.
+- Add the backup feature to the Workday Studio menu.
+
 ## CLAR Deployment: Why deploy CLAR files with CLARiNET?
 You might be asking yourself, "Why load a CLAR file from outside of Workday Studio?"
 
@@ -56,6 +60,15 @@ You might be asking yourself, "Why load a CLAR file from outside of Workday Stud
 
 Please note that a file is not deleted when sent to the trash.  Files can be individually restored from the trash if needed.
 
+## Download a snapshot of a CLAR file from Workday
+
+- Enter `clarinet` on a line by itself.  The application will prompt for all necessary information.
+- The `clarinet` command is **CLAR_DOWNLOAD**.
+- Run `clarinet --help` to view the available options.
+- Run `clarinet -w` to view the list of Workday environments and the associated numbers.
+- The downloaded CLAR file name will include the Cloud Collection name and a timestamp.
+- In addition to the CLAR file, the integration system configuration will be downloaded to an XML file.
+
 ## Loading a CLAR file to Workday
 
 - Enter `clarinet` on a line by itself.  The application will prompt for all necessary information.
@@ -66,9 +79,9 @@ Please note that a file is not deleted when sent to the trash.  Files can be ind
 
 ## Run CLARiNET from the command line using positional parameters:
 
-* %1 CLARiNET Command:  `CLAR_UPLOAD`, `DRIVE_UPLOAD`, `DRIVE_TRASH`<br/>
+* %1 CLARiNET Command:  `CLAR_UPLOAD`, `CLAR_DOWNLOAD`, `DRIVE_UPLOAD`, `DRIVE_TRASH`<br/>
 * %2 Path or Path and File Name<br/>
-* %3 Parameters for the command.  Enter the **Cloud Collection** name when performing a **CLAR_UPLOAD**.  For other commands, defaults will be used<br/>
+* %3 Parameters for the command.  Enter the **Cloud Collection** name when performing a **CLAR_UPLOAD** or **CLAR_DOWNLOAD**.  For other commands, defaults will be used<br/>
 * %4 Workday Environment Number (run `clarinet -w` to see the list of numbers)<br/>
 * %5 Tenant<br/>
 * %6 Username<br/>
@@ -87,6 +100,38 @@ Example #3: `clarinet CLAR_UPLOAD "C:\example_folder\Test.clar" Test`
 ### Sample `clarinet` Run
 ![image](https://user-images.githubusercontent.com/413552/129465336-0168f0e3-7e75-4309-83e1-8aebe9b9ae6e.png)
 
+## Downloading CLAR files from Workday Studio
+CLARiNET can be run from within Workday Studio. The External Tools feature of Workday Studio (Eclipse) allows you to add custom executables to your Workday Studio menu After adding CLARiNET to Workday Studio, you can click on a project in Project Explorer and then click on the CLARiNET menu item to backup the CLAR file.
+
+![image](https://user-images.githubusercontent.com/413552/152689476-49886183-06d6-4cfd-a147-190bdea8be19.png)
+
+### External Tools Configuration
+1. In Workday Studio, click *Run* on the menu.
+2. Navigate to External Tools -> External Tools Configurations...
+3. Select *Program*. Click *New launch configuration* (icon in the farthest left position of the External Tools dialog box).
+4. Give the configuration a name. Example: "CLARiNET Production Backup"
+5. For my setup, I placed the CLARiNET executable in my Workday workspace directory.
+6. Select an executable in the Location field. 
+        
+        Example 1: ${workspace_loc}\CLARiNET.exe 
+        ${workspace_loc} is an external tools variable that will convert to the workspace directory when run.
+        
+        Example 2: C:\CLARiNET\CLARiNET.exe 
+7. Set the Working Directory. 
+        
+        Example 1: ${workspace_loc}
+        
+        Example 2: C:\CLARiNET
+8. Set the Arguments. 
+        
+        Example: CLAR_DOWNLOAD "" "${project_loc}" {environment number} {tenant name} {username} {encrypted password} 
+        ${project_loc} is an external tools variable that will convert to the project directory. 
+        
+        CLARiNET will use the last directory name of the project path as the `Cloud Collection`.
+
+- Run CLARiNET with the "-w" parameter to get the environment number.
+- Run CLARiNET with the "-e" parameter to generate an encrypted password.
+
 ## Credits
 
 Command Line Parser - https://github.com/commandlineparser/commandline ([MIT](https://github.com/commandlineparser/commandline/blob/master/License.md))