1. Implementing Global Human Resources
  2. Deep Links for Document Records

Deep Links for Document Records

You can use deep links to open responsive pages for document records without navigating through the menu structure.

When you add deep links to a business intelligence report or a company website, users can simply click those links to go directly to the application pages they need to use, without any additional clicks or navigation. You can find all of the available deep links in the Deep Links work area. Some deep links, such as those assigned the NONE action, are ready to use as is. Other deep links, such as those assigned the VIEW action, require you to edit the link details before you can use them.

You can use these parameters in the document records deep links:

  • Category
  • Documents of Record ID

  • Document Type ID

  • Document Type Read Only - should be passed if you pass pMode as CREATE. It can either be Y or N.

  • Mode - mode of the document records page, this can be either Create, View, or List

  • Person ID

  • Person Number

  • System Document Type

Note:
  • You must not click deep links that require parameters directly on the deep links page.
  • If you try to access a document type in a deep link for which you don’t have access or the document type is inactive, you will receive an exception.
  • If the Document Records (DOCUMENT_RECORDS_ANY,NONE) deep link is used without the Person ID or Person Number parameter, then the person ID of the logged in user will be defaulted.
  • If the logged in user doesn’t have an associated person record, then a blank page is displayed when the user clicks the deep link.
  • If the document type is passed in the deep link during Create mode and the Allow Multiple Occurrence Flag for the document type is true, then the deep link will open the create page with the passed document type.
  • If the document type is passed in the deep link during Create mode and the Allow Multiple Occurrence Flag for the document type is false, then the following conditions are true:
    • If a document record exists, the deep link will open the record in Edit mode.
    • If no document record exists, the deep link will open the create page with the document type populated.

This table lists Document Records deep links that are available in the Deep links work area.

Deep Link

Purpose

ObjKey Needed? (Y/N)

Name and Description of ObjKey Parameter

ObjKey Parameter Values

Document Records (DOCUMENT_RECORDS_ANY,NONE)

Opens the Document Records page of a person without person search

Note: This is same for both HR specialists and managers.

Y

pPersonId: unique identifier of the person.

pPersonNumber: number that uniquely identifies the person.

Note: Either pPersonId or pPersonNumber is required.

pDocumentTypeId: unique identifier of the document type of a specific document record.

pSystemDocType: unique identifier of system document type of a specific document record

Note: You can pass the pDocumentTypeId or pSystemDocType parameter. If you don’t pass either parameter, all document types will be displayed on the Document Records page.

pMode: mode of document records page

It can have three values.

CREATE: To open Add Document Records page

VIEW: To open the document record of the specified type, if it exists. Else, opens the list view.

LIST: To open the Document Records list page.

Note: If you don't pass pMode, then LIST is passed as Default mode.

pDocTypeReadOnly: should be passed if you pass pMode as CREATE. It can have two values Y or N and N is the default value.

If it's Y then the document type field is read-only on the Add Document Records page, else it's editable.

pCategory: unique identifier code, and not meaning of the document category of a specific document record.

Note: This parameter is applicable only for the LIST mode.

pDocumentsOfRecordId: unique identifier of the document record.

Note: This parameter is applicable only for the VIEW mode. When you pass this parameter value, the person related or document type related parameter won’t be used. This is because the pDocumentsOfRecordId parameter is already based on the person and document type.

pPersonId: PERSON_ID column in PER_PERSONS or PER_ALL_PEOPLE_F tables

pPersonNumber: PERSON_NUMBER PER_ALL_PEOPLE_F tables

pDocumentTypeId: DOCUMENT_TYPE_ID column in HR_DOCUMENT_TYPES_VL

pSystemDocType: SYSTEM_DOCUMENT_TYPE column in HR_DOCUMENT_TYPES_VL

pCategory: CATEGORY_CODE column in HR_DOCUMENT_TYPES_VL table

pDocumentsOfRecordId: DOCUMENTS_OF_RECORD_ID column in HR_DOCUMENTS_OF_RECORD table

Document Records (MANAGER_DOCUMENT_RECORDS,NONE)

