project BLF > class BReportVariant > method apiExportCustomization
Description
Export definitions of report variants in standard XML format.
Exports all, or report variants of one report object.
Parameters
| icBusinessComponentLabel | input | character | |
| icBusinessActivityCode | input | character | |
| iiCustomizationLevel | input | integer | |
| icExportFile | input | character | |
| oiReturnStatus | output | integer | Return status of the method. |
Internal usage
unused
program code (program3/breportvariant.p)
if icBusinessComponentLabel = ?
then icBusinessComponentLabel = "".
if icBusinessActivityCode = ?
then icBusinessActivityCode = "".
if icExportFile = ?
then icExportFile = "".
if icExportFile = ""
then do:
<M-62 run SetMessage
(input trim(#T-27'You must enter the file name.':100(6490)T-27#) (icMessage),
input '' (icArguments),
input '' (icFieldName),
input '' (icFieldValue),
input 'E' (icType),
input 3 (iiSeverity),
input '' (icRowid),
input 'blf-571936':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BReportVariant>
oiReturnStatus = -1.
return.
end.
if icBusinessComponentLabel = ""
then vcDLQuery = "for each RptRequest where RptRequest.RptRequestType = 'V'"
+ " and not ( RptRequest.RptRequestName = '" + {&STOREDSEARCH-FACTORY-DEFAULT} + "' )"
+ " and not ( RptRequest.RptRequestName begins '" + {&STOREDSEARCH-LAST-USED} + "' )".
else if index(icBusinessComponentLabel, "*") = 0
then do:
<Q-2 run BusActivityByCompActCode (all) (Read) (NoCache)
(input icBusinessActivityCode, (BusActitvityCode)
input icBusinessComponentLabel, (BusComponentCode)
output dataset tqBusActivityByCompActCode) in BBusinessComponent>
for each tqBusActivityByCompActCode:
vcDLQuery = (if vcDLQuery = ""
then "for each RptRequest where RptRequest.RptRequestType = 'V'"
+ " and not ( RptRequest.RptRequestName = '" + {&STOREDSEARCH-FACTORY-DEFAULT} + "' )"
+ " and not ( RptRequest.RptRequestName begins '" + {&STOREDSEARCH-LAST-USED} + "' ) and ( "
else vcDLQuery + " or ")
+ "RptRequest.BusActivity_ID = "
+ string (tqBusActivityByCompActCode.tiBusActivity_ID).
end.
vcDLQuery = vcDLQuery + " )".
end.
else do:
<Q-37 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-58 run SetMessage
(input trim(subst(#T-48'Invalid language code: &1.':255(448)T-48#, current-language)) (icMessage),
input '' (icArguments),
input '' (icFieldName),
input '' (icFieldValue),
input 'E' (icType),
input 3 (iiSeverity),
input '' (icRowid),
input 'blf-786868':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BReportVariant>
assign oiReturnStatus = -1.
return.
end.
<Q-42 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:
<Q-3 run BusActivityByCompActCode (all) (Read) (NoCache)
(input icBusinessActivityCode, (BusActitvityCode)
input tqTranslationsForBusComp.tcBusComponentCode, (BusComponentCode)
output dataset tqBusActivityByCompActCode) in BBusinessComponent>
for each tqBusActivityByCompActCode:
vcDLQuery = (if vcDLQuery = ""
then "for each RptRequest where RptRequest.RptRequestType = 'V'"
+ " and not ( RptRequest.RptRequestName = '" + {&STOREDSEARCH-FACTORY-DEFAULT} + "' )"
+ " and not ( RptRequest.RptRequestName begins '" + {&STOREDSEARCH-LAST-USED} + "' ) and ( "
else vcDLQuery + " or ")
+ "RptRequest.BusActivity_ID = "
+ string (tqBusActivityByCompActCode.tiBusActivity_ID).
end.
end.
vcDLQuery = vcDLQuery + " )".
end.
<M-60 run DataLoad
(input '' (icRowids),
input '' (icPkeys),
input '' (icObjectIds),
input vcDLQuery (icFreeform),
input no (ilKeepPrevious),
output viFcReturnSuper (oiReturnStatus)) in BReportVariant>
if viFcReturnSuper = -4
then viFcReturnSuper = 0.
if viFcReturnSuper <> 0
then oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then return.
if iiCustomizationLevel = {&CONTROLPROPERTYLAYERTYPE-SYSTEM}
then for each tRptRequestVariant where
tRptRequestVariant.Usr_ID <> 0 and
tRptRequestVariant.Role_ID <> 0:
for each tRptRequest where tRptRequest.RptRequest_ID = tRptRequestVariant.RptRequest_ID:
delete tRptRequest.
end.
for each tRptRequestCBF where tRptRequestCBF.RptRequest_id = tRptRequestVariant.RptRequest_ID:
delete tRptRequestCBF.
end.
for each tRptRequestFilter where tRptRequestFilter.RptRequest_id = tRptRequestVariant.RptRequest_ID:
delete tRptRequestFilter.
end.
for each tRptRequestMail where tRptRequestMail.RptRequest_id = tRptRequestVariant.RptRequest_ID:
delete tRptRequestMail.
end.
delete tRptRequestVariant.
end.
if iiCustomizationLevel = {&CONTROLPROPERTYLAYERTYPE-ROLE}
then for each tRptRequestVariant where
tRptRequestVariant.Role_ID = 0:
for each tRptRequest where tRptRequest.RptRequest_ID = tRptRequestVariant.RptRequest_ID:
delete tRptRequest.
end.
for each tRptRequestCBF where tRptRequestCBF.RptRequest_id = tRptRequestVariant.RptRequest_ID:
delete tRptRequestCBF.
end.
for each tRptRequestFilter where tRptRequestFilter.RptRequest_id = tRptRequestVariant.RptRequest_ID:
delete tRptRequestFilter.
end.
for each tRptRequestMail where tRptRequestMail.RptRequest_id = tRptRequestVariant.RptRequest_ID:
delete tRptRequestMail.
end.
delete tRptRequestVariant.
end.
if iiCustomizationLevel = {&CONTROLPROPERTYLAYERTYPE-USER}
then for each tRptRequestVariant where
tRptRequestVariant.Usr_ID = 0:
for each tRptRequest where tRptRequest.RptRequest_ID = tRptRequestVariant.RptRequest_ID:
delete tRptRequest.
end.
for each tRptRequestCBF where tRptRequestCBF.RptRequest_id = tRptRequestVariant.RptRequest_ID:
delete tRptRequestCBF.
end.
for each tRptRequestFilter where tRptRequestFilter.RptRequest_id = tRptRequestVariant.RptRequest_ID:
delete tRptRequestFilter.
end.
for each tRptRequestMail where tRptRequestMail.RptRequest_id = tRptRequestVariant.RptRequest_ID:
delete tRptRequestMail.
end.
delete tRptRequestVariant.
end.
/* Nothing to export ? Then exit without export. */
if not can-find (first tRptRequest)
then return.
<M-71 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 BReportVariant>
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 = "BReportVariant".
create ttContext.
assign ttContext.propertyName = "methodName"
ttContext.propertyValue = "apiExportCustomization".
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/breportvariant.apiexportcustomization.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icBusinessComponentLabel = <parameter value>
vhParameter::icBusinessActivityCode = <parameter value>
vhParameter::iiCustomizationLevel = <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.