configureexternalfields CLI command


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

  • 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:

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.

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}}

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*