WM-Synergy Business Objects SDK Information

WM-Synergy Business Objects SDK Information

WM-Synergy Business Objects

WM-Synergy Business Objects, SBO, is a comprehensive transaction library built on the both the .net standard and .net framework platforms.  This library allows the developer to quickly read/write/update transactional data with the Visual ERP database.
  1. Ensures that all tables required for a data transaction are properly updated.
  2. Synergy supports this product, if you find a bug, we will fix it at no cost to you.
  3. The code base allows you as a developer to write your own SQL code as needed.
  4. The code allows for roll back of transactions if a record does not complete properly.

Warning
As an end user you must apply your licensee code to be able to use WM-Synergy Business Objects. 
If you are using https:\\ to the authenticator, make sure the certificate on the site is valid.
Otherwise you might see something similar to the following:

For customers that purchased SBO a license manager server is installed.  This is a local installation running in IIS  AuthenticationServer on port 8089 - it is a webservice that evaluates the domain against the license key.  During the initial database connection (passing in the URL from the implemented application)  the webservice is called and evaluated


The SBO installer package comes with sample programs on how to use the SynergyBusinessObjects.dll library see your installed Examples subfolder.  
As Microsoft moves away from standard system libraries included with Windows, it becomes important to include in your developer project any and all libraries that are provided with this SDK kit. 
With updates for support of Visual 11 the SynergyBusinessObjects.dll relies on Oracle.ManagedDataAccess.dll, even if you are a Microsoft SQL only facility. 
Notes
The following libraries may also be required, in a customer created project: the version may not matter if your project is a .exe you should be able to use the latest from nuget.

  1. Microsoft.Data.SqlClient.dll
  2. Oracle.ManagedDataAccess.dll  (min 21.18.0)
  3. System.Configuration.ConfigurationManager (min 6.0.1)
  4. <-- might be needed. -->
  5. Azure.Core (min 1.38.0)
  6. Azure.Identity (min 1.11.4)
  7. Microsoft.CSharp
  8. Microsoft.Identity.Client (min 4.6.1.3)
  9. Microsoft.BclAsyncInterfaces (min 9.0.3)
  10. Microsoft.Data.SqlClient.SNI (min 5.2.0)
  11. Microsoft.Identity.Client (min 4.61.3)
  12. Microsoft.Identity.Client.Extensions.Msal (min 4.61.3)
  13. Microsoft.IdentityModel.JsonWebTokens (min 6.35.0)
  14. Microsoft.IdentityModel.Abstractions (min 6.35.0)
  15. Microsoft.IdentityModel.JsonWebTokens(min 6.35.0)
  16. Microsoft.IdentityModel.Logging (min 6.35.0)
  17. Microsoft.IdentityModel.Protcols (min 6.35.0)
  18. Microsoft.IdentityModel.Protcols.OpenIdConnection (v6.35.0)
  19. Microsoft.IdentityModel.Tokens (min 6.35.0)
  20. System.Buffers.dll  min (4.6.1)
  21. System.ClientModel (min 1.0.0)
  22. System.Diagnostics.DiagnosticSource (min 6.0.1)
  23. System.Diagnostics.PerformanceCounter(min 6.0.2)
  24. System.DirectoryServices.Protocols(min 6.0.2) 
  25. System.formats.Asn1.dll (min 9.0.3)
  26. System.IdentityModel.Tokens.Jwt (min 6.35.0)
  27. System.IO.FileSystem.AccessControl (min 5.0.0)
  28. System.IO.Pipelines.dll ( v9.0.3)
  29. System.Memory.dll (min 4.6.2)
  30. System.Memory.Data (min 1.0.2)
  31. System.Net.Http (min 4.3.4)
  32. System.Numerics.Vectors.dll (min 4.6.1)
  33. System.Runtime.InteropServices.Unsafe (min 6.1.1)
  34. System.Runtime.InteropServices.RuntimeInformation(min 4.3.0)
  35. System.Security.AccessControls (min 6.0.0)
  36. System.Security.Cryptography.Algorithms (min 4.3.0)
  37. System.Security.Cryptography.Encoding(min 4.3.0)
  38. System.Security.Cryptography.Primitives (min 4.3.0)
  39. System.Security.Cryptography.ProtectedData (min 4.7.0)
  40. System.Security.Cryptography.X509Certificates (min 4.3.0)
  41. System.Security.Permissions (min 6.0.0)
  42. System.Security.Principal.Windows (min 5.0.0)
  43. System.Text.Encoding (min 4.3.0)
  44. Sytem.Text.Encodings.Web.dll (min 9.0.3)
  45. System.Text.Json.dll (min9.0.3)
  46. System.Threading.Tasks.Extensions.dll (min4.6.2)
  47. System.Value.Tuple.dll (min 4.6.1)
For .net standard make sure to include:  
  1. Oracle.ManagedDataAccess (nuget)
  2. Microsoft.Data.SqlClient  (nuget Use the correct version for your build)
  3. System.Configuration.ConfigurationManager (min 6.0.1)
  4. <<< might be needed as well >>>
  5. System.Net.Http
  6. System.ServiceModel
  7. System.ServiceModel.Duplex
  8. System.ServiceModel.Http
  9. System.ServiceModel.NetTcp
  10. System.ServiceModel.Primitives
  11. System.ServiceModel.Security
Alert
Please note, the .net framework version of sbo objects will be retired as .net standard will replace it.
Starting with Visual 11 support for single site, Visual ERP 7 and below, is no longer supported or provided with sbo objects.  
We can provide a non-supported version SynergyBusinessObjects70.dll  (available upon request).

