Skip to content

Commit a31437a

Browse files
authored
Update README.md
1 parent 6841081 commit a31437a

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,27 @@ You might be asking yourself, "Why load a CLAR file from outside of Workday Stud
6868
Please note that a file is not deleted when sent to the trash. Files can be individually restored from the trash if needed.
6969

7070
## Uploading files to Worker Documents
71+
7172
- Ensure that a directory named `inbound` has been created alongside the `clarinet` program file. The directory will be created automatically when `clarinet` is executed.
7273
- Place each file in the inbound directory with the following file name format: {Workday Employee ID}\~{File Name}<br/>
7374
Example: 500117\~MyExampleFile.txt
7475
- Enter `clarinet` on a line by itself. The application will prompt for all necessary information.
7576
- The `clarinet` command is **DOCUMENT_UPLOAD**.
76-
- The document category is supplied in the `Parameter`.
77-
- Each file in the `inbound` directory will be uploaded to to worker documents for the appropriate Workday employee id. The file name in Workday Drive will only show the text following the tilde (\~).
77+
- Enter the document category reference id in the CLARiNET `Parameters` option.
78+
- Each file in the `inbound` directory will be uploaded to worker documents for the appropriate Workday employee. The file name will only show the text following the tilde (\~).
7879
- Once uploaded successfully, each file will be moved to the `processed` directory.
7980

81+
## Download Profile Pictures (Employee Photos)
82+
83+
- Create a manifest file with a list of employee ids, one id on each line. This is the list of workers that will be used to download photos.
84+
- Place the manifest file in the directory to which the photos should be downloaded.
85+
- Enter `clarinet` on a line by itself. The application will prompt for all necessary information.
86+
- The `clarinet` command is **PHOTO_DOWNLOAD**.
87+
- The `Path` option should point to the path where the manifest file is located.
88+
- The `Parameter` option should be the name of the manifest file.
89+
- Run `clarinet --help` to view the available options.
90+
- Run `clarinet -w` to view the list of Workday environments and the associated numbers.
91+
8092
## Download a snapshot of a CLAR file from Workday
8193

8294
- Enter `clarinet` on a line by itself. The application will prompt for all necessary information.
@@ -96,7 +108,7 @@ Please note that a file is not deleted when sent to the trash. Files can be ind
96108

97109
## Run CLARiNET from the command line using positional parameters:
98110

99-
* %1 CLARiNET Command: `CLAR_UPLOAD`, `CLAR_DOWNLOAD`, `DRIVE_UPLOAD`, `DRIVE_TRASH`<br/>
111+
* %1 CLARiNET Command: `CLAR_UPLOAD`, `CLAR_DOWNLOAD`, `DRIVE_UPLOAD`, `DRIVE_TRASH`, `PHOTO_DOWNLOAD`, `DOCUMENT_UPLOAD`<br/>
100112
* %2 Path or Path and File Name<br/>
101113
* %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/>
102114
* %4 Workday Environment Number (run `clarinet -w` to see the list of numbers)<br/>

0 commit comments

Comments
 (0)