Information
Unsupported content This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

Configuring the Script adapter


Adapter type: ro-adapter-script_vv.rr.nn

Default adapter name: ScriptAdapter

To configure the Script adapter, see Configuring base adapters.

The following table describes the adapter configuration elements for the Script adapter that you can specify by 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.


 Configuration node elements for the Script adapter

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.

Warning

Note

You must be using BMC Atrium Orchestrator Platform version 7.8 or later to use the custom logging feature. These parameters will be ignored in earlier versions of BMC Atrium Orchestrator Platform.

These parameters are available with supported adapter versions. See your adapter documentation for details.

  • 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

 System settings for the Language Enablement (LE) feature

  1. Click Start > Control Panel.
  2. Double-click Regional and Language Options.
  3. Click the Regional Options tab, select a regional standard (for example, Chinese PRC), and then click Apply.
  4. Click the Advanced tab and select the same regional standard (for example, Chinese PRC) that you selected in Step 2.
  5. Select the check box under Default user account settings.
  6. Click Apply, and then click OK.
  7. Restart your computer.

    The following figure shows an XML template for the Script adapter configuration.

    XML template of the Script adapter configuration

    <config>
      <script-install-path></script-install-path>
      <handle-script-error></handle-script-error>
    </config>

    The following figure shows an XML sample for the Script adapter configuration.

    XML sample of the Script adapter configuration

    <config>
        <script-install-path>c:/Perl/bin/perl.exe</script-install-path>
        <handle-script-error>true</handle-script-error>
    </config>

    The following figure shows an XML sample for the Script adapter configuration when the adapter supports Language Enablement (LE) and uses Jython (version 2.2.1) scripts.

    XML sample of the Script adapter configuration when the adapter supports LE and uses Jython scripts

    <config>
     <script-install-path>C:\jython2.2.1\jython.jar</script-install-path>
     <handle-script-error>true</handle-script-error>
     <character-set>GB18030</character-set>
    </config> 

    The following figure shows an XML sample for the Script adapter configuration when the adapter supports LE and uses Perl(version 5.14.2) scripts.

    XML sample of the Script adapter configuration when the adapter supports LE and uses Perl scripts

    <config>
     <script-install-path>C:\Perl\bin\perl.exe</script-install-path>
     <handle-script-error>true</handle-script-error>
     <character-set>GB18030</character-set>
    </config> 

 

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

BMC Atrium Orchestrator Content 20.16.03