Action Parameters Action Control Mask

3-10 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management

3.1.3.2 Action Name

The second segment of an action statement defines the name of the action. ■ For the Java method action type, the action name is the Java method. ■ For the Load option list action type, the action name is the option list. ■ For the Select query, Execute query, and Select cache query action types, the action name is the query name. For standard Oracle Content Server services, typically uses a prefix to identify the action performed on the database. The possible prefixes for queries are: In the example of the first action of the DELETE_DOC service, the name of the action is QdocInfo. This specifies that a read-only query Q will be performed on the database: 5:QdocInfo:DOC_INFO:6:csUnableToDeleteItemdDocNamecsRevisionNoLongerExists

3.1.3.3 Action Parameters

The third segment of an action statement specifies the parameters that the action requires. If no parameters are required, this segment is left empty two colons appear in place of the parameters. ■ If the action requires parameters, enter the parameters as a comma-delimited list. ■ For the Select cache query action type, the first parameter is the name that the action assigns to the ResultSet returned from the query. This ResultSet can then be referenced in the template page. ■ For the Load option list action type, the parameters are optional. However, if parameters are given, the first parameter is the key under which the option list is loaded, and the second parameter is the selected value for display on an HTML page. In the example of the first action of the DELETE_DOC service, the ResultSet that is returned from the service query will be named DOC_INFO: 5:QdocInfo:DOC_INFO:6:csUnableToDeleteItemdDocNamecsRevisionNoLongerExists

3.1.3.4 Action Control Mask

The fourth segment of an action statement is an optional bit flag that controls the results of queries to the Oracle Content Server database. ■ Control Mask Bit Flag : Used to identify the control mask in the service resource file. The control mask number used in the service resource file represents the sum of the bit flags for all controls being applied. For standard Oracle Content Server services, the control mask bit flag is typically used instead of the control mask string value. ■ Control Mask String Value : Used to identify the control mask in the service resource file. For multiple control masks, the string values are placed in a Query Prefix Description Q Query retrieve information from the database read-only action. D Delete information from the database. I Insert add information in the database. U Update information in the database. Customizing Services 3-11 comma-delimited list. For custom services, the string value is used instead of the control mask bit flag. ■ Component Wizard Identifier : Used to identify the control mask in the Component Wizard. In the service resource file, the control mask is represented by either the sum of its bit flags standard Oracle Content Server services, or a comma-delimited list of bit flag string values custom services. ■ Java Constant : Used to identify the control mask in the Java code. The possible control masks are: In the example of the first action of the DELETE_DOC service, the control mask value is 6, which means that at least one record must be returned by the query 2, and the action starts a database transaction 4: 5:QdocInfo:DOC_INFO:6:csUnableToDeleteItemdDocNamecsRevisionNoLongerExists Control Mask Bit Flag Control Mask String Value Component Wizard Identifier Java Constant Description - - - No control is applied. 1 ignoreError Ignore error CONTROL_IGNORE_ERROR Do not terminate the service on error. 2 mustExist Check result non-empty CONTROL_MUST_EXIST At least one record must be returned by the query, or the action fails. Used only for the Select query and Select cache query action types. 4 beginTran Begin transaction CONTROL_BEGIN_TRAN Starts a database transaction. 8 commitTran Commit transaction CONTROL_COMMIT_TRAN Concludes a database transaction. 16 mustNotExist Check result empty CONTROL_MUST_NOT_EXIST Query must not return any rows, or the action fails. Used only for the Select query and Select cache query action types. 32 retryQuery Retry query CONTROL_RETRY QUERY When the action type is set to Execute query and the query fails, the error will be logged. After three seconds, the query will be run again. If the query fails three times, the service will fail. Used mostly for checking in content. No longer used. 64 doNotLog Do not log CONTROL_DO_NOT_LOG When the action type is set to Select query and the query fails, the service will fail. However, the error will NOT be logged in the system logs. Used internally by when developing components as a debug flag for testing. Note: The Check result non-empty and Check result empty control masks are used only for the Select query and Select cache query action types. See Section 3.1.3.1, Action Type. 3-12 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management If this was a custom service created using the Component Wizard, the sum of the control mask bit flags would be replaced by a comma-delimited list of the bit flag string values: 5:QdocInfo:DOC_INFO:mustExist, beginTran:csUnableToDeleteItemdDocName csRevisionNoLongerExists

3.1.3.5 Action Error Message