project BLF > class BCustomField > method ApiExportCustomFields

Description

Parameters

Internal usage

program code (program3/bcustomfield.p)

if icBusinessComponentLabel = ?
then icBusinessComponentLabel = "".

if icExportFile = ?
then icExportFile = "".

if icExportFile = ""
then do:
    <M-87 run SetMessage
       (input  trim(#T-16'You must enter the file name.':100(6490)T-16#) (icMessage), 
        input  '' (icArguments), 
        input  '' (icFieldName), 
        input  '' (icFieldValue), 
        input  'E' (icType), 
        input  3 (iiSeverity), 
        input  '' (icRowid), 
        input  'blf-635121':U (icFcMsgNumber), 
        input  '' (icFcExplanation), 
        input  '' (icFcIdentification), 
        input  '' (icFcContext), 
        output viFcReturnSuper (oiReturnStatus)) in BCustomField>
    oiReturnStatus = -1.
    return.
end.

if icBusinessComponentLabel = ""
then vcDLQuery = "".
else if index(icBusinessComponentLabel, "*") = 0
then vcDLQuery = "for each CustomField where CustomField.CustomFieldComponent = " + <M-41 EnQuote  (input  icBusinessComponentLabel (icToQuote)) in BCustomField>.
else do:
    <Q-85 run LanguagePrim (all) (Read) (NoCache)
       (input current-language, (LngCode)
        input ?, (LngID)
        output dataset tqLanguagePrim) in BLanguage>

    find first tqLanguagePrim where
               tqLanguagePrim.tcLngCode = current-language
               no-error.

    if not available tqLanguagePrim
    then do:
        <M-40 run SetMessage
           (input  trim(subst(#T-70'Invalid language code: &1.':255(448)T-70#, current-language)) (icMessage), 
            input  '' (icArguments), 
            input  '' (icFieldName), 
            input  '' (icFieldValue), 
            input  'E' (icType), 
            input  3 (iiSeverity), 
            input  '' (icRowid), 
            input  'blf-951969':U (icFcMsgNumber), 
            input  '' (icFcExplanation), 
            input  '' (icFcIdentification), 
            input  '' (icFcContext), 
            output viFcReturnSuper (oiReturnStatus)) in BCustomField>

        assign oiReturnStatus = -1.
        return.
    end.

    <Q-25 run TranslationsForBusComp (all) (Read) (NoCache)
       (input icBusinessComponentLabel, (TranslationStringText)
        input tqLanguagePrim.tiLng_ID, (LngID)
        output dataset tqTranslationsForBusComp) in BTranslation>

    for each tqTranslationsForBusComp where
             tqTranslationsForBusComp.tiLng_ID = tqLanguagePrim.tiLng_ID:
        vcDLQuery = (if vcDLQuery = ""
                     then "for each CustomField where "
                     else vcDLQuery + " or ")
                  + "CustomField.CustomFieldComponent = " + <M-84 EnQuote  (input  tqTranslationsForBusComp.tcBusComponentCode (icToQuote)) in BCustomField>.
    end.
end.

<M-18 run DataLoad
   (input  '' (icRowids), 
    input  '' (icPkeys), 
    input  '' (icObjectIds), 
    input  vcDLQuery (icFreeform), 
    input  no (ilKeepPrevious), 
    output viFcReturnSuper (oiReturnStatus)) in BCustomField>

/* BLF-4015 Entity maintenance uses BCompany and BCompanyProperty */
if icBusinessComponentLabel = "BCompany"
then do:
    vcDLQuery = "for each CustomField where CustomField.CustomFieldComponent = 'BCompanyProperty'".
    <M-17 run DataLoad
       (input  '' (icRowids), 
        input  '' (icPkeys), 
        input  '' (icObjectIds), 
        input  vcDLQuery (icFreeform), 
        input  yes (ilKeepPrevious), 
        output viFcCount2 (oiReturnStatus)) in BCustomField>
    if viFcReturnSuper = -4
    and viFcCount2 = 0
    then viFcReturnSuper = 0.
end.

if icBusinessComponentLabel = "BDomain"
then do:
    vcDLQuery = "for each CustomField where CustomField.CustomFieldComponent = 'BDomainProperty'".
    <M-1 run DataLoad
       (input  '' (icRowids), 
        input  '' (icPkeys), 
        input  '' (icObjectIds), 
        input  vcDLQuery (icFreeform), 
        input  yes (ilKeepPrevious), 
        output viFcCount2 (oiReturnStatus)) in BCustomField>
    if viFcReturnSuper = -4
    and viFcCount2 = 0
    then viFcReturnSuper = 0.
end.

/* Nothing to export ? Then exit without export. */
if viFcReturnSuper = -4
then return.

if viFcReturnSuper <> 0
then oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then return.

<M-54 run DumpXmlRepresentation
   (input  icExportFile (icFile), 
    input  no (ilHeaderOnly), 
    input  ? (ilSuppressEmptyFields), 
    input  0 (iiPriority), 
    input  no (ilWriteXMLSchema), 
    input  '' (icObjectRowId), 
    input  yes (ilExportForInput), 
    output viFcReturnSuper (oiReturnStatus)) in BCustomField>
if viFcReturnSuper <> 0
then 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 = "BCustomField".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiExportCustomFields".
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/bcustomfield.apiexportcustomfields.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icBusinessComponentLabel = <parameter value>
       vhParameter::icExportFile = <parameter value>.

/* 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.