This deep link is for managers. It displays the person search page where managers can search for their directs and open the Document Records page.

Y

pDocumentTypeId: unique identifier of the document type of a specific document record.

pSystemDocType: unique identifier of system document type of a specific document record

Note: You can pass the pDocumentTypeId or pSystemDocType parameter. If you don’t pass either parameter, all document types will be displayed on the Document Records page.

pMode: Mode of Document Records page.

It can have three values:

CREATE: To open Add Document Records page

VIEW: To open the document record of the specified type, if it exists. Else, open the list view

LIST: To open the Document Records list page

Note: If you don't pass pMode, then LIST is passed as Default mode.

pDocTypeReadOnly: should be passed if you pass pMode as CREATE. It can have two values Y or N and N is the default value.

If it's Y then the document type field is read-only on the Add Document Records page, else it's editable.

pCategory: unique identifier code, and not meaning of the document category of a specific document record.

Note: This parameter is applicable only for the LIST mode.

pDocumentTypeId: DOCUMENT_TYPE_ID column in HR_DOCUMENT_TYPES_VL

pSystemDocType :SYSTEM_DOCUMENT_TYPE column in HR_DOCUMENT_TYPES_VL

pCategory: CATEGORY_CODE column in HR_DOCUMENT_TYPES_VL table

Document Records (HR_DOCUMENT_RECORDS,NONE)

This deep link is for HR specialists. It displays the person search page where the HR specialist can search his organization and open the Document Records page.

Y

pDocumentTypeId: unique identifier of the document type of a specific document record.

pSystemDocType: unique identifier of system document type of a specific document record

Note: You can pass the pDocumentTypeId or pSystemDocType parameter. If you don’t pass either parameter, all document types will be displayed on the Document Records page.

pMode: mode of Document Records page.

It can have three values:

CREATE: To open Add Document Records page

VIEW: To open the document record of the specified type, if it exists. Else, open the list view

LIST: To open the Document Records list page

Note: If you don't pass pMode, then LIST is passed as Default mode.

pDocTypeReadOnly: should be passed if you pass pMode as CREATE. It can have two values Y or N and N is the default value.

If it's Y then the document type field is read-only on the Add Document Records page, else it's editable.

pCategory: unique identifier code, and not meaning of the document category of a specific document record.

Note: This parameter is applicable only for the LIST mode.

pDocumentTypeId: DOCUMENT_TYPE_ID column in HR_DOCUMENT_TYPES_VL

pSystemDocType :SYSTEM_DOCUMENT_TYPE column in HR_DOCUMENT_TYPES_VL

pCategory: CATEGORY_CODE column in HR_DOCUMENT_TYPES_VL table

Document Records (DOCUMENT_RECORDS,NONE)

Note: It’s recommended that you don't use this deep link because it will be obsoleted in future. It is currently retained because of backward compatibility.

Opens the Document Records page of the signed-in user.

Y

NA

NA

Create Document Record (EMP_CREATE_DOCUMENT_RECORDS,NONE)

Note: It’s recommended that you don't use this deep link because it will be obsoleted in future. It is currently retained because of backward compatibility.

Displays the Create Document Records page of the signed-in user.

N

NA

NA

Document Delivery Preferences (EMP_DOC_DELIVERY_PREF,NONE)

Opens the Document Records page of the signed-in user.

N

NA

NA

Document Delivery Preferences (MGR_DOC_DELIVERY_PREF,NONE)

This deep link is for managers. It displays the person search page where the manager can search for their directs and open the Document Delivery Preferences page.

N

NA

NA

Document Delivery Preferences (HR_DOC_DELIVERY_PREF,NONE)

This is for HR specialists. It displays the person search page where the HR specialist can search for their organization and open the Document Delivery Preferences page.

N

NA

NA
Mass Download of Document Records (MASS_DOWNLOAD_DOCUMENT_RECORDS,NONE) This is for HR specialists and HR analysts and opens the Mass Download of Document Records page. N NA NA

This table lists the target audience and security requirements for different Document Records deep links.

