Krugle Enterprise Administration Guide v5

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 to data of interest - and includes information about the Project that improves code search. 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 Summary in the left navigation area.

The Snapshot Status area shows the current crawling and indexing status for all defined Projects. Controls beneath the Snapshot Status area can be used to manage and navigate the Project list. The list beneath these controls contains summary information for each Project. The Snapshot Status area displays the current state of Krugle Enterprise activity.

One of four state indicators will be shown in the Snapshot Status area:

• The Crawl state indicates that Krugle Enterprise is currently crawling (reading specified files from) a data repository.
• The Index state indicates that Krugle Enterprise is creating a searchable index of the latest content that is added to the system.
• The Flip state indicates that Krugle Enterprise is changing reference from a prior index to the current index.
• Finished indicates that Krugle Enterprise has completed all currently scheduled crawling and indexing activities.

The search area located directly beneath and to the right of the Snapshot Area 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.

The links located above the search area provide options for adding projects to 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 down-loading a sample Mass Import template file. This process and available options are described in Chapter 1.

The Project table summarizes each Project crawled and indexed by Krugle Enterprise. Each row summarizes one Project.

• Project name This column displays the name assigned to each Project when the project was created in Krugle Enterprise. To sort all projects by project name, click the up/down arrows to the right of the "Project name" label. Click the up/down arrows again to change the ascending/descending order. Click any Project name to view all information in the Project definition.
• Owner This is the primary contact for the Project. To sort all projects by Owner name, click the up/down arrows to the right of the "Owner" label. Click again to change the ascending/descending order.
• Data Sets This column specifies the location 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. To sort all projects by time last crawled, click the up/down arrows to the right of the "Last crawled" label. Click again to change the ascending/descending order.
• Status This indicates the processing status for each project. Each project will display one of the following states:
  • Pending - Processing is pending completion of other tasks.
  • Fetch - Project file changes are being accessed.
  • CPI - Project files are being parsed and indexed.
  • History - SCM comments are being collected.
  • SLOC - Code files are being analyzed.
  • Complete - All processing on this project has been completed successfully.
  • Delete - All information about this project is being removed from the system.
  • KE Error - An issue with Krugle Enterprise was detected. This error will prevent further processing of the associated project. Click the icon to view issue details,
  • Non-KE Error - An error in one of the systems or hosts external to Krugle was detected. Click the icon to view issue details.

To sort all projects by status, click the up/down arrows to the right of the "Status" label. Click again to change the ascending/descending order.

• 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.
• Disk This indicates the total volume occupied by copies of the project code files. To sort all projects by disk space used for code files, click the up/down ar-rows to the right of the "Disk" label. Click again to change the ascending/descending order.
• 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 remove the Project from Krugle Enterprise, and will delete all Project files. This action cannot be undone! 

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 above the project list.

• The Update button will force a manual update for all selected projects.
• The Reindex button will recreate the index entries for the selected projects, using the files currently cached by Krugle Enterprise.
• 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:

• Repository name
• Repository type
• Host
• Root path
• Port
• Connection type
• Login name
• Password

SCMI 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

Using SCMI is a two step process. First a SCMI compliant script is defined and deployed on a host machine external to Krugle. Next, a Data Repository (of type SCMI) is defined in the Admin console. In the case of an SCMI script used for project definition, the "Project definition" checkbox must be checked in the SCMI Details page. The definition, testing and deployment of SCMI integration components are described in the Krugle Enterprise SCMI Integration Guide.