Skip to content

Commit 65f2adf

Browse files
authored
Update README.md
1 parent af9ae37 commit 65f2adf

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
A Workday command-line interface (CLI) for working with Drive files and deploying Workday Studio integrations without Workday Studio.
55

6-
Compatibility: Windows or Mac
6+
Windows or Mac
77

88
## Workday Drive Features
99
- Upload files in bulk to Workday Drive. Load files for different Workday user accounts.
@@ -25,23 +25,28 @@ You might be asking yourself, "Why load a CLAR file from outside of Workday Stud
2525
5. You may need to install the [dotnet core runtime](https://dotnet.microsoft.com/download/dotnet/5.0/runtime).
2626
6. Optional: Download [Test.clar](https://github.com/swhitley/CLARiNET/blob/main/Test.clar) to try it out.
2727

28-
**Note:** When uploading CLAR files, CLARiNET calls an unpublished Workday API endpoint. Functionality is not guaranteed.
29-
The Drive API is published and fully-supported by Workday.
28+
**Note:**
29+
- When uploading CLAR files, CLARiNET calls an unpublished Workday API endpoint. Functionality is not guaranteed.
30+
- The Drive API is published and fully-supported by Workday.
3031

3132
## Uploading files to Workday Drive
3233

34+
- Domains: Ensure you have enabled `Modify` access on Report/Task and Integration permissions for the following domains in Workday:
35+
- Drive Administrator
36+
- Drive Web Services
3337
- Ensure that a directory named `inbound` has been created alongside the `clarinet` program file. The directory will be created automatically when `clarinet` is executed.
3438
- Place each file in the inbound directory with the following file name format: {Workday User Account}\~{File Name}<br/>
3539
Example: swhitley\~MyExampleFile.txt
3640
- Enter `clarinet` on a line by itself. The application will prompt for all necessary information.
3741
- The `clarinet` command is **DRIVE_UPLOAD**.
38-
- Each file in the `inbound` directory will be uploaded to the drive for the appropriate Workday user account. The user account will be removed from the file name and the {File Name} will appear in Drive.
42+
- Each file in the `inbound` directory will be uploaded to the drive for the appropriate Workday user account. The file name in Workday Drive will only show the text following the tilde (\~).
3943
- Once uploaded successfully, each file will be moved to the `processed` directory.
4044

4145
## Sending Drive files to the Trash
4246
- Create a comma-separated value (CSV) file with the following layout:<br/>
43-
{Workday User Account},{File Name},{Drive Document Workday ID (WID)}<br/>
47+
{Workday User Account (Owned By)},{File Name},{Drive Document Workday ID (WID)}<br/>
4448
Example: swhitley,MyExampleFile.txt,8a8a350990e401003bb7a37564c10000
49+
- In the file, use the Workday account of the original file owner, or it will be changed during this operation.
4550
- Place the file in the same folder as the `clarinet` application.
4651
- When naming the file, it will be convenient to include the word **trash**.
4752
- Enter `clarinet` on a line by itself. The application will prompt for all necessary information.
@@ -59,7 +64,7 @@ Please note that a file is not deleted when sent to the trash. Files can be ind
5964

6065
## Run CLARiNET from the command line using positional parameters:
6166

62-
* %1 CLARiNET Command: CLAR_UPLOAD, DRIVE_UPLOAD, DRIVE_TRASH<br/>
67+
* %1 CLARiNET Command: `CLAR_UPLOAD`, `DRIVE_UPLOAD`, `DRIVE_TRASH`<br/>
6368
* %2 Path or Path and File Name<br/>
6469
* %3 Parameters for the command. Enter the **Cloud Collection** name when performing a **CLAR_UPLOAD**. For other commands, defaults will be used<br/>
6570
* %4 Workday Environment Number (run `clarinet -w` to see the list of numbers)<br/>

0 commit comments

Comments
 (0)