Note:

  • Replace instances of pod.oraclecloud.com with your pod name.

  • Replace the PersonNumber and PersonID with the actual person number and ID. In the examples these are indicated with sample values.

Deep Link

Audience

Security Requirements

Examples

Document Records (DOCUMENT_RECORDS_ANY,NONE)

Employee, Manager, HR

Functional Security:

  • Manage Person Documentation by Worker

  • Manage Person Documentation by Manager

  • Manage Person Documentation

  • View Person Documentation

Data Security:

  • Manage Person Documentation

  • View Person Documentation

List mode with person number

https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=DOCUMENT_RECORDS_ANY&action=NONE&objKey=pPersonNumber=955160008184689

  1. List mode with person ID

    https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=DOCUMENT_RECORDS_ANY&action=NONE&objKey=pPersonId=300100077923877

  2. List mode with person number and document type ID

    https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=DOCUMENT_RECORDS_ANY&action=NONE&objKey=pPersonNumber=955160008184689;pDocumentTypeId=100100001749404

  3. List mode with person number and system document type

    https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=DOCUMENT_RECORDS_ANY&action=NONE&objKey=pPersonNumber=955160008184689;pSystemDocType=GLB_BIRTH

  4. List mode with person ID and system document type

    https://pod.oraclecloud.com/fscmUI/faces/deeplink?objType=DOCUMENT_RECORDS_ANY&action=NONE&objKey=pPersonId=300100077923877;pSystemDocType=GLB_ADOPTION

  5. List mode with person ID and category

    https://pod.oraclecloud.com/fscmUI/faces/deeplink?objType=DOCUMENT_RECORDS_ANY&action=NONE&objKey=pPersonId=100000008153756;pCategory=LEGAL_DOC

Document Records (MANAGER_DOCUMENT_RECORDS,NONE)

Manager

Functional Security:

  • Manage Person Documentation by Worker

  • Manage Person Documentation by Manager

  • Manage Person Documentation

  • View Person Documentation

Data Security:

  • Manage Person Documentation

  • View Person Documentation

Without Parameters

https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=MANAGER_DOCUMENT_RECORDS&action=NONE

With Parameters

  1. List mode with system document type (pSystemDocType)

    https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=MANAGER_DOCUMENT_RECORDS&action=NONE&objKey=pSystemDocType=GLB_BIRTH

  2. View mode with system document type (pSystemDocType)

    https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=MANAGER_DOCUMENT_RECORDS&action=NONE&objKey=pSystemDocType=GLB_BIRTH;pMode=VIEW

  3. View mode with system document type (pSystemDocType)

    https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=MANAGER_DOCUMENT_RECORDS&action=NONE&objKey=pSystemDocType=GLB_PASSPORT;pMode=VIEW

  4. Create mode pMode (equal to CREATE) system document type (pSystemDocType)

    https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=MANAGER_DOCUMENT_RECORDS&action=NONE&objKey=pMode=CREATE

  5. Create mode pMode (equal to CREATE) with system document type

    https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=MANAGER_DOCUMENT_RECORDS&action=NONE&bjKey=pSystemDocType=GLB_BIRTH;pMode=CREATE

  6. Create mode pMode (equal to CREATE) with system document type (pSystemDocType) and pDocTypeReadOnly parameter

    https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=MANAGER_DOCUMENT_RECORDS&action=NONE&objKey=pSystemDocType=GLB_BIRTH;pMode=CREATE;pDocTypeReadOnly=Y

  7. List mode with category (pCategory)

    https://pod.oraclecloud.com/fscmUI/faces/deeplink?objType=DOCUMENT_RECORDS_ANY&action=NONE&objKey=pCategory=LEGAL_DOC

Document Records (HR_DOCUMENT_RECORDS,NONE)

HR

Functional Security:

  • Manage Person Documentation by Worker

  • Manage Person Documentation by Manager

  • Manage Person Documentation

  • View Person Documentation

Data Security:

  • Manage Person Documentation

  • View Person Documentation

Without Parameters

https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=HR_DOCUMENT_RECORDS&action=NONE

