Krugle Administration Guide V6

Chapter 3 - Projects

The Projects tab helps Krugle Enterprise administrators create, edit and manage the internal code that is cataloged for search within your organization. As explained in Chapter 1, Krugle Project definitions are used to specify Data Sets of information to be searched. Each Project definition identifies Data Repositories and Data Set Locations that define the information that Krugle searches - and includes information about the Project that improves code search result refinements. The following section describes how Projects are defined and edited.

Projects Summary

The Projects Summary area lists all Projects crawled by Krugle Enterprise and provides Project definition and management controls. To view and edit the information in this area:

• Sign in to the Krugle Administration Console.
• Click the Projects tab.
• Click Projects in the left navigation area.

Project List

The Project list summarizes each Project crawled and indexed by Krugle Enterprise. Each row summarizes one Project. Click the up/down arrows to the right of the corresponding column label to sort all projects by either Project name, Owner, Last crawled, or Status. Click again to change the ascending/descending order.

• Project name This column displays the name assigned to each Project when the project was created in Krugle Enterprise. Click any Project name to view all information in the Project definition.
• Owner This is the primary contact for the Project.
• Data Repository and Data Set Location This column specifies the details of each Data Set contained in a project.
• Last crawled This is the date and time (UTC) when the code for this Project was most recently read and used to update Krugle Enterprise's searchable index.
• Status This indicates the processing status for each project. Each project will display one of the following states:
  • update pending - Incremental update waiting for completion of other tasks.
  • update fetch - Project file changes are being incrementally fetched and processed.
  • rebuild pending - Full rebuild waiting for completion of other tasks.
  • rebuild fetch - All Project files are being fetched and processed.
  • failure fetch - Error fetching project files.
  • ready - All processing on this project has been completed successfully.
• Files This is the total number of ALL files processed for the project. In most situations, this number will be larger than the number of code files reported in the Krugle search client's Project metadata. Hidden files, non-code files and system metadata files - in addition to the code files - are included in the Files count.
• Data (MB) This is the total size of files from the Data Sets that are part of the project.
• Controls The Controls column contains operators that will perform various maintenance tasks on individual projects.
  • The Rebuild option [wrench icon] will delete, re-crawl and re-index all code files specified in the Project's SCM definition. Note that each Project will be indexed automatically once the Project is created; rebuild is an additional option that allows the index for the Project to be created from scratch.
  • The Update option [right arrow icon] will force a manual update of all Project files. Files in the Project that have been modified since the last index will be updated, new files will be added to and non-current files will be removed from the index. Note that each Project will be indexed automatically, and this feature is an additional option that allows the index for the entire Project to be updated manually.
  • Click the Edit option [page icon] to review or change any of the settings for a Project (See the Project Information section in Chapter 1 for a complete description of each setting).
  • The Delete option [ garbage can icon ] will permanently remove the Project from Krugle Enterprise. This action cannot be undone!

Project Search

The search area located at the top right provides a quick way to find Projects by name. To search for a project by name:

• Enter the name (or partial name) of any project in the field adjacent to the "Project name contains".
• Click the search icon.

The project list will show only those projects that match the search term. To show all projects, click the "x" icon in the search term field. This will clear the search term field and re-execute the query to show all projects.

Project List Utility Links

The links located above the search area provide options for working with projects in the list:

• Add New Project Use this link to create a new Project definition to the list of content that is searchable in Krugle. This process and options are fully described in Chapter 1.
• Mass Import This option lets you add multiple Projects simultaneously - via import of a single file that contains definition information in a .csv file. After clicking this option, you have the option of downloading a sample Mass Import template file. This process and available options are described in Chapter 1.
• Mass Export This option exports the project defintions for all current projects into a single .csv file. This information and layout is the same as for the Mass Import feature, as described in Chapter 1.

Bulk Operations

To perform maintenance operations on multiple projects - with a single action, first check the checkbox on the leftmost column for each project of interest, and then click one of the buttons located ABOVE the project list.

• The Update button will force a manual update for all selected projects.
• The Rebuild button will delete, crawl and reindex all code files for all selected projects.
• The Disable button discontinues crawling, processing and indexing for selected projects. Note that the last index built for this project will still be searchable when a project is disabled.
• The Enable button will allow crawling, processing and indexing to proceed as scheduled for all selected projects.
• The Delete button will permanently remove all information about the selected projects from Krugle Enterprise (including searchable index entries for the selected projects).

Data Repositories

The Data Repositories area contains a list of all repositories that Krugle Enterprise will search for specified Data Sets.

To access the SCM Repositories area:

• Sign in to the Krugle Administration Console.
• Click the Projects tab.
• Click Data Repositories in the left navigation area.
• Click the "Add New Data Repository" button to create a new Data Repository. See Chapter 1, Project Information for a complete explanation of the information required to define a Data Repository.
• To edit the information for an existing Data Repository, click the Edit button corresponding to the Data Repository that you want to modify.
• To delete the information for an existing Data Repository, click the Delete button corresponding to the Data Repository you want to delete.

SCM Repository Details

The Add New Data Repository button and Edit button will allow users to add or edit the following Data Repository information for each data source that is accessed by Krugle:

• Data Repository Host Location
• Data Repository name
• Login
• Password
• Path
• Port
• Connection type

SCMI Connector Details

SCMI is the Krugle integration API that allows custom integration to data repositories that include:

• Source code control systems
• Information repository systems
• Project definitions maintained outside of Krugle

An SCMI Connector is a program that implements the Krugle SCMI API for a particular data source (Git, Jira, Subversion, etc.) Using an SCMI Connector is a two step process. First a SCMI Connector is deployed and configured on a host machine accessible by Krugle Enterprise. Next, a Data Repository is defined in the Admin console. In the case of an SCMI Connector used for project definitions, the "Project definition" checkbox must be checked in the SCMI Details page. The deployment, configuration and testing of SCMI Connectors are described in the Krugle Enterprise SCMI Guide.