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.

The SBO installer package comes with sample programs on how to use the SynergyBusinessObjects.dll library.  

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. 

The following libraries may also be required, in a customer created project:

1. Microsoft.Bcl.AsynInterfaces.dll
   
2. Oracle.ManagedDataAccess.dll
   
3. System.Buffers.dll
   
4. System.formats.Asn1.dll
   
5. System.IO.Pipelines.dll
   
6. System.Memory.dll
   
7. System.Numerics.Vectors.dll
   
8. System.Runtime.CompilerServices.Unsafe.dll
   
9. Sytem.Text.Encodings.Web.dll
   
10. System.Text.Json.dll
    
11. System.Threading.Tasks.Extensions.dll
    
12. System.Value.Tuple.dll

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();
13. 
    
14.             ConfigurationManager.AppSettings["SchemaPath"] = Environment.CurrentDirectory + "\\";
15.             string SBOServer = ConfigurationManager.AppSettings["SBOServer"].ToString();
16.             string SBOPort = ConfigurationManager.AppSettings["SBOPort"].ToString();
17. 
    
18.             Url = new Uri(string.Format("http://{0}:{1}/AuthenticationService.asmx", SBOServer, SBOPort));
19. 
    
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();
36. 
    
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;
43. 
    
44.             DataBase.Connect();
45. 
    
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.         }
68. 
    
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();
15. 
    
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;
22. 
    
23.      DataBase.Connect();
24. 
    
25.      return DataBase;
26.  }

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.       }
30. 
    
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);
12. 
    
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);
7. 
   
8.    //   Voucher.POSTING_DATE = dtPostingDate.Value;       // This should be set at time of posting
9. 
   
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
16. 
    
17.    Line.RECEIVER_ID = txtReceiverId.Text;
18.    Line.RECEIVER_LINE_NO = Convert.ToDecimal(txtReceiverLine.Text);
19.    // Line.GL_ACCOUNT_ID = 
20. 
    
21.    Voucher.Lines.Add(Line);
22.    Voucher.Save();
23. 
    
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
15. 
    
16.                     txtCustOrderId.Text = co.ID;
17.                     txtCustOrderToShip.Text = co.ID;
18. 
    
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();
30. 
    
31.                     CUSTOMER_ORDER co1 = co.Load(co.ID);
32.                     int foo = co1.Lines.Count;
33. 
    
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.                     }
40. 
    
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();
56. 
    
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);
68. 
    
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);
79. 
    
80.                     wo.Save();
81. 
    
82.                     txtWorkOrderId.Text = wo.BASE_ID;
83. 
    
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,
97. 
    
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.                     };
106. 
     
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.
8. 
   
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.             }
27. 
    
28.             return result;
29.         }
    

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.

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.      _Database.Transaction = _Database.Connection.BeginTransaction();
3. 
   
4.      StringBuilder SqlCmd = new StringBuilder();
5.      SqlCmd.Append("SELECT TOP(1) [TempWarehouse], [TempLocation], [AutoProcess], [AutoEmail] FROM dbo.[SRI_TravelerConfig]");
6.      IDbCommand GetCommand = _Database.CreateNewCommand;
7.      GetCommand.CommandText = SqlCmd.ToString();
8.      IDataReader RecReader = GetCommand.ExecuteReader();

• Related Articles

• WM-Synergy SBO - Release Notes

  Unless otherwise noted all Versions should work with a prior release of Visual ERP. v1100.1003 - 06/11/2025 Fix Issue in ShipperLine Customer Order for Part id 500pcs, WorkOrder to make part id is for 1000pcs. Linked CO to WO for Supply links for the ...

• 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.

• Retrieving Customizable User Defined Field (CUDF) List Values with SBO

  The UFD List data is stored in the USER_DEF_FIELDS table. It looks like this: You can retrieve it with a direct SQL query, but you need to know the UDF’s ID for the field in question. Here is an example: SELECT PROGRAM_ID, ID, DOCUMENT_ID, LINE_NO, ...

• 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 - 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 ...