Welcome to Kofax RPA > Management Console > Management Console Configuration and User Interface > Repository > Snippets

Snippets

This subsection lists the snippets that have been uploaded to the Management Console Repository. At the top of the Snippets tab, you can select the project which snippets should be displayed.

When a schedule runs, the robots linked to it are executed on RoboServer. Some robots use snippets, which must be available in the repository (in the same project as the robot) or running the robot will fail.

When you upload a snippet to the repository, it is copied into the repository. Thus, if changes are later made to the snippet in Design Studio, it needs to be uploaded again. Since each snippet name must be unique (within each project), uploading the snippet again overwrites the previous version.

Note You can filter the list of items in the table by applying filters in the Filter text box. See Filtering for more information.

The following information is displayed for each snippet.

Name

Description

Folder

Name of the folder specified to store snippets. By default, the files are stored in the Root folder. You can create a new folder to store the files. The folder name is displayed in the column if the selected folder is other than Root. When deleting a snippet, you can delete an empty folder.

Name

Name of the snippet.

Project Name

Name of the project the snippet belongs to (useful when viewing all projects).

Input Types

Types used in input variables in the snippet. To use this snippet in a robot, the .type files corresponding to each of these types must be present.

Returned Types

Types of values returned by the snippet. To use this snippet in a robot, the .type files corresponding to each of these types must be present.

Stored Types

Types of values stored in a database by the snippet. To use this snippet in a robot, the .type files corresponding to each of these types must be present.

Snippets used

Name of the snippets used by this snippet. If a snippet uses snippet A and snippet A uses snippet B, only snippet A will be listed here.

Size

Size of the snippet in bytes.

Delete

Click to delete the snippet from the Repository. If you do not have a copy of the snippet in the file system, it is irrevocably lost.

Created By (hidden by default)

User name of the user who first uploaded the snippet. This feature is only available when running a stand-alone Kofax RPA using LDAP.

Modified By (hidden by default)

User name of the user who last modified the snippet. This feature is only available when running a stand-alone Kofax RPA using LDAP.

Commit Message

Summary describing the commit.

Revision Number

The number of the snippet revision.

Last modified

Timestamp for the last change of this snippet.

Imported By

User name of the user who imported the snippet that is part of the imported project or restored backup.

Imported At

Date of the importing of the snippet that is part of the imported project or restored backup.

Download

Click to get a copy of the snippet out of the Repository and save it in the file system.

  1. To add a snippet, click Add Snippet in the upper left corner.

    The "Upload snippet" window appears.

    If you are uploading a snippet with the same name as an existing one, select Override if exist to replace the existing snippet.

    In the Commit Message field, you may add a description for the commit.

    Snippets may implicitly be uploaded from Design Studio. This happens when you use Design Studio to upload a robot that uses the snippet. As Design Studio knows about the dependencies between robots and snippets, it always uploads the necessary snippets along with the robot.

  2. To remove a snippet, click in the Delete column.

    You are prompted to confirm the deletion. If the type is used by a robot or snippet, the confirmation message includes the usage count. If the snippet is used by other snippets or robots, the confirmation message includes the usage count. If you delete a snippet that is used by a robot (or a snippet used by this robot), the robot will no longer be able to execute. Any robot that is missing a required snippet, is listed with its name in a red font on the Robots tab. When deleting a snippet, you can delete an empty folder.