Basic Data Synchronization

This page provides information about the Basic Data Synchronization concept.

IFS provides a functionality to synchronize basic data throughout a set of companies. Currently there are several basic data windows supported by this functionality in Enterprise and Accounting Rules.

Use this page when you want to add more basic data windows to have this capability of synchronizing data.
 

Contents

• Register Basic Data Windows
• Server Changes
• Client Changes

Register Basic Data Windows

When you want to add the synchronization functionality to a basic data window the first step is to register the window in the Basic_Data_Window_Tab.

To do this, you will need to enter the window information in the BasicDataSyncLU.ins in the relevant component. The name of the file should be  <Component>BasicDataSyncLU.ins. If the relevant component does not have an existing file please refer the example and create a new ins file.

The call to insert window and LU information should have the following information.

Note:

...
Attribute_Row_('LuName', 'Window Name');
...

Refer example in RegistrationExample.ins

Server Changes

There are several new methods that should be written in the plsql file to support the synchronization functionality.

Public Methods

• Copy_To_Companies

Note:

...
Client_SYS.Add_To_Attr('ATTRIBUTE_LIST', attribute_list_, attr1_);
Client_SYS.Add_To_Attr('ATTRIBUTE_VALUE_LIST', attribute_value_list_, attr1_);
...

All keys except the company ID should be added to the attribute string.
 

Refer example in ServerMethodsExample.plsql

Protected Methods

• Copy_To_Companies_

Note:

...
ELSIF (name_ = 'ATTRIBUTE_LIST') THEN
   attribute_list_ := value_;
ELSIF (name_ = 'ATTRIBUTE_VALUE_LIST') THEN
   attribute_value_list_ := value_;
...

All keys except the company ID should be added to parameters as shown above.
 

Refer example in ServerMethodsExample.plsql
 

• Copy_To_Companies_

Note:

...
i_ := 0;
ptr_ := NULL;
WHILE Get_Next_Record_Sep_Val___(value_, ptr_, attribute_list_) LOOP
   ref_accounting_attribute_val_(i_).attribute := value_;
   i_ := i_ + 1;
END LOOP;
...

This should be done for all the keys of the LU except the company ID.

Refer example in ServerMethodsExample.plsql

Private Methods

• Copy_To_Companies__

Note:

...
log_key_ := key1_ || '^' || key2_;
...

Refer example in ServerMethodsExample.plsql

Implementation Methods

• Get_Next_Record_Sep_Val___

This method is used to extract the value from the list keys sent in. This is called from method Copy_To_Companies_.

• Check_Delete___

...
IF (App_Context_Sys.Find_Value(lu_name_||'.copy_to_company_', 'FALSE') != 'TRUE') THEN
   IF (Company_Basic_Data_Window_API.Check_Copy_From_Company(remrec_.company, lu_name_)) THEN
      Error_SYS.Record_General(lu_name_, 'NODIRECTREMOVE: A record cannot be removed as :P1 window has been set up for copying data only from source company in Basic Data Synchronization window.', Basic_Data_Window_API.Get_Window(lu_name_));
   END IF;
END IF;
...

        This should be added as pre-processing code.

• Check_Common___

...
IF (App_Context_Sys.Find_Value(lu_name_||'.copy_to_company_', 'FALSE') != 'TRUE') THEN
   IF (Company_Basic_Data_Window_API.Check_Copy_From_Company(newrec_.company, lu_name_)) THEN
      Error_SYS.Record_General(lu_name_, 'NODIRECTINSERT: A record cannot be entered/modified as :P1 window has been set up for copying data only from source company in Basic Data Synchronization window.', Basic_Data_Window_API.Get_Window(lu_name_));
   END IF;
END IF;
...

        This should be added as pre-processing code.

        Refer examples in ServerMethodsExample.plsql

Client Changes

These client changes should be done to support Basic Data Synchronization in the relevant client files.

CopyToCompanies

This method can be used to copy data from two data sources at the same time. This is suitable for master detail windows.

NavigateToCopyBasicDataLog

This method should be used to show the status of the action and to get user confirmation to open the history log window.

Examples from tbwAttribute.cs

...
public new SalBoolean DataSourceSaveCheckOk()
{
   #region Actions
   DbPLSQLBlock(@" {0} := &AO.Company_Basic_Data_Window_API.Is_Active_Lu_Exist( {1} IN,{2} IN) ;",
   this.QualifiedVarBindName("sState"),
   this.QualifiedVarBindName("i_sCompany"),
   this.QualifiedVarBindName("sLu"));
   if (sState == "TRUE")
   {
      sType = "AUTOMATIC";
      cControls[0] = colsAttribute;
      cCopyToCompany.CopyToCompanies(Ifs.Fnd.ApplicationForms.Const.METHOD_Execute, this, sLu, "Accounting_Attribute_API", 
                                     cControls, i_sCompany, sType, ref this.lsAttr, ref sAllInfo, ref sWindow, ref nLogId);
      sParams[0] = sWindow;
   }
   return true;
   #endregion
}
...

...
private void tbwAttribute_OnPM_DataSourceSave(object sender, WindowActionsEventArgs e)
{
   #region Actions
   e.Handled = true;
   if (Sal.SendClassMessage(Ifs.Fnd.ApplicationForms.Const.PM_DataSourceSave, Sys.wParam, Sys.lParam))
   {
      e.Return = true;
      if (Sys.wParam == Ifs.Fnd.ApplicationForms.Const.METHOD_Execute)
      {
         if (cCopyToCompany.NavigateToCopyBasicDataLog(ref sAllInfo, sParams))
         {
            NavigateToCopyBasicDataLog();
         }
      }
      return;
   }
   else
   {
      lsAttr.Clear();
      e.Return = false;
      return;
   }
   #endregion
} 
...