User’s Guide

Order Supplies

ENG
Version C
Copyright

Copyright © 2020 Brother Industries, Ltd. All rights reserved.

Information in this document is subject to change without notice. The screens in this document are for
illustration purposes only and may differ from the actual screens. The software described in this document is
furnished under licence agreements. The software may be used or copied only in accordance with the terms
of those agreements. No part of this publication can be reproduced in any form or by any means without
prior written permission of Brother Industries, Ltd.

Trademarks

Any trade names and product names of companies appearing on Brother products, related documents and
any other materials are all trademarks or registered trademarks of those respective companies.
Table of Contents
1 Background 1

2 Configuration 2
2.1 Creating and editing JSON files ............................................................................................................. 2
2.2 Settings ................................................................................................................................................... 3
2.3 Deploying the configuration file .............................................................................................................. 4

3 Usage 6
3.1 Ordering supplies from the machine’s control panel .............................................................................. 6
3.2 Troubleshooting ...................................................................................................................................... 7

Appendix - Sample JSON Files 8

Sample JSON file for a single contact entry ................................................................................................. 8
Sample JSON file for multiple contact entries (supported models only) ...................................................... 9
 1 Background

The Brother “Order Supplies” software solution allows users to quickly order Brother genuine supplies from
their network-connected machines. Such orders are then emailed to a designated Brother dealer or IT
administrator who can fulfil them according to the requested supply type and quantity.

Features
• Adds the “Order Supplies” button to the machine’s Services menu.
• Customisable maximum number of supplies and accessories allowed per order.
• An optional PIN to prevent unauthorised orders of supplies.
• Customisable user and dealer/IT administrator contact information stored on the machine.
• Quick configuration using JSON files and the Brother Mass Deployment Tool.
• Quick and secure communication via email (SSL or TLS).

NOTE
• To activate this solution, you need a valid licence code and software that can send licence codes
to target machines. For more information, contact your local Brother office.
• For a comprehensive list of all Brother machines compatible with the Brother “Order Supplies”
solution, contact your local Brother office.
 2 Configuration

To configure a service solution component, prepare a correct JSON (JavaScript Object Notation) settings
file, and then send it to the target machine using the Brother Mass Deployment Tool.

2.1 Creating and editing JSON files

