UDO - DLL (1)

Question

Hi,
I am using the User Defined Object (UDO) Wizard in B1. I am doing the UDO sample in SDK Help (Step 2 - Create a DLL for SM_MOR Object).
1) How do I build a C++ DLL (White Paper)?
2) And does it have to be a C++ DLL?
3) What about a C# DLL?
Thank you,
Rune

Answer 1

Hello,
I am going to write something about the UDO DLL development. Actually you can refer to the SDK sample <<Program Files\SAP\SAP Business One SDK\Samples\UDO\MealOrder\DllImplement>>. Or just copy to include in you own project and modify accordingly. Of course It is difficult to develop a UDO in C++ with only some C++ header files and B1UdoApi.lib without comments and instructions.  
1.Some important tips:
1).Don't forget to set Extenstion Path in Gernal Settings=>Path the before registration of UDO dll
2).Implement your UDO class inherites from CSboBusinessObject defined in SboBusinessObject.h
3).Export the dll entry point CreateObject with YourUdo.Def
EXPORTS
     CreateObject                 @1
in your UDO class, change the implementation of CreateObject
CSboBusinessObject *CreateObject (unsigned long systemHandle)
     return new CAbsenceReport (systemHandle); // change into your own UDO class
4).Override the virtual funcitons of CSboBusinessObject accordingly in your own UDO class. Very virtual function already has its default implementation in CSboBusinessObject. Don't forget to call CSboBusinessObject's default implementation after your code. For example:
call CSboBusinessObject::OnAdd() in after your code in yourUdo's OnAdd().
2.Include files: (More detailed description about the include files provided by SAP)
1).SboBusinessObject.h:  
You must implement your UDO class inheriting from CSboBusinessObject. UDO and B1 Business Object inheritING from the same base class (CSboBusinessObjectBase), which has implement the default operations(OnAdd(), OnUpdate(), OnIsValid()...). Thus UDO and B1 Business Object share the same routine of initialization and business process. You can override the virtual functions (OnAdd(), OnUpdate(), OnIsValid()...) accordingly. UDO works as plug-in of B1, loaded dynamically into B1's process. The virtual functions list as below
virtual SBOErr OnAutoComplete ();
virtual SBOErr OnCancel ();
virtual SBOErr OnCanDelete ();
virtual SBOErr OnClose ();
virtual SBOErr OnAdd ();
virtual SBOErr OnCreateDefaults ();
virtual SBOErr OnDelete ();
virtual SBOErr OnInitData ();
virtual SBOErr OnIsValid ();
virtual SBOErr OnGetByKey ();
virtual SBOErr OnUndoCancel ();
virtual SBOErr OnUpdate ();
virtual SBOErr OnUpgrade (long fromVersion, long toVersion);
virtual SBOErr AddYearTransferCondition(const CSboCondition &scConditionToAdd);
virtual SBOErr ClearAllYearTransferConditions();
virtual SBOErr OnYearTransfer (unsigned long companyRef);
There are some usful public functions that can be use in your UDO class directly.
//Get the value by collumn alias, table and row line
SBOErr GetValue (const wchar_t *alias, wchar_t *value, long maxLen = -1, ArrayOffset ao = ao_Main, long line = 0);
SBOErr GetValue (long colIndex, wchar_t *value, long maxLen = -1, ArrayOffset ao = ao_Main, long line = 0);
//Get the value by collumn alias, table (no table name but the table enum) and row line
long GetValueLength (const wchar_t *alias, ArrayOffset ao = ao_Main, long line = 0);
long GetValueLength (long colIndex, ArrayOffset ao = ao_Main, long line = 0);
//set the value into DB by collumn alias, table(no table name but the table enum) and row line
SBOErr SetValue (const wchar_t *alias, const wchar_t *value, ArrayOffset ao = ao_Main, long line = 0);
SBOErr SetValue (long colIndex, const wchar_t *value, ArrayOffset ao = ao_Main, long line = 0);
//Set the error field when return an error code. It will be display as error memessage in the status bar if return err code define in SBOErr.h.
SBOErr SetErrorField (const wchar_t *alias);
SBOErr SetErrorField (long colIndex);
//Display the message on B1 status bar
void Message (const wchar_t *str, WarningLevel type);
2).SboDataAcessGate.h and SboCondition.h
CSboDataAccessGate (dag) is the data acess layer connecting the UDO and Database. A dag is binidng with a Table. It is not accessed via the table name but some enum(aoMain: Main table, such as OCRD; ) .CSboCondition play as a role of creation of filter when access to a table in dag, similar to where clause in SQL query. It looks also like Conditions in UI API.
Example 1: UDO implementation using CSboDataAccessGate and CSboCondition
// BNBPDV.cpp : Defines the entry point for the DLL application.
#include "stdafx.h";
#include "SboBusinessObject.h";
#include "__SBOERR.h";
BOOL APIENTRY DllMain( HANDLE hModule,
                       DWORD  ul_reason_for_call,
                       LPVOID lpReserved
    return TRUE;
class BNBPDV : public CSboBusinessObject
public:
BNBPDV (unsigned long systemHandle):CSboBusinessObject(systemHandle),sysHandle(sysHandle)
~BNBPDV (){};
virtual CSboBusinessObject  *Clone (unsigned long systemHandle) {return new BNBPDV (systemHandle);}
virtual void Destroy () {delete this;}
virtual SBOErr OnAdd ()
SBOErr sboErr =noErr;
CSboDataAccessGate dagCurrent = GetDAG(ao_Main);
long key =0;
long codeCol = 0; //hardcode only once
long bpCol = 13;
wchar_t strKey[256] = {0};
//test code
//wchar_t* objName = L"BPDV";
//CSboDataAccessGate dagAllRec = GetDAG(objName, ao_Main);
//test code
//get all record
CSboDataAccessGate dagAllRec = dagCurrent.Clone( false );
CSboCondition cond;
cond.SetColAlias(L"Code");
cond.SetStaticCondVal(L"0");
cond.m_enumOperation = qot_GT;
sboErr = dagAllRec.AddCondition(cond);
if (sboErr != noErr) return sboErr;
sboErr = dagAllRec.DoQuery();
if (sboErr != noErr && sboErr != dbmNoDataFound) return sboErr;
long length = dagAllRec.GetRecordsCount();
//is the table empty
if( length ==1 && dagAllRec.GetValueLength(codeCol,0)==0 )
key =1;
else
long tmp = 0;
for( int i=0; i < length; i++ ) //we have to loop the table because there is no order by supported by UDO
wchar_t* stopStr=0;
sboErr = dagAllRec.GetValue(codeCol, strKey, -1, i);
if (sboErr != noErr) return sboErr;
tmp =  wcstol(strKey, &stopStr, 10);
if (tmp > key)
key = tmp;
key++;
//set the key
_ltow(key, strKey, 10);
sboErr = dagCurrent.SetValue(codeCol, strKey);
if (sboErr != noErr) return sboErr;
dagCurrent.SetValue(codeCol+1, strKey);
dagCurrent.SetValue(codeCol+2, strKey);
//to see if the bp is already existing
//get bp code
CSboDataAccessGate dagBP = dagCurrent.Clone( false );
wchar_t strBPCode[256] = {0};
sboErr = dagCurrent.GetValue(bpCol, strBPCode, -1, 0);
if (sboErr != noErr) return sboErr;
//query
CSboCondition condCheckBP;
condCheckBP.SetColAlias(L"U_BPCode");
condCheckBP.SetStaticCondVal( strBPCode );
condCheckBP.m_enumOperation = qot_EQ;
sboErr = dagBP.AddCondition(condCheckBP);
if (sboErr != noErr) return sboErr;
sboErr = dagBP.DoQuery();
if (sboErr != noErr && sboErr != dbmNoDataFound ) return sboErr;
length = dagBP.GetRecordsCount();
//there is already a existing bp
if( dagBP.GetValueLength(codeCol,0) != 0 )
//delete it
sboErr = dagBP.Delete(0);
if (sboErr != noErr) return sboErr;
else{} //every thing is fine
    //call father class OnAdd function
    sboErr = CSboBusinessObject::OnAdd ();
return sboErr;
private:
unsigned long sysHandle;
CSboBusinessObject *CreateObject (unsigned long systemHandle)
return new BNBPDV (systemHandle);
Example 2: Using CSboBusinessObject.Message() and SetErrorField()
#include "SboBusinessObject.h";
#include "OABR.h";
#include "SboCondition.h";
#include "__SBOERR.h";
#include "string"
#include <stdlib.h>;
#define MEAL_PRICE 25
CSboBusinessObject *CreateObject (unsigned long systemHandle)
return new CAbsenceReport (systemHandle);
CAbsenceReport::CAbsenceReport (unsigned long systemHandle) : CSboBusinessObject (systemHandle)
CAbsenceReport::~CAbsenceReport ()
void CAbsenceReport::Destroy()
delete this;
/* Virtual Functions */
SBOErr CAbsenceReport::OnAdd ()
    //Write your code here:  
    //call father class OnAdd function
    SBOErr sboErr = CSboBusinessObject::OnAdd ();
    return sboErr;
//Recommend to add
SBOErr CAbsenceReport::OnIsValid()
CSboDataAccessGate dagOABR = GetDAG (ao_Main);
CSboDataAccessGate dagClone = dagOABR.Clone( false );
TCHAR strIUser[11] = {0};
SBOErr sboErr = dagClone.GetValue(_T("U_iUser"), strIUser, -1, 0);
//this->Message(strIUser,wl_Note);
if (sboErr != noErr)
return sboErr;
if(0 == _tcslen(strIUser))
return -1;
TCHAR firstChar[1] = {strIUser[0]};
if(    0 != _tcscmp(_T("i"), firstChar)
&& 0 != _tcscmp(_T("I"), firstChar)
&& 0 != _tcscmp(_T("c"), firstChar)
&& 0 != _tcscmp(_T("C"), firstChar))
this->SetErrorArray(ao_Main);
this->SetErrorField(_T("U_iUser"));
//DisplayError(-1);
Message (_T("Invalid iUser. It must start with 'i' or 'I'."),  wl_Error);
return uiInvalidFieldValue;
return noErr;
Hope it helps. A more detail document will be followed up and back to you.
Kind Regards
-Yatsea