Administration Features and Functions > Using QAD Shell URL (qadsh:// protocol)
Using QAD Shell URL (qadsh:// protocol)
You can access QAD .NET UI using a URL defined by QAD called the qadsh:// protocol:
The qadsh:// protocol is registered on a user basis, allowing different users to access different versions of the QAD .NET UI client on the same machine.
The qadsh:// protocol is registered during the launch of the QAD .NET UI, ensuring that the protocol is defined correctly.
The qadsh:// protocol is only registered if the registry setting for the currently running QAD .NET UI client is different than the one already registered.
The qadsh:// protocol always points to the last QAD .NET UI version that was launched rather than the version most recently installed.
The user registry settings do not require administrative permissions, enabling XCOPY installations.
You can copy (and paste) qadsh:// links to Desktop programs and browses by choosing Actions | Copy Link To Clipboard. You can then paste the URL into a browser to run the Desktop program or browse.
The qadsh:// protocol has the following format:
qadsh://menu/invoke?argument_list where argument_list can include optional arguments for workspace-key, menu-key, menuitem-key, and menuitem-alias.
The following summarizes the argument_list options:
A workspace key
If provided the container will activate the workspace before forwarding the request to any service providers.
A menu key
The menus that should be searched for the menu keys and aliases. If not specified all menus in the activated workspace will be searched.
A menu item key
The keys identifying menu items to execute.
You can customize the display of menu items using the following parameters:
&target=tab: Open the program in tab view.
&target=tabgroup/Sales: Open in a tab group called Sales.
&target=window: Open in a detached window)
&target=fullscreen: Open in full screen mode)
A menu item alias
The aliases identifying menu items to execute.
A table name, a field name, an operator, start value, and end value (optional).
The fields are comma delimited and multiple search conditions can be applied by adding additional parameters to the URL.
The operator can be one of the following:
The start value specifies the value or the start of a value range if the optional end value is included.
Example: qadsh://menu/invoke?workspace-key=Domain1.1000&menuitem-key=5.1.1 starts the QAD .NET UI client installed on your machine and opens Purchase Approvals Maintenance in Domain 1.
Example: qadsh://menu/invoke?menuitem-key=7.1.1&target=fullscreen starts the QAD .NET UI client and opens Sales Order Maintenance in your default domain in full screen mode.
Example: qadsh://menu/invoke?menuitem-alias=ppptmt.p starts the QAD .NET UI client and opens Item Master Maintenance in your default domain.
Example: qadsh://menu/invoke?menuitem-alias=mgbr003.p&browse-search=brw_mstr,brw_name,=,ad001 starts the QAD .NET UI client and opens a browse with a single search condition.
Example: qadsh://menu/invoke?menuitem-alias=mgbr003.p&browse-search=brw_mstr,brw_name,=,ad001&browse-search=brw_mstr,brw_name,=,ad002 starts the QAD .NET UI client and opens a browse with multiple search conditions.
Example: qadsh://menu/invoke?menuitem-alias=mgbr003.p&browse-search=brw_mstr,brw_name,range,ad001,ad022 starts the QAD .NET UI client and opens a browse with a range condition.
Example: qadsh://menu/invoke?menuitem-alias=mgbr003.p&browse-search=lbl_mstr%2Clbl_long%2Ccontains%2C%252C starts the QAD .NET UI client with comma delimited values, where a comma is encoded as %2C.
Note: If you have installed multiple instances of the QAD .NET UI client on a machine, the qadsh:// URL will invoke the most recently opened instance.
Using QAD Shell URL to Run Reports
You can use the QAD URL Shell to run reports, in a similar way to running browses.
The report-search parameter lets you specify the report to be run, and you can also specify the value of a report field.
Example: qadsh://menu/invoke?menu-key=A.6&menuitem-key=,ca_bill,=,10000
In this example, the Call Quote Print Sample report (tt_ca_mstr) is run from the command line, and the Bill To field (ca_bill) is auto-populated with the value 10000.
The autorun=true can also be added to the command for the report, which causes the report to automatically run when launched, avoiding the need to click Run on the toolbar.
Example: qadsh://menu/invoke?menu-key=A.6&menuitem-key=
This example runs Call Quote Print Sample and automatically runs the report:
Important: You should be aware of possible performance issues when using the autorun parameter. If you automatically run multiple reports without careful filtering the search criteria, the number of system queries required can have an impact on system resources and result in lengthy delays.
Report Invoke Command
You can also run reports on the command line using the following qadsh:// command:
qadsh://report/invoke?report-code=, provider=c1, label=TestReport
where report-code is the report menu number or program name, provider is an optional parameter to identify the report builder (which defaults to c1 for Component One), and label is the description you enter to overwrite the default tab text that appears on the report when you run it.
You can enter multiple search conditions and search range conditions into the command syntax.
Example: qadsh://menu/invoke?menu-key=A.6&menuitem-key=,ca_bill,range,1000,2000
This command runs the Call Quote Print Sample report (tt_ca_mstr), and creates a range for the Bill To field ca_bill.