Updating the custom data source type

Update the custom data source type that you created earlier to include additional fields. All data sources based on this data source type will automatically update to include the fields that you added.

Before you begin

You must have already created a custom data source type, as described in Creating a custom data source type.

About this task

The following procedure describes how to add a field to an existing data source type.
Restriction: You can add additional fields to the data source type at any time; however, once data has been ingested using a data source based on this type, you cannot modify or delete any of the added fields.

Procedure

  1. Go to the following location:
  2. Edit the omnibus1100_template.properties file using a text editor of your choice, for example, vi:
    vi omnibus1100_template.properties
    The omnibus1100_template.properties file contains index definitions corresponding to one or more fields to be sent using the data source. For the Netcool®/OMNIbus data source all of the event fields must be indexed, so the omnibus1100_template.properties file contains an index entry for each event field to be sent to Operations Analytics - Log Analysis.
  3. Add the new custom field to the end of the omnibus1100_template.properties file.
    The following code snippet shows the beginning of the file and the end of the file.
    # Properties file controlling data source specification
    # Add new fields at the end of the file 
    # 'moduleName' specifies the name of the data source. 
    # Update the version number if you have created a data source with the same name previously and want 
    # to upgrade it to add an additional field. 
    
    <existing index definitions, one for each of the default event fields> 
    
    # ----------------------------------------------------------------------------------------------
    # Insert new fields after this point. 
    # Number each field sequentially, starting with 'field19'. 
    # See the IBM Smart Cloud Log Analytics documentation for the DSV Toolkit for an explanation 
    # of the field values. 
    # ------------------------------------------------------------------------------------------------
    #[field19_indexConfig] 
    #name: <INDEX NAME> 
    #dataType: TEXT 
    #retrievable: true 
    #retrieveByDefault: true 
    #sortable: false 
    #filterable: true
    The end of the file includes a commented out section which you can uncomment to add the new field. In that section, replace the name: attribute with the name of the field that you are adding.
    Here is what the end of file looks like when an index has been added for new custom field TicketNumber:
    # ----------------------------------------------------------------------------------------------
    # Insert new fields after this point. 
    # Number each field sequentially, starting with 'field19'. 
    # See the IBM Smart Cloud Log Analytics documentation for the DSV Toolkit for an explanation 
    # of the field values. 
    # ------------------------------------------------------------------------------------------------
    [field19_indexConfig] 
    name: Ticket_Number 
    dataType: TEXT 
    retrievable: true 
    retrieveByDefault: true 
    sortable: false 
    filterable: true
    Note: The order of indexes is important; it must match the order of values specified in the Gateway for Message Bus mapping file. This mapping file will be modified later in the procedure.
    For more information on the other attributes of the index, see the following Operations Analytics - Log Analysis topics:
  4. In the [DSV] section of the file, increase the value of the version parameter.
  5. Save the omnibus1100_template.properties file and exit the file editor.
  6. From within the /home/user/OMNIbusINsightPack_v1.3.1/docs directory, run the addIndex.sh script to update the data source type.
    addIndex.sh -u
    Restriction: You can add additional fields to the data source type at any time; however, once data has been ingested using a data source based on this type, you cannot modify or delete any of the added fields.