Deploying your document processing application

You make your application available to end users by adding it to a desktop in IBM Business Automation Navigator.

Before you begin

Your IBM Business Automation Navigator must be running in Platform and Content mode for this deployment process.

You must define an application root folder for single document processing applications. You add this folder to the configuration settings for the application when you deploy.

Note: You do not need to create the root folder for applications that use the Batch template.
Perform the following steps by using the Browse Content feature in IBM Business Automation Navigator to create and configure a root folder for your single document processing application.
  1. Log in as an administrator to Business Automation Navigator, go to the location where you want to create your folder, and click New Folder. Select the Folder class and enter a name for the folder.
  2. Click on the check-box to select the folder, and in the Actions drop-down list select Properties. Click the Security tab and click Select to open the search page for roles.
  3. Search for the appropriate roles and select the roles that you want to be able to access your application. It is a best practice to allow access to the roles that are associated with processing and working with finalized documents.
  4. Select Propagation to include This folder and all children and click Add.
  5. Click Apply.

About this task

The following steps explain how to deploy the application by creating a new desktop in your IBM Business Automation Navigator instance. Note that you can also add the application to an existing desktop if that works better for your environment.

Procedure

To deploy your application in IBM Business Automation Navigator:

  1. Log in to IBM Business Automation Navigator as an administrator.
  2. In the Navigation menu, click Connections.
  3. On the Platform tab, click New Connection, and select App Service.
  4. On the General tab, provide a value for the Display name and ID for the connection.
  5. Provide the App Service endpoint URL value.
    The value includes the playback server for design-time environments, and the root home for the application. The format is similar to the following example: https://playback.your-server/v1/applications
  6. If you are deploying a single document processing application, configure the root folder:
    1. From the connection that you created, click Connect, and click the Applications tab.
    2. Select the document processing application tile and select Details > Environment variables > evRootFolder > Edit. Edit the location of your folder as needed.
    3. Click Save.
  7. In the Navigation menu, click Desktops.
  8. Click New Desktop > Platform and Content.
  9. Add the values for your new application desktop:
    General tab
    • Name: Provide a name for your desktop
    • ID: A shortened way to identify your desktop
    • Description: Optionally add a description for the desktop.
    • Authentication: Choose the Connection from the list.
    • Under Desktop Configuration: Specify whether to set this desktop as the default desktop.
    • Additional settings: If you are deploying a document processing application for single documents, select Allow users to configure role-based security in entry templates (...) and its sub-option, and Allow users to configure the security inheritance of folders.
    Connections tab
    Specify connections for the desktop. Confirm that your previously created connection is listed under Selected Connections.
    Layout tab
    • Choose the layout that you want to use for your desktop.
    • For Displayed features, find and select the application that you created.
    • You can display additional options on your desktop if you want to.
  10. Click Save and Close.
  11. Close the Connections view.
    Your new desktop is added to the Desktops list.
  12. Access your new desktop by using a URL with the following construction: 
    Navigator.server_name.domain.com/navigator/?desktop=NewID

    The NewID placeholder represents the identifier that you specified on the General tab in step 9.