This document discusses the data schemas used by Bizweaver to interface with SAP Business One and how to update these schemas when changes are made in SAP Business One.

This document is intended for technical users that create and maintain Bizweaver workflows. It is not intended for general end users.

External applications like Bizweaver can interact with SAP Business One through a mechanism called the “Data Interface” or “DI.” There are two DI mechanisms available: DI Server and DI-API. These mechanisms accomplish the same thing but work in different ways. Bizweaver cab use either DI Server or DI-API.

Data schemas are files that describe functions that are available (Add, Update, etc.) and data elements that can be used when Bizweaver interacts with SAP Business One through the DI. These schemas are generated by Bizweaver based on information provided by the DI Server application. Information from the schemas is displayed in the Bizweaver Mapper tool.

Data schemas used by DI Server are found in folders named C:\ProgramData\Bizweaver\Schemas\{Server}\{Database}. (Server} and {Database} are the names specified in a DI connection as shown below. In this example, the folder path would be C:\ProgramData\Bizweaver\Schemas\SAPDEV91\bizweaver.

Data schemas used by DI-API are different in that they are generated at runtime. The SAP objects that can be manipulated by DI-API are found in a file named DIAPIMethodsInfo.xml in C:\Program Files\Bizweaver. A template file is also found in C:\ProgramData\Bizweaver.

Schemas are checked the first time a Mapper step using a particular DI Server connection is introduced into a workflow.

Manually updating (refreshing) schemas is generally not needed if no changes have been made to the data structures in SAP Business One. However, if User Defined Fields (UDF) or User Defined Objects (UDO) have been created in SAP Business One it may be necessary to do a manual update.

The preferred way to update DI Server schemas is to use the “Refresh Object Schemas” link found in the Global Connection function for the specific SAP company. The schemas can also be updated by using the “Refresh Schemas” link on any Mapper step in any workflow. However, it generally a better approach to do the update from the Global Connection function. Remember that only the schemas for the selected DI Server connection identified will be updated. This is only a concern if you have multiple DI Server connections defined.

SAP Business One provides functions to expand the data captured in the application. Additional columns can be added to the standard tables. These are called User Defined Fields or UDF. Addition data tables (User Defined Tables or UDT) can also be added however they are not available through the DI mechanisms. In order for User Defined Tables to be accessed by the DI mechanism they must be registered as User Defined Objects or UDO. Registering a UDO in SAP Business One outside the scope of this document.

In order for new User Defined Fields and User Defined Objects to be included in the data schemas used by Bizweaver it is necessary to update the schemas for the targe company following a specific set of steps as described below.

1. The new objects must be created and registered in SAP Business One before beginning this process.
   1. Ensure that only one user has Bizweaver open during this process.
2. Start Bizweaver using the “Run as administrator” option. Bizweaver will normally start in this mode. However, some installations have security controls in place that may require the following steps to be used.
   1. Hold down the <Shift> key and right-click on the Bizweaver icon.
   2. Select the “Run as administrator” option. This will allow Bizweaver to run with administrative privileges for the initial steps of the process.
3. Stop the Bizweaver Service.
4. - Click the Stop link in the General Settings function (the “gears”) in the icon bar.
5. Close Bizweaver.
6. Stop DI Server.
   1. This must be done using Windows Task Manager.

- Find “Bizweaver Service” on the “Services” tab.

  - Right-click and select "Stop".
    - Be sure to wait until the status shows "Stopped" before continuing.
- Using Windows Explorer, navigate to the folder where the schemas are located.
  - See the explanation of the location of the folders in the “What are Data Schemas” section found earlier in this document.
  - Delete (or rename) the **database** folder for the DI connection to be updated. In the sample in the earlier section the “bizweaver” folder will be deleted.
- Open Bizweaver. The “Run as administrator” option is not required at this time.
- Open the appropriate DI Server connection in the Global Connections function.
- Click the “Refresh Object Schemas” link.
  - A green progress bar is displayed in the lower right corner of the Bizweaver application. A message is displayed when the process is complete.
- Close Bizweaver.
- Open Bizweaver.
- Restart the Bizweaver Service
  -- Click the __Start__ link in the General Settings function (the "gears") in the icon bar.
- Confirm that the new object is available.
  - UDFs are displayed in the specific service (e.g. BusinessPartnerService) where they are used.
  - UDOs are displayed in the “Select Service” section of the Mapper.

When attempting to generate a schema for a UDO you may find that the service is not displayed. In most cases this is due to the fact that the name defined for the UDO contains spaces and this is not supported by DI Server. This can easily be changed. The steps below describe this process for the Third Wave RMA add-on. The process is the same for other UDOs.

1. In SAP Business One go to Tools > Customization Tools > Objects Registration Wizard.
2. Select “Update an Existing Object” option.
   1. A list of existing objects is displayed
3. Locate the object to be updated. In this example it is “TWBS RMA”.
4. Click [Next]
5. Remove any spaces from the name value.
   1. In this example the name is changed from “TWBS RMA Documents” to TWBSRMADocuments”.
6. Click [Next].
7. Click [Finish].
8. Follow the remaining prompts to update the database and then [Finish] to close the wizard.
9. Wait for approximately one minute to allow the changes to be fully recorded.
10. Follow the steps in the “General Steps” section above to update the Bizweaver schemas.