Connection Test

  1.     [TestClass]
  2.     public class ConnectionTest
  3.     {
  4.         #region Private Methods
  5.         /// <summary>
  6.         /// <c>GetSBOAuthenticator</c> url as specified in the app.config.
  7.         /// </summary>
  8.         /// <returns></returns>
  9.         private Uri GetSBOAuthenticator()
  10.         {
  11.             Uri Url = null;
  12.             SBOServer.AuthenticationService Svc = new SBOServer.AuthenticationService();

  14.             ConfigurationManager.AppSettings["SchemaPath"] = Environment.CurrentDirectory + "\\";
  15.             string SBOServer = ConfigurationManager.AppSettings["SBOServer"].ToString();
  16.             string SBOPort = ConfigurationManager.AppSettings["SBOPort"].ToString();

  18.             Url = new Uri(string.Format("http://{0}:{1}/AuthenticationService.asmx", SBOServer, SBOPort));

  20.             return Url;
  21.         }
  22.         /// <summary>
  23.         /// <c>ConnectToDbase</c> using the values set in the App.config file.
  24.         /// </summary>
  25.         /// <returns>Database connection</returns>
  26.         private Synergy.BusinessObjects.DatabaseConnection ConnectToDbase()
  27.         {
  28.             Uri Url = GetSBOAuthenticator();
  29.             Synergy.BusinessObjects.DatabaseConnection DataBase = new Synergy.BusinessObjects.DatabaseConnection(Url);
  30.             //Connection information
  31.             string DBType = ConfigurationManager.AppSettings["DBType"].ToString();
  32.             string DBServer = ConfigurationManager.AppSettings["DBServer"].ToString();
  33.             string DBDatabase = ConfigurationManager.AppSettings["DBDatabase"].ToString();
  34.             string DBUser = ConfigurationManager.AppSettings["DBUserId"].ToString();
  35.             string DBPassword = ConfigurationManager.AppSettings["DBPassword"].ToString();

  37.             DataBase.UserCredentials.UseBlind = true; //Default Value = true
  38.             DataBase.UserCredentials.DatabaseType = (DBType == "SqlServer" ? Synergy.BusinessObjects.DatabaseEngineType.SqlServer : Synergy.BusinessObjects.DatabaseEngineType.Oracle);
  39.             DataBase.UserCredentials.Server = DBServer; //Enter the Server (and instance name for SqlsErver)
  40.             DataBase.UserCredentials.Database = DBDatabase;
  41.             DataBase.UserCredentials.UserID = DBUser;
  42.             DataBase.UserCredentials.Password = DBPassword;

  44.             DataBase.Connect();

  46.             return DataBase;
  47.         }
  48.         #endregion
  49.         #region Unit Tests
  50.         [TestMethod]
  51.         public void AuthenticationTest()
  52.         {
  53.             Uri Url = null;
  54.             SBOServer.AuthenticationService Svc = new SBOServer.AuthenticationService();
  55.             try
  56.             {
  57.                 Url = GetSBOAuthenticator();
  58.                 Svc.Url = Url.ToString();
  59.                 Svc.AuthenticateNode("Test");
  60.                 Svc.Dispose();
  61.                 Assert.AreEqual(1, 1); // Success 
  62.             }
  63.             catch (Exception ex)
  64.             {
  65.                 Assert.Fail(ex.Message);
  66.             }
  67.         }

  69.         [TestMethod]
  70.         public void ConnectToDatabase()
  71.         {
  72.             try
  73.             {
  74.                 //Create the Database Connection – define the Connection Manager Server
  75.                 Synergy.BusinessObjects.DatabaseConnection Database = ConnectToDbase();
  76.                 if (Database.Connected)
  77.                 {
  78.                     Assert.IsTrue(1 == 1, "Database Connection is a Success!");
  79.                     Database.CloseConnection();
  80.                 }
  81.                 else
  82.                     Assert.Fail("Check the app.config settings.");
  83.             }
  84.             catch (Exception ex)
  85.             {
  86.                 Assert.Fail(ex.Message);
  87.             }
  88.         }
  89.         #endregion
  90.     }

Connect To Database

  1.  /// <summary>
  2.  /// <c>ConnectToDbase</c> using the values set in the App.config file.
  3.  /// </summary>
  4.  /// <returns>Database connection</returns>
  5.  private Synergy.BusinessObjects.DatabaseConnection ConnectToDbase()
  6.  {
  7.      Uri Url = GetSBOAuthenticator();
  8.      Synergy.BusinessObjects.DatabaseConnection DataBase = new Synergy.BusinessObjects.DatabaseConnection(Url);
  9.      //Connection information
  10.      string DBType = ConfigurationManager.AppSettings["DBType"].ToString();
  11.      string DBServer = ConfigurationManager.AppSettings["DBServer"].ToString();
  12.      string DBDatabase = ConfigurationManager.AppSettings["DBDatabase"].ToString();
  13.      string DBUser = ConfigurationManager.AppSettings["DBUserId"].ToString();
  14.      string DBPassword = ConfigurationManager.AppSettings["DBPassword"].ToString();

  16.      DataBase.UserCredentials.UseBlind = true; //Default Value = true
  17.      DataBase.UserCredentials.DatabaseType = (DBType == "SqlServer" ? Synergy.BusinessObjects.DatabaseEngineType.SqlServer : Synergy.BusinessObjects.DatabaseEngineType.Oracle);
  18.      DataBase.UserCredentials.Server = DBServer; //Enter the Server (and instance name for SqlsErver)
  19.      DataBase.UserCredentials.Database = DBDatabase;
  20.      DataBase.UserCredentials.UserID = DBUser;
  21.      DataBase.UserCredentials.Password = DBPassword;

  23.      DataBase.Connect();

  25.      return DataBase;
  26.  }