JSON is an open standard that allows you to specify your own settings without having to understand PCL or
PJL commands. Any JSON-supported text editor can be used to create and edit settings files.
JSON file format (Example)
2
{
"attributes": {
"software_id": "pns_firmware",  fixed value “pns_firmware”
"setting_version": "",  version (operators can use this field for tracking)
"schema_revision": 4  current schema version
},
"settings": {
"network": {
"protocol": {
"mail": {
"mail_enabled": true
},
"services_mail": {
"smtp_server_address": "192.168.0.1",
"smtp_server_port": 389,
"smtp_server_authentication_method": "smtp_auth",

Red: Setting name

Green: Setting value

The structure of the “Order Supplies” JSON settings file and the placement of individual setting entries are
described in the JSON schema files provided with the Brother Mass Deployment Tool, which is required to
send JSON settings files to Brother machines.
The following setting categories are supported:
Category Description
services_mail The Services email server settings
contact_info The details of the recipient of service requests
personal_info The details of the sender of service requests
privacy_policy The privacy notice options
order_supplies The Order Supplies solution’s settings
See Appendix for a sample JSON files.
2.2 Settings
2.2.1 Email settings

Name Description
smtp_server_address Specify the SMTP server address. Format: 0.0.0.0.
smtp_server_port Specify the SMTP server port number.
smtp_server_authentication_method Specify the SMTP server authentication method.
Values: “none”, “smtp_auth”.
smtp_auth_account_name Specify the SMTP account name.
smtp_auth_account_password Specify the SMTP account password.
smtp_ssl_tls_method Specify the SMTP security protocol.
Values: “none”, “ssl”, “tls”. 2
smtp_verify_server_certificate_enabled Select whether to enable the CA certificate when
using SSL or TLS. Values: “true”, “false”.
device_email_address Specify the email address used by the target
machine to send service requests.

2.2.2 Contact information

Name Description
contact_name The name of the recipient of service requests (up to
255 alphanumeric characters or symbols).
contact_phone_num The phone number of the recipient of service requests (up to
20 digits and the following symbols: *, #, – ).
contact_email_address The email address of the recipient of service requests (up to
255 alphanumeric characters or symbols).

NOTE
The contact information entered under channel_service > contact_info applies in one of the
following cases:
• Your model supports only a single contact entry JSON file.
• Your model supports a multiple contact entry JSON file and you want to have the same contact
information for all software solutions listed in your JSON file.
If your model supports a multiple contact entry JSON file and you want to specify separate contact
information for each solution, go to the required solution's entry in your JSON file and enter the contact
information you want under “contact_info”. See a sample JSON file for the multiple contact entry in
the Appendix.

2.2.3 Personal information

Name Description
personal_name The name of the sender of service requests (up to
255 alphanumeric characters or symbols).
personal_phone_num The phone number of the sender of service requests (up to
20 digits and the following symbols: *, #, –).
personal_email_address The email address of the sender of service requests (up to
255 alphanumeric characters or symbols).
2.2.4 Privacy settings

Name Description
privacy_notice_skip Specify whether to display the privacy notice before sending
a service request.
Values: “true”, “false”.
privacy_policy_url Specify the privacy notice URL.

2.2.5 “Order Supplies” rules

Name Description
contact_info contact_name The name of the recipient of service requests (up to
(up to two 255 alphanumeric characters or symbols). 2
settings, contact_phone_num The phone number of the recipient of service requests
supported (up to 20 digits and the following symbols: *, #, – ).
models only) contact_email_address The email address of the recipient of service requests
(up to 255 alphanumeric characters or symbols).
order_supplies_report_format Specify the supplies order report format.
Values: “plaintext”, “xml”, “csv”.
order_supplies_max_order_quantity Specify the maximum quantity of supplies the user can
order (max: 9).
order_supplies_pin_require Specify whether the user needs to confirm the supplies
order with a PIN. Options: “true”, “false”.
order_supplies_pin Specify the PIN required by the user to order supplies
(4 digits).
order_supplies_history Specify whether to display the previous order history
(supported models only) before sending the current order. Options: “true”,
“false”.

2.3 Deploying the configuration file

Use the Brother Mass Deployment Tool to send your newly created JSON file to the target machine to apply
the settings.

1. Run the Brother Mass Deployment Tool.

NOTE
Make sure you know which schema file is supported by your model. For a list of available schema files
and applicable models, see the README.TXT file in the “schema” folder. You will need this
information later.

2. Check that the machine you want is in the list.

If the machine is not in the list, click the Add devices button.

3. Select the target machine or machines.

4. Click the Set file button. Select the settings file you want to apply, and then click Open. The file you
selected appears in the Settings File column.
5. If you are applying settings to password-protected machines, enter their passwords in the Device
Password column.

6. Select the checkbox of the machine you want, and then click the Send button to finish. If unsuccessful,
click the Open log folder button and check the log file.

NOTE
• For more information, see the Mass Deployment Tool User’s Guide at support.brother.com.
• To remove this software solution and associated personal information from the machine, reset the
machine's settings to the settings originally set at the factory. For more information, see your
machine's Online User's Guide.

2
 3 Usage

3.1 Ordering supplies from the machine’s control panel

If your Brother machine’s supplies are running low, you can order new supplies by doing the following:

1. On your machine’s home screen, press Services. 2. Press Order Supplies.

3. Select the required supply items and their quantity.

(The supplies and accessories may differ depending on the model.)

4. Select the required accessories and their quantity.

(The supplies and accessories may differ depending on the model.)

5. Press Start. If required, enter the PIN provided by your Brother dealer or IT administrator.

6. Accept the privacy notice and press OK. 7. Your order has been placed.

Your Brother dealer or IT administrator will confirm your order and the new supplies will be delivered to you
shortly. A copy of your request will also be sent to your personal email address.

3.2 Troubleshooting
Problem Solution
Authenticate Err. Make sure the email settings are configured correctly.
(Authentication Error)
Sending error Make sure that the machine is connected to the network and the Contact
and Personal email addresses are configured correctly.
I want to display the Privacy To view the privacy notice again, go to Home Screen > Services >
Notice again Privacy Notice.

If the user has agreed to the Privacy Notice, the “Agree” button will be
greyed out.
Appendix - Sample JSON Files
Sample JSON file for a single contact entry
{
"attributes": {
"software_id": "pns_firmware",
"setting_version": "",
"schema_revision": 4
},
"settings": {
"network": {
"protocol": {
"mail": {
"mail_enabled": true
},
"services_mail": {
"smtp_server_address": "192.168.0.1",
"smtp_server_port": 389,
"smtp_server_authentication_method": "smtp_auth",
"smtp_auth_account_name": "account_name",
"smtp_auth_account_password": "account_password",
"smtp_ssl_tls_method": "ssl",
"smtp_verify_server_certificate_enabled": true,
"device_email_address": "[email protected]"
}
},
"channel_service": {
"contact_info": [
{
"contact_name": "dealer2",
"contact_phone_num": "000-000-000-000",
"contact_email_address": "[email protected]"
}
],
"personal_info": [
{
"personal_name": "custom2",
"personal_phone_num": "2222-2222-2222-2222",
"personal_email_address": "[email protected]"
}
],
"privacy_policy": {
"privacy_notice_skip": true,
"privacy_policy_url": "http://example2.com"
},
"order_supplies": {
"order_supplies_report_format": "plaintext",
"order_supplies_max_quantity": 5,
"order_supplies_pin_require": true,
"order_supplies_pin": "1111"
}
}
}
}
}
Sample JSON file for multiple contact entries
(supported models only)
{
"attributes": {
"software_id": "pns_firmware",
"setting_version": "",
"schema_revision": 4
},
"settings": {
"network": {
"protocol": {
"mail": {
"mail_enabled": true
},
"services_mail": {
"smtp_server_address": "192.168.0.1",
"smtp_server_port": 389,
"smtp_server_authentication_method": "smtp_auth",
"smtp_auth_account_name": "account_name",
"smtp_auth_account_password": "account_password",
"smtp_ssl_tls_method": "ssl",
"smtp_verify_server_certificate_enabled": true,
"device_email_address": "[email protected]"
}
},
"channel_service": {
"contact_info": [
{
"contact_name": "dealer2",
"contact_phone_num": "000-000-000-000",
"contact_email_address": "[email protected]"
}
],
"personal_info": [
{
"personal_name": "custom2",
"personal_phone_num": "2222-2222-2222-2222",
"personal_email_address": "[email protected]"
}
],
"privacy_policy": {
"privacy_notice_skip": true,
"privacy_policy_url": "http://example2.com"
},
"order_supplies": {
"contact_info": [
{
"contact_name": "dealer1",
"contact_phone_num": "111-111-111-111",
"contact_email_address": "[email protected]"
}
],
 "order_supplies_report_format": "plaintext",
"order_supplies_max_quantity": 5,
"order_supplies_pin_require": true,
"order_supplies_pin": "1111"
}
}
}
}
}