QuickLink Library

QuickLinks must first be defined on the QuickLink Library (QUICKLNK) page before they can be added to a home page. If the QuickLink Type supports parameters, the QuickLink Library page also shows the QuickLink Parameters at the bottom.

QuickLink - Field InformationQuickLink - Field Information

Field Name

Description

ID

A unique identification of a QuickLink for system use.  IDs less than 500000 are reserved for delivered and sample QuickLink. Numbering is controlled by a Unique Numbering record of R_QUICKLINK_LIB.

Name

Indicates the name that will appear in the QuickLink when placed on a home page.

Type

Indicates the type of QuickLink for editing and system processing. Valid values are:

  • Page – This type of QuickLink requires the selection of a value in the Page Code field to connect to a page.

  • External Link – This type of QuickLink requires a value in the External Link URL field to connect the user to the external location.

  • Webi Report – This type of QuickLink requires a value in the Report ID field to connect the user to the Business Object report.

  • External Application – This type of QuickLink provides Single Sign On (SSO) access to an external application. This type of QuickLink requires the selection of a value in the Application Type field.

  • Power BI Analytic – This type of QuickLink requires the selection of a value in the Report Name field.

  • Power BI Dashboard – This type of QuickLink requires the selection of a value in the Report Name field.

  • Power BI Paginated Report – This type of QuickLink requires the selection of a value in the Report Name field.

  • Create Transaction – This type of QuickLink allows you to specify the source transaction to copy from when creating a new transaction. To set it up, select the Page Code that matches the application where the transaction belongs and specify the Template Where Clause under QuickLink Parameters. Note that once saved, the Type of this QuickLink cannot be changed. For detailed instructions, refer to the "Create Transaction QuickLink" topic in the Transactions User Guide.

Important: When you copy a Create Transaction QuickLink, the system duplicates the QuickLink and its parameters to a new QuickLink ID and saves them immediately. If you do not want the copy, the Cancel action will not undo the copy process. You need to delete the copied QuickLink manually.

Description

Provides an extended description of the QuickLink to supplement the Name.

Icon

The required icon from the icon repository used to represent the QuickLink on each home page. In order to make a new icon available here, the icon file must first be placed in the ADV_ICON_REPO database table through DML. Before using the file, the following files have to be updated followed by a rebuild and deployment of the UI project: advantage-icon.eot, advantage-icons.svg, advantage-icons.ttf, advantage-icons.woff, and app.component.css.

Page Code

Indicates the Page Code that will open with the QuickLink to an Advantage page.

External Link URL

Indicates the external URL that will open in a new browser window from the QuickLink.

Initial Page Mode

Indicates the initial mode of the associated Advantage page, when the QuickLink is accessed: Add, Browse, or Query.

Application Name

An inferred field Indicating the application associated with the selection made for Page Code for system processing purposes.

Page Type

Inferred from the Page Type of the Application Page Registration (APGS) record corresponding to the page code selected. This field is visible only when the Type (QuickLink Type) selected is Page or Create Transaction.

Mobile

Indicates whether the QuickLink is to be used on a mobile or non-mobile home page. This field is not visible when the Type selected is Create Transaction.

  • If selected, the QuickLink can only be used on a mobile home page.

  • If not selected, the QuickLink can only be used on non-mobile home pages.

Bypass Transaction Catalog

Indicates if the QuickLink should bypass the Transaction Catalog and open the transaction page directly. This field is visible only when the Page Type is Transactions.

Report ID

Indicates the entire report path that is used to access the Business Object report. The path must include the folders and name of the report (for example, CGI infoAdvantage R41 Financial Reports/Accounts Payable/OFIN-AP-0001 Check Listing). This field is visible only when the Type (QuickLink Type) selected is Webi Report.

Report Name

This field is only visible when the Type (QuickLink Type) selected is Power BI Analytic, Power BI Dashboard, or Power BI Paginated Report. Based on selection of one of those three values, the pick list only displays records from the Widget Library table with a corresponding value in the Type field.  For example, if the Type field on QuickLink Library is set to Power BI Analytic, then the pick list for Report Name will only show records from the Widget Library table that have Power BI Analytic selected in the Type field. Reports can be searched by the Power BI workspace name too.

Application Type

This field is only visible when the Type (QuickLink Type) selected is External Application. Valid values are determined by the settings in the sso.config file. Refer to theSSO Configuration" section in the System Administration Guide for more information. If the Type field is External Application and this field does not appear, then the ability to set up links to an external application is not enabled in the feature.conf file for your site. Refer to theFeature Flag Configuration" section in the System Administration Guide for information on the ssoForExternalApplication flag, which enables this functionality.

Workspace Name

This field is visible only when the Type selected is Power BI Analytic, Power BI Dashboard, or Power BI Paginated Report. When a record is selected from the Report Name pick, the Workspace Name field is populated from the selected record in pick. This field is a non-persistent field (that is, it is not saved to the database).

EngageHub Application Name

This field is displayed only when Type is set to External Application and Application Type is set to EngageHub. This field includes a list of available EngageHub applications.

QuickLink Parameters QuickLink Parameters

QuickLink Parameters holds any additional attributes that need to be set up in order for a QuickLink to function. It is shown if the QuickLink Type supports parameters. For example, Template Where Clause is a required parameter when QuickLink Type is Create Transaction.

Field Name

Description

Parameter Name

Indicates the parameter for the QuickLink. The parameters applicable to the QuickLink Type are shown in the drop-down values.

Parameter Value

Indicates the value for the parameter.

Parameter Description

Refreshed after the Parameter Name is chosen. Explains the usage of the parameter. 

Additional Configuration InformationAdditional Configuration Information

Config file - boreport_config.conf should be deployed to the adv_conf folder in VLS\bin. This file contains all details regarding the Business Object server name, port, and so forth.

Field Name

Description

enabled

Indicates if this feature to access the business object report from the QuickLink should be enabled or not.

open_doc_url

Indicates the API and syntax for opening the business object report. This field contains the Web server name that is used for opening the BO report. The webservername in this field may/may not be different from boservername indicated in base_url.

For example:

open_doc_url="http://webservername:8080/BOE/OpenDocument/opendoc/openDocument.jsp?iDocID=<WEBI_ID>&sIDType=CUID&token=<logon>"

base_url

Indicates the base url for connecting to the business object server. This field contains the BO server name that is used to get the login token. The boservername in this field may/may not be different from webservername indicated in open_doc_url.

For example:

base_url="http://boservername:6405/biprws"

sap_trusted_user_token

Indicates the token required in the HTTP request for trusted authentication.

sap_logon_token

Indicates the token to login to SAP business object server.