Code Example with SQL.INI

(See: Sample Programs/Starter MultiSite for detailed code usage in your sdk kit)
Incorporate the SQL INI code to your database connection.
  1. private static void ParseSqlIni(string database, ref AuthenticationCredentials authCreds)
  2.         {
  3.             SqlINIEntry sqlINIEntry = new SqlINI().ParseSqlIni(database);
  4.             if (sqlINIEntry.HasWarning) throw (new Exception("'sql.ini' File error: " + sqlINIEntry.WarningMessage));

  6.             if (sqlINIEntry.DatabaseType == DatabaseTypeEnum.SqlServer || sqlINIEntry.DatabaseType == DatabaseTypeEnum.Oracle)
  7.             {
  8.                 if (sqlINIEntry.DatabaseType == DatabaseTypeEnum.SqlServer)
  9.                     authCreds.DatabaseType = DatabaseEngineType.SqlServer;
  10.                 else
  11.                     authCreds.DatabaseType = DatabaseEngineType.Oracle;

  13.                 authCreds.Server = sqlINIEntry.ServerName;
  14.                 authCreds.Database = sqlINIEntry.DatabaseName;
  15.             }
  16.         }

SqlINI.cs

  1. using System;
  2. using System.IO;
  3. using System.Runtime.InteropServices;
  4. using System.Text;

  6. namespace Synergy.INI
  7. {
  8.     public class SqlINI
  9.     {
  10.         #region Externals
  11.         internal static class NativeMethods
  12.         {
  13.             [DllImport("kernel32.dll", CharSet = CharSet.Unicode)]
  14.             internal static extern uint GetPrivateProfileString(
  15.                 string lpAppName,
  16.                 string lpKeyName,
  17.                 string lpDefault,
  18.                 StringBuilder lpReturnedString,
  19.                 uint nSize,
  20.                 string lpFileName);

  22.             [DllImport("kernel32.dll", CharSet = CharSet.Unicode)]
  23.             internal static extern uint GetPrivateProfileSection(
  24.                 string lpAppName,
  25.                 IntPtr lpReturnedString,
  26.                 uint nSize,
  27.                 string lpFileName);
  28.         }
  29.         #endregion

  31.         #region Enums
  32.         public enum DatabaseTypeEnum
  33.         {
  34.             None,
  35.             Oracle,
  36.             SqlServer
  37.         }
  38.         #endregion

  40.         #region SqlINIEntry class
  41.         public class SqlINIEntry
  42.         {
  43.             public DatabaseTypeEnum DatabaseType = DatabaseTypeEnum.None;
  44.             public string ServerName = string.Empty;
  45.             public string DatabaseName = string.Empty;
  46.             public string WarningMessage = string.Empty;
  47.             public bool HasWarning
  48.             {
  49.                 get
  50.                 {
  51.                     return !string.IsNullOrEmpty(WarningMessage);
  52.                 }
  53.             }
  54.         }
  55.         #endregion

  57.         #region Methods
  58.         private static string[] GetPrivateProfileSection(string sectionName, string iniFileName)
  59.         {
  60.             string[] sectionKeyArray = null;

  62.             if (!File.Exists(iniFileName)) return null;

  64.             uint MAX_BUFFER = 32767;

  66.             IntPtr pReturnedString = Marshal.AllocCoTaskMem((int)MAX_BUFFER * sizeof(char));

  68.             uint bytesReturned = NativeMethods.GetPrivateProfileSection(sectionName, pReturnedString, MAX_BUFFER, iniFileName);

  70.             if ((bytesReturned == MAX_BUFFER - 2) || (bytesReturned == 0))
  71.             {
  72.                 Marshal.FreeCoTaskMem(pReturnedString);
  73.                 return null;
  74.             }

  76.             // bytesReturned -1 to remove trailing \0

  78.             // NOTE: Calling Marshal.PtrToStringAuto(pReturnedString) will
  79.             //       result in only the first pair being returned
  80.             string returnedString = Marshal.PtrToStringAuto(pReturnedString, (int)bytesReturned - 1);

  82.             sectionKeyArray = returnedString.Split('\0');

  84.             Marshal.FreeCoTaskMem(pReturnedString);
  85.             return sectionKeyArray;
  86.         }

  88.         private string INIRead(string sectionName, string sKeyName, string iniFileName)
  89.         {
  90.             StringBuilder sb = new StringBuilder(500);
  91.             uint charCount = NativeMethods.GetPrivateProfileString(sectionName, sKeyName, string.Empty, sb, (uint)sb.Capacity, iniFileName);
  92.             if (charCount > 0) return sb.ToString().Substring(0, (int)charCount);
  93.             else return string.Empty;
  94.         }

  96.         public SqlINIEntry ParseSqlIni(string database)
  97.         {
  98.             SqlINIEntry sqlINIEntry = new SqlINIEntry();
  99.             try
  100.             {
  101.                 // sql.ini search order
  102.                 // current working dir i.e. the Visual program dir
  103.                 // %windir%\system32
  104.                 // %windir%\system
  105.                 // %windir%
  106.                 // %PATH% order

  108.                 string[] sysPaths = new string[4];
  109.                 sysPaths[0] = Path.Combine(Environment.CurrentDirectory, "sql.ini");
  110.                 sysPaths[1] = Path.Combine(Environment.GetEnvironmentVariable("windir"), @"system32\sql.ini");
  111.                 sysPaths[2] = Path.Combine(Environment.GetEnvironmentVariable("windir"), @"system\sql.ini");
  112.                 sysPaths[3] = Path.Combine(Environment.GetEnvironmentVariable("windir"), "sql.ini");

  114.                 string iniPath = string.Empty;
  115.                 for (int i = 0; i < sysPaths.Length; i++)
  116.                 {
  117.                     if (File.Exists(sysPaths[i]))
  118.                     {
  119.                         iniPath = sysPaths[i];
  120.                         break;
  121.                     }
  122.                 }

  124.                 if (string.IsNullOrEmpty(iniPath)) // We haven't found the SQL.ini file yet...
  125.                 {
  126.                     string[] environmentPaths = Environment.GetEnvironmentVariable("PATH").Split(';');
  127.                     for (int i = 0; i < environmentPaths.Length; i++)
  128.                     {
  129.                         if (File.Exists(Path.Combine(environmentPaths[i], "sql.ini")))
  130.                         {
  131.                             iniPath = Path.Combine(environmentPaths[i], "sql.ini");
  132.                             break;
  133.                         }
  134.                     }
  135.                 }

  137.                 if (!string.IsNullOrEmpty(iniPath))
  138.                 {
  139.                     // Test Name in SqlServer
  140.                     string connstring = INIRead("sqlserver", database, iniPath);
  141.                     string[] strs = connstring.Split(',');
  142.                     if (strs.Length == 2)
  143.                     {
  144.                         sqlINIEntry.DatabaseType = DatabaseTypeEnum.SqlServer;
  145.                         sqlINIEntry.ServerName = strs[0];
  146.                         sqlINIEntry.DatabaseName = strs[1];
  147.                         return sqlINIEntry; // Return if found
  148.                     }

  150.                     // Test Oracle next
  151.                     string[] oraGtwy = GetPrivateProfileSection("oragtwy", iniPath);
  152.                     if (oraGtwy != null)
  153.                     {
  154.                         foreach (string section in oraGtwy)
  155.                         {
  156.                             string REMOTEDBNAMEString = "REMOTEDBNAME=" + database.ToUpper() + ",@";
  157.                             if (section.ToUpper().StartsWith(REMOTEDBNAMEString))
  158.                             {
  159.                                 sqlINIEntry.DatabaseType = DatabaseTypeEnum.Oracle;
  160.                                 string dbName = section.ToUpper().Replace(REMOTEDBNAMEString, "");
  161.                                 sqlINIEntry.ServerName = dbName;
  162.                                 sqlINIEntry.DatabaseName = dbName;
  163.                                 return sqlINIEntry; // Return if found
  164.                             }
  165.                         }
  166.                     }

  168.                     sqlINIEntry.WarningMessage = "Can't find database name: '" + database + "' in file: " + iniPath;
  169.                 }
  170.                 else
  171.                     sqlINIEntry.WarningMessage = "Can't find 'sql.ini' file.";

  173.                 return sqlINIEntry;
  174.             }
  175.             catch (Exception ex)
  176.             {
  177.                 throw new Exception("Can't find or parse 'sql.ini' file in ParseSqlIni!" + Environment.NewLine + ex.Message + Environment.NewLine + ex.Source);
  178.             }
  179.         }
  180.         #endregion
  181.     }
  182. }

