Link Parameters

The following table describes all the possible parameters for static links and dynamic links. The scope of a link defines the subset of these parameters that RDC appends to your specified URL or passes to your specified function.

Static Links Parameter Name	Dynamic Links Parameter Name	Database Object	Description
userid	pUserId	USERID	Sends the login user ID of the RDC session.
user_role	pUserRole	USER_ROLE	Sends the RDC login user's assigned role value.
test_prod	pTestProd	TEST_PROD	Sends the session's study mode: T for Test mode or P for Production mode.
study_id	pStudyId	CLINICAL_STUDY_ID	Sends the internal Oracle Clinical identifier that corresponds to the STUDY value.
study	pStudy	STUDY	Sends the session's Oracle Clinical Study name.
site_id	pSiteId	SITE_ID	Sends the internal Oracle Clinical identifier that corresponds to the SITE value.
site	pSite	SITE	Sends the session's SITE value.
patient_id	pPatientId	PATIENT_POSITION_ID	Sends the internal Oracle Clinical identifier that corresponds to the PATIENT value.
patient	pPatient	PATIENT	Sends the name of the PATIENT the user is currently viewing.
book_id	pBookId	DCI_BOOK_ID	Sends the internal identifier that corresponds to DCI_BOOKS.NAME.
book	pBook	DCI_BOOKS.NAME	Sends the name of the DCI book the user is currently viewing.
dci_id	pDciId	DCI_ID	Sends the internal Oracle Clinical identifier that corresponds to the user's currently viewed DCI.
cpe_id	pCpeId	CLIN_PLAN_EVE_ID	Sends the internal Oracle Clinical identifier that corresponds to the user's currently viewed Clinical Planned Event.
subno	pSubNo	SUBEVENT_NUMBER	Sends the subevent number.
page_display_sn	PPageDisplaySn	DISPLAY_SN	Sends the DCI's sequence number, its viewing order in the currently viewed DCI Book. DISPLAY_SN is in the DCI_BOOK_PAGES table.
page_no	pPageNo	—	Sends the derived page number in the currently viewed Data Entry window of a multiple-page DCI.
—	pHeader	—	Sends the value of the URL field. This value is used in earlier RDC releases. It is available in dynamic links but not in static links.
—	pScope	—	Sends the scope type to a dynamic link function. It is available in dynamic links but not in static links.

For more information, see:

Parent topic: Configuring Links

Parameters for Static Links Based on Scope

Static links generate a URL from the target HTTP address defined in the Maintain Links form. Based on the scope of the link, RDC appends a subset of parameter values from the user's current session to your specified URL when the user clicks the link.

You create a target Web page that can resolve the parameter values that RDC appends to the URL. You do not have to use all of the parameters, but the target page must be able to open the URL.

The following table lists the parameter strings that RDC appends to static links, according to the scope of the link.

Scope	Parameter String Appended to the URL Value
None	RDC appends no parameters to the URL value.
User	`?user_role=user_role`
Study	`?userid=userid&user_role=user_role&test_prod=test_prod` `&study_id=study_id&study=study`
Site	`?userid=userid&user_role=user_role&test_prod=test_prod` `&study_id=study_id&study=study&site_id=site_id&site=site`
Patient	`?userid=userid&user_role=user_role&test_prod=test_prod` `&study_id=study_id&study=study&site_id=site_id&site=site` `&patient_id=patient_id&patient=patient`
CRF	`?userid=userid&user_role=user_role&test_prod=test_prod` `&study_id=study_id&study=study&site_id=site_id&site=site` `&patient_id=patient_id&patient=patient&book_id=book_id` `&book=book&dci_id=dci_id&cpe_id=cpe_id&subno=subno` `&page_display_sn=page_display_sn&page_no=page_no`

Parent topic: Link Parameters

Parameters for Dynamic Links Based on Scope

Dynamic links derive an HTTP address from a function. You create a function that returns a URL.

The following table lists the parameters that RDC passes to a SQL function, according to the scope of the link. All parameters are VARCHAR2 except for the pStudyId and pSiteId parameters, which are NUMBER.

Scope	Parameters Passed to the SQL Function
None	`pHeader, pScope`
User	`pHeader, pScope, pUserRole`
Study	`pHeader, pScope, pUserId, pUserRole, pTestProd, pStudyId, pStudy`
Site	`pHeader, pScope, pUserId, pUserRole, pTestProd, pStudyId, pStudy, pSiteId, pSite`
Patient	`pHeader, pScope, pUserId, pUserRole, pTestProd, pStudyId, pStudy, pSiteId, pSite, pPatientId, pPatient`
CRF	`pHeader, pScope, pUserId, pUserRole, pTestProd, pStudyId, pStudy, pSiteId, pSite, pPatientId, pPatient, pBookId, pBook, pDciId, pCpeId, pSubNo, PPageDisplaySn, pPageNo`

Note:

The Maintain Links form does not verify the existence of, validity of, or access privileges to functions or data.

For more information, see:

Parent topic: Link Parameters

Sample Function Available

Oracle provides the following sample function that you can use when defining links:

dmo_links.geturl

This function is in the rxcpbdmolinks.sql file, which is located in the INSTALL directory.

Parent topic: Parameters for Dynamic Links Based on Scope

Function Specification for Dynamic Links

The following specification outlines the requirements of the function that is accessed by dynamic links with a scope of CRF.

Note:

A dynamic link with a scope of CRF processes all available session parameters. You can specify functions for dynamic links of other scopes with fewer parameters, but if you use DEFAULT NULL then you can include the extra parameters.

Create or replace FUNCTION sub-program name here(
    , pHeader        IN VARCHAR2 DEFAULT NULL
    , pScope         IN VARCHAR2 DEFAULT NULL
    , pUserId        IN VARCHAR2 DEFAULT NULL
    , pUserRole      IN VARCHAR2 DEFAULT NULL
    , pTestProd      IN VARCHAR2 DEFAULT NULL
    , pStudyId       IN VARCHAR2 DEFAULT NULL
    , pStudy         IN VARCHAR2 DEFAULT NULL
    , pSiteId        IN VARCHAR2 DEFAULT NULL
    , pSite          IN VARCHAR2 DEFAULT NULL
    , pPatientId     IN VARCHAR2 DEFAULT NULL
    , pPatient       IN VARCHAR2 DEFAULT NULL
    , pBookId        IN VARCHAR2 DEFAULT NULL
    , pBook          IN VARCHAR2 DEFAULT NULL
    , pDciId         IN VARCHAR2 DEFAULT NULL
    , pCpeId         IN VARCHAR2 DEFAULT NULL
    , pSubNo         IN VARCHAR2 DEFAULT NULL
    , PPageDisplaySn IN VARCHAR2 DEFAULT NULL
    , pPageNo        IN VARCHAR2 DEFAULT NULL
)RETURN VARCHAR2 IS
BEGIN sub-program logic here
END;

Parent topic: Parameters for Dynamic Links Based on Scope