Page tree
Skip to end of metadata
Go to start of metadata

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

ParameterDescription
-d
Host name of the Console Server
-p
Port number of the Console Server.
-u
User name to use to connect with the Console Server.
-w
Password corresponding to the user name to use to connect with the Console Server.
-ops

 

 

Name of the operation that you want to perform.

Based on the operation type, the value can be:

OperationValue
List field settings (global and customized) and list data collectors for which field settings were customized.
To list the global field settings, run the list operation with the application type (type parameter).

Specify the value, -ops list -type <applicationType>. 

In the preceding syntax, applicationType refers to the application type – change or incident.

Examples:  

  • -ops list -type change
  • -ops list -type incident
To list data collectors for which field settings were customized, run the list operation only.

Specify the value, -ops list.

To list the customized field settings, run the list operation with the name of the data collector (collector parameter).

Specify the value, -ops list -collector <collectorName>. 

In the preceding syntax, collectorName refers to the name of a data collector as it appears on the Administration > Data Collectors page.

Example: -ops list -collector DataCollA

Update field settings by adding or removing values for the specified field setting and in context of the specified application type for an individual data collector or globally (for all the data collectors).

To update field settings globally (for all data collectors), run the update operation with the application type (type parameter).

Note: When you update field settings globally, it means the change will be applied across all the data collectors, but only to those field settings that are not already customized.

Example: Suppose you have three data collectors Collector1, Collector2, and Collector3. Suppose, you updated the value for the index field setting for  Collector2 only. Now, if you try to update the value of the same setting globally, the change will be applied to Collector1 and Collector3 only. But suppose if you try to change the worknotes field setting globally, the change will be applied to all the data collectors because this field setting has not been changed for any of the data collectors. 

To update field settings for an individual data collector, run the update operation with the application type (type parameter) and the data collector name (collector parameter).

Additionally, provide the following inputs:

  • To add or remove a field value, provide the field name (key parameter) and the corresponding value (value parameter).
  • To add or remove more than one field value, provide the path to a text file containing the new inputs (f parameter).

If you provide a text file as input: Note that the text file must include the name of the field setting for which you want to change values and the value must be a comma-separated list of entries (or fields). For more information about which settings can be customized, see Field settings available for modification.

The field setting and value must be separated by a semi-colon (;), see sample file.

The value that you provide in the file as input, overrides the current value of that setting (to apply both addition and deletions).

If you exclude a field setting from the file provided as input, then that setting is not updated.

Specify the value in one of the following ways:

  • To add or remove a field value, specify the following value:
    • For all data collectors: 
      -ops update -type <applicationType> -key <fieldName> -value "<fieldValue>"
    • For an individual data collector: 
      -ops update -collector <collectorName> -type <applicationType> -key <fieldName> -value "<fieldValue>"
  • To add or remove more than one field value, specify the following value:
    • For all data collectors:
      -ops update -type <applicationType> -f <fileDetails>
    • For an individual data collector:
      -ops update -collector <collectorName> -type <applicationType> -f <fileDetails>

In the preceding syntax, the following definitions apply:

  • applicationType refers to the application type – change or incident.
  • fieldName refers to a field name that you want to add or an existing field name for which you want to change the value.
  • fieldValue refers to the value (or the new value) corresponding to the field name specified. The value must be enclosed in double quotes.
  • fileDetails refers to the complete path to the file containing details of the new fields or fields with new values.
  • collectorName refers to the name of a data collector as it appears on the Administration > Data Collectors page.

Examples:

  • -ops update -collector DataCollA -type incident  -key index -value "Incident Number,Entry ID,Description,Submitter,Submit Date,Last Modified Date,Impact,Urgency,Priority,Assignee,Assigned Group"
  • -ops update -type change -f C:\My Documents\NewFieldSettings_Change.txt
  • -ops update -collector DataCollB -type change -f C:\My Documents\NewFieldSettings_Change.txt
Clear any customizations (or changes) made to field settings and restore the global settings for an individual data collector or globally (for all the data collectors).

To clear customizations for the specified data collector, run the reset operation with the data collector name (collector parameter).

Specify the value, -ops reset -collector <collectorName>. 

In the preceding syntax, collectorName refers to the name of a data collector as it appears on the Administration > Data Collectors page.

Example: -ops reset -collector DataCollectorA

To clear customizations globally (for all data collectors), run the reset operation only.

Specify the value, -ops reset -type <applicationType>.

In the preceding syntax, applicationType refers to the application type – change or incident.

Examples:  

  • -ops reset -type change
  • -ops reset -type incident
-l