Run your own SQL Query

  1.  [TestMethod]
  2.  public void TestSQLCommand()
  3.  {
  4.      Synergy.BusinessObjects.DatabaseConnection Database = null;
  5.      try
  6.      {
  7.          Database = ConnectToDbase();
  8.          if (Database.Connected)
  9.          {
  10.              IDbCommand SQLCmd = Database.CreateNewCommand;
  11.              SQLCmd.CommandText = "SELECT COUNT(*) FROM PART";
  12.              object CmdReturn = SQLCmd.ExecuteScalar();      // Oracle returns a decimal, sql an int
  13.              if (CmdReturn != DBNull.Value)
  14.              {
  15.                  int PartCnt = 0;
  16.                  int.TryParse(CmdReturn.ToString(), out PartCnt);
  17.                  Assert.IsTrue(PartCnt > 0, "Fail, Perhaps you have no parts in dbo.PART?");
  18.              }
  19.              else
  20.                  Assert.Fail("Perhaps you have no Parts.");
  21.          }
  22.          else
  23.              Assert.Fail("Datbase Connection Failed, Check App.config");
  24.      }
  25.      catch (Exception ex)
  26.      {
  27.          Assert.Fail(ex.Message);
  28.      }
  29.      finally
  30.      {
  31.          if (Database != null) Database.Transaction = null;
  32.      }
  33.  }

Read Site Information

  1.    [TestMethod]
  2.    public void ReadSite()
  3.    {
  4.        Synergy.BusinessObjects.DatabaseConnection Database = null;
  5.        try
  6.        {
  7.            Database = ConnectToDbase();
  8.            if (Database.Connected)
  9.            {
  10.                Synergy.BusinessObjects.VE.SITE Site = new Synergy.BusinessObjects.VE.SITE(Database);
  11.                Site.ID = "%";
  12.                int Count = 0;
  13.                foreach (Synergy.BusinessObjects.VE.SITE Rec in Site.LoadLike(Site))
  14.                {
  15.                    Count += 1;
  16.                }
  17.                Assert.IsTrue(Count > 0, "Fail, did not find any Site records");
  18.            }
  19.            else
  20.                Assert.Fail("Datbase Connection Failed, Check App.config");
  21.        }
  22.        catch (Exception ex)
  23.        {
  24.            Assert.Fail(ex.Message);
  25.        }
  26.        finally
  27.        {
  28.            if (Database != null) Database.Transaction = null;
  29.        }
  30.    }

Read a Customer Record

