Hooks Implementation
This section lists all hooks OneData supports.
MsValue
Use to specify multi-select values as an array of var char data type. Applicable only to stored procedures.
Extended from: Not applicable.
Includes attributes: Not applicable.
Column
Use to include all properties of a column.
Extended from: Not applicable.
Included attributes | Usage notes | Stored procedures Getter/Setter usage |
name | Name of the column | In Stored procedures: *.name/use <t_column constructor > In Java: getName/setName In Integration Server: Use the given hook specification. |
value | Value of the column Note: For dates, use the format YYYY-MM-DD HH:MI:SS. Where HH should be in the twenty-four hour format. For example: 2012-09-11 13:30:32 | In Stored procedures: iHook package function: iHook.getColumnValue/iHook.setColumnValue In Java: getValue/setValue In Integration Server: Use the given hook specification. |
oldValue | To update existing data, you can retrieve or set the old values in a post-event hook. | In Stored procedures: iHook package function: iHook.getColumnOldValue/use <t_column constructor > In Java: getOldValue/getsetValue In Integration Server: Use the given hook specification. |
primaryKey | Specifies whether the column is a Primary Key column. | In Stored procedures: *.primaryKey/use <t_column constructor > In Java: isPrimaryKey/setPrimaryKey. Additionally, getPrimaryKeyDesc/setPrimaryKeyDesc function is available which uses the value yes. In Integration Server: Use the given hook specification. |
isMultiSelect | | In Stored procedures: *.multiSelect/*.multiSelect  0 - false 1 - true In Java: getIsMultiSelect isMultiSelect/setIsMultiSelect In Integration Server: Use the given hook specification. |
msValue | Retrieves values of the multi select column as a list. | In Stored procedures:iHook.getmscolumnvalue/ use t_column constructor function and iHook.setmscolumnvalue In Java: getMSValues/setMSValues In Integration Server: Use the given hook specification for string list. |
oldMSValue | To update existing data, you can retrieve or set the old values of the multi select column in a post-event hook. | In Stored procedures: iHook.getmscolumnoldvalue / setmscolumnoldvalue In Java: In Integration Server: Use the given hook specification for string list. |
blobValue | Retrieves values of the multi select column as a list. Applicable only to the stored procedure hooks. | In Stored procedures: In Java: getOldMSValues/setOldMSValues In Integration Server: |
clobValue | Retrieves values of the multi select column as a list. Applicable only to the stored procedure hooks. | In Stored procedures: In Java: In Integration Server: |
Row
Represents single data row . Row is a collection of Column.
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
column | Use iHook package function - as shown below: row := t_row(); rows.extend; iHook.setColumnValue (row,<columnName>,<columnValue); | In Stored procedures:iHook package function - getColumn/setColumnValue In Java: In Integration Server: Row is a collection of key value pair. Enter Name of the column as key and Value as value. |
Rows
Specifies a collection of rows. Applicable only to the stored procedure hooks.
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
row | Use database-specific steps to add objects into lists as shown in this example: rows t_rows; rows := t_rows(); rows.extend; rows(rows.last) := row; Note: To retrieve the row count in rowset, use the count function *.rowset.count. | In Stored procedures:*.rowset (n)/<use database-specific steps> In Java: In Integration Server: |
detailedRow
Used instead of Row only in Integration Server. It is a list of Column in a single data row for PL/SQL and Java.
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
columns | Uses Column. | In Stored procedures:Not applicable. In Java: Not applicable. In Integration Server: Not applicable. |
Rowset
Use to specify information for one or more rows in a database table.
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
rows | Specifies list of rows. | In Stored procedures:*.<name of rowset object>/use constructor t_rowset In Java: getRows/addRow & setRows In Integration Server: Use the given hook specification. |
tableName | Specifies the name of the physical table. | In Stored procedures:*.tableName/<use constructor functions> In Java: getTableName/setTableName In Integration Server: Use the given hook specification. |
objectName | Name of the data object. | In Stored procedures:*.objectName/<use constructor functions> In Java: getObjectName/setObjectName In Integration Server: Use the given hook specification. |
objectId | If you know the objectId. | In Stored procedures:*.objectId/<use constructor functions> In Java: getObjectId/setObjectId In Integration Server: Use the given hook specification. |
objectType | Uses the object type to retrieve data object details. Valid object type values are: If tableName is used. If objectName is used. If a virtual row. That is, the data object structure is present in OneData, but data in the row is not present in the database. If metadata is not present. | In Stored procedures:*.objectType/<use constructor functions> In Java: getObjectType/setObjectType In Integration Server: Use the given hook specification. |
detailedRowset
Specifies a list of Column-like Row in PL/SQL and Java. You can only use this hook in Integration Server in place of Row because, in Integration Server, Row represents a list of columns as simple key-value pair.
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
| | In Stored procedures:Not applicable. In Java:Not applicable. In Integration Server: Use the given hook specification. |
ActionRowset
Specifies tabular data and list of data rows along with the type of action to perform for each data.
Extended from: Rowset
Included attributes | Usage notes | Getter/Setter usage |
actionType | Performs the specified DML action: Delete Insert Purge Update Restore | In Stored procedures:*.actionType/<use t_actionRowset constructor> In Java: getActionType/setActionType In Integration Server: Use the given hook specification to get or set the action to perform from the drop-down list: Insert Update Delete |
actionDesc | Specifies the name of the physical table. Sets the description for the DML action performed: Delete Insert Purge Update Restore Applicable only to Java hooks. | In Stored procedures:Not applicable. In Java:getActionTypeDesc/setActionTypeDesc <DML action> The action values are: insert. Insert update. Update delete. Delete purge. Purge • restore. Restore In Integration Server: Use the given hook specification. |
order | Specifies the order of action to be executed. While execution, the actions are sorted in descending order. | In Stored procedures:*.actionOrder/<use t_actionRowset constructor> In Java: getOrder/setOrder In Integration Server: Use the given hook specification. |
conceptualObjectName | Optional. Use to combine the DML action in work flows in the context of the conceptual object. | In Stored procedures:*.conceptualObjectName/<use t_actionRowset constructor> In Java: getConceptualObjectName/setConceptualObjectName In Integration Server: Use the given hook specification. |
conceptualObjectId | Optional. If you know the object ID of the conceptual object, use to combine the DML action in work flows. | In Stored procedures: In Java:getConceptualObjectId/setConceptualObjectId In Integration Server: |
triggersWorkflow | Set a flag for a workflow trigger. Applicable only to Java hooks. | In Stored procedures:Not applicable. In Java:isTriggersWorkflow/setTriggersWorkflow In Integration Server: No applicable. |
detailedActionRowset
Specifies a list of Column-like Row in PL/SQL and Java. You can only use this hook in Integration Server in place of Row because, in Integration Server, Row represents a list of columns as simple key-value pair.
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
| | In Stored procedures:Not applicable. In Java:Not applicable. In Integration Server: Use the given hook specification. |
ShowableRowset
Specifies a Rowset.
Extended from: Rowset
Included attributes | Usage notes | Getter/Setter usage |
selectionType | Specifies the number of rows that are permitted for selection from the allowed values for rowset: User is not permitted to select any rows. User is permitted to select only one row. User is permitted to select multiple rows. Set the output for the user to select from a grid. Grid can be for an existing object or for a virtual object. If existing object, then grid draws as per metadata. | In Stored procedures:getmethod not used/<use t_showablerowset constructor> Valid values are: Unselectable Single Multiple In Java:getSelectionType/setSelectionType Valid values are: Unselectable Single Multiple In Integration Server: Use the given hook specification. Valid values are: Unselectable Single Multiple |
selectionTypeDesc | Specifies the number of rows that are permitted for selection from the allowed values for rowset. Identical to selectionType, but uses description. Applicable only to Java hooks. | In Stored procedures:Not applicable. In Java: getSelectionTypeDesc/setSelectionTypeDesc <selection type value> Valid values are: 1. Unselectable. 2. Single. 3. Multiple. In Integration Server: Use the given hook specification. |
Answer
Provides an answer construction to create the structure for a question.
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
id | Numeric ID of the answer that is returned with the hookInput on the next invocation. | In Stored procedures:*.id/<use t_answer constructor> In Java:getId/setId In Integration Server: Use the given hook specification. |
answerOrder | Specifies the order in which the answer to the hook invocation is to be displayed to user. | In Stored procedures:*.answerOrder/<use t_answer constructor> In Java:getOrder/setOrder In Integration Server: Use the given hook specification. |
text | Specifies the answer text displayed to the user. | In Stored procedures:*.text/<use t_anwser constructor> In Java:getText/setText In Integration Server: Use the given hook specification. |
Answers
Use to include a collection of Answer. Applicable only to stored procedure hooks.
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
Answer | Use database-specific steps to add objects into lists as shown in this example: answers := t_answers (); answer := t_answer (1, 1, 'Insert'); answers.EXTEND; answers (answers.LAST) := answer; | In Stored procedures: -/<use dbspecific steps> In Java:Not applicable. In Integration Server: Not applicable. |
Question
A complex structure that has embedded question text and answers.
When there is a question, the Cancel button appears automatically in the iHook window. Click Cancel to close the iHook window and end the session.
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
text | Text of the answer displayed to users. In the case of Question invocation, the text is displayed to users at the question prompt. | In Stored procedures:*.text/<use t_question constructor> In Java:getText/setText In Integration Server: Use the given hook specification. |
answers | Specifies a collection of Answer. | In Stored procedures:getmethod not used/<use t_question constructor> In Java:getAnswers/addAnswer, setAnswers In Integration Server: Use the given hook specification. |
Form
Use in:
hookOutput.To show a user entry form to prompt the user to enter data.
hookInput. To return a form along with the data provided by the user for the next execution. When a form is displayed on an iHook invocation, you can specify default values to be set on the form.
The following validations are applied to the form when the user clicks the command button in the iHook screen:
Regular expression validation
Reference key validation
Passive constraint validation
Pending reference key validation
Temporal rule validation
Transfer date validation
Validation using data validation script
Rules engine validation
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
objectName | Retrieves the name of the data object. The values are: 1. Object type for object physical tables. 2. Object type for table name. | In Stored procedures:*.objectName/<use t_form constructor functions> In Java:getObjectName/setObjectName In Integration Server: Use the given hook specification. |
objectId | If the user knows the objectId. | In Stored procedures:Not applicable. In Java:getObjectId/setObjectId In Integration Server: Use the given hook specification. |
objectType | Specifies the name of the object to be displayed. The name corresponds to on fo the following object type: Table Data object | In Stored procedures:*.objectType/<use t_form constructor functions> In Java:getObjectType/setObjectType In Integration Server: Use the given hook specification. |
cardinality | Number of forms to display for data insert or edit. | In Stored procedures:*.cardinality/<use t_form constructor functions> In Java:getCardinality/setCardinality In Integration Server: Use the given hook specification. |
rowset | Specifies the rowset. | In Stored procedures:*.rowset/<use t_form constructor functions> In Java:getRowset/setRowset In Integration Server: Use the given hook specification. |
skipReferenceValidation | Specifies whether to skip the reference validations in the object. To skip, use the value 1. | In Stored procedures:*.skipReferenceValidation/*.skipReferenceValidation In Java:getSkipReferenceValidation/setSkipReferenceValidation In Integration Server: Use the given hook specification. |
Forms
Use to include a collection of Form. Applicable only to stored procedure hooks.
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
Form | Use database-specific steps to add object into list as shown in this example: forms := t_forms(); form := t_form(<objname>, 1, 1); forms.extend; forms(forms.last) := form; | In Stored procedures: get : forms(n) set : <use database-specific steps> In Java:Not applicable. In Integration Server: Not applicable. |
Actions
Use to communicate DML actions to OneData.
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
ActionRowset | Represents tabular data with a list of rows handled by a hook, and the type of DML action performed for the data. | In Stored procedures:getmethod not required/<use dbspecific steps to add object into the list> Example: myaction t_actionRowset; myaction := t_actionRowset(*.rowset , <objName>, 1, 'insert'); In Java:getActions/addAction & setActions In Integration Server: Use the given hook specification. |
WorkflowHookDetail
Includes the information to configure external workflow rules. This object represents one approver in a level of the external workflow rule and the object can be linked to another approver at the same level using OR/AND operators.
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
approverId | Sets the approver ID of the current level in the workflow. When used in hookInput, this parameter can only have values hookInput is invoked for external workflows. | In Stored procedures:Not applicable. In Java:getApproverID/setApproverID In Integration Server: Use the given hook specification. |
operator | Specifies the operator used to link the current approver to the next approver in the workflow level. | In Stored procedures:Not applicable. In Java:getOperator/setOperator In Integration Server: Use the given hook specification. |
objectId | Specifies the objectId of the object for which external workflow rule is configured. | In Stored procedures:Not applicable. In Java:getObjectId/setObjectId In Integration Server: Use the given hook specification. |
WorkflowAction
Use to configure external workflow rules for a one level of the workflow pipeline. It contains a collection of WorkflowHookDetail.
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
workflowHookDetailList | Uses the type WorkflowHookDetail | In Stored procedures:Not applicable. In Java: getWorkflowHookDetailList/addWorkflowHookDetail In Integration Server: Use the given hook specification. |
level | Specifies the level of current approvers in the workflow pipeline. | In Stored procedures:Not applicable. In Java:getLevel/setLevel In Integration Server: Use the given hook specification. |
hasMoreLevels | Specifies that there are more workflow rule levels after the current level in the workflow pipeline. | In Stored procedures:Not applicable. In Java: isHasMoreLevels/setHasMoreLevels In Integration Server: Use the given hook specification. |
HookInput
HookInput is the top level object that is passed between OneData and the hook implementations.
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
originalRowset | Belongs to the type ActionRowset. It holds the data row on which the hook is executed. The original data set can have more than one rowset. When used in command hooks, there can be more than one rowset. However, when used in post-hook invocations, there can be only one rowset. | In Stored procedures:*.originalrowset/*.originalrowset In Java:getOriginalRowset/setOriginalRowset In Integration Server: Use the given hook specification. |
selectedRowset | When users are prompted for a response, the selectedRowset value appears. Depending on the selection type (single or multiple), more than one rowset can appear in the selection prompt. | In Stored procedures:*.selectedRowset/- In Java:getSelectedRowset/setSelectedRowset In Integration Server: Use the given hook specification. |
answerId | Use set the answer ID for the answer selected by the user from an available list of possible answers to a question posed. The answer returned determines the next hook invocation. Therefore, only one answer can be returned. | In Stored procedures:*.answerId/- In Java:getAnswerId/setAnswerId In Integration Server: Use the given hook specification. |
invocationNumber | Set the counter if the hook is called multiple times. The initial counter is zero, with increment of one for each subsequent hook invocation. | In Stored procedures:*.invocationNumber/- In Java:getInvocationNumber/setInvocationNumber In Integration Server: Use the given hook specification. |
userId | UserId of the current user. | In Stored procedures:.userId/- In Java:getAnswerId/setAnswerId In Integration Server: Use the given hook specification. |
forms | | In Stored procedures:*.forms/*.forms In Java:getForms/setForms In Integration Server: Use the given hook specification. |
clientId | Retrieves the ID of the current OneData client. | In Stored procedures:*.clientId/- In Java:getClientId/setClientId In Integration Server: Use the given hook specification. |
projectId | Retrieves ID of the current project. | In Stored procedures:*.projectId/- In Java:getProjectId/setProjectId In Integration Server: Use the given hook specification. |
schemaId | Retrieves the ID of the schema currently logged into. | In Stored procedures:*.schemaId/- In Java:getSchemaId/setSchemaId In Integration Server: Use the given hook specification. |
repositoryId | Retrieves the ID of the repository currently connected to. | In Stored procedures:*.repositoryId/- In Java:getRepositoryId/setRepositoryId In Integration Server: Use the given hook specification. |
databaseType | Retrieves the ID of the database type currently connected to. | In Stored procedures:*.databaseType/- In Java:getDatabaseType/setDatabaseType In Integration Server: Use the given hook specification. |
invokedFromWorkflow | Set flag for hookInput to indicate that the hook was invoked from the Workflow Approval page. The value is 1 when the post-hook is invoked from the Workflow Approval page | In Stored procedures: *.invokedFromWorkflow/- In Java: getInvokedFromWorkflow/setInvokedFromWorkflow In Integration Server: Use the given hook specification. |
approverId | Sets the approver ID of the current level in the workflow. When used in hookInput, this parameter can only have values hookInput is invoked for external workflows. | In Stored procedures:*.approverId/*.approverId In Java:getApproverID/setApproverID In Integration Server: Use the given hook specification. |
updatedColName | | In Java:getUpdatedColumnName/setUpdatedColumnName In Integration Server: Use the given hook specification. |
workflowPassPhrase | Retrieves the passphrase, which is a unique string used to identify the transaction in an external workflow. | In Stored procedures:*.workflowPassPhras/*.workflowPassPhrase In Java:getWorkflowPassPhrase/setWorkflowPassPhrase In Integration Server: Use the given hook specification. |
refreshTransaction | Returns the value 1 if a transaction is to be refreshed by an external workflow engine. | In Stored procedures: *.refreshTransaction/*.refreshTransaction In Java: getRefreshTransaction/setRefreshTransaction In Integration Server: Use the given hook specification. |
originalExpandedRowset | Belongs to the type ActionRowset. It holds the data row on which the hook is executed. The original data set can have more than one rowset. When used in command hooks, there can be more than one rowset. However, when used in post-hook invocations, there can be only one rowset. | In Stored procedures:Not applicable. In Java: getOriginalExpandedRowset/setOriginalExpandedRowset In Integration Server: Use the given hook specification. |
detailedOriginalExpandedRowset | Refers to detailedActionRowset which has Column object instead of key value pair. | In Stored procedures:Not applicable. In Java:Not applicable. In Integration Server: Use the given hook specification. |
wfLevelCleared | Relevant for workflow mapped hooks. | In Stored procedures:Not applicable. In Java:getWFLevelCleared/setWFLevelCleared In Integration Server: Use the given hook specification. |
wfActionType | Specifies the action type of the workflow. | In Stored procedures:Not applicable. In Java:getWFActionType/setWFActionType In Integration Server: Use the given hook specification. |
wfRuleName | Specifies the name of the workflow rule. | In Stored procedures:Not applicable. In Java:getWFRuleName/setWFRuleName In Integration Server: Use the given hook specification. |
transType | | In Stored procedures:Not applicable. In Java:getTransactionType/setTransactionType In Integration Server: Use the given hook specification. |
conceptualTransactionId | | In Stored procedures:Not applicable. In Java:getConceptualTransactionId/setConceptualTransactionId In Integration Server: Use the given hook specification. |
wfLevel | | In Stored procedures:Not applicable. In Java:getWfLevel/setWfLevel In Integration Server: Use the given hook specification. |
HookOutput
Use to change the Oracle type HookOutput.
Extended from: Not applicable.
Included attributes | Usage notes | Getter/Setter usage |
invocationNumber | Set the counter if the hook is called multiple times. The initial counter is zero, with increment of one for each subsequent hook invocation. | In Stored procedures:- /*.invocationNumber In Java:getInvocationNumber/setInvocationNumber In Integration Server: Use the given hook specification. |
showableRowset | When the user is prompted to select one or more records, showableRowset appears. Records belong to a persistent object (data object in OneData) or a virtual object. | In Stored procedures:- /*.showRowset In Java: In Integration Server: Use the given hook specification. |
originalRowset | Belongs to the type ActionRowset. It holds the data row on which the hook is executed. The original data set can have more than one rowset. When used in command hooks, there can be more than one rowset. However, when used in post-hook invocations, there can be only one rowset. | In Stored procedures:.originalrowset/*.originalrowset In Java: getOriginalRowset/setOriginalRowset In Integration Server: Use the given hook specification. |
actions | Uses Actions. | In Stored procedures: In Java:getActions/setActions In Integration Server: Use the given hook specification. |
message | Specifies the message to display to users when the event status is complete. | In Stored procedures:- /*.message In Java:getMessage/setMessage In Integration Server: Use the given hook specification. |
forwardHookName | Specifies the name of the hook to which control shifts when the current hook execution is complete. It is used for chain hooks. | In Stored procedures:- /*.forwardHookName In Java: getForwardHookName/setForwardHookName In Integration Server: Use the given hook specification. |
status | Controls the execution of a hook. | In Stored procedures:- /*.status Valid values are: stop continue In Java:getStatus/setStatus Valid values are: 1. To stop hook execution. 2. To continue hook execution. In Integration Server: Use the given hook specification. |
statusDesc | Retrieves or sets the status description of a hook execution. | In Stored procedures:Not applicable. In Java:getStatusDesc/setStatusDesc getStatusDesc/setStatusDesc Valid values are: stop continue In Integration Server: Use the given hook specification. |
question | Uses Question | In Stored procedures: In Java:getQuestion/setQuestion In Integration Server: Use the given hook specification. |
forms | Uses Forms | In Stored procedures: In Java:getForms/setForms In Integration Server: Use the given hook specification. |
workflowActionList | Uses list of WorkflowAction. | In Stored procedures:Not applicable. In Java:getWorkflowActionList/addWorkflowAction In Integration Server: Use the given hook specification. |