Configuring the CSV adapter

Adapter type: bmc-ao-adapter-csv-actor_vv.rr.nn

Default adapter name: CSVAdapter

The Properties field in the adapter configuration of Grid Manager is a required field. If the default values are acceptable for all elements, you can enter a configuration node, <config/>, in the Properties field. When you set a configuration node, the adapter uses the default values for all the elements.

BMC recommends that you do not include unused elements in the adapter configuration because they might cause the adapter to enter a fault state.

To configure the CSV actor adapter

1. Log on to the TrueSight Orchestration Grid Manager.
2. Access the adapters page, by clicking the Manage tab; then click the Adapters tab.
3. In the Adapters in Repository list, select the check box corresponding for the type of adapter to be added.
   The adapter type use the following naming convention: ro-adapter- adapter type. For example, the adapter type for the IMAP adapter would be ro-adapter-imap.
4. Click Add to Grid to include the adapter in the Adapters on Grid list.
5.   Click Configure corresponding to the newly added adapter.
6. On the Add an Adapter Configuration page, perform the following substeps to configure the adapter using the form view or jump to step 7 to configure the adapter using the XML view:
   1.   Enter a name for the adapter.
   2.   Enter a description for the adapter.
   3. Under Properties, enter or select values for the configuration elements. 
      
      The configuration elements for each adapter are described in that adapter's section. Include all required elements indicated with an asterisk (*).

   4. (Optional) Click Switch to XML View and use the following steps to specify elements and attributes that are not in the form view.

      Note

      Switching to the XML view to specify those elements and attributes not included in the form means that you cannot thereafter use the form for modifying that configuration. This step is not required for base adapters that can be fully configured using the form.

7. On the Warning message that appears, click Switch View.
8. In the Properties text box, use XML format to enter the configuration elements and attributes not available as fields in the form view.
9. Click OK.
10.   ( optional ) Configure the adapter in the XML view using the following substeps:
    1. Enter a name and a description for the adapter.
    2. Click Switch to XML View.
    3. On the Warning message that appears, click Switch View.
    4. Copy the configuration elements and attributes from the appropriate adapter configuration section into the Properties text box, and then click OK.

       If the default value for an optional element is acceptable, omit the element. Do not include empty elements.

    5. On the Warning message that appears, click Save. 
       
       This saves the adapter configuration with settings in the XML view permanently. The newly configured adapter is now listed in the Adapters on Grid list. 

The following table describes the elements of an actor adapter configuration that you can specify using the form view, XML view, or both. You cannot use the form view to configure elements and attributes that do not have an entry in the "UI label" column. To configure such elements and attributes, you have to switch to XML view.

Node elements for configuring the actor adapter

The following figure describes a sample XML configuration for the CSV adapter.

Sample XML configuration for the CSV adapter

<config>
  <delimiter>,</delimiter>
  <text-qualifier>"</text-qualifier>
  <read-headers>false</read-headers>
  <maximum-rows>0</maximum-rows>
</config>

Encrypting an element's contents

You can add the attribute secure="true" to an XML adapter element XML view to ensure that the element's contents is encrypted when displayed.

Enabling custom logging

To enable custom logging for the adapter, you must specify a log file name. You can also provide additional parameters for logging.

• Log File Name: Provide a name for the log file.
  This file will be stored in the AO_HOME/tomcat/logs directory. If Log File Max Backup Index value is greater than 0, the log file name is suffixed with the backup index. For example, if the parameter value is a.log, backup log files will have names, such as a.log.1, a.log.2.
• Log File Size: Specify a size limit for the log file. 
  If the value specified for Log File Max Backup Index is greater than 0, when the specified size is reached, the current file is renamed with the suffix .1. Otherwise, the log file will be reset and over-written. The default value is 10MB. The available units are KiloBytes (KB), MegaBytes (MB) or GigaBytes (GB).
• Log File Max Backup Index: Enter the maximum number of backup files allowed. The default value is 10.
• Log File Append: Select this option to append new log information to the existing information in the file. If unselected, the file will be overwritten with new log information.

• Log Level: Enter the logging level using one of the following choices:

  Logging level	Description
  DEBUG	The most detailed logging level; logs low-level messages, normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions
  INFO (default)	Logs normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions
  WARN	Logs recoverable erroneous conditions and unrecoverable erroneous conditions
  ERROR	The least detailed logging level; logs only error conditions that are not usually recoverable