project BLF > class BBusinessComponent > method ApiSynchronise

Description

ApiSynchronise; this method will do the synchronisation (=upload of the classes and activities).


Parameters


tBusinessComponentsBCinputtemp-tableInput temp-table containing the classes
tBusinessActivitiesBCinputtemp-tableInput temp-table containing the classes
tBusinessComponentLabelinputtemp-table
olUpdatesDoneoutputlogicalUpdatesDone; true in cases updates were done
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


BLF
method BSystem.SynchroniseNavig


program code (program9/bbusinesscomponent.p)

define variable v1 as character case-sensitive.
define variable v2 as character case-sensitive.
define variable v3 as character case-sensitive.
define variable v4 as character case-sensitive.

/* Return if no information is passed */
if not can-find (first tBusinessComponentsBC)
then return.

vlSyncIsRunning = yes.

/* Load all components that are not user-defined */
<M-17 run DataLoad
   (input  '' (icRowids), 
    input  '' (icPkeys), 
    input  '' (icObjectIds), 
    input  'for each BusComponent where BusComponent.BusComponentIsUserDefined = false' (icFreeform), 
    input  no (ilKeepPrevious), 
    output viFcReturnSuper (oiReturnStatus)) in BBusinessComponent>

if viFcReturnSuper = -4
then assign viFcReturnSuper = 0.

if viFcReturnSuper <> 0
then assign oiReturnStatus = viFcReturnSuper.

if viFcReturnSuper < 0
then return.

<Q-46 assign vlFcQueryRecordsAvailable = CheckSettingByName (NoCache)
   (input {&SETTINGCONFIG-KEEPACTIVITIES}, (ConfigName)
    input {&SETTINGCONFIG-LEVEL-INTERNAL}, (ConfigLevel)
    input 'INTERNAL':U, (Scope)
    input yes, (Active)) in BSettingConfiguration >

assign vlKeepActivities = vlFcQueryRecordsAvailable <> no.
 
/* Delete old components (rename is not supported) */
if not vlKeepActivities then
for each tBusComponent on error undo, throw:
    assign tBusComponent.tc_Status = "D".
end.

