project BLF > class BStoredSearch > method ApiExportCustomization
Description
Export definitions of stored searches in standard XML format.
Exports all, or stored searches of one business object.
Parameters
| icBusinessComponentLabel | input | character | |
| iiCustomizationLevel | input | integer | |
| icExportFile | input | character | |
| oiReturnStatus | output | integer | Return status of the method. |
Internal usage
unused
program code (program3/bstoredsearch.p)
if icBusinessComponentLabel = ?
then icBusinessComponentLabel = "".
if icExportFile = ?
then icExportFile = "".
if icExportFile = ""
then do:
<M-94 run SetMessage
(input trim(#T-9'You must enter the file name.':100(6490)T-9#) (icMessage),
input '' (icArguments),
input '' (icFieldName),
input '' (icFieldValue),
input 'E' (icType),
input 3 (iiSeverity),
input '' (icRowid),
input 'blf-274748':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BStoredSearch>
oiReturnStatus = -1.
return.
end.
if icBusinessComponentLabel = ""
then vcDLQuery = "for each StoredSearch where not ( StoredSearch.StoredSearchName = '" + {&STOREDSEARCH-FACTORY-DEFAULT} + "' )"
+ " and not ( StoredSearch.StoredSearchName begins '" + {&STOREDSEARCH-LAST-USED} + "' )".
else if index(icBusinessComponentLabel, "*") = 0
then vcDLQuery = "for each StoredSearch where not ( StoredSearch.StoredSearchName = '" + {&STOREDSEARCH-FACTORY-DEFAULT} + "' )"
+ " and not ( StoredSearch.StoredSearchName begins '" + {&STOREDSEARCH-LAST-USED} + "' )"
+ " and StoredSearch.StoredSearchLookupRef matches "
+ <M-11 EnQuote (input '*/' + icBusinessComponentLabel + '~.*' (icToQuote)) in BStoredSearch>.
else do:
<Q-60 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-23 run SetMessage
(input trim(subst(#T-30'Invalid language code: &1.':255(448)T-30#, current-language)) (icMessage),
input '' (icArguments),
input '' (icFieldName),
input '' (icFieldValue),
input 'E' (icType),
input 3 (iiSeverity),
input '' (icRowid),
input 'blf-413270':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BStoredSearch>
assign oiReturnStatus = -1.
return.
end.
<Q-10 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 StoredSearch where not ( StoredSearch.StoredSearchName = '" + {&STOREDSEARCH-FACTORY-DEFAULT} + "' )"
+ " and not ( StoredSearch.StoredSearchName begins '" + {&STOREDSEARCH-LAST-USED} + "' ) and ( "
else vcDLQuery + " or ")
+ "StoredSearch.StoredSearchLookupRef matches "
+ <M-86 EnQuote (input '*/' + tqTranslationsForBusComp.tcBusComponentCode + '~.*' (icToQuote)) in BStoredSearch>.
end.
vcDLQuery = vcDLQuery + " )".
end.
if iiCustomizationLevel = {&CONTROLPROPERTYLAYERTYPE-SYSTEM}
then vcDLQuery = vcDLQuery + " and StoredSearch.Usr_ID = 0 and StoredSearch.Role_ID = 0".
if iiCustomizationLevel = {&CONTROLPROPERTYLAYERTYPE-ROLE}
then vcDLQuery = vcDLQuery + " and StoredSearch.Role_ID <> 0".
if iiCustomizationLevel = {&CONTROLPROPERTYLAYERTYPE-USER}
then vcDLQuery = vcDLQuery + " and StoredSearch.Usr_ID <> 0".
<M-79 run DataLoad
(input '' (icRowids),
input '' (icPkeys),
input '' (icObjectIds),
input vcDLQuery (icFreeform),
input no (ilKeepPrevious),
output viFcReturnSuper (oiReturnStatus)) in BStoredSearch>
/* Nothing to export ? Then exit without export. */
if viFcReturnSuper = -4
then return.
if viFcReturnSuper <> 0
then oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then return.
<M-61 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 BStoredSearch>
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 = "BStoredSearch".
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/bstoredsearch.apiexportcustomization.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icBusinessComponentLabel = <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.