In this sample the code will read all customer records.  Including the ones that are no longer active.
  1.   [TestMethod]
  2.   public void ReadCustomer()
  3.   {
  4.       Synergy.BusinessObjects.DatabaseConnection Database = null;
  5.       try
  6.       {
  7.           Database = ConnectToDbase();
  8.           if (Database.Connected)
  9.           {
  10.               Synergy.BusinessObjects.VE.CUSTOMER Customer = new Synergy.BusinessObjects.VE.CUSTOMER(Database);
  11.               Customer.ID = "%";
  12.               int Count = 0;
  13.               foreach (Synergy.BusinessObjects.VE.CUSTOMER Rec in Customer.LoadLike(Customer))
  14.               {
  15.                   Count += 1;
  16.               }
  17.               Assert.IsTrue(Count > 0, "Fail! Could not find any Customer records.");
  18.           }
  19.           else
  20.               Assert.Fail("Datbase Connection Failed, Check App.config");
  21.       }
  22.       catch (Exception ex)
  23.       {
  24.           Assert.Fail(ex.Message);
  25.       }
  26.       finally
  27.       {
  28.           if (Database != null) Database.Transaction = null;
  29.       }

  31.   }

Read Application Global

  1.   [TestMethod]
  2.   public void ReadApplication_Global()
  3.   {
  4.       Synergy.BusinessObjects.DatabaseConnection Database = null;
  5.       try
  6.       {
  7.           Database = ConnectToDbase();
  8.           if (Database.Connected)
  9.           {
  10.               APPLICATION_GLOBAL AppGlobal = new APPLICATION_GLOBAL(Database);
  11.               AppGlobal = AppGlobal.Load(1);

  13.               Assert.IsTrue(!string.IsNullOrEmpty(AppGlobal.COMPANY_NAME), "Fail!  Check app global for a company name");
  14.           }
  15.           else
  16.               Assert.Fail("Datbase Connection Failed, Check App.config");
  17.       }
  18.       catch (Exception ex)
  19.       {
  20.           Assert.Fail(ex.Message);
  21.       }
  22.       finally
  23.       {
  24.           if (Database != null) Database.Transaction = null;
  25.       }
  26.   }

Create a Customer Order

  1.  [TestMethod]
  2.  public void CreateCustomerOrder()
  3.  {
  4.      Synergy.BusinessObjects.DatabaseConnection Database = null;
  5.      try
  6.      {
  7.          Database = ConnectToDbase();
  8.          if (Database.Connected)
  9.          {
  10.              CUSTOMER_ORDER CustOrd = new CUSTOMER_ORDER(Database)
  11.              {
  12.                  SITE_ID = "101AMC",
  13.                  CUSTOMER_ID = "C-00001",
  14.                  STATUS = "R" //release it so we can ship it below.
  15.              };
  16.              CustOrd.Save();                   //Save it and you get the auto-generated ID
  17.              Assert.IsTrue(!string.IsNullOrEmpty(CustOrd.ID), "Fail!  Did not create an order for customer 'C-00001'");
  18.          }
  19.          else
  20.              Assert.Fail("Datbase Connection Failed, Check App.config");
  21.      }
  22.      catch (Exception ex)
  23.      {
  24.          Assert.Fail(ex.Message);
  25.      }
  26.      finally
  27.      {
  28.          if (Database != null) Database.Transaction = null;
  29.      }
  30.  }

Create a Voucher

There is a sample program, StarterMultiSite, that includes, or may be similar to,  the following code:

  1.    PAYABLE Voucher = new PAYABLE(_Database);
  2.    Voucher.SITE_ID = txtSiteId.Text;
  3.    Voucher.INVOICE_ID = txtInvoiceId.Text;
  4.    Voucher.VENDOR_ID = txtVendorId.Text;
  5.    Voucher.INVOICE_DATE = dtInvoiceDate.Value;
  6.    Voucher.TOTAL_AMOUNT = Convert.ToDecimal(txtTotalAmount.Text);

  8.    //   Voucher.POSTING_DATE = dtPostingDate.Value;       // This should be set at time of posting

  10.    PAYABLE_LINE Line = new PAYABLE_LINE(_Database);
  11.    Line.PURC_ORDER_ID = txtPOrder.Text; ;
  12.    Line.PURC_ORDER_LINE_NO = Convert.ToDecimal(txtLineNmbr.Text);
  13.    Line.QTY = Convert.ToDecimal(txtLineQty.Text);
  14.    Line.PO_UNIT_PRICE = Convert.ToDecimal(txtPOUnitPrice.Text);
  15.    Line.AMOUNT = Convert.ToDecimal(txtPOUnitPrice.Text) * Line.QTY;        // Calculate the total line amount

  17.    Line.RECEIVER_ID = txtReceiverId.Text;
  18.    Line.RECEIVER_LINE_NO = Convert.ToDecimal(txtReceiverLine.Text);
  19.    // Line.GL_ACCOUNT_ID = 

  21.    Voucher.Lines.Add(Line);
  22.    Voucher.Save();

  24.    MessageBox.Show(this, "Voucher Created", "Create Voucher", MessageBoxButtons.OK);

Create Customer Order with a Work Order

