Event Streaming enables inter site communications between two or more sites. You can subscribe to Document Types and stream Documents between different sites.

For example, if you have several companies hosted across different sites, with one designated as the primary site for ledger posting and others generating sales invoices, Event Streaming can be employed. In this setup, child company sites can subscribe to the main company site for Document Types like Item, Customer, and Supplier. Conversely, the main company can subscribe to the child companies for Sales Invoices.

To access Event Streaming, go to:

Home > Automation > Event Streaming

1. Prerequisites

Before setting up an Event Producer, it’s essential to create a shared user account on both sites, which will serve as the access point and act as an Event Subscriber. Ensure that this user is designated as a System Manager and possesses the required permissions for creating, updating, and deleting the subscribed Document Types.

2. How to set up Event Streaming

Let’s take two sites for explaining the process. http://testsite:8000 (Consumer site) and http://testsite_producer:8000 (Producer site)

2.1 Obtain the Event Subscriber’s keys from the Producer Site

1. On http://testsiteproducer:8000 (producer site), go to the User list.
2. Access the user document designated for use as an Event Subscriber. Navigate to the section labeled “API Access” within the document. Within this section, generate keys for the user by selecting the “Generate Keys” button. A prompt will appear containing the user secret. Copy the user secret and securely save it. Additionally, an API key will be generated during this process.

2.2 Generate Keys for the Event Subscriber on the Consumer Site

1. On http://test_site:8000 (consumer site), go to the User list and follow the same process specified in the previous step.

2.3 Create an Event Producer on the Consumer Site

The site you wish to subscribe to is referred to as the Event Producer. To create an Event Producer document for the desired site and receive updates from it, follow these steps:

