Constructing a URL for Datacap Navigator

Edit online

You can construct a URL that an external application can use to access Datacap Navigator features and actions. You can append parameters to the URL that run actions and open Datacap Navigator pages.

You must configure IBM® Content Navigator to support Secure Sockets Layer (SSL) communication when you use URLs to access Datacap Navigator features. For more information, see Planning for Secure Sockets Layer (SSL).

To construct and use a URL to access Datacap Navigator features and actions:

Start with the following base URL:
```
https://server:port/context_root/?
```
Use the question mark (?) before you append any parameters.

Append the appropriate parameters to the base URL.

Separate each parameter-value pair with an ampersand (&).

The following lists describe the parameters that you can append to the URL, the appropriate format, and valid values for each parameter.

Running Datacap Navigator actions

You can add parameters to the URL to run existing actions or custom actions. The following table lists actions that are available on the Job Monitor page.

Table 1. Valid parameters and values for running actions.
Parameters	Values
dcAction	editBatchPluginAction Specifies the edit batch action. Format: dcAction=`editBatchPluginAction` editJobPluginAction Specifies the edit job action. Format: dcAction=`editJobPluginAction` viewBatchHistoryPluginAction Specifies the view batch history action. Format: dcAction=`viewBatchHistoryPluginAction` viewBatchPropertyPluginAction Specifies the view batch property action. Format: dcAction=`viewBatchPropertyPluginAction` executeBatchPluginAction Specifies the start batch action. Format: dcAction=`executeBatchPluginAction` deleteBatchPluginAction Specifies the batch delete action. Format: dcAction=`deleteBatchPluginAction`
queueID	Specifies the queue ID of the action. The queueID parameter is not required if the action does not apply to a queue item. Format: queueID=`queue_ID`

Running shortcuts

You can run a Datacap Navigator shortcut. If you specify a job and task, the shortcut is run for the specified job and task only. Running a shortcut with a specified job and task is analogous to clicking a job under a shortcut in the Datacap Navigator shortcut pane.

Tip: To run a scan, specify a scan shortcut in the URL.

Table 2. Valid parameters and values for running Datacap Navigator shortcuts.
Parameters	Values
dcShortcut	Specifies the name of the shortcut. Format: dcShortcut=`shortcut_name`
dcJob	Specifies the name of the job. Format: dcJob=`job_name`
dcTask	Specifies the name of the task. Format: dcTask=`task_name`

Opening Datacap Navigator pages

You can open a specific page of Datacap Navigator by using the IBM Content Navigator feature parameter.

Table 3. Valid parameters and values for opening Datacap Navigator pages.
Parameters	Values
feature	DatacapMainFeature Opens the Datacap Navigator main page. Format: feature=`DatacapMainFeature` DatacapWebAdminFeature Opens the Datacap Navigator Administration View. Format: feature=`DatacapWebAdminFeature`

More IBM Content Navigator parameters are available. For example, you can use the sideChrome parameter to hide the Datacap Navigator side bar and banner. For more information, see Constructing a URL for IBM Content Navigator.

Open the Datacap Navigator main page

https://myserver.mycompany.com:myport/navigator/?desktop=datacap
&feature=DatacapMainFeature&sideChrome=0

Tip: To show Job Monitor only, hide the shortcut pane and quick launch pane in your desktop definition.

View the history of a batch with an associated queue ID

https://myserver.mycompany.com:myport/navigator/?desktop=datacap
&feature=DatacapMainFeature&sideChrome=0&dcAction=
viewBatchHistoryPluginAction&dcQueueID=3

View the history of a batch with an associated Station ID

You can view history of a batch with an associated Station ID. For example, if you used Station ID as Lansing, then after scanning, the scan batches show the Station ID as Lansing.

Run a queue

https://myserver.mycompany.com:myport/navigator/?desktop=datacap
&feature=DatacapMainFeature&sideChrome=0&dcAction=
executeBatchPluginAction&dcQueueID=3

Run a Verify shortcut with a specified job (Web job) and task (Verify)

https://myserver.mycompany.com:myport/navigator/?desktop=datacap
&feature=DatacapMainFeature&sideChrome=0&dcShortcut=
Verify&dcJob=Web%20Job&dcTask=Verify

Run a Verify shortcut without specifying a job and task

https://myserver.mycompany.com:myport/navigator/?desktop=datacap
&feature=DatacapMainFeature&sideChrome=0&dcShortcut=Verify

Authenticating without single sign-on (SSO)

If you are not using SSO, you can authenticate with an IBM Content Navigator web service call (jaxrs/logon) that has the following parameters in the body: desktop, userid, password, and contextPath. When the request succeeds, the logon session to the IBM Content Navigator server is returned. Then, you can use a URL to access Datacap batches in the authentication repository of that desktop.

Your Datacap application must be specified as the default authentication repository for your desktop. To handle cross-domain restrictions, you can put the logon result into an iFrame to know when the logon request completes and when you can access your Datacap batches. See the following example of a logon that uses a form submit request:

<form action="https://myserver:myport/navigator/jaxrs/logon" method="post"
target="output_frame">
      <input type="text" name="desktop" value="datacap" style="display:none;"></input>
      <input type="text" name="contextPath" value="/navigator" style="display:none;">
      </input>
      <input type="text" name="userid" value="admin" style="display:none;"></input>
      <input type="text" name="password" value="admin" style="display:none;"></input>
      <input type="submit" value="Go to Navigator" />
</form>

Tip: If a logon window is displayed in Internet Explorer when you access Datacap Navigator with a URL, you can resolve this issue by adding the Datacap Navigator IP or domain address to your list of managed sites. In Internet Options, on the Privacy tab, click Sites. Then, in the Per Site Privacy Actions window, enter the Datacap Navigator IP or domain address in the Address of website box and click Allow.

The following sample HTML code shows how you can log on and open Job Monitor without SSO. You can create a blank HTML file, paste the sample code into the file, edit as required, and then open the file in a browser.

<html>
	<header>
	   <Script>
	      window.onload = function(){
	         var iFrame = document.getElementById("output_frame");
	         iFrame.onload = function () {
                  window.open("https://myserver:myport/navigator/?desktop=datacap");
            };
         }
      </Script>
   </header>
	
   <body>		
      <form action="https://myserver:myport/navigator/jaxrs/logon" method="post"
      target="output_frame">
         <input type="text" name="desktop" value="datacap"
         style="display:none;"></input>
         <input type="text" name="contextPath" value="/navigator"
         style="display:none;"></input>
         <input type="text" name="userid" value="myusername"
         style="display:none;"></input>
         <input type="text" name="password" value="mypassword"
         style="display:none;"></input>
         <input type="submit" value="Go to Navigator" />
      </form>
      <iframe name="output_frame" src="" id="output_frame" width="300" 
      height="300" style="display:none;">
      </iframe> 
   </body>
</html>