iKnowBase


Package IKB_TRANSFORMATION_SERVICE


Field Summary
 INTEGERMAX_AGE_EDITION CONSTANT := 300
          
 INTEGERMAX_AGE_BLOB CONSTANT := 86400
          
 VARCHAR2(60)BATCH_TRANSFORMATION_Q CONSTANT := UPPER(IKB_GLOBAL_PREFS.PROVIDER_SCHEMA) || '.BATCH_TRANSFORMATION_Q'
          
 INTEGERMAXWAITRESPONSE CONSTANT := 10
          

Method Summary
 VARCHAR2 CLEANUP(P_MAX_AGE_EDITION IN INTEGER, P_MAX_AGE_BLOB IN INTEGER DEFAULT IKB_TRANSFORMATION_SERVICE.MAX_AGE_BLOB)
           Cleanup the transformation cache
 VARCHAR2 CLEANUP()
           Cleanup the transformation cache with the default settings.
 VARCHAR2 GET_TRANSFORMATION(P_KEY IN VARCHAR2 DEFAULT NULL, P_EXTENSION IN VARCHAR2 DEFAULT NULL)
           Find the actual instruction based on a transformation key.
  GET_TRANSFORMATION(P_KEY IN VARCHAR2 DEFAULT NULL, P_EXTENSION IN VARCHAR2 DEFAULT NULL, P_INSTRUCTION OUT VARCHAR2, P_OUTPUT_EXTENSION OUT VARCHAR2)
           Find the actual instruction based on a transformation key.
 OT_TRANSFORMATION_BASE PROCESS(P_REQUEST IN OT_TRANSFORMATION_BASE, P_MAXWAITRESPONSE IN NUMBER DEFAULT NULL)
           Find the actual BLOB by either a document, a versioned document or a document attribute and passes it to the Content Transformation Service with a transformation instruction.
 BLOB PROCESS(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT_REFERENCE IN OT_DOCUMENT_REFERENCE, P_DOCUMENT_ATTRIBUTE_GUID IN RAW DEFAULT NULL, P_TRANSFORMATION IN VARCHAR2, P_MAXWAITRESPONSE IN NUMBER DEFAULT NULL)
           Find the actual BLOB by either a document, a versioned document or a document attribute and passes it to the Content Transformation Service with a transformation instruction.
 BLOB PROCESS(P_FILE IN BLOB, P_TRANSFORMATION IN VARCHAR2, P_MAXWAITRESPONSE IN NUMBER DEFAULT NULL)
           Find the actual BLOB by either a document, a versioned document or a document attribute and passes it to the Content Transformation Service with a transformation instruction.

Field Detail

BATCH_TRANSFORMATION_Q

        public VARCHAR2(60) BATCH_TRANSFORMATION_Q CONSTANT := UPPER(IKB_GLOBAL_PREFS.PROVIDER_SCHEMA) || '.BATCH_TRANSFORMATION_Q'

MAX_AGE_BLOB

        public INTEGER MAX_AGE_BLOB CONSTANT := 86400

MAX_AGE_EDITION

        public INTEGER MAX_AGE_EDITION CONSTANT := 300

MAXWAITRESPONSE

        public INTEGER MAXWAITRESPONSE CONSTANT := 10

Method Detail

CLEANUP

public VARCHAR2 CLEANUP(P_MAX_AGE_EDITION IN INTEGER, 
P_MAX_AGE_BLOB IN INTEGER DEFAULT IKB_TRANSFORMATION_SERVICE.MAX_AGE_BLOB)
Cleanup the transformation cache
Parameters:
P_MAX_AGE_EDITION - Removes editions older than (sysdate - p_max_age_edition), with only the latest edition remaining. p_max_age_edition is given in seconds
P_MAX_AGE_BLOB - Removes editions with no reference to documents older than (sysdate - p_max_age_blob). p_max_age_blob is given in seconds
Returns:
A string with information about the deleted editions.


CLEANUP

public VARCHAR2 CLEANUP()
Cleanup the transformation cache with the default settings. max_age_edition will be set to ikb_transformation_service.max_age_edition and max_age_blob will be set to ikb_transformation_service.max_age_blob
Returns:
A string with information about the deleted editions.


GET_TRANSFORMATION

public VARCHAR2 GET_TRANSFORMATION(P_KEY IN VARCHAR2 DEFAULT NULL, 
P_EXTENSION IN VARCHAR2 DEFAULT NULL)
Find the actual instruction based on a transformation key. It will validate on format/extension. If the key is missing, it will return the input value (p_key) as instruction.
Parameters:
P_KEY - Transformation key
P_EXTENSION - Extension for the input object.
Returns:
The transformation key


GET_TRANSFORMATION

public  GET_TRANSFORMATION(P_KEY IN VARCHAR2 DEFAULT NULL, 
P_EXTENSION IN VARCHAR2 DEFAULT NULL,
P_INSTRUCTION OUT VARCHAR2,
P_OUTPUT_EXTENSION OUT VARCHAR2)
Find the actual instruction based on a transformation key. It will validate on format/extension. Raises error if the key does not match a registered transformation. Null output format means that there was no explicit format set on the transformation and the caller should use the original format/extension.
Parameters:
P_KEY - Transformation key
P_EXTENSION - Extension for the input object.
P_INSTRUCTION - Output - The transformation instruction for this extension
P_OUTPUT_EXTENSION - Output - The extension of the transformed object


PROCESS

public OT_TRANSFORMATION_BASE PROCESS(P_REQUEST IN OT_TRANSFORMATION_BASE, 
P_MAXWAITRESPONSE IN NUMBER DEFAULT NULL)
Find the actual BLOB by either a document, a versioned document or a document attribute and passes it to the Content Transformation Service with a transformation instruction.
Parameters:
P_REQUEST - Reference to the request defined in the object type ot_transformation_req
P_MAXWAITRESPONSE - Specifies how long it should wait for a response from the transformation service.
Returns:
A response that can be a ot_transformation_res_metadata or ot_transformation_res_data. They are both returned by the super-type ot_transformation_base. To identity which of them are returned, you can test like this : IF (responses IS OF (ONLY ot_transformation_res_data))


PROCESS

public BLOB PROCESS(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT_REFERENCE IN OT_DOCUMENT_REFERENCE,
P_DOCUMENT_ATTRIBUTE_GUID IN RAW DEFAULT NULL,
P_TRANSFORMATION IN VARCHAR2,
P_MAXWAITRESPONSE IN NUMBER DEFAULT NULL)
Find the actual BLOB by either a document, a versioned document or a document attribute and passes it to the Content Transformation Service with a transformation instruction.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DOCUMENT_REFERENCE - Reference to the document to be retrieved
P_DOCUMENT_ATTRIBUTE_GUID - Specifies how the object guid to the attribute that holds the content to be transformed.
P_TRANSFORMATION - Specifies the transformation instruction.
P_MAXWAITRESPONSE - Specifies how long it should wait for a response from the transformation service.
Returns:
The transformed object


PROCESS

public BLOB PROCESS(P_FILE IN BLOB, 
P_TRANSFORMATION IN VARCHAR2,
P_MAXWAITRESPONSE IN NUMBER DEFAULT NULL)
Find the actual BLOB by either a document, a versioned document or a document attribute and passes it to the Content Transformation Service with a transformation instruction.
Parameters:
P_FILE - Reference to actual BLOB to be transformed
P_TRANSFORMATION - Specifies the transformation instruction.
P_MAXWAITRESPONSE - Specifies how long it should wait for a response from the transformation service.
Returns:
The transformed object


iKnowBase