GR:Gravity/Xref/Setup/basic configuration

Basic Configuration

Example configuration:

• The Xref Server URL points to the Gravity server installation hosting Xref. The URL is used for configuring Xref clients like TD/OMS. The URL is synchronized with the Web server URL (set in the Web configuration). If the host/IP address or port of the Xref server is not correct then check the Web server URL.
• File ignore patterns is a comma-separated list of patterns of which the files are to be excluded from indexing. Allowed regex characters are '*' and '?', for example '*.sh' (matching is case sensitive, i.e. *.sh will not match script.SH). By default most Unix library types and Windows binaries (.a, .so, .exe, .dll ...) are ignored. This is a global setting and applies to all defined locations.
• Dir. ignore patterns is a comma-separated list of sub/directory names to be excluded from indexing. For example 'archive' or 'src/test' (matching is case sensitive). By default repository meta-data directories such as '.git' and '.svn' are ignored.
• Checkout Interval is the interval in minutes on which the Xref locations will be checked out and optionally indexed if any repository changes were detected.
• Parallel Checkout is the number of checkout jobs that may run parallel during Xref maintenance. The minimum is 1 and maximum is 10, setting 0 will disable checkouts but not the maintenance of a location if it is removed as an Xref location.
• Last Indexing time is the time Xref has run a cross-reference against the provided locations. A cross-reference indexing is automatically run when the Xref configuration is updated (location added, removed, updated). Cross-reference indexing will also run on a fixed period so that remote repository information is refreshed in the Xref projects, by default the period is set at 60 minutes.
• The 'Reschedule Indexing' button can be used to force the re-indexing to run even if no changes to the configuration have been made.

Note that re-indexing can take a few minutes (at most around 5-7 minutes) before it starts on the server, see the xref.log, accessible through the Gravity web, to view indexing progress.

When opening the Xref configuration a check will be done of the server URL in the configuration and the server URL in the Xref preferences. If a difference is detected then it is being assumed that a configuration switch has taken place and the following message is displayed:

When this message is displayed then the Xref Server URL and currently logged in Gravity user will have been set in the Xref preferences. It is usually sufficient to update the password to correct the preferences setting.