configureexternalfields CLI command

Use this command to configure settings for entries (or fields) collected from Remedy Action Request System.

During data collection, a set of total entries are automatically collected from the change management and incident management applications. From this set, a limited set is indexed and displayed as fields on the Search page. You can customize the settings based on which entries are collected and indexed. This change can be performed at the following levels:

Global level: This means the change will impact all the data collected (or all the data collectors).
Individual data collector level: This means the change will impact the individual data collector specified.

To understand the syntax, examples, and field settings, see:

Syntax

Note

Before you run the command, note the following points:

Set up the CLI. For more information, see Managing-the-product-from-the-command-line-interface.
Prefix this command with the following, as appropriate:
- For Windows: itda.bat
- For Linux: ./itda.sh

configureexternalfields -d <hostname> -p <portNumber> -u <username> -w <password> -ops <operationName> [-l <locale>] [-v] [-s]

Angle brackets (< >) indicate a variable value that needs to be user defined.
Square brackets ([ ]) indicate optional parameters.

The following table describes the parameters used in the syntax:lis

Field settings available for modification

Settings in the following table can be customized by running this command.The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

Example inputs

The following example provides the input for customizing the field setting for indexing and extracting the incident management-related fields for data collector, {{code language="none" source="string:{{code language=~"none~"~}~}
DataCollectorA.
{{/code~}~}"/}}{{/code}}

{{panel borderColor="grey"}}
##configureexternalfields -d localhost -p 9797 -u admin -w admin12345 -ops {{code language="none"}}update{{/code}} (% style="color: rgb(51, 51, 51); color: rgb(51, 51, 51)" %)##-collector DataCollectorA -type incident -key index -value "{{code language="none"}}Incident Number,Entry ID,Description,Submitter,Submit Date,Last Modified Date,Impact,Urgency,Priority,Assignee,Assigned Group{{/code}}"##(%%)
##
{{/panel}}

The following example provides the input for listing data collectors for which field settings were customized.

{{panel borderColor="grey"}}
##configureexternalfields -d localhost -p 9797 -u admin -w admin12345 (% style="color: rgb(51,51,51);" %)##{{code language="none"}}-ops {{/code}}lis##(%%)t
##
{{/panel}}

The following example provides the input for listing the customized field settings for data collector, {{code language="none"}}DCB{{/code}}.

{{panel borderColor="grey"}}
##configureexternalfields -d localhost -p 9797 -u admin -w admin12345 (% style="color: rgb(51, 51, 51); color: rgb(51, 51, 51); color: rgb(51, 51, 51); color: rgb(51, 51, 51)" %){{code language="none"}}-ops list{{/code}} {{code language="none"}}-collector DCB{{/code}}(%%)
##
{{/panel}}

The following example provides the input for clearing the customizations made to all the field settings and restoring the global settings for all the data collected.

{{panel borderColor="grey"}}
##configureexternalfields -d localhost -p 9797 -u admin -w admin12345 (% style="color: rgb(51, 51, 51); color: rgb(51, 51, 51); color: rgb(51, 51, 51); color: rgb(51, 51, 51)" %){{code language="none"}}-ops reset{{/code}}(%%)
##
{{/panel}}

configureexternalfields CLI command

Syntax

Field settings available for modification

Example inputs

On this page