Projects

Use the Projects section in the Admin menu to configure and create projects for the Management Console.

Projects are a way to segment robots, types, snippets, resources, schedules, and other work assets. Robots have access only to types, snippets, and resources contained in the project they belong to. Also, names of robots, types, and other objects need to be distinct within a project.

By default, Management Console contains a single project called "Default project."

You can change the way the information for each project is presented as follows:

  • Select the table columns to display for a project using the menu icon on the right.
  • Refresh the displayed information by clicking the refresh icon on the right.
  • Reset the custom column settings by clicking the reset icon on the right.
  • Select the number of items to display per page and navigate among pages by using the navigation menu in the bottom right corner.

By default, the following table columns are displayed for each project.

Column Description
Name Name of the project. Project name must be unique.

The project name is used as a foreign key in the log tables to determine who has permission to view the log files. If you rename a project, all existing robot runs and robot messages belonging to this project must be updated to reflect the new name. Otherwise, they are not shown when the logs are filtered by project. If Management Console is connected to the logging database, when you rename a project, Management Console automatically renames the robot runs/messages entries in the log database. However, if it is not connected, or the connection is lost during the update, the administrator must manually run the following SQL to update the log tables.

UPDATE ROBOT_RUN SET projectName = '<newName>' where projectName = '<oldName>';
UPDATE ROBOT_MESSAGE SET projectName = '<newName>' where projectName = '<oldName>';

Where <oldName> is the old project name, and <newName> is the new project name.

Description Description of the project.
Authenticate REST Indicates if the authentication for REST/SOAP requests is enabled.
Optional Columns
Imported by

User name of the user who imported the project or restored it as part of a backup.

Imported at

Date when the project was imported or restored as part of a backup.

Permissions Any configured project permissions for this project.
REST cluster Cluster used to execute robots for this project when robots are invoked as REST services.

Create New Project

  1. To create a new project, click the plus sign in the upper left corner.

    Several new tabs appear.

  2. On the Basic tab, specify a name for the project and its description.

  3. On the Permissions tab, set project permissions.

    1. To add a permission, click the plus sign.

    2. Specify a project role and optionally a security group that it belongs to.

      For a description of project roles, see Users & groups.

    When deploying Management Console on a standalone web container, you can also configure project permissions for users based on their group membership (for example, LDAP groups). For more information, see the "Tomcat Management Console" section of "Project Permissions" in the Kofax RPA Administrator's Guide.

  4. On the Services tab, you can optionally select a service cluster to execute robots for this project when robots are invoked as REST services.

    • Use only service cluster in project: Service cluster is a cluster used to run REST services in the current project. REST services always use the selected service cluster. If you select this option, Management Console hides all other clusters and use the service cluster for all schedules, when generating code, and when running robots from the robot menu. When you select this option, you also need to select a Service cluster.
    • Authenticate REST/SOAP requests: By default, REST/SOAP services are protected by basic authentication. When calling the services directly from a browser using XMLHttpRequest, disable the authentication, as you would otherwise be exposing login credentials in the JavaScript source files. When calling REST/SOAP services from a programming language like Java, Ruby, C#, and other, enable the authentication to protect the services, assuming that you can keep the credentials stored in a secure manner.

    • Access-Control-Allow-Origin: Specify a header for the client to be allowed to process a resource from another domain.

      There are certain restrictions when calling a REST/SOAP service from a browser, unless the service is located on the same web server as the web page from which it is invoked. When calling a REST/SOAP service from another domain (referred to as CORS Cross-Origin Resource Sharing), you have to include certain headers for the client to be allowed to process a resource from another domain. The Access-Control-Allow Origin is one such header. If you call a REST/SOAP service in a cross-domain fashion, you must specify the domain, from which the page that generated the request was loaded. If a page on http://example.com contains a page with JavaScript that generates a request to a service located on http://kofax.com, then the service response from http://kofax.com must contain the header "Access-Control-Allow-Origin: http://example.com" or built-in security mechanisms in the browser will prevent it from processing the cross-origin response. You may use * as a wildcard, which means that any domain can invoke your REST/SOAP service in a cross-domain fashion.

  5. On the Repository tab, you can optionally configure the Robot Lifecycle Management feature that enables you to control work objects in the Git version control system. For a detailed example of using this feature, see the Kofax RPA Best Practices Guide for Robot Lifecycle Management.

    Here, specify the following information:

    1. URL: Type the path to the Git repository.

      Example: /gitrepos/example.git/

    2. Branch: Type the name of the branch to use.

      Example: If you have a setup with two Management Consoles, one for production and one for development, you can have a dedicated "development" branch.

    3. To make the repository the only source for object changes, select Read-only. We recommend that you select this option to avoid any changes to objects belonging to the synchronized project in the production Management Console.

    4. To enable the configuration specified above, select Enable configuration.

    5. Under Objects to synchronize, select the objects to include in the synchronization.

  6. Click Submit to save the changes.

Additionally, you can perform the following actions on projects from the context menu:

  • Edit: Contains the same fields as when creating a new project.

To delete a project, select it and click the icon.

If you delete a project, all of the robots, types, snippets, resources, and schedules associated with it are deleted as well.