/* Go through all input classes  */
/* Skip the ones with sequence 0 */
for each tBusinessComponentsBC where
         tBusinessComponentsBC.tiSequence <> 0 and
         tBusinessComponentsBC.tiSequence <> ? on error undo, throw:
    /* Try to find the component by name */
    find first tBusComponent where
               tBusComponent.BusComponentCode = tBusinessComponentsBC.tcName
               no-error.

    if available tBusComponent
    then do:
        assign v1 = tBusComponent.BusComponentLabel
               v2 = tBusinessComponentsBC.tcLabel.

        if  tBusComponent.BusComponentCategory      = tBusinessComponentsBC.tcCategoryName    and
            tBusComponent.BusComponentHasCustomFlds = tBusinessComponentsBC.tlHasCustomFields and
            tBusComponent.BusComponentIsActive      = true and
            v1                                      = v2
        then assign tBusComponent.tc_Status = "".
        else assign tBusComponent.BusComponentHasCustomFlds = tBusinessComponentsBC.tlHasCustomFields
                    tBusComponent.BusComponentCategory      = tBusinessComponentsBC.tcCategoryName
                    tBusComponent.BusComponentLabel         = tBusinessComponentsBC.tcLabel
                    tBusComponent.BusComponentIsActive      = true
                    tBusComponent.tc_Status                 = "C".
    end.
    else do:
        <M-18 run AddDetailLine
           (input  'BusComponent' (icTable), 
            input  '' (icParentRowid), 
            output viFcReturnSuper (oiReturnStatus)) in BBusinessComponent>

        if viFcReturnSuper <> 0
        then assign oiReturnStatus = viFcReturnSuper.

        if viFcReturnSuper < 0
        then return.

        assign tBusComponent.BusComponentCode          = tBusinessComponentsBC.tcName
               tBusComponent.BusComponentLabel         = tBusinessComponentsBC.tcLabel
               tBusComponent.BusComponentIsActive      = true
               tBusComponent.BusComponentIsRSVEnabled  = false
               tBusComponent.BusComponentHasCustomFlds = tBusinessComponentsBC.tlHasCustomFields
               tBusComponent.BusComponentCategory      = tBusinessComponentsBC.tcCategoryName.
    end.

    /* Go through all activities of the component */
    if not vlKeepActivities then
    for each tBusActivity where
             tBusActivity.tc_ParentRowid = tBusComponent.tc_Rowid on error undo, throw:
        assign tBusActivity.tc_Status = "D".
    end.

    for each tBusinessActivitiesBC where
             tBusinessActivitiesBC.tcClassName = tBusinessComponentsBC.tcName on error undo, throw:
        find first tBusActivity where
                   tBusActivity.tc_ParentRowid  = tBusComponent.tc_Rowid and
                   tBusActivity.BusActivityCode = tBusinessActivitiesBC.tcName
                   no-error.

        if available tBusActivity
        then do:
            assign v1 = tBusActivity.BusActivityButtonLabel
                   v2 = tBusinessActivitiesBC.tcButtonLabel
                   v3 = tBusActivity.BusActivityLabel
                   v4 = trim(tBusinessActivitiesBC.tcLabel).

            if  v1                                  = v2                                       and
                tBusActivity.BusActivityDocActivity = tBusinessActivitiesBC.tcDocumentActivity and
                tBusActivity.BusActivityIsActive    = tBusinessActivitiesBC.tlEnabled          and
                tBusActivity.BusActivityFormName    = tBusinessActivitiesBC.tcFormName         and
                tBusActivity.BusActivityIsInstDep   = tBusinessActivitiesBC.tlInstanceNeeded   and
                v3                                  = v4                                       and
                tBusActivity.BusActivityMethodName  = tBusinessActivitiesBC.tcMethodName       and
                tBusActivity.BusActivityOpenForm    = tBusinessActivitiesBC.tlOpenForm         and
                tBusActivity.BusActivitySequence    = tBusinessActivitiesBC.tiSequence         and
                tBusActivity.BusActivityAccelerator = tBusinessActivitiesBC.tiShortcut
            then assign tBusActivity.tc_Status = "".
            else assign tBusActivity.BusActivityDocActivity = tBusinessActivitiesBC.tcDocumentActivity
                        tBusActivity.BusActivityFormName    = tBusinessActivitiesBC.tcFormName
                        tBusActivity.BusActivityIsInstDep   = tBusinessActivitiesBC.tlInstanceNeeded
                        tBusActivity.BusActivityMethodName  = tBusinessActivitiesBC.tcMethodName
                        tBusActivity.BusActivityOpenForm    = tBusinessActivitiesBC.tlOpenForm
                        tBusActivity.BusActivityButtonLabel = tBusinessActivitiesBC.tcButtonLabel
                        tBusActivity.BusActivityIsActive    = tBusinessActivitiesBC.tlEnabled
                        tBusActivity.BusActivityLabel       = trim(tBusinessActivitiesBC.tcLabel)
                        tBusActivity.BusActivitySequence    = tBusinessActivitiesBC.tiSequence
                        tBusActivity.BusActivityAccelerator = tBusinessActivitiesBC.tiShortcut
                        tBusActivity.tc_Status              = "C".
        end.
        else do:
            <M-22 run AddDetailLine
               (input  'BusActivity' (icTable), 
                input  tBusComponent.tc_Rowid (icParentRowid), 
                output viFcReturnSuper (oiReturnStatus)) in BBusinessComponent>

            if viFcReturnSuper <> 0
            then assign oiReturnStatus = viFcReturnSuper.

            if viFcReturnSuper < 0
            then return.

            assign tBusActivity.BusActivityButtonLabel = tBusinessActivitiesBC.tcButtonLabel
                   tBusActivity.BusActivityDocActivity = tBusinessActivitiesBC.tcDocumentActivity
                   tBusActivity.BusActivityIsActive    = tBusinessActivitiesBC.tlEnabled
                   tBusActivity.BusActivityFormName    = tBusinessActivitiesBC.tcFormName
                   tBusActivity.BusActivityIsInstDep   = tBusinessActivitiesBC.tlInstanceNeeded
                   tBusActivity.BusActivityLabel       = trim(tBusinessActivitiesBC.tcLabel)
                   tBusActivity.BusActivityMethodName  = tBusinessActivitiesBC.tcMethodName
                   tBusActivity.BusActivityOpenForm    = tBusinessActivitiesBC.tlOpenForm
                   tBusActivity.BusActivitySequence    = tBusinessActivitiesBC.tiSequence
                   tBusActivity.BusActivityAccelerator = tBusinessActivitiesBC.tiShortcut
                   tBusActivity.BusComponent_ID        = tBusComponent.BusComponent_ID
                   tBusActivity.BusActivityCode        = tBusinessActivitiesBC.tcName.
        end.

        /* Make sure the unique values are unique */
        if tBusActivity.BusActivitySequence <> 0
        then do viCounter = 1 to 1000:
            if can-find(first bBusActivity where
                              bBusActivity.BusComponent_ID     = tBusActivity.BusComponent_ID     and
                              bBusActivity.BusActivitySequence = tBusActivity.BusActivitySequence and
                              bBusActivity.tc_rowid           <> tBusActivity.tc_Rowid            and
                              bBusActivity.tc_Status          <> "D")
            then assign tBusActivity.BusActivitySequence = tBusActivity.BusActivitySequence + viCounter.
            else leave.
        end.

        do viCounter = 1 to 1000:
            if can-find(first bBusActivity where
                              bBusActivity.BusComponent_ID  = tBusActivity.BusComponent_ID  and
                              bBusActivity.BusActivityLabel = tBusActivity.BusActivityLabel and
                              bBusActivity.tc_rowid        <> tBusActivity.tc_Rowid         and
                              bBusActivity.tc_Status       <> "D")
            then assign tBusActivity.BusActivityLabel = tBusActivity.BusActivityLabel + " " + string(viCounter).
            else leave.
        end.

        if tBusActivity.BusActivityIsDefault and
           can-find(first bBusActivity where
                          bBusActivity.BusComponent_ID      = tBusActivity.BusComponent_ID      and
                          bBusActivity.BusActivityIsDefault = tBusActivity.BusActivityIsDefault and
                          bBusActivity.tc_rowid            <> tBusActivity.tc_Rowid             and
                          bBusActivity.tc_Status           <> "D")
        then assign tBusActivity.BusActivityIsDefault = false.
    end.
