method StoreDocument

Description

Store a document in the application database, and link it to parent object.
If the document already exists, it will be replaced.

Parameters

icBusinessComponent	input	character	Business component name of the parent object
iiObjectId	input	integer	Identity value of the parent object
tDocumentSegments	input	temp-table	Contents of the document to store, serialized with base64 encoding and split up in segments of maximum 4K characters.
icFileName	input	character	file name to be added to the document properties (informational only)
ilOpenDocument	input	logical	automatically open the document when opening the parent object in a UI form
iiSize	input	integer
oiDocumentLinkID	output	integer	Identity value of the document
oiReturnStatus	output	integer	Return status of the method.

Internal usage

BLF

method BDocumentLink.SerializeAndStoreDocument

program code (program3/bdocumentlink.p)

if icBusinessComponent = "" or
   icBusinessComponent = ?  or
   iiObjectId          = 0  or
   iiObjectId          = ?
then do:
    <M-1 run SetMessage
       (input  trim(#T-11'Parent object is missing.':100(475)t-11#) (icMessage), 
        input  '' (icArguments), 
        input  '' (icFieldName), 
        input  '' (icFieldValue), 
        input  'S' (icType), 
        input  3 (iiSeverity), 
        input  '' (icRowid), 
        input  'BLF-67':U (icFcMsgNumber), 
        input  '' (icFcExplanation), 
        input  '' (icFcIdentification), 
        input  '' (icFcContext), 
        output viFcReturnSuper (oiReturnStatus)) in BDocumentLink>

    assign oiReturnStatus = -1.
    return.
end.

if icFileName = "" or
   icFileName = ?
then return.

assign vcFreeform = "for each DocumentLink where"                       +
                    "         DocumentLink.DocumentLinkDescription = '" + icFileName          + "' and" +
                    "         DocumentLink.DocumentLinkComponent   = '" + icBusinessComponent + "' and" +
                    "         DocumentLink.DocumentLinkInternal_ID = "  + string (iiObjectId).

<M-10 run DataLoad
   (input  '' (icRowids), 
    input  '' (icPkeys), 
    input  '' (icObjectIds), 
    input  vcFreeform (icFreeform), 
    input  no (ilKeepPrevious), 
    output viFcReturnSuper (oiReturnStatus)) in BDocumentLink>

if viFcReturnSuper = -4
then do:
    <M-5 run DataNew  (output viFcReturnSuper (oiReturnStatus)) in BDocumentLink>
end.

if viFcReturnSuper <> 0
then assign oiReturnStatus = viFcReturnSuper.

if viFcReturnSuper < 0
then return.

find first tDocumentLink
           no-error.

assign oiDocumentLinkID = tDocumentLink.DocumentLink_ID.

/* Delete old document */
for each tDocumentStorage:
    assign tDocumentStorage.tc_Status = "D".
end.

/* Add new document */
assign viFcCount1 = 0.

for each tDocumentSegments on error undo, throw:
    <M-6 run AddDetailLine
       (input  'DocumentStorage' (icTable), 
        input  tDocumentLink.tc_Rowid (icParentRowid), 
        output viFcReturnSuper (oiReturnStatus)) in BDocumentLink>

    if viFcReturnSuper <> 0
    then assign oiReturnStatus = viFcReturnSuper.

    if viFcReturnSuper < 0
    then return.

    assign viFcCount1                                = viFcCount1 + 1
           tDocumentStorage.DocumentStorageSegmentNr = viFcCount1
           tDocumentStorage.DocumentStorageString    = tDocumentSegments.tcDocumentStorageString.
end.

assign tDocumentLink.DocumentLinkComponent     = icBusinessComponent
       tDocumentLink.DocumentLinkDate          = today
       tDocumentLink.DocumentLinkDescription   = icFileName
       tDocumentLink.DocumentLinkExternStorage = no
       tDocumentLink.DocumentLinkExternalUrl   = ""
       tDocumentLink.DocumentLinkInternal_ID   = iiObjectId
       tDocumentLink.DocumentLinkSegments      = viFcCount1
       tDocumentLink.DocumentLinkOpenDocument  = ilOpenDocument
       tDocumentLink.DocumentLinkSize          = iiSize
       tDocumentLink.Usr_ID                    = viUsrId.

if tDocumentLink.tc_Status = ""
then assign tDocumentLink.tc_Status = "C".

<M-7 run ValidateBC  (output viFcReturnSuper (oiReturnStatus)) in BDocumentLink>

if viFcReturnSuper <> 0
then assign oiReturnStatus = viFcReturnSuper.

if viFcReturnSuper < 0
then return.

<M-8 run AdditionalUpdates  (output viFcReturnSuper (oiReturnStatus)) in BDocumentLink>

if viFcReturnSuper <> 0
then assign oiReturnStatus = viFcReturnSuper.

if viFcReturnSuper < 0
then return.

<M-9 run DataSave  (output viFcReturnSuper (oiReturnStatus)) in BDocumentLink>

if viFcReturnSuper <> 0
then assign oiReturnStatus = viFcReturnSuper.

if viFcReturnSuper < 0
then return.

Sample code: how to call this method through RPCRequestService (QXtend Inbound)

define temp-table ttContext no-undo
    field propertyQualifier as character
    field propertyName as character
    field propertyValue as character
    index entityContext is primary unique
        propertyQualifier
        propertyName
    index propertyQualifier
        propertyQualifier.

define dataset dsContext for ttContext.

define variable vhContextDS as handle no-undo.
define variable vhExceptionDS as handle no-undo.
define variable vhServer as handle no-undo.
define variable vhInputDS as handle no-undo.
define variable vhInputOutputDS as handle no-undo.
define variable vhOutputDS as handle no-undo.
define variable vhParameter as handle no-undo.

/* Create context */
create ttContext.
assign ttContext.propertyName = "programName"
       ttContext.propertyValue = "BDocumentLink".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "StoreDocument".
create ttContext.
assign ttContext.propertyName = "applicationId"
       ttContext.propertyValue = "fin".
create ttContext.
assign ttContext.propertyName = "entity"
       ttContext.propertyValue = "1000".
create ttContext.
assign ttContext.propertyName = "userName"
       ttContext.propertyValue = "mfg".
create ttContext.
assign ttContext.propertyName = "password"
       ttContext.propertyValue = "".

/* Create input dataset */
create dataset vhInputDS.
vhInputDS:read-xmlschema("file", "xml/bdocumentlink.storedocument.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icBusinessComponent = <parameter value>
       vhParameter::iiObjectId = <parameter value>
       vhParameter::icFileName = <parameter value>
       vhParameter::ilOpenDocument = <parameter value>
       vhParameter::iiSize = <parameter value>.

vhParameter = vhInputDS:get-buffer-handle("tDocumentSegments").
vhParameter:buffer-create().
assign vhParameter::<field-name-1> = <field-value-1>
       vhParameter::<field-name-2> = <field-value-2>
       ...

/* Connect the AppServer */
create server vhServer.
vhServer:connect("-URL <appserver-url>").

if not vhServer:connected()
then do:
    message "Could not connect AppServer" view-as alert-box error title "Error".
    return.
end.

/* Run */
assign vhContextDS = dataset dsContext:handle.

run program/rpcrequestservice.p on vhServer
    (input-output dataset-handle vhContextDS by-reference,
           output dataset-handle vhExceptionDS,
     input        dataset-handle vhInputDS by-reference,
     input-output dataset-handle vhInputOutputDS by-reference,
           output dataset-handle vhOutputDS).

/* Handle output however you want, in this example, we dump it to xml */
if valid-handle(vhExceptionDS)
then vhExceptionDS:write-xml("file", "Exceptions.xml", true).

if valid-handle(vhOutputDS)
then vhOutputDS:write-xml("file", "Output.xml", true).

/* Cleanup */
vhServer:disconnect().
assign vhServer = ?.

if valid-handle(vhInputDS)
then delete object vhInputDS.

if valid-handle(vhOutputDS)
then delete object vhOutputDS.

if valid-handle(vhExceptionDS)
then delete object vhExceptionDS.