ADCUtility Manual 1.16
ADCUtility Manual 1.16
Rev. 1.16
Date of update: September 9, 2015
Sharp Corporation
Digital Document Systems Group
1. Introduction .......................................................................................................... 2
3. Restrictions .......................................................................................................... 3
1
1. Introduction
This specification describes a utility for converting Address Book data in digital MFPs sold by the Digital Document
Systems Group.
2. Utility Overview
This utility operates as shown in Figure 1.
It defines a common Address Book format (xml) not depending on digital MFP models, and creates a conversion
module (bidirectional) between Address Book of each model and the common one. This configuration enables
conversion of Address Book via the common Address Book format (xml) between models supporting this utility. Also
when a new model is created in the future, just one bidirectional conversion module is required to be created
between the Address Book of the new model and the common one so that mutual conversion of Address Book can
be performed with models supporting this utility.
A AdressBook B AdressBook
Common AdressBook
C AdressBook D AdressBook(New)
Figure 1 New Address Book Conversion Method (*The arrows mean conversion.)
2
3. Restrictions
> This utility does not send/receive Address Book data to/from MFPs.
Use the Address Book Transfer Tool or the Storage Backup function in each MFP to send/receive Address Book
data to/from MFPs.
> When the language code used in the Address Book (code page) is not installed in the OS, characters may not be
converted correctly.
Use the OS of the same language as the one used in the Address Book.
> Address Book items to be converted differ depending on models and functions of MFPs.
> Only Address Book items that can be used with the Address Book Transfer Tool used in each MFP can be
converted. Items that can be used only with the MFP cannot be converted.
> The number of registrations, digits of destination numbers, and characters that can be used in the Address Book
differ depending on each model.
3
4. Operation Environment
4.1. Supported OS
This utility operates in the following environment.
OS Required Component
Windows 98 MSXML V2 (*1)
Windows ME MSXML V2 (Installed as standard)
Windows NT Workstation 4.0 MSXML V2 (*1)
(ServicePack4 or later)
Windows 2000 Professional MSXML V2 (Installed as standard)
Windows XP Home Edition MSXML V2 (Installed as standard)
Windows XP Professional
or later
*1 "MSXML V2" is not installed as standard in Windows98 and WindowsNT Workstation 4.0. It needs to be
installed according to the following procedure.
[Check of MSXML]
First, check if MSXML V2 is installed in the system.
The following describe the method of checking.
1) Boot Explore and open the following folder.
(Note) Windows NT/2000…C:\WINNT\system32
Windows 98/ME…C:\Windows\system
Windows XP…C:\Windows\system32
2) If "msxml.dll" exists in the file list and the file version is 5.0 or later, MSXML V2 is installed. In this case, skip the
following [Installation Method of MSXML V2].
4
4.3. Language Support
Address Book Type Language Code
Common Address Book Data UTF-8*1
Address Book Data per Model (For Japan) Shift-JIS, UTF-8*1
Address Book Data per Model (For US and Western ISO-8859-1(ASCII)
Europe) UTF-8*1
*1 UTF-8 can be used in models where data output by the Storage Backup function is used for conversion.
5
5. Operation Method
5.1. Address Book Conversion
This is used to convert Address Book data between different models.
Boot the utility and click the "Convert" tab to open the following window.
6
Model of Address Book Data to be Converted (Common in Source and Target Address Book)
Model Description
(Ex.) AR- XXX Address Book registered in MFPs
Display MFP series names.
PC-FAX VX Address Book of PC-FAX Driver (X of VX: version number)
English
UTF-8
1) Select or enter the model, language information, and file name of the Source Address Book data.
Press the "Reference" button to display a file selection dialogue to select files.
*If the source Address Book or target Address Book has been selected “Text (Tab delimited) (UTF-8)” ,
You must select “UTF-8” for language.
2) Select or enter the model and file name of the Target Address Book.
Press the "Reference" button to display a file selection dialogue to select files.
*Language data cannot be changed.
3) Check/uncheck the "A default value is used when a value is inaccurate" checkbox.
Source Address Book data may not be able to be converted without additional operations or may lack required
data. Therefore the utility automatically validates Address Book data before converting it.
Checked: Simplify data validation. Even if some information is lacked because of limit of the number of
characters, errors do not occur. Also default settings are applied. Therefore the number of errors decreases.
However check Target Address Book data because it may differ from the Source Address Book data.
Unchecked: Validate data in detail. Report all differences of data storing formats depending on model as errors.
4) Press the Convert button.
1. If the Address Book data was encrypted when it is obtained, a dialogue for entering the password for the
Source Address Book file.
> Enter the configured password and then click the "OK (O) " button.
> If the "Cancel (C) " button is clicked, the window will be closed and conversion will not begin.
> When the password does not match, an error message appears indicating that the format is incorrect.
> If the number of characters of the entered password exceeds the limit, an error message appears and
directs the user to enter the password again.
> When the obtained Address Book data is not encrypted, this dialogue does not appear.
7
2. When the model of the Target Address Book supports encryption of Address Book data, a dialogue for
entering the password for the Target Address Book file.
> Enter the configured password and then click the "OK (O) " button.
> If the "OK (O) " button is clicked without entering the password, conversion will be performed without
encryption.
> If the "Cancel (C) " button is clicked, the window will be closed and conversion will not begin.
> If the number of characters of the entered password exceeds the limit, an error message appears and
directs the user to enter the password again.
> When the model of the Target Address Book does not support encryption, this dialogue does not appear.
This message shows that validation is completed without problems and the Address Book has been converted
normally.
8
5.1.2.3. Error
When data errors are detected in validation, the following error dialogue appears.
The error log list and text file for editing in the following formats are output to the folder for storing files after
conversion specified on the utility screen.
Validation result files are output in the following format based on error content.
When multiple errors occur, they are listed in the same format. (Refer to the above figure.)
============================
[Category : ID]
Error Content
============================
9
Category List
Category Description
DEST Destination (FAX, IFAX, DSMTP, EMAIL, FTP, DESKTOP, SMB, GRP)
ID Display Method
Category Description
.. Troubles not depending on ID
*ID refers to ID per category used in editing files. Independent ID is used for each category.
5.1.2.5. Editing
Press the "Edit (E) " button in the error dialogue to output the text file (tab delimited) for editing. At the same time,
the file is displayed in Microsoft Excel.
In editing files, "***" is added to the items whose formats differ from those of the Target Address Book data and
items that need to be modified. Modify the items reported in the error log list.
There is that the source Address Book in UTF-8 can not be displayed correctly by Microsoft Excel. If this is the
case, please correct the source Address Book to check the contents of the error log list and “***” above.
10
5.2. Boot of the Address Book Transfer Tool
Boot this utility and click the "Tool" tab to open the following window.
2. Address Book Transfer Tool Display the Address Book Transfer Tool name in full path relating to the
model selected in "1" above.
3. Reference Open a file selection dialogue. When the Address Book Transfer Tool
name is entered in the dialogue, the file path is automatically entered into
the text box of "2" above.
4. Start Boot the Address Book Transfer Tool relating to the model selected in 1
above.
Model Information
Model Description
(Ex.) AR- XXX Display the series name of the MFP where Address Book data is
sent/received.
11
5.2.2. Operation Method
First Use
When a model is selected in the "Model" pull-down list for the first time, nothing appears in the "Address Book
Transfer Tool" text box. Enter the path of the Address Book Transfer Tool, and then press the “Start” button to boot
the Address Book Transfer Tool for each selected model.
[Resolution]
Reinstall MSXML. For the installation method, refer to "2.1 Supported OS".
[Resolution]
Check if ADCIF.dll exists in the specified path.
If it exists in the specified location, it may have been corrupted while it was downloaded. Download it again.
12
3) When the convertor modules for editing (dll, xml) do not exist or they are corrupted.
[Resolution]
Check if the modules (CVEdit.dll, CVEdit.xml) for creating editing files exist in the specified path.
If they exist in the specified path, they may have been corrupted while they were downloaded. Download them
again.
4) When no Address Book exists in the path specified in Source Address Book
5) When conversion is not required because the data is converted between the same model, or because the same
Address Book format is used.
6) When the Source Address Book is the same as the Target Address Book
13
7) When an Address Book file already exist in the path designated in File Name of Target Address Book.
[Resolution]
Disable the read-only attribute of the file after conversion.
[Resolution]
The model name and the selected Address Book file may not match. Check the selected file again.
14
11) When the editing file could not be created
12) When the Address Book Transfer Tool could not be booted
[Resolution]
The Address Book Transfer Tool does not exit in the specified path. Check the path again.
13) When a conversion module supporting the password entry function could not display a password dialogue.
[Resolution]
Check if the displayed dll file version is the latest one. If it is not, update it to the latest one.
14) When the entered number of characters of passwords exceeds the entry range.
[Resolution]
Enter the password again within the displayed range.
15
5.4. Editing of Address Book Data
To edit Address Book data, use Text(Tab delimited) (hereinafter referred to as "editing file"). Microsoft Excel is
recommended to be used for editing Address Book.
The following describes the method of creating editing files treating all data as text.
1) Boot Microsoft Excel.
2) Click the red circle part in the following figure so that all cells will be selected.
3) With all cells selected, right-click on any cell, and then select "Format Cells".
4) When the "Format Cells" dialogue appears, click the "Number" tab.
5) Select "Text" in "Category” and then press the OK button. Now all data is treated as text.
6) Register Address Book data according to Chapter 6 "Address Book Data (for editing) Format".
7) Save the editing file.
Click "Save As" in the "File" menu.
When the "Save As" dialogue appears, set "Save as type" at the bottom of the dialogue to "Text (Tab delimited), "
enter the file name, and save the file. (The extension of editing files is "txt. ")
In the case of store the data in UTF-8, please save it in a text that supports UTF-8.
16
To create Address Book data using a sample file (with a header line) for new entry, refer to "5.4.2 Editing Method
with Microsoft Excel". For storing location of sample files for editing, refer to "4.5 File Configuration".
Source Address Book data may not be able to be converted without additional operations or may lack required data.
Therefore the utility automatically validates Address Book data before converting it. If the result of the validation
shows that the Address Book is required to be edited or modified, the utility automatically create the editing file. The
editing file is output to the folder for storing files after conversion as a " Text(Tab delimited)". For details, refer to "5.1
Address Book Conversion".
For the editing method of created editing files with Microsoft Excel, refer to "5.4.2 Editing Method with Microsoft
Excel".
The following describes the method of opening data in editing files in the text format.
(Some display of the sample screen below may differ depending on Microsoft Excel version.)
17
1) Boot Microsoft Excel.
2) Select "File"- "Open" from the menu. When the "Open" dialogue appears, change "Files of type" at the bottom to
"All Files" or "Text Files" and then select the target file.
(The extension of editing files is "txt. ")
3) "Text Import Wizard -Step 1 of 3" appears.
Check that "Delimited-Characters such as commas or tabs separate each field" is selected in "Original data type"
and then press the Next button.
18
5) "Text Import Wizard -Step 3 of 3" appears.
Select all items in "Data preview" by pressing the "Shift" key on the keyboard.
When all items are selected, they are highlighted.
6) Edit the file according to Chapter 6 "Address Book Data (for editing) Format".
[Supplementary]
When data includes "double quotation marks (")" or "commas(,)" Microsoft Excel performs the following processing
before storing the data.
> When data includes double quotation marks ("), they will be replaced with ("").
> Double quotation marks are added to the beginning and end of data.
This processing is the same as that performed when CSV format data is treated.
The Address Data Control Utility correctly reads data for which such processing was performed.
The above processing is not required in the tab-delimited text format used for editing Address Book data.
When you edit data using Microsoft Excel, you needn’t be aware of the above processing. Microsoft Excel
automatically performs it. When the Address Data Control Utility reads data, it automatically converts data to its
original format.
19
The following show examples of processing performed by the Address Data Control Utility when data is read.
Example 1:
Original Data "Johnny Depp"
After Reading "Johnny Depp"
The Address Data Control Utility determines that the double quotation marks (") were not automatically added by
Microsoft Excel because (") or (,) is not included in double-quoted "Johnny Depp".
Example 2:
Original Data "Johnny , Depp"
After Reading Johnny , Depp
It determines that the double quotation marks were automatically added by Microsoft Excel because a comma is
included in double-quoted "Johnny , Depp" and it removes them.
Example 3:
Original Data "Johnny""Depp"
After Reading Johnny"Depp
It determines that the 2 double quotation marks at the begging and end of the data were automatically added by
Microsoft Excel because double quotation marks are included in double-quoted “Johnny""Depp” and it removes
them. Also it replaces the 2 double quotation marks ("") with 1 quotation mark (").
20
6. Address Book Data (for editing) Format
6.1. Overview of Address Book Data
One line is registered as one Address Book data. (Some exceptions. For details, refer to 6.2.4.)
Each item is delimited with tabs.
Category
Destination (DEST)
Custom Index (CINX)
Category Type
Fax (FAX)
Internet Fax (IFAX)
Direct SMTP (DSMTP)
E-mail (EMAIL)
Destination (DEST)
File Server (FTP)
Desktop (DESK)
Network Folder (SMB)
Group (GRP)
21
6.2.1. Data Entry Format
Example: MX-M283/M363~423/M453~503
Search Custo Frequentl Displa Fax Transmissio F-Code Chain Search
Mode Sub Address Pass Code FaxLine
String m y Used y Number n Speed Setting Setting Number
Search Custo Frequentl Displa E-mail Reception File Format Compression Compressio Search
File Format Compression
String m y Used y Address Report (color) (color) n Number
Search Custo Frequentl Displa E-mail Specified Hostname / File Format Compressio Compression Search
File Format Compression
String m y Used y Address Host IP Address (color) n(color) Level(color) Number
Search Custo Frequentl Displa E-mail File Format Compression Compression Search
File Format Compression
String m y Used y Address (color) (color) Level(color) Number
Search Custo Frequentl Displa CharCod Hostname Process File Format Compressio Compressio Search Enable
File Format Compression Hyperlink User Name Password
String m y Used y e / IP Directory (color) n(color) n Level Number SSL
Search Custo Frequentl Displa Hostname Process File Format Compressio Compressio Search Enable
(Blank) File Format Compression Port Number User Name Password
String m y Used y / IP Directory (color) n(color) n Level Number SSL
Search Custo Frequentl Displa Hostname Process File Format Compressio Compressio Search
(Blank) File Format Compression Hyperlink User Name Password
String m y Used y / IP Directory (color) n(color) n Level Number
Search Custo Frequentl Displa Search
String m y Used y Number
Fax Transmissio F-Code Chain
(Blank) (Blank) (Blank) (Blank) Mode Sub Address Pass Code (Blank) FaxLine
Number n Speed Setting Setting
E-mail Reception File Format Compression Compressio
(Blank) (Blank) (Blank) (Blank) File Format Compression
Address Report (color) (color) n
E-mail File Format Compression Compression
(Blank) (Blank) (Blank) (Blank) File Format Compression
Address (color) (color) Level(color)
E-mail File Format Compression Compression
(Blank) (Blank) (Blank) (Blank) File Format Compression
Address (color) (color) Level(color)
*The above example is not applied in all models. Items that can be entered differ depending on models.
*Nothing is entered in " (Blank)". Even if data is entered accidentally, the data will not be accepted.
22
6.2.2. Data Entry Format Specification
23
FaxLine Number (0-2) 0: auto
1: line1
2: line2
3: line3
E-mail Address Text (arbitrary)
File Format Number (0-6) 0:TIFF-F
1:TIFF
2:PDF
3:JPEG
4:Encrypted-PDF
5:TIFF-S
6: XPS
pdf-a
docx
pdfa-1a
pptx
rtf
searchable-pdf
txt
xlsx
Compression Number (0-5) 0: No compression
1:MH
2:MR
3:MMR
4:JBIG
5:JPEG
File Format (color) Number (0-10) 0:TIFF-F
1:TIFF
2:PDF
3:JPEG
4:Encrypted-PDF
5:TIFF-S
6:XPS
7:Compact-PDF
8:Compact-Hq-PDF
9:Compact-Encrypted-PDF
10:Compact-Encrypted-Hq-PDF
pdf-a
compact-hq-pdf-a
docx
pdfa-1a
pptx
rtf
searchable-pdf
txt
xlsx
Compression (color) Number (0-5) 0: No compression
1:MH
2:MR
3:MMR
4:JBIG
5:JPEG
black-char
Compression Level (color) Number (1-100)
Reception Report setting Number (0 or 1) 0: Not request Reception Report.
1: Request Reception Report.
Hyperlink Number (0 or 1) 0: Not perform hyperlink.
1: Perform hyperlink.
Host Name Setting Number (0 or 1) 0: Not set
1:Set
Hostname/IP Address Text (arbitrary)
24
Process Directory Text (arbitrary)
User Name Text (arbitrary)
Password Text (arbitrary)
Port Number Number
Search Number Number (1-) Unique value in DEST (excluding virtual
addresses)
SSL Setting Number (0 or 1) 0:SSL setting invalid
1:SSL setting valid
CharCode Number (1 or 3) 1: JIS
2: Shift JIS
3: EUC
*1 Multiple Fax numbers, e-mail addresses, Internet Fax addresses, and Direct SMTP addresses can be
directly entered in one record in some models.
However since only one data can be entered in "destination number" or "e-mail address" elements in the
other models, the second or later data is registered as virtual data (VRT**).
* Values that can be set are restricted depending on models.
For functions and settings not listed, it may no longer be eligible for conversion in the table above.
If the data in the excluded are included in the source data and the conversion will succeed, but the value is
changed to the initial value of the MFP.
(For example, if it is set to "PDF / A" file format, because it is data excluded, it is changed to "PDF" converted in this
utility.)
25
6.2.3. Group Member Registration Method
In "6.2.1 Data Entry Format, " the element for registering group members is not set.
To register group members, write the group ID that the target data belongs to in the "Belong ID" item of each data
Ex.) Register group data in ID5, ID1-4 Fax data as the members, group data in ID6, and ID 4 Fax data as the member.
Belong Search Custom Frequently Transmissio F-Code Sub Pass Chain Search
(REF)DEST ID FAX Destination Name Display Name Fax Number Mode
ID String Index Used n Speed Setting Address Code Setting Number
Search Custom Frequently
(REF)DEST ID GRP Destination Name Display Name Search Number
String Index Used
DEST 1 FAX 5 DocumentSystem d 1 0 DocumentSystem 0123-45-6789 1 0 1 1111 1111 0 1
DEST 2 FAX 5 InformationSystem i 1 1 InformationSystem 01-1111-1111 1 1 0 1 2
DEST 3 FAX 5 DencaSystem d 1 0 DencaSystem 02-2345-6789 1 2 0 0 3
DEST 4 FAX 5/6 TransmissionSystem t 1 1 TransmissionSystem 03-9876-5432 1 3 0 0 4
DEST 5 GRP SHARP s 1 0 SHARP 5
DEST 6 GRP NARA n 1 1 NARA 6
* Lines that include " (REF) " at the beginning are header lines. They are ignored when files are read.
Header lines are not necessarily required to be inserted. However they are always inserted when editing files are created by the utility.
For details, refer to “6.4 Header Line.”
Explanation)
"5" is written in Belong ID of ID 1-4 Fax data. (red circle in the figure)
This means that the target data is registered as a member of data (group) with ID 5.
The ID of the group that the target data belongs to is written in each registration data.
This specification avoids the problem in Microsoft Excel that only up to 255 bytes of characters can be entered in one cell.
When the target data is registered as members of multiple groups, delimit numbers with slash (/), as shown in Belong ID of ID 4.
26
6.2.4. Virtual Data (VRTFA, VRTMA, VRTIA, VRTDA)
Registered destination data as well as directly-entered destination data can be registered as group members in some models.
When directly-entered destination data is registered, set the following virtual data.
Ex.) Register group data in ID 4, and ID 1-3 e-mail data as the members, and also register the [email protected] e-mail address and the [email protected] I-Fax address
with direct entry as the members.
ID=Belonging ID
Explanation)
Virtual Data ID must be the same as Belong ID.
This is because a directly-entered item must be virtually treated as one data.
27
6.3. Custom-Index
28
Appendix 1 Error Log List (Error Content List)
29
There is no Transmission Speed. Please input it.
The input form of Transmission Speed is not correct.
Duplication registration of Transmission Speed is carried out. ※1
The F-Code Setting and Chain Setting cannot be performed effectively simultaneously.
Please repeal either.
The F-Code is inconsistent with Sub Address.
31
There is no Login Name. Please input it.
The input form of Login Name is not correct.
It is over the number of the maximum characters of Login Name.
Duplication registration of Login Name is carried out.※1
32