1. Access http://test_site:8000 (the consumer site), then navigate to Home > Automation > Event Streaming > Event Producer.
2. Enter the URL of the site you want to subscribe to (e.g., http://testsiteproducer:8000) in the Producer URL field.
3. In the Event Producer Document Types table, add all the Document Types you wish to subscribe to.
4. If you want the created documents to have the same name as on the remote Event Producer site, check the ‘Use Same Name‘ checkbox for the relevant Document Type.
5. Set the Event Subscriber field to the user that will create the fetched documents from the Event Producer. Ensure this user is created on both the Event Consumer and Event Producer sites before creating the Event Producer.
6. Paste the API key and API secret generated earlier (in step 2.1) into the corresponding fields.
7. Save the configuration.

Upon saving, an Event Consumer is automatically created on the producer site (http://testsiteproducer:8000). The user keys from the consumer site are copied to the Event Consumer document on the producer site during this process.

Note: If at all the API Secret is changed for the users on any of these sites, you will have to manually update the keys in the Event Producer as well as the Event Consumer on both the sites.

2.4 Approve Event Consumer on the Event Producer site

Once the Event Producer is created, an Event Consumer is automatically generated on the producer site. By default, all the subscribed Document Types have the status set to ‘Pending’. To allow the Event Consumer to process documents of these types, their status must be updated to ‘Approved’.

To update the status of the subscribed Document Types, follow these steps:

1. Navigate to Home > Automation > Event Streaming > Event Consumer.
2. Open the Event Consumer document to view the list of subscribed Document Types.
3. Change the status from ‘Pending’ to ‘Approved’ for all the Document Types you want to enable for consumption. Alternatively, you can set the status to ‘Rejected’ if you wish to exclude documents of a particular type.
4. Save the changes.

This process ensures that the Event Consumer is configured to process documents of the approved Document Types.

Note: Document updates for Subscribed Document Types won’t be synced unless they are Approved.

2.5 Offline access with single site

If you encounter areas with limited internet connectivity, such as a store located in a remote area where sales invoices are generated, and you wish to synchronize these invoices from the store to your hosted account, you can establish offline syncing using the steps below:

1. Set up a local instance of BizCentric.
2. Ensure you have a hosted account configured for your company.
3. Create an Event Producer within the hosted account and specify the producer URL as the URL of your local account.
4. Include the desired doctypes for synchronization in the Event Producer Document Types child table.
5. Approve the selected doctypes.

3. Features

3.1 Unsubscribe from the updates

As an Event Consumer, if you intend to cease receiving updates for any previously subscribed doctypes, simply mark “unsubscribe” against the respective doctype. Upon unsubscribing, you will no longer receive updates from the producer site for that specific doctype.

3.2 Event Update Log

To access the “Event Update Log,” which records every create, update, and delete action for documents with consumers on the Event Producer site, follow these steps:

Navigate to: Home > Automation > Event Streaming > Event Update Log.

• For ‘Create’ entries, the log includes the Update Type, Document Type, Document Name, and the complete document (in JSON format).
• For ‘Update’ entries, the log includes the Update Type, Document Type, Document Name, and the updated data (the changes between the previous and current states of the document).
• For ‘Delete’ entries, the log includes only the Update Type, Document Type, and Document Name.

3.3 Event Sync Log

To access the “Event Sync Log,” which records every document synced from the Event Producer on the Event Consumer site, follow these steps:

1. Navigate to: Home > Automation > Event Streaming > Event Sync Log.
2. For successfully synced events, a log document is generated with the following details:
   • Update Type: Indicates whether the event was a create, update, or delete action.
   • Status: Shows the synchronization status.
   • DocType: Specifies the type of document.
   • Event Producer: The URL of the site where the document was created.
   • Document Name: The name of the document.
   • Remote Document Name: This field appears if ‘Use Same Name’ is unchecked.
   • Data: The document data in JSON format.
3. For failed events, the log document includes the above fields plus:
   • Error: Describes the error that prevented the document from being synced.
4. Additionally, a ‘Resync’ button is provided to allow users to attempt to resynchronize the failed event.

3.4 Dependency Syncing

Some Document Types rely on dependencies. For instance, prior to syncing a Sales Invoice, the presence of both the Item and Customer is required on the current site. Therefore, Item and Customer serve as dependencies for Sales Invoice. Event Streaming manages this through on-demand dependency syncing. When syncing a document, the system checks for any dependencies, such as Link fields, Dynamic Link fields, Child Table fields, etc. If a dependency is not met—meaning the dependent document (e.g., Item) is not available on the consumer site—it will be synced first before the Sales Invoice is synchronized.

3.5 Naming Configuration

Selecting the ‘Use Same Name’ checkbox ensures that the documents have the same name on both the Event Producer and Event Consumer sites. If this option is not selected, the document will be created using the naming conventions specific to the current site.

Note: For Document Types that have naming series, it is advised to keep the ‘Use Same Name’ checkbox unchecked, to prevent naming conflicts. If this is unchecked, the Documents are created by following the naming conventions on the current site and the ‘Remote Site Name’ and ‘Remote Document Name’ custom fields are set in the synced document to store the Event Producer site URL and the document name on the remote site respectively.

3.6 Mapping Configuration

If you want to stream documents in BizCentric instance.

For this you need to first set up a Document Type Mapping.

To access Document Type Mapping, go to:

Home > Automation > Event Streaming > Document Type Mapping.

3.6.1 Mapping for DocTypes with similar structure

• Mapping Name: Assign a unique name to the mapping.
• Local Document Type: The Document Type in your current site.
• Remote Document Type: The Document Type on the Event Producer site that you wish to synchronize.

In the Field Mapping child table:

• Local Fieldname: The field name in the Local Document type of your current site.
• Remote Fieldname: The field name in the Remote Document type of the Event Producer site that you want to map to the Local Fieldname.

During the synchronization process, the value of the remote field name is copied to the local field name.

3.6.2 Default value for some field

If your field isn’t mapped to any other remote field name and you always want the field to maintain the same value, ensure to specify it in the default value field. Even if a remote field name is set, if the value of the remote field isn’t found during the synchronization process and a “Default Value” has been specified, it will be applied.

3.6.3 Mapping for DocTypes having child tables

If the field you are trying to map is a child table, you need to create another Document Type Mapping for the child table fields.

• Mapping Type: Select the Mapping Type as Child Table.
• Mapping: Select the Document Type Mapping document you created for the child table.