Skip to content

Commit 0742e43

Browse files
committed
Merge branch 'main' of https://github.com/swhitley/CLARiNET
2 parents ae6f372 + 2add5ae commit 0742e43

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

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

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

6-
## Drive Features
6+
Windows or Mac
7+
8+
## Workday Drive Features
79
- Upload files in bulk to Workday Drive. Load files for different Workday user accounts.
810
- Send files to the Workday Drive Trash.
911

10-
## Why deploy CLAR files with CLARiNET?
12+
## CLAR Deployment: Why deploy CLAR files with CLARiNET?
1113
You might be asking yourself, "Why load a CLAR file from outside of Workday Studio?"
1214

1315
- Distribute an integration to someone who is not a developer.
@@ -23,23 +25,30 @@ You might be asking yourself, "Why load a CLAR file from outside of Workday Stud
2325
5. You may need to install the [dotnet core runtime](https://dotnet.microsoft.com/download/dotnet/5.0/runtime).
2426
6. Optional: Download [Test.clar](https://github.com/swhitley/CLARiNET/blob/main/Test.clar) to try it out.
2527

26-
**Note:** When uploading CLAR files, CLARiNET calls an unpublished Workday API endpoint. Functionality is not guaranteed.
27-
The Drive API is published and fully-supported by Workday.
28+
**Notes:**
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.
31+
- On a Mac, you will be blocked from executing CLARiNET by an "Unidentified Developer" warning. Use Ctrl-Click or right-click to open CLARiNET.
32+
- https://www.macworld.co.uk/how-to/mac-app-unidentified-developer-3669596/
2833

2934
## Uploading files to Workday Drive
3035

36+
- Domains: Ensure you have enabled `Modify` access on `Report/Task` and `Integration` permissions for the following domains in Workday:
37+
- Drive Administrator
38+
- Drive Web Services
3139
- Ensure that a directory named `inbound` has been created alongside the `clarinet` program file. The directory will be created automatically when `clarinet` is executed.
3240
- Place each file in the inbound directory with the following file name format: {Workday User Account}\~{File Name}<br/>
3341
Example: swhitley\~MyExampleFile.txt
3442
- Enter `clarinet` on a line by itself. The application will prompt for all necessary information.
3543
- The `clarinet` command is **DRIVE_UPLOAD**.
36-
- 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.
44+
- 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 (\~).
3745
- Once uploaded successfully, each file will be moved to the `processed` directory.
3846

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

5867
## Run CLARiNET from the command line using positional parameters:
5968

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

0 commit comments

Comments
 (0)