Setting up Office Brands integration
Table of Contents
WebX integration
WebX integration will enable customer order downloads, category synchronisation and product, contract and image uploads to your WebX web site.
Readysell staff may already have access to many of the below details, please contact a Readysell Support team member if you require assistance.
Obtain the following details from Readysell, the member and/or Office Brands
Readysell
WebX Username (starts with robi and then continues onto the store name/abbreviation - whatever you want it to be)
WebX Password (Generate this out of LastPass > advanced > Generate passwords - do not include symbols - the office brands end particularly does not like & symbol)
API Username (if it is a multisite with multiple websites, the API username and password is the same across all the sites as you can only have 1 user for API)
API Password
API endpoint url, API password, API username, WebX username and WebX password all need to be sent to Office Brands.
Office Brands
Office Brands Store Identifier
WebX Store ID
Catalogue Filter ID (which is the Web Filter ID on the Site's integration tab)
List Web Price Level ID
Cost Web Price Level ID
Government Web Price Level ID
sell1 through to sell8 Web Price Level IDs
Make sure that Office Brands has a Category set up to be called Store Products. If there are more than 1 website for more that one site owned by the same owners where Readysell is set up to be one program 2 databases, that the category Store Products sits in exactly the same position as the Store Products category on the primary site. Otherwise you will wind up with problems at the store with products not uploading and Failing.
Member Code
AWS Bucket Directory
FTP Directory
Price Level IDs and Codes
In Readysell, go to Administration > Price Levels
Set the Web Price Level ID of "List", "Bulk1", "Bulk2" and "Bulk3" to the List Web Price Level ID obtained from Office Brands
List Web Price Level Code should be 1
Bulk 1 Web Price Level Code should be 11
Bulk 2 Web Price Level Code should be 12
Bulk 3 Web Price Level Code should be 13
Set the Web Price Level ID of "Gov" to the Government Web Price Level ID obtained from Office Brands
Gov Web Price Level Code should be 4
Set the Web Price Level ID of "Cost" to the Cost Web Price Level ID obtained from Office Brands
Cost Web price Level Code should be 2
Set any extra price levels for their Web Price Level ID that lines up to the sell1 through to sell8 Web Price Level ID obtained from Office Brands
i.e. Sell 1 should have a Web price Level Code of s1
The Web Price Level Code must be a lowercase s
Make sure that it lines up with whatever price level Office Brands has been using prior to Readysell for the extra price levels
Sites
Go to Administration > Sites
Select the site for the settings
Make sure the tick box is on for Trading
Click on the tab called Integration
Place the Office Brands Store Identifier in the Store Identifier field
Place the WebX Store ID in the Web Store ID field
Place the WebX Username into the Web Username field
Place the WebX Password into the Web Password field
Place the Web Filter ID into the Web Filter ID field
Place the Member Code intothe Member Code field
Place the AWS Bucket Directory into the AWS Bucket Directory field
Place the FTP Directory into the FTP Directory field.
System Types
Go to Administration > Advanced > System Types
Select the "OFFICE-BRANDS" system type
Fill in the following system references based on the instructions in the Description of each reference and the details collected earlier
If the store is running with BI, set the BI-CUSTOMER-DATA value field to True (otherwise leave it as False)
ONEX-BRAND-ID set it to 1 if it is an ON store, 2 if it is an OPD store, 3 if it is a ONET store
USE-EX-TAX-PRICING make sure the value for this is set to True before running any tasks at all for the Office Brands integration
WEBX-CATALOG-ID (this will be a different based on ON, ONET and OPD stores - check another store of the same brand code before setting)
WEBX-CATALOG-OWNER-ID (this will be a different based on ON, ONET and OPD stores - check another store of the same brand code before setting)
WEBX-DEFAULT-CATEGORY - Should be Store Products unless Office Brands tells you otherwise
WEBX-ROOT-CATEGORY - Should be Web Products
Tasks for the Office Brands Integration
Go to Administration > Advanced > Tasks
Find the "Office Brands Category Sync" job, make sure it is enabled
Click the Parameters tab
Set the value for "CreateNew" to "True"
Run the job
Once the job completes, find the "Office Brands Sync" job, make sure it is enabled
Run the job to test
Once the job completes, find the "Office Brands End of Day" job and make sure it is enabled
Run the job to test
Restart Readysell Server service
Catalogue and product data integration
Catalogue and product data integration will enable catalogue downloads, price book downloads and (optional) direct update of product data from the Office Brands data service.
Go to Administration > Advanced > System Types
Select the "OFFICE-BRANDS" system type
Fill in the following "ONEX-BRAND-ID" system reference based on the instructions in the Description
Go to Administration > Advanced > Tasks
Find the "Office Brands Product Import" task
Make sure the task is enabled and that the LastRunProductImport value is empty
Run the task to test that it works and to bring in all the products.
Set up the API user and give that API user a role
Setting up the API user and assigning it to a role
Business Intelligence (BI) integration
Business Intelligence integration will enable uploads of sales data to Office Brands for analysis purposes.
Readysell staff may already have access to the below details, please contact a Readysell Support team member if you require assistance.
In Readysell, go to Administration > Advanced > System Types
Select the "OFFICE-BRANDS" system type
Fill in the following system references based on the instructions in the Description of each reference and the details collected earlier
BI-FTP-USERNAME
BI-FTP-PASSWORD
BI-FTP-PATH
If there are multiple sites, each site's FTP path must be entered, semicolon delimited in site ID alphabetical order
BI-MEMBER-CODE
If there are multiple sites, each site's member code must be entered, semicolon delimited in site ID alphabetical order
Go to Administration > Advanced > Tasks
Find the "Office Brands Business Intelligence" job
Make sure the job is enabled (Don't forget to restart the Readysell server service when you enable a task)
Click the Parameters tab
Set the "LastRunSalesUpload" date to be the date from which you want uploads to start (e.g. 15/06/2014)
Run the job to test
Go to Administration > Advanced > Tasks
Find the "Office Brands End Of Day Sync" and run the task.
Populate the following relevant details and send it to support@officebrands.com.au, requesting its addition into the ESB entities configuration:
Email format to send to Office Brands
Hi Patrick/Winston,
Please find below the settings for the new store INSERT NEW STORE NAME HERE which will be going live on date: XX/XX/XXXX
Customer WebX / ESB Username:
Customer WebX / ESB Password:
API username
API Password
API url
Please supply the following:
Office Brands Store Identifier
WebX Store ID
Catalogue Filter ID (which is the Web Filter ID on the Site's integration tab)
List Web Price Level ID
Cost Web Price Level ID
Government Web Price Level ID
sell1 through to sell8 Web Price Level IDs
Make sure that Office Brands has a Category set up to be called Store Products. If there are more than 1 website for more that one site owned by the same owners where Readysell is set up to be one program 2 databases, that the category Store Products sits in exactly the same position as the Store Products category on the primary site. Otherwise you will wind up with problems at the store with products not uploading and Failing.
Member Code
AWS Bucket Directory
FTP Directory