With Parameters

  1. List mode with system document type (pSystemDocType)

    https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=HR_DOCUMENT_RECORDS&action=NONE&objKey=pSystemDocType=GLB_BIRTH

  2. View mode with system document type (pSystemDocType)

    https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=HR_DOCUMENT_RECORDS&action=NONE&objKey=pSystemDocType=GLB_BIRTH;pMODE=VIEW

  3. View mode with system document type (pSystemDocType)

    https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=HR_DOCUMENT_RECORDS&action=NONE&objKey=pSystemDocType=GLB_PASSPORT;pMode=VIEW

  4. Create mode pMode equal to (CREATE)

    https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=HR_DOCUMENT_RECORDS&action=NONE;pMode=CREATE

  5. Create mode pMode equal to (CREATE) with system document type (pSystemDocType)

    https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=HR_DOCUMENT_RECORDS&action=NONE&objKey=pSystemDocType=GLB_BIRTH;pMode=CREATE

  6. Create mode pMode equal to (CREATE) with system document type (pSystemDocType) and (Doc Type Read Only)pDocTypeReadOnly parameter

    https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=HR_DOCUMENT_RECORDS&action=NONE&objkey=pSystemDocType=GLB_BIRTH;pMode=CREATE;pDocTypeReadOnly=Y

  7. List mode with category (pCategory)

    https://pod.oraclecloud.com/fscmUI/faces/deeplink?objType=DOCUMENT_RECORDS_ANY&action=NONE&objKey=pCategory=LEGAL_DOC

Document Records (DOCUMENT_RECORDS,NONE)

Employee, Manager, HR

Functional Security:

  • Manage Person Documentation by Worker

  • Manage Person Documentation by Manager

  • Manage Person Documentation

  • View Person Documentation

Data Security:

  • Manage Person Documentation

  • View Person Documentation

https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=DOCUMENT_RECORDS&action=NONE

Create Document Record (EMP_CREATE_DOCUMENT_RECORDS,NONE)

Employee, Manager, HR

Functional Security:

  • Manage Person Documentation by Worker

  • Manage Person Documentation by Manager

  • Manage Person Documentation

  • View Person Documentation

Data Security:

  • Manage Person Documentation

  • View Person Documentation

https://pod.oraclecloud.com/fscmUI/faces/deeplink? objType=EMP_CREATE_DOCUMENT_RECORDS&action=NONE

Document Delivery Preferences (EMP_DOC_DELIVERY_PREF,NONE)

Employee, Manager, HR

Functional Security:

  • Manage Person Document Delivery Preferences

  • View Person Document Delivery Preferences

Data Security:

  • Manage Person Document Delivery Preferences

  • View Person Document Delivery Preferences

https://pod.oraclecloud.com/fscmUI/faces/deeplink?objType=EMP_DOC_DELIVERY_PREF&action=NONE

Document Delivery Preferences (MGR_DOC_DELIVERY_PREF,NONE)

Manager, HR

Functional Security:

  • Manage Person Document Delivery Preferences

  • View Person Document Delivery Preferences

Data Security:

  • Manage Person Document Delivery Preferences

  • View Person Document Delivery Preferences

https://pod.oraclecloud.com/fscmUI/faces/deeplink?objType=MGR_DOC_DELIVERY_PREF&action=NONE

Document Delivery Preferences (HR_DOC_DELIVERY_PREF,NONE)

Employee, Manager, HR

Functional Security:

  • Manage Person Document Delivery Preferences

  • View Person Document Delivery Preferences

Data Security:

  • Manage Person Document Delivery Preferences

  • View Person Document Delivery Preferences

https://pod.oraclecloud.com/fscmUI/faces/deeplink?objType=HR_DOC_DELIVERY_PREF&action=NONE

Mass Download of Document Records

(MASS_DOWNLOAD_DOCUMENT_RECORDS,NONE)

 HR Functional Security:
  • Mass Download Document Records
Data Security:
  • Manage Person Documentation
  • View Person Documentation
 https://pod.oraclecloud.com/fscmUI/faces/deeplink?objType=MASS_DOWNLOAD_DOCUMENT_RECORDS&action=NONE

Related Topics