end.

/* Minimize errors on duplicate labels and sequences */
for each tBusComponent where
         tBusComponent.tc_Status = "N" or
         tBusComponent.tc_Status = "C" by tBusComponent.BusComponentCode descending on error undo, throw:
    if can-find(first btBusComponent where
                      btBusComponent.BusComponentLabel = tBusComponent.BusComponentLabel and
                      btBusComponent.tc_Status        <> "D":U                           and
                      rowid(btBusComponent)           <> rowid(tBusComponent))
    or can-find(first t_iBusComponent where
                      t_iBusComponent.BusComponentLabel = tBusComponent.BusComponentLabel and
                      t_iBusComponent.tc_Rowid         <> tBusComponent.tc_Rowid)
    then assign tBusComponent.BusComponentLabel = tBusComponent.BusComponentLabel + "-" + string(tBusComponent.BusComponent_ID).
end.

for each tBusActivity where
         tBusActivity.tc_Status = "N" or
         tBusActivity.tc_Status = "C" by tBusActivity.BusComponent_ID
                                      by tBusActivity.BusActivityCode descending on error undo, throw:
    if can-find(first btBusActivity where
                      btBusActivity.BusActivityLabel = tBusActivity.BusActivityLabel and
                      btBusActivity.tc_Status       <> "D"                           and
                      btBusActivity.tc_ParentRowid   = tBusActivity.tc_ParentRowid   and
                      rowid(btBusActivity)          <> rowid(tBusActivity))
    then assign tBusActivity.BusActivityLabel = tBusActivity.BusActivityLabel + "-" + string(tBusActivity.BusActivity_ID).
end.

