/
Add Company Document Links to the Employee Self-Service Portal

Add Company Document Links to the Employee Self-Service Portal

03 04, 2019

Issue/Symptom/Question

How do I add Company Document Links to the Employee Self-Service Portal for distribution?

Applies To

Employee Self-Service Portal

PENTA for Windows > System Management > Security > Portal Configuration > Employee Portal tab

Resolution/Fix/Answer

1) On the server that Penta Technologies, Inc. installed the Employee Self-Service Portal, save a copy of each document you want available in the portal to this location: C:\ProgramData\Penta Technologies, Inc\Employee Portal\{Application Name/URL}\Documents

If you do not know the Application Name/URL, you can find it in the Employee Portal Configuration Tool’s Application Name/URL field. 

2) With a file editor, open the companyDocuments.json file. If a file does not already exist, use the documents.json template to create one.

3) Add each document you saved in step 1 to the companyDocuments.json file by identifying the name and URL of each document in the properly formatted JSON file.

File format:

  • Name is companyDocuments.json

  • Is in JSON format

  • Starts and ends with square brackets [ ]

  • Contains entries that start and end with curly brackets { }

  • Contains a name and a URL for each link entry

    • name – displays in the document links section of your portal to identify the document

    • URL – specifies the location and name of the document to open when an employee clicks the link in the portal

  • A comma after an entry’s closing curly bracket to separate it from the next entry when the file contains multiple entries

Example:

[{

"name": "Sample Document 1",

"url": "documents/sampledoc1.pdf"

}, {

"name": "Sample Document 2",

"url": "documents/sampledoc2.docx"

}]

In the sample file above, two links are added to the portal Documents section. The first link has a label of Sample Document 1. When a portal user clicks on it, it will open the documents/sampledoc1.pdf. The second link has a label Sample Document 2. When a user clicks on it, it will open the documents/sampledoc2.docx.

  • On the portal web page, link names display in the order in which they list in the JSON file

  • All valid entries in the file display in the portal for employee access. Remove links to documents you do not want shown in the portal.

4) Save the file.