Table of Contents

Search

  1. Preface
  2. Introduction
  3. Servers
  4. Console Client
  5. Search Clients
  6. Table Loader
  7. Update Synchronizer
  8. Globalization
  9. Siebel Connector
  10. Web Services
  11. ASM Workbench
  12. System Backup and Restore
  13. Batch Utilities

iirconfig-tool Utility

iirconfig-tool Utility

Use the iirconfig-tool utility to retrieve or update the configuration metadata of a system. The configuration metadata includes details about the system, identify table, identity index, identity fields, search configuration, and other system-related configuration.
The iirconfig-tool utility uses the following format:
$SSABIN/iirconfig-tool -p|--print [<Key>] -u|--update [<Key>=<Value>|<File Name>] -h|--host <Connection Details of the Rulebase Server> -r|--rulebase <Name of the Rulebase> -s|--system <Name of the Sysem> [-a|--audit-log [<File Name for Audit Log>]] [-t|--test] [-e|--escape] [-f|--force] [-q|--quiet] [-v|--verbose]
The iirconfig-tool utility uses the following parameters:
-p|--print [<Key>]
Retrieves the configuration metadata of the specified key or all the keys of the specified system. If you do not specify any key, the utility retrieves the configuration metadata of all the keys.
For example, the following command retrieves the Compress_Method value of the (System)SalesSystem key:
$SSABIN/iirconfig-tool -h OrgHost:8080 -r odb:0:myuid/mypassw@oraserv -s SalesSystem -p '(System)SalesSystem:Compress_Method'
Retrieve the configuration metadata of all the keys at least once to view the format of the keys and their values.
-u|--update [<Key>=<Value>|<File Name>]
Updates the value of the specified key or the values of all the keys that you add to the specified input file. If you want to update multiple key values, add all the keys and their values to an input text file and specify the input file name as a parameter.
For example, the following command updates the Compress_Method value of the (System)SalesSystem key to Default:
$SSABIN/iirconfig-tool --host OrgHost:8080 --rulebase odb:0:myuid/mypassw@oraserv --system SalesSystem --update '(System)SalesSystem:Compress_Method=[Default]'
The following command updates the values of all the keys that you add to the
update.txt
file:
$SSABIN/iirconfig-tool --host OrgHost:8080 --rulebase odb:0:myuid/mypassw@oraserv --system SalesSystem --update update.txt
Retrieve the configuration metadata of all the keys to view the format of the keys and their values. In the input file, you can specify the keys and their values in the same format.
-h|--host <Connection Details of the Rulebase Server>
Connection details of the Rulebase server.
Use the following format:
<Host Name of Rulebase Server>:<Port Number>
For example,
-h OrgHost:8080
-r|--rulebase <Name of the Rulebase>
Name of the Rulebase or the dictionary alias of the Rulebase name.
Use the following format for a Rulebase name:
<DB Type>:<Number>:<User>/<Password>@<Service>
For example,
-r odb:0:myuid/mypassw@oraserv
Use the following format for the dictionary alias of a Rulebase name:
ids:<Rulebase Alias>
For example,
ids:rb
-s|--system <Name of the System>
Name of the system. The utility retrieves or updates the metadata information of the specified system.
For example,
-s SalesSystem
-a|--audit-log [<File Name for Audit Log>]
Optional. Name and directory path for the audit log file. The utility adds entries to the log file when you update any key values. By default, the utility creates the
iirconfig-tool-audit.log
file in the current working directory.
-t|--test
Optional. Runs the utility in the test mode and validates the keys and the values that you want to update. If the validation fails, you get a message about the failure. After you successfully validate the keys and the values, you can update them in the system.
For example, the following command validates the format of the (System)SalesSystem:Compress_Method key and its value:
$SSABIN/iirconfig-tool -h OrgHost:8080 -r odb:0:myuid/mypassw@oraserv -s SalesSystem -u '(System)SalesSystem:Compress_Method=[From IDT]' -t
-e|--escape
Optional. Replaces the special characters with their respective URL-encoded characters when you retrieve the configuration metadata of the specified key or all the keys of the specified system.
For example, the following command replaces the special characters with their respective URL-encoded characters in the retrieved metadata:
$SSABIN/iirconfig-tool -h OrgHost:8080 -r odb:0:myuid/mypassw@oraserv -s SalesSystem -p -e
-f|--force
Optional. Forces the utility to update the values of the specified keys without reloading the system even though the update requires a system reload.
-q|--quiet
Optional. Does not include the blank and non-editable keys in the output when you retrieve the configuration metadata of a system.
-v|--verbose
Optional. Displays the values of the updated keys after the utility successfully updates the key values.
For example, the following command updates the Comment parameter of the (System)SalesSystem key:
$SSABIN/iirconfig-tool -h OrgHost:8080 -r odb:0:myuid/mypassw@oraserv -s SalesSystem -u '(System)SalesSystem:Comment=New Value' -v
If the utility successfully updates the (System)SalesSystem key, you get the following output:
(System)testx538:Comment old="Outdated Value" new="New Value"

0 COMMENTS

We’d like to hear from you!