/* Prepare translations for saving by the ancestor code */
for each tBusComponent where
         tBusComponent.BusComponentIsUserDefined = false and
         tBusComponent.tc_Status <> "D"
         on error undo, throw:

    for each tBusinessComponentLabel where
             tBusinessComponentLabel.tcRelatedObject = "B:" + tBusComponent.BusComponentCode on error undo, throw:

        find first tTransString where
                   tTransString.tiParentObject_ID = tBusComponent.BusComponent_ID and
                   tTransString.tcLngCode         = tBusinessComponentLabel.tcLngCode
                   no-error.
        if available tTransString
        then do:
            v1 = tTransString.tcTranslationStringText.
            v2 = tBusinessComponentLabel.tcTranslationText.
            if v1 <> v2
            then assign tTransString.tcTranslationStringText = tBusinessComponentLabel.tcTranslationText
                        tTransString.tc_Status = (if tTransString.tc_Status = "" then "C" else tTransString.tc_Status).
        end.
        else do:
            create tTransString.
            assign tTransString.tiParentObject_ID       = tBusComponent.BusComponent_ID
                   tTransString.tcLngCode               = tBusinessComponentLabel.tcLngCode
                   tTransString.tcTranslationStringText = tBusinessComponentLabel.tcTranslationText
                   tTransString.tc_Rowid                = tBusinessComponentLabel.tcLngCode + "=" + tBusComponent.tc_Rowid.
        end.
    end.

    for each tBusActivity where
             tBusActivity.tc_ParentRowid = tBusComponent.tc_Rowid and
             tBusActivity.tc_Status <> "D", 
        each tBusinessComponentLabel where
             tBusinessComponentLabel.tcRelatedObject = "D:" + tBusComponent.BusComponentCode + "." + tBusActivity.BusActivityCode on error undo, throw:

        find first tTransString where
                   tTransString.tiParentObject_ID = tBusActivity.BusActivity_ID and
                   tTransString.tcLngCode         = tBusinessComponentLabel.tcLngCode
                   no-error.
        if available tTransString
        then do:
            v1 = tTransString.tcTranslationStringText.
            v2 = tBusinessComponentLabel.tcTranslationText.
            if v1 <> v2
            then assign tTransString.tcTranslationStringText = tBusinessComponentLabel.tcTranslationText
                        tTransString.tc_Status = (if tTransString.tc_Status = "" then "C" else tTransString.tc_Status).
        end.
        else do:
            create tTransString.
            assign tTransString.tiParentObject_ID       = tBusActivity.BusActivity_ID
                   tTransString.tcLngCode               = tBusinessComponentLabel.tcLngCode
                   tTransString.tcTranslationStringText = tBusinessComponentLabel.tcTranslationText
                   tTransString.tc_Rowid                = tBusinessComponentLabel.tcLngCode + "-" + tBusActivity.tc_Rowid.
        end.
    end.
end.

if can-find (first tBusComponent where tBusComponent.tc_Status <> "")
or can-find (first tBusActivity where tBusActivity.tc_Status <> "")
or can-find (first tTransString where tTransString.tcTranslationStringText <> "" and tTransString.tc_Status <> "")
then assign olUpdatesDone = yes.

if olUpdatesDone
then do:
    /* Validate, AdditionalUpdates and Save */
    <M-14 run ValidateBC  (output viFcReturnSuper (oiReturnStatus)) in BBusinessComponent>

    if viFcReturnSuper <> 0
    then assign oiReturnStatus = viFcReturnSuper.

    if viFcReturnSuper < 0
    then return.

    <M-15 run AdditionalUpdates  (output viFcReturnSuper (oiReturnStatus)) in BBusinessComponent>

    if viFcReturnSuper <> 0
    then assign oiReturnStatus = viFcReturnSuper.

    if viFcReturnSuper < 0
    then return.

    <M-16 run DataSave  (output viFcReturnSuper (oiReturnStatus)) in BBusinessComponent>

    if viFcReturnSuper <> 0
    then assign oiReturnStatus = viFcReturnSuper.

    if viFcReturnSuper < 0
    then return.
end.


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 = "BBusinessComponent".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiSynchronise".
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/bbusinesscomponent.apisynchronise.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tBusinessComponentsBC").
vhParameter:buffer-create().
assign vhParameter::<field-name-1> = <field-value-1>
       vhParameter::<field-name-2> = <field-value-2>
       ...

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

vhParameter = vhInputDS:get-buffer-handle("tBusinessComponentLabel").
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.