Wiki

Scale Your Enterprise

User Tools

Site Tools

mbstring extension must be loaded in order to run mPDF

versago:configuring_report_links

This is an old revision of the document!


Configuring Links

General Notes

A link can be created on an existing column or a new column. Keep the following in mind when determining which type of link to use.

  • If the action is associated with a specific column in the main record, that value should be used for the link. This makes it easier for the user to understand the relationship of the action to the main record. For example, the main report might be a list of customer orders. The action is a report of details about a specific order. Using the “Order Number” value in the main report as the linking item helps the user understand what is being used to control the child report.
  • Any “new columns” specified for linking will always appear at the end of the main record. These columns cannot be moved so it may be difficult for the user to find them.
  • An action can use a “Calculated Value” column as the linking item. This “calculated value” can be set up to show a text value. And “calculated value” columns can be re-positioned in the column sequence, so the links can be set in a more logical sequence within the row.

All actions use the same basic setup as shown below.

  • Link Name is a unique name for this link. It is displayed as the column header and content value if the Link From is “New Column (Link name)”.
  • The Type drop-down list is used to select the type of action to be used. Available actions are:
    • Report
    • Forms
    • Crystal Report
    • Bizweaver Webservice
    • Other URL
  • Link From indicates if the link will use an existing column or a new column. Select the desired option from the drop-down list.
  • The Link Column is the column used for the link if the “Existing Column” option is used for Link From. Select the desired column from the drop-down list.
  • Destination defines the target of the action. The values in this field will change depending on the link Type. More information on Destinations is found in the discussion of each Type below.
  • Show in New Browser tab indicates if the link action results should be displayed in a new browser tab (default) or in the current page.
  • Conditions can be used to control when an action link is active based on values in other columns. See Link Conditions for more information.
  • Click the red X icon to delete an existing action.
  • The Link Parameters section is used when it is necessary to pass parameters to the target function. There may be some instances where the target function does not require information and this section is not needed.
    • Click the red X icon to remove a parameter.
  • Destination Field is the linking item in the target function. For example, we might need to pass an invoice number to a child report that shows more details about the invoice. The target function must have a column that will receive the value.
  • The Is Static checkbox indicates whether the value to be passed to the target function will be a value from a column in the source report or a fixed value. When this option is selected the Source Field will be a text box rather than a drop-down.
  • The Source Field provides a parameter value to the target function. If the Is Static checkbox is not selected, a drop-down list of columns from the main report is provided. Otherwise the field appears as a text box where a static value can be entered.

Report Setup

The Report link is the execution of a Versago report. The concept is like the Sub-Reports function described earlier, except that the report being opened does not necessarily need to be connected to the main report, as it is in the Sub-Reports. Using a Link rather than a Sub-Report is sometimes helpful if having the child results open in a new browser tab will make the results easier to use.

The following image shows the setup for a Report action to call the Sub-Report illustrated earlier in this document.

Forms Setup

The Form action provides a mechanism to open a Versago Form from a Versago Report and either find an existing record for maintenance or start a new record and automatically populate fields on the form.

The following example shows the Form action calling a Versago form used to create Service Call for SAP Business One.

In this example, the customer code (BP Code) and customer name (BP Name) are being passed into the form.

If the value passed to the form is the primary key (e.g. vgoRecNum or whatever it has been named) the application will automatically execute a lookup for the record of the value passed. If the record is found the remaining fields will be populated.

Crystal Report Setup

The Crystal Report action provides a way to execute a Crystal Report for presentation to the user. An example of how this could be used is where the main report is a list of customer invoices. A Crystal Report action could cause a copy of the invoice document to be generated using Crystal Reports.

Registration of the Crystal Report is the same as described for Crystal Reports in the Report Object Types of this page.

Crystal Reports that use a specific value for execution (e.g. an invoice number) must have a parameter in their definition. The Link Parameters will show the parameter(s) as Destination Field(s) that are mapped to a Source Field from the main report.

Crystal Reports Configuration

When designing a Crystal Report that will use a SQL Server database as its data source, the report connection type must be OLE DB (ADO).

When designing a Crystal Report that will us a HANA database as its data source, the report connection type be ODBC (RDO). This document explains how to configure this type of connection for use with HANA. Two options are described in the document. Be sure to use the B1CRHPROXY32 option. Here is a sample connection string to use as a starting point.

DRIVER={B1CRHPROXY32};SERVERNODE=<YourServer>:30015;DATABASE=<YourDB>

Replace <YourServer> and <YourDB> (without the < > symbols) with the appropriate values.

Bizweaver Webservice Setup

A Bizweaver Webservice link allows a user to execute a Bizweaver workflow from a report using the Bizweaver API. These workflows can be used for a variety of background processing.

Beginning with v2.3, calls can be made using GET or POST. POST provides authentication that is not available using GET. Using the POST option is strongly recommended.

Calling Bizweaver Using POST

The POST option is easier to configure since most of the values are entry/selection fields rather than working with a text string

  • Method is POST.
  • Task ID is the target workflow ID defined in Bizweaver.
  • Destination is the URL needed to contact the Bizweaver web service.
https://<YourURL>/BWService/api/workflow/InvokeWorkFlow
  • <YourURL> is the URL to your Bizweaver web server. It should include the actual URL and port number.
    • Use HTTP or HTTPS as needed by your site
    • If Versago uses HTTPS the Bizweaver web service must use HTTPS as well.
  • Link Parameters are any values that need to be passed to the workflow.
    • Enter the name of the variable expected by the Bizweaver workflow in the Destination field.
    • Select the source value from the drop-down list in the Source Field.
    • Leave these two values blank if no parameters need to be sent to the workflow.

The “Destination” value is the string that calls the Bizweaver web service and passes any parameters that are needed. When parameters are specified in this string the are automatically set as Destination Fields in the Parameters section. Each parameter then needs to be matched to a Source Field from the report using the drop-down lists.

Calling Bizweaver Using GET

  • Method is GET.
  • Task ID is not used for GET.
  • Destination is the URL needed to contact the Bizweaver web service.
    • All values to be used to execute the Bizweaver workflow are included in the “Destination” string when using the GET option.
https://<YourURL>/BWService/api/workflow/InvokeWorkFlow?pTaskID=NN&pStartAfter=0&pArguments={Parameter:Value}
  • <YourURL> is the URL to your Bizweaver web server. It should include the actual URL and port number.
    • Use HTTP or HTTPS as needed by your site
    • If Versago uses HTTPS the Bizweaver web service must use HTTPS as well.
  • Task ID is the target workflow ID defined in Bizweaver.
  • Arguments are any values that need to be passed to the workflow.

URL Setup

The URL action is used to call a “website” (the URL). The URL is entered in the “Destination” field. The page being called could contain general information. In this case the “Destination” string is whatever you would type into a browser (e.g. www.twbs.com) to open the Third Wave website.

Or you may want to pass information to the page for processing there. An example of how this could be used is to call the UPS website and pass a tracking number.

An example of how the UPS example might be set up is shown below (the “source” fields are used only for illustration).

The Links Parameters are determined by Versago from information in the URL. In this case the URL is “wwwapps.ups.com/WebTracking/track?track=&trackNums=”. Values after the question mark in the URL are treated as parameters by Versago. When parameters are specified in this string the are automatically set as Destination Fields in the Parameters section. Each parameter then needs to be matched to a Source Field from the report using the drop-down lists.

versago/configuring_report_links.1589567826.txt.gz · Last modified: 2020/05/15 14:37 by runger