insert_journal action

This option uses the 'insert_journal' action to insert a record into the alerts.journal schema of the Tivoli Netcool/OMNIbus database. The following table describes the request elements for an actor adapter with insert_journal action.

Elements of an actor adapter request with insert_journal action

Element	Description	Required
`<UID>`	Specifies the user ID of the owner of the record that will be updated	Yes
`<Serial>`	Specifies the serial ID number of the record that will be updated	Yes
`<Text>`	Specifies the text that will be written to update a journal record Note: The maximum length of individual text entry in the Tivoli Netcool/OMNIbus database is 255 characters. If the text string exceeds this length, it is split to accommodate up to 16 segments, with each Netcool/OMNIbus entry containing 255 characters or less.	Yes

The following figure shows an XML template of an actor adapter request with insert_journal action.

XML template for an actor adapter request with insert_journal action


<OMNIbusAdapterRequest>
 <UID></UID>
 <Serial></Serial>
 <Text></Text>
</OMNIbusAdapterRequest>

The following figure shows an XML sample of an actor adapter request with insert_journal action. Use the adapter request XML when you create a custom process by using the Call Adapter activity in TrueSight Orchestration Development Studio.

XML sample for an actor adapter request with insert_journal action


<OMNIbusAdapterRequest>
 <UID>owner ID of record to be updated</UID>
 <Serial>serial ID of record to be updated</Serial>
 <Text>text to be written to journal</Text>
</OMNIbusAdapterRequest>

The actor adapter request returns a response that contains the results of an SQL query executed to insert the specified values into the alerts.journal schema.

The following table describes the elements of the Tivoli Netcool/OMNIbus adapter response to a request with the insert_journal action.

Elements of Tivoli Netcool/OMNIbus adapter response to a request with insert_journal action

Element	Description
`<metadata>`	Contains the response level summary information from an SQL query
`<queryExecuted>`	Contains the syntax of the SQL query statement defined in the OMNIbus adapter request
`<status>`	Indicates the status of the command execution Valid values: success, error
`<error>`	Contains the error message in the event of a command level error When the value of the `<status>` is success, the `<error>` element will not be present.

The following figure shows an XML sample of the Tivoli Netcool/OMNIbus adapter response with the insert_journal action.

XML sample for adapter response with insert_journal action


<omnibus-response>
 <metadata>
 <queryExecuted>INSERT into alerts.journal (KeyField, Serial, UID,
  Chrono, Text1) values ('1:1:1149860750580',1,1,11489860750,
  ('1:1:1149860750580',1,1,11489860750, text to be inserted);
 </queryExecuted>
 <status>success</status>
 <error>present only with status of 'error'</error
 </metadata>
<omnibus-response>

insert_journal action

Comments