There is a sample program, StarterMultiSite, that includes, or may be similar to,  the following code:
  1.             using (new HourGlass())
  2.             {
  3.                 try
  4.                 {
  5.                     // Create a Customer Order
  6.                     CUSTOMER_ORDER co = new CUSTOMER_ORDER(_Database)
  7.                     {
  8. #if MultiSite
  9.                         SITE_ID = "MMC",
  10. #endif
  11.                         CUSTOMER_ID = "FINMAN",
  12.                         STATUS = "R" //release it so we can ship it below.
  13.                     };
  14.                     co.Save();                   //Save it and you get the auto-generated ID

  16.                     txtCustOrderId.Text = co.ID;
  17.                     txtCustOrderToShip.Text = co.ID;

  19.                     //Create an Order Line
  20.                     CUST_ORDER_LINE col = new CUST_ORDER_LINE(co)
  21.                     {
  22. #if MultiSite
  23.                         SITE_ID = co.SITE_ID,
  24. #endif
  25.                         PART_ID = "PRODUCT_P",
  26.                         USER_ORDER_QTY = 3,
  27.                         SELLING_UM = "EA"
  28.                     };
  29.                     col.Save();

  31.                     CUSTOMER_ORDER co1 = co.Load(co.ID);
  32.                     int foo = co1.Lines.Count;

  34.                     CUSTOMER_ORDER coLoader = new CUSTOMER_ORDER(_Database) { ID = "0200%" };
  35.                     List<CUSTOMER_ORDER> CoList = co.LoadLike(coLoader);
  36.                     foreach (CUSTOMER_ORDER c in CoList)
  37.                     {
  38.                         int foo2 = c.Lines.Count;
  39.                     }

  41.                     //Create a Work Order with an operation and a material 
  42.                     WORK_ORDER wo = new WORK_ORDER(_Database)
  43.                     {
  44. #if MultiSite
  45.                         SITE_ID = "MMC",
  46. #endif
  47.                         TYPE = "W",
  48.                         //wo.BASE_ID = "00_SS1"; //Don't set for auto number gen - NEXT_NUMBER_GEN table
  49.                         LOT_ID = "0",
  50.                         SPLIT_ID = "0",
  51.                         SUB_ID = "0",
  52.                         PART_ID = col.PART_ID
  53.                     };
  54.                     wo.DESIRED_QTY = wo.DESIRED_QTY;
  55.                     //wo.Save();

  57.                     //Create an operation on the WO
  58.                     OPERATION op = new OPERATION(wo)
  59.                     {
  60. #if MultiSite
  61.                         SITE_ID = wo.SITE_ID,
  62. #endif
  63.                         SEQUENCE_NO = 10,
  64.                         RESOURCE_ID = "DRILL"
  65.                     };
  66.                     //op.Save();
  67.                     wo.OPERATIONS.Add(op);

  69.                     //Add a material to the OPERATION
  70.                     REQUIREMENT req = new REQUIREMENT(op)
  71.                     {
  72. #if MultiSite
  73.                         SITE_ID = op.SITE_ID,
  74. #endif
  75.                         PART_ID = "1/4plate"
  76.                     };
  77.                     //req.Save();
  78.                     op.REQUIREMENTS.Add(req);

  80.                     wo.Save();

  82.                     txtWorkOrderId.Text = wo.BASE_ID;

  84.                     //
  85.                     //Connect the Demand fron the CO Line to the Supply from the WO
  86.                     //
  87.                     DEMAND_SUPPLY_LINK dsl = new DEMAND_SUPPLY_LINK(_Database)
  88.                     {
  89.                         SUPPLY_TYPE = "WO",
  90. #if MultiSite
  91.                         SUPPLY_SITE_ID = wo.SITE_ID,
  92. #endif
  93.                         SUPPLY_BASE_ID = wo.BASE_ID,
  94.                         SUPPLY_LOT_ID = wo.LOT_ID,
  95.                         SUPPLY_SPLIT_ID = wo.SPLIT_ID,
  96.                         SUPPLY_SUB_ID = wo.SUB_ID,

  98.                         DEMAND_TYPE = "CO",
  99. #if MultiSite
  100.                         DEMAND_SITE_ID = co.SITE_ID,
  101. #endif
  102.                         DEMAND_BASE_ID = co.ID,
  103.                         DEMAND_SEQ_NO = col.LINE_NO,
  104.                         ALLOCATED_QTY = wo.DESIRED_QTY
  105.                     };

  107.                     dsl.Save();                          //Save and the link is made
  108.                 }
  109.                 catch (Exception ex)
  110.                 {
  111.                     MessageBox.Show(ex.ToString());
  112.                 }
  113.             }

Delete a Packlist with SBO

The following code snippet demonstrates how to delete a Shipper, (Pack list), from the Infor Visual ERP database.
  1.  public bool Delete_Packlist(string packlist_id)
  2.         {
  3.             DatabaseConnection _Database;
  4.             bool result = true;
  5.             try
  6.             {
  7.                 // Add DB connection specific code here.

  9.                 using (IDbConnection conn = _Database.Connection)
  10.                 {
  11.                     conn.Open();
  12.                     SHIPPER s = new SHIPPER(_Database).Load(packlist_id);
  13.                     s.Delete();
  14.                     s.Save();
  15.                 }
  16.             }
  17.             catch (Exception ex)
  18.             {
  19.                 _Database.Transaction?.Rollback();
  20.                 result = false;
  21.             }
  22.             finally
  23.             {
  24.                 _Database.Transaction?.Dispose();
  25.                 _Database.Transaction = null;
  26.             }

  28.             return result;
  29.         }

Working with Authentication Server

For customers who have a licensed version of sbo objects,  you will need to go through Authentication server for credentials.  you will then communicate with the sbo objects using this _Database (sample connection below) connection.
  1.   private DatabaseConnection _Database;
  2.   public DatabaseConnection Database
  3.   {
  4.       get
  5.       {
  6.           if (_Database == null)
  7.           {

  9.               _Database = new DatabaseConnection("http://localhost/AuthenticationService.asmx");
  10.               _Database.UserCredentials.DatabaseType = DatabaseEngineType.SqlServer;
  11.               _Database.UserCredentials.Server = "yourservernamehere";
  12.               _Database.UserCredentials.Database = "your database VMFG here";
  13.               _Database.UserCredentials.UserID = "your program UserId here";
  14.               _Database.UserCredentials.Password = "your program UserId password here";
  15.               _Database.UserCredentials.ConnectionStringAppend = "Trusted_Connection=False;Encrypt=False;";
  16.           }
  17.           if (!_Database.Connected) _Database.Connect();
  18.              if (!_Database.Connected) MessageBox.Show(this,"No Connection","Database Connection", MessageBoxButtons.OK);
  19.           return _Database;
  20.       }
  21.   }
