Moving your application to runtime

When you are ready for test, staging, or production, you export your application and then import it into a runtime IBM Business Automation Navigator deployment.

Before you begin

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

About this task

When you first deploy the application, the deployment occurs in the context of an authoring environment. You can run and test your application, and return to both Document Processing Designer or Application Designer to make updates to the project and the way that the application functions.

After you complete development on the project and the application, you move from your authoring or development environment to your runtime environment:
Project
Deploy the project to the runtime environment by using the deployment scripts before you move the application to the runtime environment. Follow the instructions in Deploying your Document Processing project in a runtime environment.
Application
Use the instructions next in this page to export your application from the authoring environment and import it into the runtime environment.
Remember: Before you can deploy or move to a runtime environment, your deployment or operator administrator must prepare your runtime environment by deploying it with the Document Processing pattern and runtime configuration settings. For more information, see the Automation Document Processing information in Capabilities.

In Business Automation Navigator in the runtime instance, you configure a connection to the Application Engine. You also create or designate a desktop where you want to add your application or applications.

For applications that are based on the Document Processing (single document) template, you also create a root folder for your application, and configure permissions.

Procedure

To move your application to the runtime environment:

  1. In your authoring environment, log in to Business Automation Studio as a Document Process Analyst or Document Process Manager user.
  2. If needed, create a version for your application:
    You can skip this step if you have already created a version that you want to use.
    1. Go to Applications, find your application, and use the Open link to open your application.
    2. In Application Designer, click the snapshot icon and choose Create a version.
      This step creates a version of the application in Business Automation Studio.
    3. Return to Business Automation Studio.
  3. Go to Applications, find the tile for your application, and double-click the tile (instead of using the Open link).
  4. Choose a version to export:
    • If you want to export the most recent or tip version, click the Overflow menu Vertical 3-dot menu and click Export.
    • If you want to export a specific version, highlight the version in the list, click the Overflow menu Vertical 3-dot menu on the list item, and click Export.
  5. Choose Export this version to be published (.zip) and click Export.
    Save the file to a location on your client computer. If you have more than one application to export, repeat the steps for each application in your authoring environment.
  6. In your new runtime environment, log in to IBM Business Automation Navigator as a Navigator administrator.
  7. From the Navigation menu, click Connections.
  8. Click New Desktop > Platform and Content.
  9. In the General settings tab for APPENG0, click Connect.
    The Applications tab is enabled.
  10. Click the Applications tab, click Import, click Choose Files, and locate the exported .zip file that you exported from Business Automation Studio in your authoring environment.
  11. Click Open.
    You can import only one file at a time.
  12. Click Import.
    If you have more than one application to import, repeat the steps to import more application .zip files.
  13. If the application that you imported is created from the Batch template, update the object store name for the application.
    1. On the application tile, click Details.
    2. Click the Environment variables tab, and change the evObjectStoreName value to the new object store that you created for the runtime environment.
    3. Configure the Batch application settings:
      On the tile for the application click Details, click the Permissions tab, and then click Add Teams:
      DocProcessingManagers
      ProjectAdmins-ProjectName
      Classification Workers-ProjectName
  14. If the application that you imported is created from the Doc Processing (single document) template, prepare your Navigator root folder, update the permissions, and update the object store for the application:
    1. Log in to your Navigator desktop.
    2. Click the Browse content tile, and click New Folder.
    3. For the Class, choose Folder.
    4. For the Folder Name, provide the same name that you used for the evRootFolder configuration value when you created the application in Application Designer.
    5. Select the checkbox next to the folder, and in the drop-down list select Properties > Security > Select to open the search page for roles.
    6. In the search window, type Doc and add all the roles that apply for your project:
      Doc Processing Managers
      Document Editors-ProjectName-DocumentTypeName
      Document Owners-ProjectName-DocumentTypeName
      Document Viewers-ProjectName-DocumentTypeName
      ProjectAdmins-ProjectName
      Classification Workers-ProjectName
      Tip: Skip all the listed roles that include the word Membership.
    7. For the Propagation setting, choose This folder and all children.
    8. Apply updates and save all your changes.
    9. Configure the Doc Processing (single document) application settings:
      On the tile for the application, click Details, click the Permissions tab, and click Add Teams:
      DocProcessingManagers
      ProjectAdmins-ProjectName
      Classification Workers -ProjectName
    10. Click Apply, then click Close.
      The Permissions tab lists the teams that you added.
    11. Click the Environment variables tab, and change the following parameters.
      evObjectStoreName
      Change this value to the new object store that you created for the runtime environment.
      evRootFolder
      Change this value to the name of the root folder that you just created for the Doc Processing (single document) application.
    12. Click Close.
  15. Click New desktop > Platform and content to create the desktop where you will host your application.
    You can also use an existing desktop to host the application, in which case, confirm the following settings for your existing desktop.
    Add the following values:
    General tab
    • Name: Provide a name for the desktop.
    • ID: A shortened way to identify your desktop in a URL.
    • Description: Optionally add a description for the desktop.
    • Authentication: Choose the Connection from the list.
    • Under Desktop Configuration, specify the Viewer map from the list, and specify whether to set this desktop as the default desktop.
    • Under Additional settings, check the following:

      Allow users to configure role-based security in entry templates, documents, and folders.

      Allow users to configure only role-based security in entry templates, documents, and folders.

      Allow users to configure the security inheritance of folders.

    Connections tab

    Confirm that your previously created connections to APPENG0 and your runtime object store for Document Processing are listed under Selected Connections. You can test the connection to the object store to make sure that your credentials are correct.

    Click the Repositories tab, find your object store in the list, and click Edit.

    On the General tab, click Connect, and supply the login credentials to the object store to test the connection. Check or supply the values for the following fields:
    • Object store symbolic name
    • Object store display name
    Layout tab
    1. For Displayed features, find and select the applications that you created.
    2. Select in the Displayed Feature list:
      • Browse Content
      • Search Content
      • Your imported application - Batch
      • Your imported application - Document Processing (single document)
      • Home
    3. Select a Default feature, for example, Home.
  16. To access to your new desktop, use 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 15.