(Optional) Indicates the locale in which you want to display messages when the command is run.

You can set one of the following locales:

  • English
  • Simplified Chinese
  • German
  • French

By default, the messages are displayed in the locale of the system on which the CLI is run.

The value can be set to one of the following depending on the locale you choose:

  • English: en
  • Simplified Chinese: chs
  • German: de
  • French: fr

Example: If you want to set the locale as Simplified Chinese, you need to specify, l=chs.

-v
(Optional) Version of the IT Data Analytics product.
-s
(Optional) Indicates an HTTPS connection.

Field settings available for modification

Settings in the following table can be customized by running this command.

Setting nameDescription
form

Indicates the change management (or the incident management) application from which you want to collect entries (or fields).

 See examples

form=CHG:Infrastructure Change


form=HPD:Help Desk

fields

Indicates a comma-separated list of total entries collected from the change management (or the incident management) form specified. For more information, see List of entries (or fields) collected by default.

The entry names specified in the value must be derived from the REST API response used for getting details of multiple entries. For more information, see REST API for getting details of multiple entries.

 See examples

fields=Infrastructure Change ID,Request ID,Description,Submitter,Submit Date,Last Modified Date,Status History,Impact,Urgency,Priority,Change Type,Risk Level,Change Request Status,Categorization Tier 1,Categorization Tier 2,Categorization Tier 3,Product Cat Tier 1,Product Cat Tier 2,Product Cat Tier 3


fields=Incident Number,Entry ID,Description,Submitter,Submit Date,Last Modified Date,Status History,Impact,Urgency,Priority,Categorization Tier 1,Categorization Tier 2,Categorization Tier 3,Product Categorization Tier 1,Product Categorization Tier 2,Product Categorization Tier 3,Assignee,Assigned Group,Assigned Support Organization,Assigned Support Company

index

Indicates a comma-separated list of change management-related entries (or incident management-related entries) to be indexed and extracted as fields.

 See examples

index=Infrastructure Change ID,Request ID,Description,Submitter,Submit Date,Last Modified Date,Impact,Urgency,Priority,Change Type,Risk Level,Change Request Status,Assigned Support Company,Assigned Support Organization,Status Reason,Change Timing,SLM Status


index=Incident Number,Entry ID,Description,Submitter,Submit Date,Last Modified Date,Impact,Urgency,Priority,Assignee,Assigned Group,Assigned Support Organization,Assigned Support Company,Status,Company,SLM Status

worknotesform

Indicates the change management (or incident management) application from which you want to collect work notes information.


 See examples

worknotesform=CHG:CRQ:Worklog


worknotesform=HPD:INC:Worklog

worknotes

Indicates a comma-separated list of entries (or fields) from the work notes section that must be collected and indexed from the change management (or the incident management) form specified.

The entry names specified in the value must be derived from the REST API response used for getting details of multiple entries. For more information, see REST API for getting details of multiple entries.

Note: Entries from the work notes section can only be indexed and displayed as part of the raw data (and not extracted fields).

 See examples

worknotes=Submitter,Submit Date,Status,Short Description,Description,Detailed Description,Work Log Submit Date,Work Log Submitter,Work Log Type,Infrastructure Change ID


worknotes=Submitter,Submit Date,Status,Short Description,Description,Detailed Description,Work Log Submit Date,Work Log Submitter,Work Log Type,Incident Entry ID

ciform

Indicates the configuration item (CI) form name associated with the change management (or incident management) application from which you are collecting data.

 See examples

ciform=CHG:CRQ:Associations


ciform=HPD:INC:Associations

cifields

Indicates a comma-separated list of entries (or fields) from the CI form that indicate the host names.

The entry names specified in the value must be derived from the REST API response used for getting details of multiple entries. For more information, see REST API for getting details of multiple entries.

Notes:

 See examples

cifields=Lookup Keyword,Request Description01


cifields=Lookup Keyword,Request Description01

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, DataCollectorA.

configureexternalfields -d localhost -p 9797 -u admin -w admin12345 -ops update -collector DataCollectorA -type incident -key index -value "Incident Number,Entry ID,Description,Submitter,Submit Date,Last Modified Date,Impact,Urgency,Priority,Assignee,Assigned Group"

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

configureexternalfields -d localhost -p 9797 -u admin -w admin12345 -ops list

The following example provides the input for listing the customized field settings for data collector, DCB.

configureexternalfields -d localhost -p 9797 -u admin -w admin12345 -ops list -collector DCB

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.

configureexternalfields -d localhost -p 9797 -u admin -w admin12345 -ops reset