Uploading files to the Production Server via the Repository Utilities tool
Our IX Developers created the Repository Utilities tool for the relatively small group of Genesys Multicloud writers who are still updating HTML release notes, and for those writers who are posting non-wiki documents for their products.
Access for this tool is located on docs.genesys.com under Helpful links for writers/MediaWiki tools/Special pages/Other special pages/Utils to upload and manage repository files or on all.docs.genesys.com. Once you have accessed the tool, bookmark the page for future use.
In addition to posting your non-wiki files to the Production Server Repository, you must also upload a copy of the file to the Global IX SharePoint site. This step is for internal IX (Tech Pubs) archival purposes only.
Who can do what
Pubs Editors and writers (ie: docteam group members) have slightly different permissions within the Repository Utilities tool.
| wiki group name | add new file | update file | rename file/folder | delete file/folder | download file | add folder | reinstate backup |
|---|---|---|---|---|---|---|---|
| pubs-editors | yes | yes | yes | yes | yes | yes | yes |
| docteam | yes | yes | no | no | yes | no | yes |
There are three main directories in the repository:
- endofsupport
- public
- restricted
NOTE:
- Writers should only upload files to the associated product folders in the public directory.
- Only certain members of Pubs Editors are designated to place files in the endofsupport directory. ALERT: Writers may take on this responsibility starting in 2022.
- The restricted directory was maintained for one specific product (SpeechMiner) and Pubs Editors are responsible for uploading files to those folders. However, in early 2021, SpeechMiner documentation is no longer Closed. As such, all of the associated documentation was moved to the public directory.
Updating an existing file in the Repository
Note: Here's a link to the demo (stored in SharePoint) that Kate gave at the IX Global Office Hour on July 9, 2020: Repository Utility demo.
- Access the Repository Utilities tool.
- Under Browse Repository Content/Cache/Public, choose the appropriate product directory and release sub-directory. If you are unsure what directory the file resides in, use the "Search for" tool located at the top of the Browse Repository Content box.
- Confirm that the directory selected is the one in which you want to update the file. When you scroll down to the Draft and drop area, it should display the path to the directory you selected.
- Drag and drop the file into the “Drag and drop files in /public” box. NOTE: The file should be located on your computer, not on a network drive.
- If you are updating an existing file, a dialog box appears stating that the file already exists and asking if you want to update it. Click OK. If it uploads successfully, a check mark will briefly display across the file icon. If unsuccessful, an X will display.
- Upload the file to the appropriate product directory and release sub-directory in SharePoint > Genesys Public.
Adding a new file to the Repository
- Files are not limited to documentation; they can include almost any file type. That being said, we should offer executable files with some caution as they might be blocked on the client side if considered an untrusted/dangerous download.
- Although the Repository does have a file size limit, it's configurable on our end so we can expand it if there is a valid reason.
- If a large file fails to upload, contact the Tech Pubs Support email alias to help you with a resolution.
- Check with Pubs Editors first to confirm that the file name meets standards and isn’t already in use. If a file already exists in another folder with the same name, the Repository tool will reject it.
- Access the Repository Utilities tool.
- Under Browse Repository Content/Cache/Public, choose the appropriate product directory and release sub-directory.
- Confirm that the directory selected is the one in which you want to add the file. When you scroll down to the Draft and drop area, it should display the path to the directory you selected.
- Drag and drop the file into the “Drag and drop files in /public” box. NOTE: A dialog box will appear in the upper right providing you with the details of the upload and the appropriate wiki coding for the document: {{Repository|filename|| displaytext}}
- Go to the top of the Repository Utils page (just below the title) and click on "(force) Refresh the map ".
- Take a look at the Journal box to confirm that the operation has completed successfully.
- Upload the file to the appropriate product directory and release sub-directory in SharePoint > Genesys Public.
Contact Pubs Editors to request the creation of a new directory.
Moving a subfolder to another folder in the Repository
The structure of the repository is based on product > version. As such, it is a rare thing that a subfolder would need to be moved to another folder. However, if there is a legitimate reason for doing so, the repository tool allows you to do this.
Only Pubs Editors can perform this action. So, contact them to explain the situation and request it. To move a subfolder:
- In the repository, select the folder you want to move.
- On the right side of the screen, click the Pencil icon (called Rename or Move). The Rename to dialog box appears.
- Change the path in the dialog box to move the subfolder and click Rename.
- Refresh the Map.
- Move the folder in Global IX SharePoint as well.