A call would look similar to:
  1.    CUSTOMER_ORDER CustOrder = new CUSTOMER_ORDER(Database)


Working with WM-Synergy Macro Server

Creating a callable library


When creating a library, (.dll), module the important thing to know is that there are 2 required Public Properties that must be a part of the class file.
  1.  public class MyClass
  2. {       
  3.        #region MacroServer        
  4.         public string ServerURL { get; set; }                               //Url to ServerLib of MacroServer
  5.         public string Key { get; set; }                                          // Encrypted Database Key
  6.         internal MacroServer MacroServer
  7.         {
  8.             get
  9.             {
  10.                 if (_MacroServer == null)
  11.                 {
  12.                     _MacroServer = new MacroServer(ServerURL, Key);
  13.                 }
  14.                 return _MacroServer;
  15.             }
  16.         }
  17.         #endregion
A typical WM-Synergy macro call would look like the following:
  1. dim obj
  2. lib.ActivateObject "obj", "MyFamousibrary.dll", "MyFamouslibrary.MyClass"
  3. set obj = lib.GetObject("obj")
  4. obj.Key = util.authenticationHash
  5. obj.ServerURL = util.ServerURL & "/ServerLib.asmx"
  6. obj.DatabaseType = "SQLServer"
  7. obj.MyMethod
It will be important to store your library in the working directory for the Macro Server Web API.

Create a .dll for a Macro

A Visual ERP Macro must be made as a COM compliant .dll.  In order to do this, the developer should set the following at the project level:

The next step is to set some compile directives on your base class for the .dll
Notes
It is suggested to avoid a Constructor as it may cause issues when loading the .dll (you should validate if it is an issue with your design)
  1.    [ComVisible(true)]   // Expose the class
  2.    [ClassInterface(ClassInterfaceType.None)]  // Select None, as we want to specify what is to be exposed.
  3.    [Guid("5b37be8d-293c-46ba-9503-a4ac961b7101")]  // not required would auto pull from project guid
  4.    [ProgId("CreatePPGSRequests.CreatePPGSRequests")] // suggested, should match with how it would be evoked.
  5.    public class CreatePPGSRequests
  6.    {
  7.        #region Private Variables
  8.        private MacroServer _MacroServer = null;
  9.        private DatabaseConnection _Database = null;

  11.        #endregion
  12.        #region MacroServer Required Properties
  13.        [ComVisible(true)]   // Place these here to ensure the program is making visible to com call those items you want visible
  14.        public string Key { get; set; }             // Key for Authenticator
  15.        [ComVisible(true)]
  16.        public string ServerURL { get; set; }       // MacroServer Authenticator
  17.        [ComVisible(true)]
  18.        public string DatabaseType { get; set; }    // SQLServer vs Oracle

  20.        internal MacroServer MacroServer
  21.        {
  22.            get
  23.            {
  24.                if (_MacroServer == null)
  25.                {
  26.                    _MacroServer = new MacroServer(ServerURL, Key);
  27.                }
  28.                return _MacroServer;
  29.            }
  30.        }
  31.        internal string ServerXMLURL
  32.        {
  33.            get
  34.            {
  35.                return string.Format("{0}/Credentials/{1}.xml", Regex.Replace(ServerURL, "/Serverlib.asmx", "", RegexOptions.IgnoreCase), Key);
  36.            }
  37.        }
  38.        #endregion
For each public method, make sure to add the [ComVisible(true)], this ensures that this method will be available to the vbscript. 
Notes
These extra steps help to ensure that when the project Make project com visible, is actually making visible those objects that you as a developer need exposed to the calling vbscript code base.
  1.         #region Public Methods
  2.         /// <summary>
  3.         /// <c>ProcessWorkOrder</c> 
  4.         /// <para>Create the PPGS OrderImport requests, and move inentory to a temporary holding area, 
  5.         /// until the PPGS has completed all the pulls for the given Pick.</para>
  6.         /// </summary>
  7.         /// <param name="SiteId"></param>
  8.         /// <param name="WorkOrder"></param>
  9.         /// <returns>true if success</returns>
  10.         [ComVisible(true)]
  11.         public bool ProcessWorkOrder(string SiteId, string WorkOrder, string UserId)
  12.         { ...

Sample Macro Call

When creating an SRI style macro for use with Visual ERP, make sure your .dll can be found from a directory withing Macro Server Web API directory.
  1.        Dim obj
  2. lib.ActivateObject "obj","YourSubDirectory/MyFamousDll.dll","MyFamousDll.Client"   // Note the direction of the '/' as this is going through MacroServerer API.
  3. set obj  = lib.GetObject ( "obj" )                              // Instantiate the Reflection into your .dll method
  4. obj.Key = util.authenticationHash                         // Your .dll must have a propert for Key
  5. obj.ServerUrl = util.ServerURL                              // Your .dll must have a property for ServerUrl

  7. obj.LoadForm ORDER_ID

.dll Code Template for your Visual ERP Macro method call

  1.  #region MacroServer Required Properties
  2.  public string Key { get; set; }                        // Key for Authenticator
  3.  public string ServerURL { get; set; }           // MacroServer Authenticator
  4. #endregion

If using sbo objects with your .dll then use the following code snippet to connect sbo objects
  1. private DataBaseConnection _Database = null;

  3. public bool Client()
  4. {
  5.                     _Database = new DatabaseConnection();
  6.                     _Database.UserCredentials.MacroServerXmlUrl = $"{ServerURL.Replace("/Serverlib.asmx", "")}/Credentials/{Key}.xml";
  7.                    _Database.Connect();
  8.                   using (SqlCommand SqlCmd = (SqlCommand)_Database.CreateNewCommand)
  9.                     {
  10.                       SqlCmd.CommandText = $@"SELECT DBVERSION FROM APPLICATION_GLOBAL";
  11.                      if (Convert.ToString(SqlCmd.ExecuteScalar()) != "9.0.8")
  12.                              {
  13.                               MessageBox.Show(this,"This code only works with Visual ERP 9.0.8","Connect to Server");
  14.                               return false;
  15.                            }
  16. ...

Interface with Database Server

There are two methods that can be used when your application needs to connect to the database
  1. Connect through MacroServer
  2. Connect through Synergy BusinessObjects

MacroServer

Given a connection to the Macro Server, try the following:

  1.             string SqlCmd = $@"
  2. SELECT CODE, DESCRIPTION
  3. FROM {TablePrefix}.SRI_TAX_ENTITY_USE_CODES
  4. ";
  5.             SRIMacroServer.ExecuteQueryResults Results = MacroServer.ExecuteQuery(SqlCmd);

SynergyBusinessObjects

Given a MacroServer connection one can try the following:
  1.   
         _Database = new DatabaseConnection(ServerURL);
  2.         #region MacroServer Required Properties
  3.         public string Key { get; set; }                 // Key for Authenticator
  4.         public string ServerURL { get; set; }           // MacroServer Authenticator
  5.         public string DatabaseType { get; set; }        // SQLServer vs Oracle
  6.         internal MacroServer MacroServer
  7.         {
  8.             get
  9.             {
  10.                 if (_MacroServer == null)
  11.                 {
  12.                     _MacroServer = new MacroServer(ServerURL, Key);
  13.                 }
  14.                 return _MacroServer;
  15.             }
  16.         }
  17.         internal string ServerXMLURL
  18.         {
  19.             get
  20.             {
  21.                 return string.Format("{0}/Credentials/{1}.xml", Regex.Replace(ServerURL, "/Serverlib.asmx", "", RegexOptions.IgnoreCase), Key);
  22.             }
  23.         }
  24.         #endregion
  25. public void myMethod()
    {
  26.        _Database = new DatabaseConnection();
  27.        _Database.UserCredentials.MacroServerXmlUrl = ServerXMLURL;
  28.       _Database.UserCredentials.ConnectionStringAppend = "TrustServerCertificate=True";
  29.       _Database.Connect();
  30.      _Database.Transaction = _Database.Connection.BeginTransaction();

  32.      StringBuilder SqlCmd = new StringBuilder();
  33.      SqlCmd.Append("SELECT TOP(1) [TempWarehouse], [TempLocation], [AutoProcess], [AutoEmail] FROM dbo.[SRI_TravelerConfig]");
  34.      IDbCommand GetCommand = _Database.CreateNewCommand;
  35.      GetCommand.CommandText = SqlCmd.ToString();
  36.      IDataReader RecReader = GetCommand.ExecuteReader();

Errors

A connection was successfully established with the server, but then an error occurred during the login process. (provider: SSL Provider, error: 0 - The certificate chain was issued by an authority that is not trusted.)

Causes and Solutions

1. Using a Self-Signed Certificate

If your SQL Server is using a self-signed certificate, it won't be trusted by default. You can either disable encryption or trust the self-signed certificate.

Solution: Add TrustServerCertificate=True to your connection string.

Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=myPassword;TrustServerCertificate=True;

2. Using a Certificate from a Non-Trusted Authority

If the certificate is from a non-trusted authority, you need to add it to the Trusted Root Certification Authorities store on the client machine.

Solution: Export the server certificate and install it on the client machine2.

  1. Export the server certificate using MMC.

  2. Import it into the Trusted Root Certification Authorities store on the client machine.

3. Disabling Encryption (Not Recommended)

As a quick fix, you can disable encryption in your connection string, but this is not recommended for production environments.

Solution: Add Encrypt=False to your connection string3.

Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=myPassword;Encrypt=False;

By following these steps, you can resolve the SSL provider error and establish a secure connection to your SQL Server.

    • Related Articles

    • WM-Synergy - Avalara Tax Connector - Version Info

      To Find the version of Synergy Tax. Launch Visual Manufacturing Navigate to Sales > Customer Maintenance > Macros Menu >Tax Configuration The bottom of the Tax Configuration Screen will have the version number.

    • WM-Synergy SBO - Release Notes

      Unless otherwise noted all Versions should work with a prior release of Visual ERP. The .net framework version will be discontinued. Please begin your transition over to the .net standard version of sbo objects. .Net Standard Compatibility Chart: (as ...

    • WM-Synergy - Avalara Tax - Release Notes

      v1100.1003 2025.05.11 Add more diagnostic to validate the shipping address sent mod to SRI Macros SRITAX/SRITAXC to better handle an empty Avalara return data packet Add <line1><line2><line3> to the request packet information for traceability in ...

    • WM-Synergy Macro Editor

      WM-Synergy Macro Editor This is rich client user interface, which allows for the maintenance of Synergy Created Macros that support the Infor Visual ERP Manufacturing, (VE), Visual Basic Scripts (VBScript) typically used in a VE Macro situation. Each ...

    • WM-Synergy - Avalara Tax - Visual to Avalara Mapping