JP1 Version 12 JP1/Data Highway - Server Configuration and Administration Guide

3021-3-D41(E)

Notices

Relevant program products

For details about the applicable OS versions, and a service pack and patch that are prerequisites for JP1/Data Highway - Server, check the Release Notes.

P-2A41-9ACL JP1/Data Highway - Server version 12-00 (For Windows Server 2012, Windows Server 2012 R2, and Windows Server 2016)

P-8141-9ACL JP1/Data Highway - Server version 12-00 (For Linux 6 (x64))

P-2A41-9BCL JP1/Data Highway - Server Starter Edition 12-00 (For Windows Server 2012, Windows Server 2012 R2, and Windows Server 2016)

P-8141-9BCL JP1/Data Highway - Server Starter Edition 12-00 (For Linux 6 (x64))

P-2A41-9CCL JP1/Data Highway - Server Starter to Standard Upgrade 12-00 (For Windows Server 2012, Windows Server 2012 R2, and Windows Server 2016)

P-8141-9CCL JP1/Data Highway - Server Starter to Standard Upgrade 12-00 (For Linux 6 (x64))

Trademarks

HITACHI, Cosminexus,Groupmax,HA Monitor,JP1 are either trademarks or registered trademarks of Hitachi, Ltd. in Japan and other countries.

Active Directory is either a registered trademark or a trademark of Microsoft Corporation in the United States and/or other countries.

Linux(R) is the registered trademark of Linus Torvalds in the U.S. and other countries.

Microsoft is either a registered trademark or a trademark of Microsoft Corporation in the United States and/or other countries.

Oracle and Java are registered trademarks of Oracle and/or its affiliates.

Red Hat is a trademark or a registered trademark of Red Hat Inc. in the United States and other countries.

RSA and BSAFE are either registered trademarks or trademarks of EMC Corporation in the United States and/or other countries.

Windows is either a registered trademark or a trademark of Microsoft Corporation in the United States and/or other countries.

Windows Server is either a registered trademark or a trademark of Microsoft Corporation in the United States and/or other countries.

Other company and product names mentioned in this document may be the trademarks of their respective owners.

This product includes RSA BSAFE Cryptographic software of EMC Corporation.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

This product includes software developed by Ben Laurie for use in the Apache-SSL HTTP server project.

Portions of this software were developed at the National Center for Supercomputing Applications (NCSA) at the University of Illinois at Urbana-Champaign.

This product includes software developed by the University of California, Berkeley and its contributors.

This software contains code derived from the RSA Data Security Inc. MD5 Message-Digest Algorithm, including various modifications by Spyglass Inc., Carnegie Mellon University, and Bell Communications Research, Inc (Bellcore).

Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel, and copyright by the University of Cambridge, England. The original software is available from ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/

This product includes software developed by Ralf S. Engelschall <rse@engelschall.com> for use in the mod_ssl project (http://www.modssl.org/).

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

This product includes software developed by IAIK of Graz University of Technology.

This product includes software developed by Daisuke Okajima and Kohsuke Kawaguchi (http://relaxngcc.sf.net/).

This product includes software developed by the Java Apache Project for use in the Apache JServ servlet engine project (http://java.apache.org/).

This product includes software developed by Daisuke Okajima and Kohsuke Kawaguchi (http://relaxngcc.sf.net/).

This product includes software developed by Andy Clark.

Java is a registered trademark of Oracle and/or its affiliates.

1. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)

2. This product includes cryptographic software written by Eric Young (eay@cryptsoft.com)

3. This product includes software written by Tim Hudson (tjh@cryptsoft.com)

4. This product includes the OpenSSL Toolkit software used under OpenSSL License and Original SSLeay License. OpenSSL License and Original SSLeay License are as follow:

LICENSE ISSUES

==============

The OpenSSL toolkit stays under a dual license, i.e. both the conditions of

the OpenSSL License and the original SSLeay license apply to the toolkit.

See below for the actual license texts. Actually both licenses are BSD-style

Open Source licenses. In case of any license issues related to OpenSSL

please contact openssl-core@openssl.org.

OpenSSL License

---------------

/* ====================================================================

* Copyright (c) 1998-2016 The OpenSSL Project. All rights reserved.

*

* Redistribution and use in source and binary forms, with or without

* modification, are permitted provided that the following conditions

* are met:

*

* 1. Redistributions of source code must retain the above copyright

* notice, this list of conditions and the following disclaimer.

*

* 2. Redistributions in binary form must reproduce the above copyright

* notice, this list of conditions and the following disclaimer in

* the documentation and/or other materials provided with the

* distribution.

*

* 3. All advertising materials mentioning features or use of this

* software must display the following acknowledgment:

* "This product includes software developed by the OpenSSL Project

* for use in the OpenSSL Toolkit. (http://www.openssl.org/)"

*

* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to

* endorse or promote products derived from this software without

* prior written permission. For written permission, please contact

* openssl-core@openssl.org.

*

* 5. Products derived from this software may not be called "OpenSSL"

* nor may "OpenSSL" appear in their names without prior written

* permission of the OpenSSL Project.

*

* 6. Redistributions of any form whatsoever must retain the following

* acknowledgment:

* "This product includes software developed by the OpenSSL Project

* for use in the OpenSSL Toolkit (http://www.openssl.org/)"

*

* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY

* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR

* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT

* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,

* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED

* OF THE POSSIBILITY OF SUCH DAMAGE.

* ====================================================================

*

* This product includes cryptographic software written by Eric Young

* (eay@cryptsoft.com). This product includes software written by Tim

* Hudson (tjh@cryptsoft.com).

*

*/

Original SSLeay License

-----------------------

/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)

* All rights reserved.

*

* This package is an SSL implementation written

* by Eric Young (eay@cryptsoft.com).

* The implementation was written so as to conform with Netscapes SSL.

*

* This library is free for commercial and non-commercial use as long as

* the following conditions are aheared to. The following conditions

* apply to all code found in this distribution, be it the RC4, RSA,

* lhash, DES, etc., code; not just the SSL code. The SSL documentation

* included with this distribution is covered by the same copyright terms

* except that the holder is Tim Hudson (tjh@cryptsoft.com).

*

* Copyright remains Eric Young's, and as such any Copyright notices in

* the code are not to be removed.

* If this package is used in a product, Eric Young should be given attribution

* as the author of the parts of the library used.

* This can be in the form of a textual message at program startup or

* in documentation (online or textual) provided with the package.

*

* Redistribution and use in source and binary forms, with or without

* modification, are permitted provided that the following conditions

* are met:

* 1. Redistributions of source code must retain the copyright

* notice, this list of conditions and the following disclaimer.

* 2. Redistributions in binary form must reproduce the above copyright

* notice, this list of conditions and the following disclaimer in the

* documentation and/or other materials provided with the distribution.

* 3. All advertising materials mentioning features or use of this software

* must display the following acknowledgement:

* "This product includes cryptographic software written by

* Eric Young (eay@cryptsoft.com)"

* The word 'cryptographic' can be left out if the rouines from the library

* being used are not cryptographic related :-).

* 4. If you include any Windows specific code (or a derivative thereof) from

* the apps directory (application code) you must include an acknowledgement:

* "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"

*

* THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND

* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE

* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS

* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

* SUCH DAMAGE.

*

* The licence and distribution terms for any publically available version or

* derivative of this code cannot be changed. i.e. this code cannot simply be

* copied and put under another distribution licence

* [including the GNU Public Licence.]

*/

Microsoft product name abbreviations

This manual uses the following abbreviations for Microsoft product names.

Full name or meaning

Abbreviation

Windows(R) 10 Home

Windows 10

Windows

Windows(R) 10 Pro

Windows(R) 10 Enterprise

Microsoft(R) Windows(R) 7 Professional

Windows 7

Microsoft(R) Windows(R) 7 Enterprise

Microsoft(R) Windows(R) 7 Ultimate

Windows(R) 8.1

Windows 8.1

Windows(R) 8.1 Pro

Windows(R) 8.1 Enterprise

Microsoft(R) Windows Server(R) 2012 Standard

Windows Server 2012

Microsoft(R) Windows Server(R) 2012 Datacenter

Microsoft(R) Windows Server(R) 2012 R2 Standard

Windows Server 2012 R2

Microsoft(R) Windows Server(R) 2012 R2 Datacenter

Microsoft(R) Windows Server(R) 2016 Standard

Windows Server 2016

Microsoft(R) Windows Server(R) 2016 Datacenter

Restrictions

Information in this document is subject to change without notice and does not represent a commitment on the part of Hitachi. The software described in this manual is furnished according to a license agreement with Hitachi. The license agreement contains all of the terms and conditions governing your use of the software and documentation, including all warranty rights, limitations of liability, and disclaimers of warranty.

Material contained in this document may describe Hitachi products not available or features not available in your country.

No part of this material may be reproduced in any form or by any means without permission in writing from the publisher.

Issued

Jan. 2019: 3021-3-D41(E)

Copyright

All Rights Reserved. Copyright (C) 2019, Hitachi, Ltd.

All Rights Reserved. Copyright (C) 2019, Hitachi Solutions, Ltd.

Colophon

Publisher

Hitachi, Ltd.

6-6, Marunouchi 1-chome, Chiyoda-ku, Tokyo, 100‒8280 Japan

Summary of amendments

The following table lists changes in this manual (3021-3-D41(E)) and product changes related to this manual.

Changes

Location

The application (App) that is used to send and receive files and messages is now supported. Accordingly, the Application window interface is added to the New Delivery window.

3.3.26, 5.3.1(1)(b)

SAML Single Sign-on (SSO) authentication is now supported.

3.3.27, 5.3.1(1)(b)

Notes on using Java software included in the product were added.

8.1, 8.2,9.2

The following OSs are now supported:

SUSE Linux Enterprise Server 15

9.1.2

The following OSs are no longer supported:

Windows Server 2008 R2

--

The following required software is no longer supported for the data transfer command:

Java Runtime Environment Version 6.0

--

In addition to the above changes, minor editorial corrections were made.

Preface

This manual describes how to install and set up JP1/Data Highway - Server (hereinafter abbreviated as JP1/DH - Server).

Intended readers

This manual is intended for:

System administrators who introduce, configure, and operate a system that uses JP1/DH - Server

Conventions: Fonts and symbols

The following table explains the text formatting conventions used in this manual:

Text formatting

Convention

Bold

Bold characters indicate text in a window, other than the window title. Such text includes menus, menu options, buttons, radio box options, or explanatory labels. For example:

From the File menu, choose Open.

Click the Cancel button.

In the Enter name entry box, type your name.

Italic

Italic characters indicate a placeholder for some actual text to be provided by the user or system. For example:

Write the command as follows:

copy source-file target-file

The following message appears:

A file was not found. (file = file-name)

Italic characters are also used for emphasis. For example:

Do not delete the configuration file.

Monospace

Monospace characters indicate text that the user enters without change, or text (such as messages) output by the system. For example:

At the prompt, enter dir.

Use the send command to send mail.

The following message is displayed:

The password is incorrect.

The following table explains the symbols used in this manual:

Symbol

Convention

|

In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR. For example:

A|B|C means A, or B, or C.

{ }

In syntax explanations, curly brackets indicate that only one of the enclosed items is to be selected. For example:

{A|B|C} means only one of A, or B, or C.

[ ]

In syntax explanations, square brackets indicate that the enclosed item or items are optional. For example:

[A] means that you can specify A or nothing.

[B|C] means that you can specify B, or C, or nothing.

...

In coding, an ellipsis (...) indicates that one or more lines of coding have been omitted.

In syntax explanations, an ellipsis indicates that the immediately preceding item can be repeated as many times as necessary. For example:

A, B, B, ... means that, after you specify A, B, you can specify B as many times as necessary.

x

Multiplication sign

/

Division sign

Conventions: Version numbers

The version numbers of Hitachi program products are usually written as two sets of two digits each, separated by a hyphen. For example:

Version 1.00 (or 1.0) is written as 01-00.

Version 2.05 is written as 02-05.

Version 2.50 (or 2.5) is written as 02-50.

Version 12.25 is written as 12-25.

The version number might be shown on the spine of a manual as Ver. 2.00, but the same version number would be written in the program as 02-00.

Domain on a directory server

If the word domain refers to a domain on a directory server, it is explained that way in this manual.

If the word domain is used without such an explanation, it means the management unit of groups in JP1/DH - Server.

JP1/DH - Server notation

Where JP1/DH - Server is distinguished from JP1/Data Highway - Server Starter Edition in this manual, it is so described. Unless otherwise specified, the term JP1/DH - Server is used to also refer to JP1/Data Highway - Server Starter Edition.

The data transfer command notation

Where data transfer command notation is distinguished from data transfer management command in this manual, it is so described. Unless otherwise specified, the term data transfer command is used to also refer to data transfer management command.

File path notation

In this manual, file paths are written on the assumption that a Windows OS is used. If a Linux OS is used and there is no coding for Linux, change a backslash (\) in a file path for Windows to a forward slash (/).

File path of Windows

If you specify the path with spaces as an argument of the command, enclose the whole path with double quotes ("), like "...".

Updating the version of the App

The App, which is the application that sends and receives files and messages, uses OpenJDK when using the client application, and the administrator commands and data transfer command that come with the Java execution environment. Therefore, it is recommended to update the App every six months for security reasons.

When you update the version of the client application and the commands, follow the version update procedure that comes with the client application command.。

1 Overview of JP1/DH - Server

This chapter provides an overview of JP1/DH - Server and describes its prerequisites.

1.1 JP1/DH - Server

JP1/DH - Server is a server system that enables high-speed passing of large files among domestic and overseas bases.

If you use JP1/DH - Server in an Internet environment, you can transfer files at high speed to remote locations due to multiplex communication technology. You can also transfer a multiple gigabyte file that is too large to be sent by email over an existing Internet connection without dividing the file into two or more parts.

1.1.1 Features of JP1/DH - Server

Features of JP1/DH - Server are as follows.

(1) Fast, secure, safe transfer of large data via a long-distance low-quality network

JP1/DH - Server adopts multiplex transfer technology# to improve the performance and certainty of file transfers. For this reason, JP1/DH - Server can securely and safely deliver large data at high speed to remote locations including overseas that are a narrow-band area or an area in which network communication is likely to be interrupted.

#: Technology for using multiple HTTPS sessions concurrently.

(2) System operation log that allows you to check who used the system when

You can view events to check who sent or received which file when. In addition, you can download other operation log files to audit the usage status of the system.

(3) Easy introduction for users

You do not need to arrange any dedicated line because your existing Internet connection is used for communication.

(4) Multilingual support

Because, in addition to Japanese, web windows in English and simplified Chinese are supported as the JP1/DH - Server user interface, local users in overseas bases can use web windows smoothly.

1.2 JP1/DH - Server software configuration

JP1/DH - Server consists mainly of the following three pieces of software: JP1/DH Web application server, JP1/DH Web server, and JP1/DH client program.

Table 1‒1: JP1/DH - Server software configuration

Software configuration

Description

JP1/DH Web application server

This is the main software of JP1/DH - Server. The JP1/DH Web application server runs on a server machine on which JP1/DH - Server is configured and provides the functionality of JP1/DH - Server. This software is the requisite software for JP1/DH - Server.

JP1/DH Web server

This built-in reverse proxy server analyzes SSL communication from a client over HTTPS protocol and transfers it to the JP1/DH Web application server over HTTP protocol. Depending on the network configuration when JP1/DH - Server is configured, JP1/DH Web server can be replaced by another reverse proxy server.

JP1/DH client program

This client program is automatically downloaded onto a client machine that communicates with JP1/DH - Server. This software is the requisite software for JP1/DH - Server.

1.3 Prerequisites

This section describes the prerequisites for using JP1/DH - Server.

1.3.1 Prerequisite products and prerequisite products for a specific function or with conditions

Table 1‒2: Prerequisite products and prerequisite products for a specific function or with conditions

Server

Prerequisite products and prerequisite products for a specific function or with conditions

JP1/DH - Server

Prerequisite products

One of the following OSs is required:

Microsoft(R) Windows Server(R) 2012 Standard

Microsoft(R) Windows Server(R) 2012 Datacenter

Microsoft(R) Windows Server(R) 2012 R2 Standard (with or without Update)

Microsoft(R) Windows Server(R) 2012 R2 Datacenter (with or without Update)

Microsoft(R) Windows Server(R) 2016 Standard

Microsoft(R) Windows Server(R) 2016 Datacenter

Red Hat Enterprise Linux(R) Server 6 (64-bit x86_64)

Prerequisite products for a specific function or with conditions

If you want to use the delivery notification function, you need a mail server that supports SMTP protocol.

The following mail servers have been verified:

Postfix 2.10.1

Mailstream Switch/MTA 3.3

Groupmax Version 7

Microsoft Exchange Server 2010

Note that JP1/DH - Server does not support any email text and message encryption methods (such as S/MIME and PGP).

If you want to perform user authentication by using a directory server when a user logs in to this product, you need one of the following products:

Windows Server 2012 R2 Active Directory server

Windows Server 2012 Active Directory server

Windows Server 2016 Active Directory server

OpenLDAP V2.4

2 System Configuration

This chapter provides information for determining the configuration of a high-speed file transfer system that uses JP1/DH - Server.

2.1 Network configurations

This section describes different kinds of network configurations for building JP1/DH - Server. JP1/DH - Server is a secure product and only supports SSL (HTTPS) communication. JP1/DH - Server includes a built-in reverse proxy server (JP1/DH Web server), which is responsible for encryption and multiplexing of SSL traffic. However, you can replace the server with another reverse proxy server. A key point to examine when determining your network configuration is how you will install this reverse proxy server.

2.1.1 Example configuration where a JP1/DH - Server machine acts as an access point

This subsection describes a configuration where a single server machine has both the JP1/DH application server and web server installed and configured, and can be directly accessed from a web browser on a client machine.

Figure 2‒1: Example configuration where the JP1/DH - Server machine acts as an access point

(1) Features

This configuration can be built and operated by using just a single JP1/DH - Server machine. It is easy to build and operate, but can be adopted only if JP1/DH - Server is used in your private network. If you want to operate JP1/DH - Server on a network connected to the Internet, from a security point of view, consider the other configurations described in 2.1.2 Example configuration for working with a reverse proxy with SSL traffic analyzer or 2.1.3 Example configuration for working with a reverse proxy with SSL traffic forwarding.

(2) Software requirements for each machine

Each machine requires the following software:

Client machine

A client machine requires a web browser and a JP1/DH client program.

JP1/DH - Server machine

The machine for installation of JP1/DH - Server. The following pieces of software are required:

JP1/DH Web application server

JP1/DH Web server

2.1.2 Example configuration for working with a reverse proxy with SSL traffic analyzer

This subsection describes a configuration where a DMZ is secured between a web browser on a client machine and the JP1/DH - Server machine, and a reverse proxy server# with an SSL traffic analyzer resides on the DMZ. If you want to operate your JP1/DH - Server on a network connected to the Internet, use this example configuration as a reference to examine and determine your network configuration.

#

The JP1/DH Web server (built-in reverse proxy server) does not run separately on a machine other than the JP1/DH - Server machine. Therefore, a different reverse proxy server from the JP1/DH Web server is used in this example configuration.

Figure 2‒2: Example configuration for working with a reverse proxy with SSL traffic analyzer

(1) Features

This configuration can limit access to JP1/DH - Server only from the reverse proxy server placed on the DMZ and prevent JP1/DH - Server from being accessed directly by client machines.

A web browser on the client machine communicates with the reverse proxy server over HTTPS, while the reverse proxy server communicates with JP1/DH - Server over HTTP.

You can separate high-load encryption and multiplexing processes of SSL traffic from the JP1/DH - Server machine, resulting in taking full advantage of performance of the JP1/DH - Server machine for transfer in higher speed.

(2) Software requirements for each machine

Each machine requires the following software:

Client machine

A client machine requires a web browser and a JP1/DH client program.

Reverse proxy server machine

A reverse proxy server in this configuration requires functions that analyze HTTPS traffic from web browsers on client machines and forwards the traffic to JP1/DH - Server as HTTP traffic.

JP1/DH - Server machine

The machine for installation of JP1/DH - Server. The following pieces of software are required:

JP1/DH Web application server

2.1.3 Example configuration for working with a reverse proxy with SSL traffic forwarding

This subsection describes a configuration example where a DMZ is secured between a web browser on a client machine and the JP1/DH - Server machine, and a reverse proxy server# that can forward SSL traffic resides on the DMZ. If you want to operate your JP1/DH - Server on a network connected to the Internet, use this example configuration as a reference to examine and determine your network configuration.

#

The JP1/DH Web server (built-in reverse proxy server) does not run separately on a machine other than the JP1/DH - Server machine. Therefore, a different reverse proxy server from the JP1/DH Web server is used in this example configuration.

Figure 2‒3: Example configuration for working with a reverse proxy with SSL traffic forwarding

(1) Features

This configuration can limit access to JP1/DH - Server only from the reverse proxy server placed on the DMZ and prevent JP1/DH - Server from being accessed directly by client machines.

A web browser on the client machine and the reverse proxy server, as well as the reverse proxy server and JP1/DH - Server, communicate with each other over HTTPS.

(2) Software requirements for each machine

Each machine requires the following software:

Client machine

A client machine requires a web browser and a JP1/DH client program.

Reverse proxy server machine

A reverse proxy server in this configuration requires a function that forwards HTTPS traffic from web browsers on client machine to a JP1/DH - Server.

JP1/DH - Server machine

The machine for installation of JP1/DH - Server. The following pieces of software are required:

JP1/DH Web application server

JP1/DH Web server

2.1.4 Notes about the reverse proxy server

A proven reverse proxy server, other than the JP1/DH Web server, that has actually worked is as follows:

Pound-2.6

nginx-1.6.2

Important

Make sure that you read the notes in the Release Notes if you use a reverse proxy server other than the JP1/DH Web server.

2.1.5 Ensuring the network bandwidth

To use the high-speed transfer through multiplexing featured in JP1/DH - Server, the network to which the server is connected must have a sufficient bandwidth. You must use a network environment with a bandwidth of 1 Gbps or higher in order to effectively use this high-speed transfer.

Note that limiting the bandwidth of the network path that reaches the servers where JP1/DH - Server is installed reduces the performance of data transfer and reception.

2.1.6 Notes on network configurations

(1) TCP/UDP port numbers used by JP1/DH - Server

JP1/DH - Server uses the TCP/UDP port numbers listed below. Management software and other software programs that are installed on the JP1/DH - Server machine must be configured not to use these port numbers.

Table 2‒1: List of TCP/UDP port numbers used by JP1/DH - Server

Port number

Description

80

Port on which the server listens for HTTP requests

443

Port on which the server listens for HTTPS requests

900

Port on which the server listens for naming-service requests

5432

Port to communicate with the database

8080

Communication port for management

8007

Port on which the server listens for requests from the redirector

14000

Communication port for smart agents

20302

Communication port for processing transaction recovery

20351

Port on which the server listens for events from the shared queue function

23152

Port on which the server listens for RMI registry requests

20295

Communication port for operations management agents

(2) Firewall or proxy setup

A client machine must be able to communicate with JP1/DH - Server by using HTTPS (TCP port 443). The port number is fixed to 443 and cannot be changed.

In addition, a content firewall, proxy, or any other program must not limit the number of concurrent HTTPS connections in order to use high-speed transfers through the multiplexing of JP1/DH - Server.

(3) "hosts" file on the reverse proxy server machine

A host name (computer name) or FQDN that is associated with the global IP address of the reverse proxy server is sometimes defined in the hosts file on the proxy server machine. In this case, the following JP1/DH - Server functions have limitations:

Audit log

The audit log records IP addresses of client machines accessed to the server. In the environment mentioned above, however, the global IP address of the reverse proxy server machine will be recorded as a client IP address.

Access control with the network set function

The network set function, which limits access based on IP addresses of client machines accessed to the server, does not work properly in the above environment.

(4) Number of characters of the authentication ID and password for the proxy server

If a web browser on a client machine accesses the JP1/DH - Server machine via a proxy server, you can specify a maximum of 57 characters for the authentication ID and password for the proxy server.

2.2 Software

This section provides information about software required for building your JP1/DH - Server.

2.2.1 JP1/DH - Server software

Determine the software components to be run on the JP1/DH - Server machine by seeing 2.1 Network configurations.

Table 2‒2: Software components to be run on the JP1/DH - Server machine

JP1/DH - Server software components

Running

Description

JP1/DH Web application server

Required

It must be installed and run on the JP1/DH - Server machine.

JP1/DH Web server

Optional

It does not need to be run if you use a reverse proxy server other than the JP1/DH Web server.#

Legend:

Required: It must be running.

Optional: It is run only if this software component is used.

#

The JP1/DH Web server is always installed on the JP1/DH - Server machine.

2.2.2 Reverse proxy server

If you want to use a reverse proxy server other than the JP1/DH Web server, determine the reverse proxy to be used. In particular, if you build a configuration shown in 2.1.2 Example configuration for working with a reverse proxy with SSL traffic analyzer, you need a reverse proxy# with the SSL wrapper function.

#

A reverse proxy that has the ability to communicate with client machines over an SSL communication through HTTPS

2.3 Hardware equipment

This section provides information about hardware equipment on which JP1/DH - Server runs.

2.3.1 JP1/DH - Server machine

(1) Preparing dedicated server machine

Your JP1/DH - Server machine must be dedicated to running JP1/DH - Server, and any other system must not reside on this machine together.

JP1/DH - Server features the high-speed file transfer. For functions to perform their best, the system must be able to intensively use resources on the machine, such as CPU, memory, disk I/Os, and bandwidth of the network interface.

(2) Hardware specifications

Information about hardware specifications required for building a JP1/DH - Server machine is as follows.

(a) CPU

CPU performance significantly affects the performance of data transfer and reception. With poor CPU performance, you cannot obtain a satisfactory transfer rate, even with sufficient network bandwidth. The performance of CPUs is affected by some factors, including the clock frequency and number of cores. The CPU requirement for the JP1/DH - Server machine is as follows:

Dual core 64-bit processor (2.4 GHz or higher)

(b) Memory

JP1/DH - Server consumes a significant amount of memory when transferring and receiving large files or concurrently accepting multiple connections to the system. If the machine has a smaller amount of memory, you cannot obtain a satisfactory transfer rate when a large file is transferred and received, or when multiple files are transferred concurrently. The memory requirement for the JP1/DH - Server machine is as follows:

3 GB or more

(c) Required amount of disk space

You can estimate the required amount of disk space by adding together the following disk space amounts:

Disk space for installing the application: Approximately 2,048 MB#

Disk space required for the database at run-time: Approximately 32,768 MB#

Disk space for storing delivery data

You can estimate this amount based on the average file size of deliveries, the number of deliveries per day, and the storage period of the data by using the calculation formula mentioned below.

Disk space for storing delivery data:

Average file size of deliveries (in MB) × number of deliveries per day × maximum storage period of the data (in days)

#: The amount contains a temporary space consumed by the running database, and the actual usage might be somewhat different.

(d) Network interface

Performance of the network interface significantly affects the performance of data transfer and reception. The network-interface requirement for the JP1/DH - Server machine is as follows:

1 Gbps or greater

(3) Cluster operations

For the configuration to operate your JP1/DH - Server in a clustered environment, see C. Configurations for Clustered System Operations.

(4) Storage redundancy

Storage devices of the JP1/DH - Server machine must be redundant to improve their availability. For example, you can set up your system drives or data-storage drives in a RAID configuration.

In this case, make sure that the redundant configuration will not deteriorate disk I/O performance. Poor disk I/O performance prevents JP1/DH - Server from providing a sufficient transfer rate.

2.3.2 Client machines

(1) Hardware specifications

Information about the hardware specifications required for a client machine is as follows:

(a) CPU

CPU performance significantly affects the performance of data transfer and reception. With poor CPU performance, you cannot obtain a satisfactory transfer rate, even with sufficient network bandwidth. The CPU requirement for the client machine is as follows:

Dual-core processor (2.0 GHz or higher)

(b) Memory

If the machine has a smaller amount of memory, you cannot obtain a satisfactory transfer rate when a large file is transferred and received. The memory requirement for the client machine is as follows:

1 GB or more

(c) Calculation formula for estimating the amount of disk space

When a client accesses JP1/DH - Server, a JP1/DH client program will be downloaded to that client. The client program outputs applet logs during data transfer and reception with the system. Make sure that your system has adequate disk space for these logs. You can estimate the capacity necessary for the applet logs by using the calculation formula below.

Capacity necessary for the applet logs:

Average file size of the deliveries (in MB) × 0.06 × number of deliveries per day × 14

(d) Network interface

Performance of the network interface significantly affects the performance of data transfer and reception. The network-interface requirement for the client machine is as follows:

100 Mbps or greater

3 Operational Details

This chapter provides information about how to operate JP1/DH - Server.

3.1 Operational parameters

Configure the parameters necessary for installation and environment settings before installing JP1/DH - Server. The parameters consist of required and optional parameters. Make sure that you configure the required parameters before installation. You can configure the optional parameters if necessary. If the optional parameters are not set or modified, JP1/DH - Server runs with its default settings.

3.2 Required parameters

This section provides information about the required parameters.

3.2.1 Installation folder

JP1/DH - Server is installed in the folder below by default. Determine whether you need to change the default folder.

Table 3‒1: Default settings for the installation folder

OS

Path to the folder

Windows Server 2012

C:\Program Files\Hitachi\jp1dh\server\

Windows Server 2012 R2

Windows Server 2016

Linux

/opt/jp1dh/server

For a Windows OS, the installation folder can be changed during JP1/DH - Server installation.

3.2.2 Storage folder for delivery data

By default, JP1/DH - Server stores data to be transferred and received in the location listed below. Determine whether you need to change the default folder. We recommend that you estimate the required disk space based on the average file size of delivery data and how frequent the data is sent, prepare a dedicated drive with sufficient free space, and then specify a folder on the drive as a storage location. With regard to the storage folder for the delivery data, note the following:

Specify a folder on the local file system. You cannot use any network folder or a folder on a network drive.

The length of the path must be from 4 to 70 characters.

Table 3‒2: Default settings for the storage folder for the delivery data

OS

Path to the folder

Windows Server 2012

C:\Program Files\Hitachi\jp1dh\server\data\

Windows Server 2012 R2

Windows Server 2016

Linux

/opt/jp1dh/server/data

The storage folder for the delivery data can be changed in environment setup after JP1/DH - Server installation.

3.2.3 Mail server used by the system

JP1/DH - Server uses email notifications to notify users of data transfers and reception.

If you want to use this function, you need to determine which mail server (SMTP server) receives the email notifications. You can use your choice of mail server as long as it supports the SMTP protocol. If you want to use one of the proven mail servers that have actually worked, see 1.3.1 Prerequisite products and prerequisite products for a specific function or with conditions.

You can use SMTPS or STARTTLS to encrypt SMTP traffic. To do this, you must first obtain the root certificate of a certificate authority that signed the certificate for SSL traffic that is stored in the mail server that JP1/DH - Server works with. You must then store the root certificate in the JP1/DH - Server server. For information about how to obtain the root certificate, consult with your certificate authority. For details about how to store the root certificate in the JP1/DH - Server server, see 5.3.4 Registering a root certificate.

The mail server that JP1/DH - Server works with is specified in environment setup after JP1/DH - Server installation.

3.2.4 Sender email address

Determine a sender email address for email notifications that JP1/DH - Server sends to users. This email address is set on the From header of those email notifications.

The sender email address is specified in environment setup after JP1/DH - Server installation.

3.2.5 Directory server used by the system

JP1/DH - Server can use a directory server for user authentication when users log in. If you want to use this function, you need to determine which directory server works with the JP1/DH - Server system.

For details about a list of proven directory servers that have actually worked, see 1.3.1 Prerequisite products and prerequisite products for a specific function or with conditions. JP1/DH - Server uses the LDAP protocol to communicate with the directory server. You can use LDAPS to encrypt traffic. To do this, you must first obtain the root certificate of a certificate authority that signed the certificate for SSL traffic that is stored in the directory server that JP1/DH - Server works with. You must then store the root certificate in the JP1/DH - Server server.

For information about how to obtain the root certificate, consult with your certificate authority. For details about how to store the root certificate in the JP1/DH - Server server, see 5.3.4 Registering a root certificate.

3.3 Optional parameters

This section provides information about the optional parameters.

3.3.1 The Java heap memory size

Determine the Java heap memory size for your system. Insufficient Java heap memory size could cause a lower transfer rate or an improper operation of the system during transfer over concurrent connections or during delivery of a large file. You can specify both initial and maximum sizes (in MB) for the Java heap memory. You must set the maximum size to a minimum of 1,024 MB, which is the default setting. You can estimate the preferred value for the maximum size by using the following calculation formula:

Maximum size ≥ default setting of 1,024 MB + (maximum number of concurrent connections × buffer size for transfer and reception)

For details about the maximum number of concurrent connections, see 3.3.4 Concurrent connections. For details about the buffer size for transfer and reception, see 3.3.8 Buffer size during transfer and reception.

We recommend that you specify the same size for both initial and maximum values. The following table describes the default settings.

Table 3‒3: Default settings for the Java heap memory size

Setting item

Default value

Initial size

1,024 MB

Maximum size

1,024 MB

The Java heap memory size is specified in environment setup after JP1/DH - Server installation.

3.3.2 Network bandwidth limit

JP1/DH - Server provides high-speed data communications by multiplexing connections to take full advantage of the bandwidth of the network on the path. This could occupy the network bandwidth during data communications, thus adversely affecting other communication services. To avoid this situation in your environment, you might have to limit the network bandwidth available to JP1/DH - Server. You can set the limit (in Mbps) separately for both uploading to and downloading from JP1/DH - Server. The following table describes the default settings.

Table 3‒4: Default settings for the network bandwidth limit

Setting item

Default value

Upload

Not limited

Download

Not limited

The network bandwidth limit is specified in environment setup after JP1/DH - Server installation.

3.3.3 Keep-alive timeoutperiod

Determine a keep-alive timeout period for data communications. During data communications, JP1/DH - Server clients and servers send and receive bidirectional keep-alive packets to confirm their active connection with each other. If a client or server does not receive any keep-alive packet after the timeout period has elapsed, it assumes that the connection is no longer active and suspends the data communications. It might take some time to send and receive keep-alive packets to and from locations outside of your country or with poor communication line quality. In this case, a short timeout period can often cause interruption of data communications. You can specify the separate timeout periods (in seconds) for both clients and server. The following table describes the default settings.

Table 3‒5: Default settings for the keep-alive timeout period

Setting item

Default value

Client

180 seconds

Server

180 seconds

The keep-alive timeout period is specified in environment setup after JP1/DH - Server installation.

3.3.4 Concurrent connections

JP1/DH - Server can accept concurrent connections from multiple clients for transfer. Determine the number of concurrent connections. Specifically, this includes determining the number of initial connections and the maximum number of connections. When starting up, JP1/DH - Server first reserves server resources that allow for as many connections as the number of initial connections. When the number of concurrent connections increases over time and exceeds the initial number of connections, the system dynamically assigns more server resources until the maximum number of concurrent connections is reached.

We recommend that if you know the specific average number of concurrent connections, set the initial number of connections to a value a little greater than the average.

You can set the maximum number of connections to a value based on your own environment, such as the network bandwidth. However, the upper limit for the maximum number of concurrent connections is 64. If the number of concurrent connection requests from clients exceeds the maximum number of connections, those requests are put into the connection queue (which is discussed later) and wait for a connection to become available.

Table 3‒6: Default settings for the number of concurrent connections

Setting item

Default value

Number of initial connections

JP1/DH - Server : 16

JP1/Data Highway - Server Starter Edition : 4

Maximum number of connections

JP1/DH - Server : 16

JP1/Data Highway - Server Starter Edition : 4

The number of concurrent connections is specified in environment setup after JP1/DH - Server installation.

3.3.5 Connection queue size

JP1/DH - Server might receive connection requests, from clients, that exceed the defined maximum number of connections (see 3.3.4 Concurrent connections). If this happens, JP1/DH - Server first stores those requests in its connection queue, making them wait for an available connection. If the system receives additional connection requests from a client when the connection queue is full, the system immediately lets the client know that the server is currently busy.

We recommend that you set the connection queue size to the same value as the maximum number of concurrent connections or greater.

Table 3‒7: Default settings for the connection queue

Setting item

Default value

Connection queue size

16

The connection queue size is specified in environment setup after JP1/DH - Server installation.

3.3.6 Storage period of the audit log

JP1/DH - Server records its usage in the audit log. The audit log contains the series of transfers and reception history of files, as well as the operating history such as user or group administrative tasks performed on JP1/DH - Server. Determine how many days the audit log is to be kept in the system. The audit log will have a separate file every day. Audit log files will be removed after their storage period.

Table 3‒8: Default settings for the storage period of the audit log

Setting item

Default value

Audit log storage period

365

The audit log storage period is specified in environment setup after JP1/DH - Server installation.

3.3.7 Block size during transfer and reception

Data is transferred in a unit of a particular size, which is called a block. Determine a block size for a client to send data to, and to download data from JP1/DH - Server.

By default, the system automatically determines the block sizes depending on the network condition at the beginning of transfer and reception. We recommend the default settings. If, however, you want to always send and receive data in specific block sizes, you can use fixed block sizes. Note that the block size is associated with the buffer size, so you also need to determine the buffer size during transfer and reception.

Table 3‒9: Default settings for the block sizes during transfer and reception

Setting item

Default value

Block size for transfer

Automatically determined by the system (maximum: 256 KB)

Block size for downloading

Automatically determined by the system (maximum: 256 KB)

3.3.8 Buffer size during transfer and reception

Determine the size of the buffer per client connection that JP1/DH - Server uses in transfer and reception. You can estimate the buffer size for optimal performance by using the following calculation formula:

Buffer size per client connection ≥ maximum number of TCP connections × block size

For details about the maximum number of TCP connections, see the JP1/Data Highway - Server System Administrator Guide and the JP1/Data Highway - Server Administrator Guide. For details about the block size, see 3.3.7 Block size during transfer and reception.

These settings can limit allocation of communication buffer memory to the specified values even if the size of data to be transferred or received is larger than one of the values set here. However, too small of a value can slow the transfer rate.

Table 3‒10: Default settings for the buffer size for transfer and reception

Setting item

Default value

Transfer buffer size in JP1/DH - Server

8 MB

Reception buffer size in JP1/DH - Server

8 MB

3.3.9 Packet queue size of clients

Determine the packet queue size for clients. You can estimate the packet queue size for optimal performance by using the following calculation formula:

Packet queue size ≥ maximum number of connections × block size × 2

For details about the maximum number of connections, see 3.3.4 Concurrent connections. For details about the block size, see 3.3.7 Block size during transfer and reception.

Table 3‒11: Default setting for the packet queue size of clients

Setting item

Default value

Packet queue size of clients

16 MB

3.3.10 Maximum size of files available for transfer

Determine the maximum size of a single delivery attempt and the maximum file size per file. You can see the specified values in the window for creating or editing delivery policy on the web interface.

If you want any files or folders over 4 GB to be compressed when transferred, see 3.3.16 Displaying the Compress Method options.

Table 3‒12: Default settings for the maximum size of files available for transfer

Setting item

Default value

Maximum size per delivery

50 GB

Maximum size per file

50 GB

3.3.11 Password obfuscation (SALT string)

Consider using a SALT string so that user passwords cannot be cracked easily. Specifying the SALT string makes it difficult to analyze an encrypted password, preventing the original password from being guessed easily.

Table 3‒13: Default settings for the password

Setting item

Default value

Password

Clear text

3.3.12 Maximum storage period of files

Determine how many days files to be transferred are to be kept in the system.

Table 3‒14: Default setting for the maximum storage period of files

Setting item

Default value

Storage period

31 days

Important

In JP1/DH - Server 11-00 or earlier, the system treats the value specified here as the maximum value allowed for Storage period in the New Delivery Policy window and the Edit Delivery Policy window.

In JP1/DH - Server 11-10 or later, the system treats the value specified here as the maximum value allowed for Maximum storage period of files in the New Group window and the Edit Group window.

3.3.13 Maximum number of destinations

Determine the maximum number of destinations that a user can specify for a delivery on the web interface. The maximum number represents the sum of approvers and recipients. For details about this value when JP1/Data Highway - AJE and the data transfer command is used, see 3.3.22 Maximum number of destinations.

Table 3‒15: Default setting for the maximum number of destinations

Setting item

Default value

Maximum number of destinations

100

3.3.14 Enabling or disabling the initial environment setup function

Determine whether to create a default address book and delivery policy when you create a domain. If you use this function, the address book, delivery policy, and delivery rule will be automatically created when you create a domain. This allows you to reduce the time to actually start a file delivery after the domain creation.

Table 3‒16: Default setting for the initial environment setup function

Setting item

Default value

Initial environment setup function

FALSE

3.3.15 Default setting for the processing status type of deliveries to be displayed in the in-box

Determine delivery data with which processing status is displayed in the in-box by default. A user's in-box displays deliveries with the specified default status type. You can choose one of the following processing statuses: Not opened, Opened, and All. Setting the default delivery status for display on the window allows users to identify processing statuses in the in-box at a glance.

Table 3‒17: Default setting for the processing status type for deliveries to be displayed in the in-box

Setting item

Default value

Status

All

3.3.16 Displaying the Compress Method options

Determine whether to display the Compress Method options in the window for creating or editing delivery policy.

If the Compress Method options are not displayed in the window, the system uses the extended compression method for file transfer. The extended compression method allows you to compress files and folders over 4 GB in size.

If the Compress Method options are displayed, both Standard, and Extended are displayed as options for Compress Method. If you need to transfer data in the standard compression method, display the Compress Method options.

For JP1/Data Highway - AJE, the JP1/Data Highway - AJE 10-10 and later versions can receive delivery data in the extended compression method. JP1/Data Highway - AJE 10-00 ignores delivery data in the extended compression method. In addition, a single reception attempt might contain mixed data deliveries in extended and other compression methods, which causes an error with the delivery only in the extended compression method. To avoid this, you must use an appropriate delivery policy according to the version of JP1/Data Highway - AJE for reception.

Table 3‒18: Default settings for whether the Compress Method options are displayed

Setting item

Default value

Whether the Compress Method options are displayed upon new installation

FALSE

3.3.17 External storage options for the data sent by using the extended compression method

If you want to scan delivery data for viruses on the server or if you want to extract the delivered folder by using the command for extracting delivery data, determine where and how the data is to be stored on the server.

When sending files or folders, JP1/DH - Server stores copies of the sent files or folders on the server. If a folder is sent with a delivery policy by using the extended compression method, or if a file or folder is sent in one of STRONG, MIDDLE, or WEAK of the Compress Level setting, the system uses its own compression scheme to store the file or folder on the server. As a result, a virus scan on the delivery data cannot detect any virus. In such a case, consider storing (to an external location) some of the sent files without compression.

In addition, if you want to extract the delivered folder by using the command for extracting delivery data, you must externally store files to be sent before executing the command.

The settings for externally stored files consist of the number of files stored externally and the upper limit of the total file size (in KB).

Externally-stored files consume disk space where the delivery data is stored. We recommend that you do not store the delivery data externally unless you intend to scan the data for viruses or use the command for extracting delivery data.

Table 3‒19: Default settings for the external storage options for extended compression method

Setting item

Default value

Maximum number of files to be externally stored from among files or files in a folder in a single delivery

0 (not stored externally)

Maximum total file size of files to be externally stored from among files or files in a folder in a single delivery

0 (not stored externally)

3.3.18 Displaying the options related to number of TCP connections

Determine whether to display the items for Max. TCP sessions per Connection and Always connect with Max. TCP sessions in the window for creating or editing delivery policy. If these items are displayed, you can configure settings related to TCP connections not only in the window for the default delivery policy but also in other delivery policy windows.

Table 3‒20: Default settings for the options related to number of TCP connections

Setting item

Default value

Displaying Max. TCP sessions per Connection

FALSE

Displaying Always connect with Max. TCP sessions

FALSE

3.3.19 Timeout period when using a directory server

You can use a directory server to authenticate users who try to log in to JP1/DH - Server. Before doing this, you need to determine the timeout period for connecting to the directory server and for searching the directory server for a user.

Table 3‒21: Default settings for the timeout period when using the directory server

Setting item

Default value

Timeout period for connecting to the directory server

30,000 milliseconds (30 seconds)

Timeout period for searching for a user

30,000 milliseconds (30 seconds)

3.3.20 Approval exclusion function

Consider using this function when using JP1/Data Highway - AJE and the data transfer command. If you activate this function, an approval route can be skipped for transfer when a delivery rule specifies the approval route if JP1/Data Highway - AJE and the data transfer command is used to transfer a file or folder.

Table 3‒22: Default setting for the approval exclusion function

Setting item

Default value

Approval exclusion function

FALSE

3.3.21 Using the file validation disabling function

Consider using this function when using JP1/Data Highway - AJE and the data transfer command. This function disables the file validation when JP1/Data Highway - AJE and the data transfer command is used to transfer a file, thus reducing the time spent on transferring. Receiving delivery data through this function on JP1/Data Highway - AJE version 10-00 causes an error, and the system ignores that delivery. If the file validation disabling function is not enabled, the system can receive that delivery data without any error.

Table 3‒23: Default setting for the file validation disabling function

Setting item

Default value

File validation disabling function

FALSE

Important

The file validation function prevents files that sender users do not intend to send from being sent to recipient users when sender users inadvertently update or modify the files while they are being sent. Note that the file validation function does not work if you specify TRUE for the setting of the file validation disabling function.

3.3.22 Maximum number of destinations

Consider specifying this item when JP1/Data Highway - AJE and the data transfer command is used. You need to determine the maximum number of possible destinations when using JP1/Data Highway - AJE and the data transfer command to transfer a file or folder. With a valid value specified, the number of destinations set here takes precedence over the maximum number of destinations defined in a delivery policy. The maximum number represents the sum of approvers and recipients.

Table 3‒24: Default setting for the maximum number of destinations

Setting item

Default value

Maximum number of destinations

0 (uses the maximum number of destinations defined in the delivery policy)

3.3.23 Using the file validation disabling function when using the web user-interface

Consider using this function when using the web user-interface. This function disables the file validation, thus reducing the time spent on transferring. Receiving delivery data through this function on JP1/Data Highway - AJE version 10-50 causes an error, and the system ignores that delivery. If the file validation disabling function when using the web user-interface is not enabled, the system can receive that delivery data without any error.

Table 3‒25: Default setting for the file validation disabling function when using the web user-interface

Setting item

Default value

File validation disabling function when using the web user-interface

FALSE

Important

The file validation function prevents files that sender users do not intend to send from being sent to recipient users when sender users inadvertently update or modify the files while they are being sent. Note that the file validation function does not work if you specify TRUE for the setting of the file validation disabling function.

3.3.24 Initial state of selection for choosing an approver

Consider the initial state of selection when users choose their approver on the web window. You need to specify the initial state of selection in the following windows:

Whether The sender must select the approver (except for the commands) check box in the New Delivery Rule window is selected by default

What is selected by default in the Select Approver window displayed when a sender chooses the approver in the New Delivery window

Table 3‒26: Default settings for the initial state of selection when an approver is chosen

Setting item

Default value

Initial state of selection for choosing an approver

TRUE

3.3.25 Function to automatically delete files before the storage expiration date based on the evaluation of download completion by all recipients

This function automatically deletes files before the storage expiration date is reached if all the users specified as the recipients download all the files. With the function, the system finds out that all the users specified as the recipients already downloaded all the files and then deletes the files automatically before the storage expiration date is reached. This function can be enabled for each of the address types (TO, CC, and BCC).

Table 3‒27: Default settings for the function to automatically delete files before the storage expiration date based on the evaluation of download completion by all recipients

Setting item

Default value

Function to automatically delete files before the storage expiration date based on the evaluation of download completion by all recipients

TO: TRUE

CC: FALSE

BCC: FALSE

3.3.26 Window interface for the New Delivery window

This function allows you specify a window interface of the New Delivery window, which is used for transferring files on the web window. You can specify the following interfaces:

Java applet

Geared toward JP1/DH - Server 11-00 or earlier, this interface uses a Java applet. The New Delivery window works on the web browser.

JWS

Geared toward JP1/DH - Server 11-10 or later, this interface uses JWS (Java Web Start). The New Delivery window works on a separate window from the web browser.

Application

Geared toward JP1/DH - Server 12-00 or later, this interface can be used by downloading the Send and Receive App. The New Delivery window works on a separate window from the web browser.

Java applet and JWS interfaces can work only when using JRE 8. In addition, you need to prepare Java software by yourself. For these reasons, we recommend that you use the Application, which comes with a Java execution environment, for the New Delivery window.

You can specify the window interface to use, or display a menu on the web browser that allows users to select an interface they want to use.

Table 3‒28: Default settings for the window interface of the New Delivery window

Setting item

Default value

Java applet

TRUE

JWS

TRUE

Application

TRUE

3.3.27 SAML SSO authentication

Determine whether to use SAML Single Sign-On (SSO) authentication. With SSO authentication, Single Sign-On authentication can be performed per domain using JP1/DH - Server as the service provider.

Table 3‒29: Default settings for the SAML SSO authentication

Setting item

Default value

SAML SSO authentication

FALSE

3.4 Operations with system capacity in mind

This section covers capacity planning of the JP1/DH - Server system, such as the number of groups, users, and delivery rules. Before the system goes live, you need to plan operations with the capacity in mind.

For details about how to configure individual capacity settings mentioned below, see the JP1/Data Highway - Server System Administrator Guide and the JP1/Data Highway - Server Administrator Guide.

3.4.1 User capacity

As the number of users increases, more users access the system at the same time.

Therefore, you need to limit the maximum number of users of the system. For example, the number of concurrently-logged-in users to a single server system must be 100 users or less. The number of concurrent connections for high-speed transfer must be within the range mentioned in 3.3.4 Concurrent connections. The size of the connection queue for high-speed transfer must be within the range mentioned in 3.3.5 Connection queue size.

If the number of users will exceed the upper limit of a single server system, you need to choose to add a further JP1/DH - Server server so that users can share the servers. Note that one JP1/DH - Server server cannot send and receive files with another server.

In the case of JP1/Data Highway - Server Starter Edition, the number of users that can be registered is up to 30.

3.4.2 Group capacity

As the number of groups increases, it takes a longer time to display the list of groups in the Users & Groups window, which system administrators or representative users can use.

The number of groups must be 1,000 groups or less within an entire single server system.

The groups can be nested to a maximum of 10 levels. You need to consider the upper limit of the level to determine the hierarchical structure of your groups.

3.4.3 Address book capacity

A user uses an address book for sending a file on JP1/DH - Server. As the number of users to be displayed in the address book increases, it takes proportionally more time to display all the addresses in the address book. Therefore, you need to determine the structure and display settings of groups so that the minimum number of required users appear in a user's address book.

We recommend the setting such that 100 or less users are displayed in an address book.

3.4.4 Other objects capacity

The table below lists and describes what impacts arise when system administrators or representative users create more objects, and the capacities of each object. You need to plan operations such that the minimum required number of objects is created.

Table 3‒30: Capacities of other objects

Object

Impacts

Capacity#

Delivery rule and delivery policy

Increased time to fill destination data in the destination fields when a user chooses an address in the address book for sending a new file.

Increased time for a list of delivery rules or delivery policies to be displayed to system administrators or representative users.

100 each for rules and policies in an entire single server system

Authentication rule and authentication policy

Increased time for the initial window to be displayed after a user logs in to JP1/DH - Server.

Increased time for a list of authentication rules or authentication policies to be displayed to system administrators or representative users.

100 each for rules and policies in an entire single server system

Network set

Increased time for the initial window to be displayed after a user logs in to JP1/DH - Server.

Increased time for a list of network sets for system to be displayed to administrators or representative users.

100 in an entire single server system

Approval route

Increased time for a list of approval routes to be displayed to system administrators or representative users.

100 in an entire single server system

#: If you have multiple domains created, the capacity represents the total of objects in each domain.

3.5 Operational tasks

This section describes operational tasks performed on the JP1/DH - Server machine.

For details about system administrative tasks, such as creating authentication policies or setting representative users, see the JP1/Data Highway - Server System Administrator Guide. For details about representative user's or group manager's operational tasks, such as adding groups or users, see the JP1/Data Highway - Server Administrator Guide.

3.5.1 Secure operations

If you want to operate your JP1/DH - Server accessible to and from the Internet, you need to protect the system against server attacks or unauthorized access from a third-party. This subsection covers information related to secure operations of the system.

Also, even if you operate JP1/DH - Server in your private network, you can make use of the information depending on the security level you want.

(1) OS operations that follow security guides from your OS vendor

Examples of measures required to build and maintain a secure JP1/DH - Server machine environment include the following:

Having appropriate control over users, roles, and privileges for the OS

Eliminating unnecessary services and applications and limiting the role that the JP1/DH - Server machine plays

Monitoring logs and audit records

Security guides for Windows are available from the Microsoft web site. Follow these guides to take necessary measures.

(2) Access permissions

To control who and which systems have access to JP1/DH - Server, example measures include the following:

Filter access to the JP1/DH - Server server by using, for example, a reverse proxy.

Check logs of the reverse proxy periodically for any unauthorized access or attacks.

Consider taking measures such as blocking access from terrorist-supporting states or countries under a trade embargo.

(3) Virus scanning

When a user attempts to send a file, JP1/DH - Server copies it to a folder on the JP1/DH - Server machine, keeping it temporarily. This might result in storing a virus-infected file in the JP1/DH - Server machine if a user sends an infected file. JP1/DH - Server does not execute these files on the machine or open them with a corresponding application. However, spreading the virus-infected file to recipients must be avoided. For this purpose, you need to consider operations to install an anti-virus software on the JP1/DH - Server machine, and to monitor whether any virus-infected files are detected.

For details about the storage location for files sent and received by users, see 3.2.2 Storage folder for delivery data.

If an anti-virus program removes a file to be transferred or received from the disk on the JP1/DH - Server machine, the system deactivates the Download button on the web user-interface, disabling downloads of the file.

3.5.2 Resource monitoring

You need to use a tool, such as a resource monitoring tool, to monitor the usage of resources listed in the table below in order to check the running JP1/DH - Server for resource shortage.

You can view system and resource usage summaries in the System Monitor window, which system administrators can open on the web interface. For more information, see the JP1/Data Highway - Server System Administrator Guide.

Table 3‒31: Monitored resource

Monitored resource

Description

CPU usage

High CPU usage can lead to a declining system response time over time. In this case, the system might be running out of CPU resources compared to CPU usage.

If this happens, you need to consider operations, such as installing additional CPUs, or adding a JP1/DH - Server server so that users can share the servers.

Memory usage

High memory usage can lead to an out-of-memory error or a declining system response time over time. In this case, the system might be running out of memory resources compared to memory usage.

If this happens, you need to consider operations, such as installing extra memory to set a larger value for the Java heap size of the JP1/DH - Server server, or adding a JP1/DH - Server server so that users can share the servers.

Disk I/O

High disk I/O can lead to a declining system response time over time. In this case, the system might be running out of disk I/O performance compared to disk usage.

If this happens, you need to take measures such as replacing your hard disks with ones that offer higher disk I/O performance.

Disk usage

Insufficient free disk space due to high disk usage can cause an error, preventing the system from working properly. The errors include storage errors of files to be sent or received, data storage errors in the database, and write errors of files necessary to run the system such as server logs.

If disk usage becomes higher, you need to have free disk space by backing up unnecessary log files and other files, or consider adding extra disk space by installing another disk drive.

Network usage

High network usage can lead to declining throughput values of file transfers recorded in the JP1/DH - Server audit log. In this case, the system can be running out of network bandwidth compared to system usage.

If this happens, you need to consider increasing the capacity in your network infrastructure so that the system can use more network bandwidth.

3.5.3 Alive monitoring

With your system operation, you need to consider whether to adopt the alive monitoring mechanism which monitors for a continuous operation of the JP1/DH - Server server. Note the following points when performing alive monitoring:

To perform the alive monitoring of JP1/DH - Server over the network, send HTTP GET requests to the login window (https://servername/index.jspx) of JP1/DH - Server at regular intervals, and check for responses. If the system does not respond to successive requests, or if server error responses (HTTP status code 5xx) are continuously returned, contact your operational administrator.

Sending an HTTP GET request to the login window of JP1/DH - Server causes access from the web server to the database. Thus, this approach allows you to detect whether the JP1/DH - Server database has a failure or is down.

Perform the alive monitoring over the network on a different machine from the JP1/DH - Server machine. Also, use the same network path as the one that users actually use for access to JP1/DH - Server. In this way, you must monitor whether the service is down because of a failure in the network infrastructure or a device before JP1/DH - Server is reached.

3.5.4 Monitoring the mail server

JP1/DH - Server uses a mail server to send email messages such as file delivery notifications. You might have to consider monitoring the mail server for proper delivery of the email messages. Keep the following in mind when considering this for operation:

An email delivery error can occur on the mail server, but JP1/DH - Server does not detect the error. Examples of causes of the errors include an incorrect or removed email address for a user in the JP1/DH - Server system, a stopped destination mail server, rejected delivery of email messages on the destination mail server.

Because of this, you must use the logs or monitoring function offered by your mail server to check for proper delivery of email messages.

JP1/DH - Server does not provide a function that resends email messages such as delivery notifications. If an email message needs to be resent because of an email delivery error, use the function on the mail server to resend the message.

If your mail server cannot resend the message, identify and resolve the cause of the error, and then transfer the file again on JP1/DH - Server. Email messages sent from JP1/DH - Server are intended to notify users and prompt them to download a delivered file or approve the delivery. The users can use these functions by logging in to JP1/DH - Server, instead of clicking a URL on the body of the email message.

3.5.5 Import/export control on files sent or received

Users must comply with laws and regulations related to importing and exporting if they send or receive electronic files or information contained in those files to or from users outside of your country or non-resident users. For import and export control, consult with your import and export control department, and determine how you handle it.

3.6 Maintenance

This section describes maintenance tasks performed on the JP1/DH - Server machine.

3.6.1 Notes about the What's new function

The What's new function displays messages from the system administrator to JP1/DH - Server users in the login window. It can be used for notifying the users of events, such as shutting down the JP1/DH - Server machine for system maintenance. The following steps show how to use the What's new function:

Log in to the JP1/DH - Server machine as a built-in Administrator user (for Windows) or root user (for Linux).

Determine which file you need to edit.

Each display language has its own language file to be edited. You must choose the file you need and edit it.

For Japanese:

installation-folder#\uCPSB\CC\web\containers\jp1dh\webapps\digikatsuwide\digikatsuwide\WEB-INF\jsp\themes\digivery\index_information_ja.jsp

For English:

installation-folder#\uCPSB\CC\web\containers\jp1dh\webapps\digikatsuwide\digikatsuwide\WEB-INF\jsp\themes\digivery\index_information_en.jsp

For Chinese:

installation-folder#\uCPSB\CC\web\containers\jp1dh\webapps\digikatsuwide\digikatsuwide\WEB-INF\jsp\themes\digivery\index_information_zh.jsp

#: In Linux, change installation-folder to /opt/jp1dh/server.

Edit the message.

Enter the message# you want to display in the login window.

<div style="font-size: 12px;">your-message</div>

#: The field you edit is part of the HTML code. Do not use any special characters of the HTML language.

Example:

<div style="font-size: 12px;">[Maintenance notice] This service will be unavailable because of system maintenance during the following period: From 21:00 to 22:00 on MM DD, YYYY</div>

Apply the changes.

Start the command prompt and run the command below for the edited message to take effect in the login window.

In Windows

installation-folder\bin\reload_app.bat

In Linux

/opt/jp1dh/server/bin/reload_app.sh

Important

If the login window does not appear properly after this edit operation is performed, restore the edited message in the file to its original message. If the message cannot be reverted to the original one, copy the following files to the file path mentioned above and overwrite these files:

installation-folder#\misc\digikatsuwide\digikatsuwide\WEB-INF\jsp\themes\digivery\index_information_ja.jsp

installation-folder#\misc\digikatsuwide\digikatsuwide\WEB-INF\jsp\themes\digivery\index_information_en.jsp

installation-folder#\misc\digikatsuwide\digikatsuwide\WEB-INF\jsp\themes\digivery\index_information_zh.jsp

#: In Linux, change installation-folder to /opt/jp1dh/server.

3.6.2 Registering the number of purchased user licenses

You can register the number of user licenses you purchased in JP1/DH - Server. The number of user licenses you registered appears in the sidebar area of the JP1/DH - Server window, together with the number of registered users in the entire system.# This function allows you to easily confirm that the number of registered users across the entire system does not exceed the number of purchased user licenses.

For details about how to register the number of purchased user licenses, see 12.3.4 regist_users_number.bat (registering the number of purchased user licenses).

#: Only a system administrator can see it.

3.6.3 Time clock synchronization of the server

JP1/DH - Server records file-transfer-and-reception times in the audit log. You need to consider time clock synchronization with an NTP server so that the system can record correct times in the log. If the date changes due to time synchronization with the NTP server, log integrity cannot be maintained. To avoid this, do not synchronize the server time around midnight.

3.6.4 Maintaining log files

After starting operation, the JP1/DH - Server server (and related systems) output data to various logs.

Log files for the data output from JP1/DH - Server roll over when they reach a certain size, and older generations of the log files are removed automatically.

You need to maintain logs of related systems such as the OS on which JP1/DH - Server is installed, mail server, and reverse proxy, by backing up or removing the log files periodically according to the logging specifications for each system.

The following table lists and describes folders in which JP1/DH - Server outputs its log files.

Table 3‒32: Log output folders

Log output folder

Description

installation-folder#\log

The JP1/DH Web application server outputs its data to the log file in this folder.

installation-folder#\uCPSB\httpsd\logs

The JP1/DH Web server outputs its data to the log file in this folder.

installation-folder#\PostgreSQL\9.4\data\pg_log

The database used by JP1/DH - Server outputs its data to the log file in this folder.

#: In Linux, change installation-folder to /opt/jp1dh/server.

The following table lists and describes the maximum capacity per file and number of output files for each log file.

Table 3‒33: Maximum capacities and number of output files for log files

Log output folder

Log file name

Description

Maximum capacity per file

Number of files

installation-folder#1\log

jp1dh-audit.log.YYYY_MM_DD#4

JP1/DH - Server audit log

Variable#2

365#3

user_err[n].log

JP1/DH - Server error log

1,024 KB

2

user_out[n].log

JP1/DH - Server log

1,024 KB

2

web_servlet[n].log

Web servlet log

1,024 KB

4

javalog[nn].log

Log for maintenance information and garbage collection of Java VM

256 KB

4

ehjavalog[nn].log

Event log for the Explicit heap function

4,096 KB

4

cjmessage[n].log

Operation log

1,024 KB

2

cjexception[n].log

Exception information in the event of a failure

1,024 KB

2

installation-folder#1\log\WS

c4webcl-default-[n].log

Trace file

2,048 KB

2

installation-folder#1\log\WS\maintenance

c4webcl-default-[n].log

Trace file

2,048 KB

2

installation-folder#1\log\watch

cjhttpsessionwatch[n].log

Monitoring log for HTTP sessions

1,024 KB

2

cjmemorywatch[n].log

Monitoring log for memory usage

1,024 KB

2

cjrequestqueuewatch[n].log

Monitoring log for the HTTP request execution queue

1,024 KB

2

cjthreaddumpwatch[n].log

Monitoring log for thread dump files

1,024 KB

2

cjthreadwatch[n].log

Monitoring log for threads

1,024 KB

2

installation-folder#1\log\http

cjhttp_access.inprocess_http[n].log

Processing results of the in-process HTTP server

4,096 KB

16

installation-folder#1\log\http\maintenance\comm

cjhttp_comm.[YYYYMMDDHHmmssSSS].inprocess_http.mm#4

Communication tracing information

16,998.4 KB

16

installation-folder#1\log\http\maintenance\thr

cjhttp_thr.YYYYDDMMHHmmssSSS.inprocess_http.mm#4

Thread tracing information

3,276.8 KB

16

installation-folder#1\log\CC\maintenance

cj_shutdown[n].log

Finished-process information

1,096 KB

2

cjconsole[n].log

Console message

1,024 KB

2

cjejbcontainer[n].log

Maintenance information on the EJB container

1,024 KB

2

cjmaintenance[n].log

Maintenance information

16 KB

4

cjstdout.log

Standard output information from running processes

1,048 KB

1

cjstdout_save.log

Backup of the standard output information from running processes

1,048 KB

1

cjwebcontainer[n].log

Maintenance information on the web container

1,024 KB

2

installation-folder#1\log\CC\rmi

cjrmi[n].log

RMI communication log of the J2EE server

1,024 KB

4

installation-folder#1\PostgreSQL\9.4\data\pg_log

postgresql-[DD].log

Database log

Variable#2

31

installation-folder#1\uCPSB\httpsd\logs

access.[nnnnnnnnnn]

JP1/DH Web server access log

Variable#2

8

error.[nnn].

JP1/DH Web server error log

8,192 KB

5

hwsrequest.[nnnnnnnnnn]

JP1/DH Web server request log

Variable#2

8

#1

In Linux, change installation-folder to /opt/jp1dh/server.

#2

The system creates one file per day. The size of the file depends on usage.

#3

The storage period of the audit log is an adjustable operational parameter.

#4

YYYY: Year

MM: Month

DD: Day

HH: Hour

mm: Minute

ss: Second

SSS: millisecond

3.6.5 Backup and restore

This section describes how to back up and restore part of JP1/DH - Server data.

To back up and restore the entire system on the server where JP1/DH - Server is installed, use a backup tool, such as a commercially available tool.

(1) Performing a backup operation

Perform the procedures described below to back up the JP1/DH - Server database, storage folders for delivery data, log files, and configuration files.

You can perform a backup operation with the JP1/DH Web application server running. If, however, you want to take snapshot of the system before the backup, let users know that the service will be down, shut down the JP1/DH Web application server, and then back data up while JP1/DH - Server is unavailable to the users.

Use the dbbackup.bat command to back up the database. For details about how to use the command, see 12.3.1 dbbackup.bat (backing up the database).

Back up all files and folders in the storage folder for delivery data defined in 3.2.2 Storage folder for delivery data in some way, such as a file copy command.

Back up log files output from JP1/DH - Server in some way such as a file copy command. For details about where the log files are output, see 3.6.4 Maintaining log files.

Back up the files edited and created in 5.3 Setting up the JP1/DH Web application server environment in some way, such as a file copy command.

(2) Performing a restore operation

Perform the procedures described below to restore the JP1/DH - Server database, storage folders for delivery data, log files, and configuration files.

Before the restore operation is performed, let users know that the service will be down, shut down the JP1/DH Web application server, and then restore data while JP1/DH - Server is unavailable to the users.

Restore the files edited and created in 5.3 Setting up the JP1/DH Web application server environment from their backups in some way, such as a file copy command, if necessary.

Restore backups of the log files output from JP1/DH - Server in some way, such as a file copy command, if necessary. For details about where the log files are output, see 3.6.4 Maintaining log files.

Restore all the backed-up files and folders to the storage folder for delivery data defined in 3.2.2 Storage folder for delivery data in some way, such as a file copy command.

Use the dbrestore.bat command to restore the database. For details about how to use the command, see 12.3.2 dbrestore.bat (restoring the database). To use the dbrestore.bat command, the database service (JP1_DH_DATABASE_SVR) must be running.

3.6.6 Emergency login

If a system administrator cannot log in to the system because an incorrect authentication rule for system administrators is applied, perform the procedures described below to allow for an emergency login to the system#. After the successful emergency login, disable the authentication rule for system administrators in question. For details about the authentication rule for system administrators, see the JP1/Data Highway - Server System Administrator Guide.

#

With the emergency login active, users other than system administrators cannot log in to the system. After disabling the authentication rule for system administrators in question, remember to disable the emergency login.

Log in to the JP1/DH - Server machine as a built-in Administrator user (for Windows) or root user (for Linux).

Stop the JP1/DH Web application server.

You must stop the JP1_DH_WEB CONTAINER service for Windows, or the JP1_DH_WEBCON service for Linux. For details about how to stop the service, see 6. Starting and Stopping.

Edit the digikatsuwide.xml file.

File path

installation-folder#\uCPSB\CC\web\containers\jp1dh\webapps\digikatsuwide\digikatsuwide\WEB-INF\digikatsuwide.xml

#: In Linux, change installation-folder to /opt/jp1dh/server.

Part you must edit in the file

Change the value in the following element from false to true.

[Before change]

<biz-connect>
    <emergency-login>false</emergency-login>
</biz-connect>

[After change]

<biz-connect>
    <emergency-login>true</emergency-login>
</biz-connect>

Start the JP1/DH Web application server.

You must start the JP1_DH_WEB CONTAINER service for Windows, or the JP1_DH_WEBCON service for Linux. For details about how to start the service, see 6. Starting and Stopping.

Disable the authentication rule for system administrators.

Log in to JP1/DH - Server, and then disable the authentication rule for system administrators in question. After this is done, change the value of the emergency-login element back from true to false and restart the JP1/DH Web application server.

3.7 Email customization

If you want to use email notifications for deliveries or approvals, you can customize the subject and body of email messages sent by JP1/DH - Server.

3.7.1 List of customizable email notifications

The following table describes email notifications you can customize and names of their email template files.

Table 3‒34: Customizable email templates

No.

Type of email notification

Email template file name#

Related subsection

1

File delivery notification

delivery_notification_ja.xml

3.7.5

2

File delivery notification (reminder)

notification_not_downloaded_ja.xml

3.7.6

3

File delivery confirmation

delivery_confirmation_ja.xml

3.7.7

4

File delivery notification (opened)

delivery_opened_notification_ja.xml

3.7.8

5

File delivery notification (expires soon)

notification_before_expired_ja.xml

3.7.9

6

File delivery notification (expired)

notification_after_expired_ja.xml

3.7.10

7

Approval request notification

delivery_approval_notification_ja.xml

3.7.11

8

Approval request notification (reminder)

notification_not_approved_ja.xml

3.7.12

9

Approved-delivery notification (The notification to the sender)

delivery_accepted_confirmation_ja.xml

3.7.13

10

Approved-delivery notification (Notify all the sender and approver)

delivery_accepted_confirmation_for_approvers_ja.xml

3.7.14

11

Rejected-delivery notification (The notification to the sender)

delivery_rejected_confirmation_ja.xml

3.7.15

12

Rejected-delivery notification (Notify all the sender and approver)

delivery_rejected_confirmation_for_approvers_ja.xml

3.7.16

#

These are the names of the Japanese files. For the names of English or Chinese files, see the sections for each template file in the later sections.

3.7.2 How to customize email notifications

To customize your email notifications:

Stop the JP1/DH - Server services by seeing 6.1.2(1) Stopping services for Windows, or 6.2.2(1) Stopping services for Linux.

Select the email template file to be customized in installation-folder#\misc\digikatsuwide\digikatsuwide\WEB-INF\classes\jp\clealink\digivery\notifier\template\ where the email template files for editing are stored.

Edit the message subject or message body in the template file, and then save the file.

Change the configuration of your application by seeing 5.3.2 Changing the application configuration.

Start the JP1/DH - Server services by seeing 6.1.1(1) Starting services for Windows, or 6.2.1(1) Starting services for Linux.

#: In Linux, change installation-folder to /opt/jp1dh/server.

3.7.3 Restoring an email template file

If editing an email template file causes JP1/DH - Server to malfunction, you must return the file back to its original state.

To restore the email template file:

Stop the JP1/DH - Server services by seeing 6.1.2 (1) Stopping services for Windows, or 6.2.2 (1) Stopping services for Linux.

Copy the email template file from the installation-folder#\template\mail_template\ folder where the original files are stored, to the installation-folder#\misc\digikatsuwide\digikatsuwide\WEB-INF\classes\jp\clealink\digivery\notifier\template\ folder, overwriting the template file for editing with the original one.

Change the configuration of your application by seeing 5.3.2 Changing the application configuration.

Start the JP1/DH - Server services by seeing 6.1.1(1) Starting services for Windows, or 6.2.1(1) Starting services for Linux.

#: In Linux, change installation-folder to /opt/jp1dh/server.

3.7.4 Structure and notes on editing of an email template file

This section describes a structure and notes on editing of the email template file.

(1) Structure of the email template file

The email template is a file in XML format. You can only edit the message subject and message body parts in the file.

The structure of the file is as follows:

<?xml version="1.0" encoding="UTF-8"?>
  <notification-template type=type-of-email-template lang=language>
    <headers>
    </headers>
      <contents>
        <subject>
        message-subject
        </subject>
        <body>
        message-body
        </body>
      </contents>
  </notification-template>

(2) Notes on editing

An email template file must be created in XML format.

To represent an element with no content, use the form of <tag-name/>, which combines a start tag and end tag together. You cannot use the form of <tag-name><tag-name/>.

Also, if the content of an element contains any format control character or characters in XML, such as a left angle bracket (<), you must follow the notation as defined in the XML specifications to use such characters. This allows you to represent those characters by using the entity reference or CDATA section.

The following table describes notations of several format control characters of XML if the characters are used as an entity reference in an email template file.

Table 3‒35: Entity-referenced notations of format control characters of XML used in an email template file

No.

Format control character

Notation in the email template file

1

Left angle bracket (<)

&lt;

2

Right angle bracket (>)

&gt;

3

Ampersand (&)

&amp;

4

Double quotation mark (")

&quot;

5

Apostrophe mark (')

&apos;

The message subject and body can contain a placeholder element that consists of particular characters.

If a placeholder element is specified, the system replaces it with a particular value when forming the message subject or message body. Possible placeholder elements vary depending on the type of email notifications. For details about the placeholder element, see the description for each template file.

3.7.5 File delivery notification

This subsection provides information about editing the email template for a file delivery notification.

(1) Target file for edit

The template files for editing the file delivery notification are as follows:

For Japanese: delivery_notification_ja.xml

For English: delivery_notification_en.xml

For Chinese: delivery_notification_zh.xml

(2) Editing the message subject

For the file delivery notification, you can edit the message subjects for when a sender enters the subject of a new transfer, and when not.

The structure of elements for editing the message subject of the file delivery notification is as follows:

...
  <subject>
    <subject-with-user-input>
      <file-delivery-subject>message-subject-for-file-transfer</file-delivery-subject>
      <message-delivery-subject>message-subject-for-sending-messages-only</message-delivery-subject>
    </subject-with-user-input>
    <subject-without-user-input>
      <file-delivery-subject>message-subject-for-file-transfer</file-delivery-subject>
      <message-delivery-subject>message-subject-for-sending-messages-only</message-delivery-subject>
    </subject-without-user-input>
  </subject>
...

The following table describes relevant message subject elements in the file delivery notification.

Table 3‒36: Message subject elements for the file delivery notification

Element

Number of elements

Edit

Omit

Description

subject

1

No

No

Element that indicates the message subject in the file delivery notification.

subject-with-user-input

1

No

No

Element that indicates the message subject if the sender enters the subject for a new transfer.

file-delivery-subject

1

Yes

No

Element that indicates the message subject when a file is sent.

message-delivery-subject

1

Yes

No

Element that indicates the message subject when only a message is sent.

subject-without-user-input

1

No

No

Element that indicates the message subject if the sender does not enter the subject for a new transfer.

file-delivery-subject

1

Yes

No

Element that indicates the message subject when a file is sent.

message-delivery-subject

1

Yes

No

Element that indicates the message subject when only a message is sent.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes placeholder elements available in editing the message subject.

Table 3‒37: Placeholder elements available in editing the message subject

No.

Placeholder element

Description

Possible parent element

1

<system-name-subject/>

Replaced with the following system-name string:

[Data Highway]

file-delivery-subject

message-delivery-subject

2

<user-input-subject/>

Replaced with the subject that the sender entered in the New Delivery window.

subject-with-user-input / file-delivery-subject

subject-with-user-input / message-delivery-subject

(3) Editing the message body

The structure of elements for editing the message body of the file delivery notification is as follows:

...
  <body>
    message-body-in-the-file-delivery-notification
  </body>
...

The following table describes relevant message body elements in the file delivery notification.

Table 3‒38: Message body elements for the file delivery notification

Element

Number of elements

Edit

Omit

Description

body

1

Yes

No

Indicates text in the message body.

In the body of the text, the elements listed in the rows below can be included.

file-delivery-title

1

Yes

Yes

Indicates the predefined subject format text that is included in the message body.

The predefined subject format text introduced by this element is used when sending a file.

If a message is sent without any file, the predefined subject format text introduced by this element is not included in the message body.

message-delivery-title

1

Yes

Yes

Indicates the predefined subject format text that is included in the message body.

The predefined subject format text introduced by this element is used for sending a message without any file.

If a message is sent with a file, the predefined subject format text introduced by this element is not included in the message body.

file-delivery-auto-message

1

Yes

Yes

Indicates predefined message format text that is included in the message body.

The predefined message format text introduced by this element is used for sending a file.

If a message is sent without any file, the predefined message format text introduced by this element is not included in the message body.

message-delivery-auto-message

1

Yes

Yes

Indicates predefined message format text that is included in the message body.

The predefined message format text introduced by this element is used for sending a message without any file.

If a message is sent with a file, the predefined message format text introduced by this element is not included in the message body.

user-id-part

1

Yes

Yes

Used to enclose a string containing the placeholder element <user-id-suffix/>.

For details about the placeholder element, see Table 3-39.

sender-message-part

1

Yes

Yes

Used to enclose a string included in the message body when a sender enters message text in the New Delivery window.

The string enclosed in the elements is not included in the message body if the sender does not enter message text in the New Delivery window.

recipient-check

1

Yes

Yes

Used to specify information included in the message body if a sender does not select the Hide the detailed information of this delivery from the notification. check box on the Extended Options tab in the New Delivery window.

from-part

1

Yes

Yes

Used to enclose a string containing the placeholder element <from />.

For details about the placeholder element, see Table 3-39.

file-part

1

Yes

Yes

Used to enclose a string that is included in the message body only when a file is sent.

The string enclosed in the elements is not included in the message body if only a message is sent.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes placeholder elements available in editing the message body in the file delivery notification.

Table 3‒39: Placeholder elements available in editing the message body in the file delivery notification

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-top/>

Replaced with the following system-name string:

Data Highway

body

2

<to-name/>

Replaced with the name of the recipient.

In Japanese and Chinese: Name of the recipient

In English: Name of the recipient (in English)

body

recipient-check

3

<from-name/>

Replaced with the name of the sender.

In Japanese and Chinese: Name of the sender

In English: Name of the sender (in English)

body

recipient-check

4

<user-id-suffix/>

Replaced with the name of the domain that the recipient belongs to.

user-id-part

5

<sender-message/>

Replaced with the message text that a sender entered in the New Delivery window.

sender-message-part

6

<url/>

Replaced with the download URL for the recipient.

body

7

<check-number/>

Replaced with the following string:

delivery-date-and-time-delivery-ID(recipient-number)

recipient-check

8

<from/>

Replaced with the email address of the sender.

from-part

9

<shelf-life-time/>

Replaced with the storage expiration date.

recipient-check

10

<delivery-files/>

Replaced with a list of delivery files.

file-part

left-margin attribute

Specifies the left margin for a list of delivery files included in the message body by using the number of space characters.

--

11

<delivery-time/>

Replaced with the date and time of the delivery.

recipient-check

12

<system-name-body-bottom/>

Replaced with the following system-name string:

Data Highway

body

3.7.6 File delivery notification (reminder)

This subsection provides information about editing the email template for a file delivery notification (reminder).

(1) Target file for edit

The template files for the file delivery notification (reminder) are as follows:

For Japanese: notification_not_downloaded_ja.xml

For English: notification_not_downloaded_en.xml

For Chinese: notification_not_downloaded_zh.xml

(2) Editing the message subject

For the file delivery notification (reminder), you can edit the message subjects for when a sender enters the subject of a new transfer, and when not.

The structure of elements for editing the message subject of the file delivery notification (reminder) is as follows:

...
  <subject>
    <subject-with-user-input>
      <file-delivery-subject>message-subject-for-file-transfer</file-delivery-subject>
      <message-delivery-subject>message-subject-for-sending-messages-only</message-delivery-subject>
    </subject-with-user-input>
    <subject-without-user-input>
      <file-delivery-subject>message-subject-for-file-transfer</file-delivery-subject>
      <message-delivery-subject>message-subject-for-sending-messages-only</message-delivery-subject>
    </subject-without-user-input>
  </subject>
...

The following table describes relevant message subject elements in the file delivery notification (reminder).

Table 3‒40: Message subject elements for the file delivery notification (reminder)

Element

Number of elements

Edit

Omit

Description

subject

1

No

No

Element that indicates the message subject in the file delivery notification (reminder).

subject-with-user-input

1

No

No

Element that indicates the message subject if the sender enters the subject for a new transfer.

file-delivery-subject

1

Yes

No

Element that indicates the message subject when a file is sent.

message-delivery-subject

1

Yes

No

Element that indicates the message subject when only a message is sent.

subject-without-user-input

1

No

No

Element that indicates the message subject if the sender does not enter the subject for a new transfer.

file-delivery-subject

1

Yes

No

Element that indicates the message subject when a file is sent.

message-delivery-subject

1

Yes

No

Element that indicates the message subject when only a message is sent.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes placeholder elements available in editing the message subject.

Table 3‒41: Placeholder elements available in editing the message subject

No.

Placeholder element

Description

Possible parent element

1

<system-name-subject/>

Replaced with the following system-name string:

[Data Highway]

file-delivery-subject

message-delivery-subject

2

<user-input-subject/>

Replaced with the subject that the sender entered in the New Delivery window.

subject-with-user-input/file-delivery-subject

subject-with-user-input/message-delivery-subject

(3) Editing the message body

The structure of elements for editing the message body of the file delivery notification (reminder) is as follows:

...
  <body>
    message-body-in-the-file-delivery-notification-(reminder)
  </body>
...

The following table describes editable message body elements in the file delivery notification (reminder).

Table 3‒42: Message body elements for the file delivery notification (reminder)

Element

Number of elements

Edit

Omit

Description

body

1

Yes

No

Indicates text in the message body.

In the body of the text, the elements listed in the rows below can be included.

file-delivery-title

1

Yes

Yes

Indicates the predefined subject format text that is included in the message body.

The predefined subject format text introduced by this element is used when sending a file.

If a message is sent without any file, the predefined subject format text introduced by this element is not included in the message body.

message-delivery-title

1

Yes

Yes

Indicates the predefined subject format text that is included in the message body.

The predefined subject format text introduced by this element is used for sending a message without any file.

If a message is sent with a file, the predefined subject format text introduced by this element is not included in the message body.

file-delivery-auto-message

1

Yes

Yes

Indicates predefined message format text that is included in the message body.

The predefined message format text introduced by this element is used for sending a file.

If a message is sent without any file, the predefined message format text introduced by this element is not included in the message body.

message-delivery-auto-message

1

Yes

Yes

Indicates predefined message format text that is included in the message body.

The predefined message format text introduced by this element is used for sending a message without any file.

If a message is sent with a file, the predefined message format text introduced by this element is not included in the message body.

user-id-part

1

Yes

Yes

Used to enclose a string containing the placeholder element <user-id-suffix/>.

For details about the placeholder element, see Table 3-43.

sender-message-part

1

Yes

Yes

Used to enclose a string included in the message body when a sender enters message text in the New Delivery window.

The string enclosed in the elements is not included in the message body if the sender does not enter message text in the New Delivery window.

recipient-check

1

Yes

Yes

Used to specify information included in the message body if a sender does not select the Hide the detailed information of this delivery from the notification. check box on the Extended Options tab in the New Delivery window.

from-part

1

Yes

Yes

Used to enclose a string containing the placeholder element <from/>.

For details about the placeholder element, see Table 3-43.

file-part

1

Yes

Yes

Used to enclose a string that is included in the message body only when a file is sent.

The string enclosed in the elements is not included in the message body if only a message is sent.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes placeholder elements available in editing the message body in the file delivery notification (reminder).

Table 3‒43: Placeholder elements available in editing the message body in the file delivery notification (reminder)

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-top/>

Replaced with the following system-name string:

Data Highway

body

2

<to-name/>

Replaced with the name of the recipient.

In Japanese and Chinese: Name of the recipient

In English: Name of the recipient (in English)

body

recipient-check

3

<from-name/>

Replaced with the name of the sender.

In Japanese and Chinese: Name of the sender

In English: Name of the sender (in English)

body

recipient-check

4

<user-id-suffix/>

Replaced with the name of the domain that the recipient belongs to.

user-id-part

5

<sender-message/>

Replaced with the message text that a sender entered in the New Delivery window.

sender-message-part

6

<url/>

Replaced with the download URL for the recipient.

body

7

<check-number/>

Replaced with the following string:

delivery-date-and-time-delivery-ID(recipient-number)

recipient-check

8

<from/>

Replaced with the email address of the sender.

from-part

9

<shelf-life-time/>

Replaced with the storage expiration date.

recipient-check

10

<delivery-files/>

Replaced with a list of delivery files.

file-part

left-margin attribute

Specifies the left margin for a list of delivery files included in the message body by using the number of space characters.

--

11

<delivery-time/>

Replaced with the date and time of the delivery.

recipient-check

12

<system-name-body-bottom/>

Replaced with the following system-name string:

Data Highway

body

3.7.7 File delivery confirmation

This subsection provides information about editing the email template for a file delivery confirmation.

(1) Target file for edit

The template files for the file delivery confirmation are as follows:

For Japanese: delivery_confirmation_ja.xml

For English: delivery_confirmation_en.xml

For Chinese: delivery_confirmation_zh.xml

(2) Editing the message subject

The structure of elements for editing the message subject of the file delivery confirmation is as follows:

...
  <subject>
    <file-delivery-subject>message-subject-for-file-transfer</file-delivery-subject>
    <message-delivery-subject>message-subject-for-sending-messages-only</message-delivery-subject>
  </subject>
...

The following table describes relevant message subject elements in the file delivery confirmation.

Table 3‒44: Message subject elements for the file delivery confirmation

Element

Number of elements

Edit

Omit

Description

subject

1

No

No

Element that indicates the message subject in the file delivery confirmation.

file-delivery-subject

1

Yes

No

Element that indicates the message subject when a file is sent.

message-delivery-subject

1

Yes

No

Element that indicates the message subject when only a message is sent.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes a placeholder element available in editing the message subject in the file delivery confirmation.

Table 3‒45: Placeholder element available in editing the message subject in the file delivery confirmation

No.

Placeholder element

Description

Possible parent element

1

<system-name-subject/>

Replaced with the following system-name string:

[Data Highway]

subject

(3) Editing the message body

The structure of elements for editing the message body of the file delivery confirmation is as follows:

...
  <body>
    message-body-in-the-file-delivery-confirmation
  </body>
...

The following table describes relevant message body elements in the file delivery confirmation.

Table 3‒46: Message body elements for the file delivery confirmation

Element

Number of elements

Edit

Omit

Description

body

1

Yes

No

Indicates text in the message body.

In the body of the text, the elements listed in the rows below can be included.

file-delivery-title

1

Yes

Yes

Indicates the predefined subject format text that is included in the message body.

The predefined subject format text introduced by this element is used when sending a file.

If a message is sent without any file, the predefined subject format text introduced by this element is not included in the message body.

message-delivery-title

1

Yes

Yes

Indicates the predefined subject format text that is included in the message body.

The predefined subject format text introduced by this element is used for sending a message without any file.

If a message is sent with a file, the predefined subject format text introduced by this element is not included in the message body.

file-delivery-auto-message

1

Yes

Yes

Indicates predefined message format text that is included in the message body.

The predefined message format text introduced by this element is used for sending a file.

If a message is sent without any file, the predefined message format text introduced by this element is not included in the message body.

message-delivery-auto-message

1

Yes

Yes

Indicates predefined message format text that is included in the message body.

The predefined message format text introduced by this element is used for sending a message without any file.

If a message is sent with a file, the predefined message format text introduced by this element is not included in the message body.

recipients

1

Yes

Yes

Element that is used for including a list of recipients in the message body.

If more than one recipient is specified, the system iterates through the element the same number of times as the number of recipients.

Example:

Value: <receipts>Dear Mr./Ms. </receipts>

In the actual message body:

Dear Mr./Ms. recipient-name (1)

Dear Mr./Ms. recipient-name (2)

information

1

Yes

Yes

Used to specify information included in the message body if a sender does not select the Hide the detailed information of this delivery from the notification. check box on the Extended Options tab in the New Delivery window.

from-part

1

Yes

Yes

Used to enclose a string containing the placeholder element <from/>.

For details about the placeholder element, see Table 3-47.

file-part

1

Yes

Yes

Used to enclose a string that is included in the message body only when a file is sent.

The string enclosed in the elements is not included in the message body if only a message is sent.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes placeholder elements available in editing the message body in the file delivery confirmation.

Table 3‒47: Placeholder elements available in editing the message body in the file delivery confirmation

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-top/>

Replaced with the following system-name string:

Data Highway

Body

2

<to-name/>

Replaced with a list of recipient names.

In Japanese and Chinese: Name of the recipient

In English: Name of the recipient (in English)

recipients

left-margin attribute

Specifies the left margin for a list of recipient names included in the message body by using the number of space characters.

--

3

<from-name/>

Replaced with the name of the sender.

In Japanese and Chinese: Name of the sender

In English: Name of the sender (in English)

body

4

<check-number/>

Replaced with the following string:

delivery-date-and-time-delivery-ID(recipient-number)

body

5

<from/>

Replaced with the email address of the sender.

from-part

6

<shelf-life-time/>

Replaced with the storage expiration date.

body

7

<delivery-files/>

Replaced with a list of delivery files.

file-part

left-margin attribute

Specifies the left margin for a list of delivery files included in the message body by using the number of space characters.

--

8

<delivery-time/>

Replaced with the date and time of the delivery.

body

9

<system-name-body-bottom/>

Replaced with the following system-name string:

Data Highway

body

3.7.8 File delivery notification (opened)

This subsection provides information about editing the email template for a file delivery notification (opened).

(1) Target file for edit

The template files for editing the file delivery notification (opened) are as follows:

For Japanese: delivery_opened_notification_ja.xml

For English: delivery_opened_notification_en.xml

For Chinese: delivery_opened_notification_zh.xml

(2) Editing the message subject

The structure of elements for editing the message subject of the file delivery notification (opened) is as follows:

...
  <subject>
    message-subject-in-the-file-delivery-notification-(opened)
  </subject>
...

The following table describes a relevant message subject element in the file delivery notification (opened).

Table 3‒48: Message subject element for the file delivery notification (opened)

Element

Number of elements

Edit

Omit

Description

subject

1

Yes

No

Element that indicates the message subject in the file delivery notification (opened).

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes a placeholder element available in editing the message subject in the file delivery notification (opened).

Table 3‒49: Placeholder element available in editing the message subject in the file delivery notification (opened)

No.

Placeholder element

Description

Possible parent element

1

<system-name-subject/>

Replaced with the following system-name string:

[Data Highway]

subject

(3) Editing the message body

The structure of elements for editing the message body of the file delivery notification (opened) is as follows:

...
  <body>
    message-body-in-the-file-delivery-notification-(opened)
  </body>
...

The following table describes relevant message body elements in the file delivery notification (opened).

Table 3‒50: Message body elements for the file delivery notification (opened)

Element

Number of elements

Edit

Omit

Description

body

1

Yes

No

Indicates text in the message body.

In the body of the text, the elements listed in the rows below can be included.

from-part

1

Yes

Yes

Used to enclose a string containing the placeholder element <from/>.

For details about the placeholder element, see Table 3-51.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes placeholder elements available in editing the message body in the file delivery notification (opened).

Table 3‒51: Placeholder elements available in editing the message body in the file delivery notification (opened)

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-top/>

Replaced with the following system-name string:

Data Highway

body

2

<to-name/>

Replaced with the name of the recipient.

In Japanese and Chinese: Name of the recipient

In English: Name of the recipient (in English)

body

3

<from-name/>

Replaced with the name of the sender.

In Japanese and Chinese: Name of the sender

In English: Name of the sender (in English)

body

4

<check-number/>

Replaced with the following string:

delivery-date-and-time-delivery-ID(recipient-number)

body

5

<shelf-life-time/>

Replaced with the storage expiration date.

body

6

<delivery-files/>

Replaced with a list of delivery files.

body

left-margin attribute

Specifies the left margin for a list of delivery files included in the message body by using the number of space characters.

--

7

<delivery-time/>

Replaced with the date and time of the delivery.

body

8

<system-name-body-bottom/>

Replaced with the following system-name string:

Data Highway

body

3.7.9 File delivery notification (expires soon)

This subsection provides information about editing the email template for a file delivery notification (expires soon).

(1) Target file for edit

The template files for editing the file delivery notification (expires soon) are as follows:

For Japanese: notification_before_expired_ja.xml

For English: notification_before_expired_en.xml

For Chinese: notification_before_expired_zh.xml

(2) Editing the message subject

The structure of elements for editing the message subject of the file delivery notification (expires soon) is as follows:

...
  <subject>
    message-subject-in-the-file-delivery-notification-(expires-soon)
  </subject>
...

The following table describes a relevant message subject element in the file delivery notification (expires soon).

Table 3‒52: Message subject element for the file delivery notification (expires soon)

Element

Number of elements

Edit

Omit

Description

subject

1

Yes

No

Element that indicates the message subject in the file delivery notification (expires soon).

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes a placeholder element available in editing the message subject in the file delivery notification (expires soon).

Table 3‒53: Placeholder element available in editing the message subject in the file delivery notification (expires soon)

No.

Placeholder element

Description

Possible parent element

1

<system-name-subject/>

Replaced with the following system-name string:

[Data Highway]

subject

(3) Editing the message body

The structure of elements for editing the message body of the file delivery notification (expires soon) is as follows:

...
  <body>
    message-body-in-the-file-delivery-notification-(expires-soon)
  </body>
...

The following table describes relevant message body elements in the file delivery notification (expires soon).

Table 3‒54: Message body elements for the file delivery notification (expires soon)

Element

Number of elements

Edit

Omit

Description

body

1

Yes

No

Indicates text in the message body.

In the body of the text, the elements listed in the rows below can be included.

for-recipient-checks

1

Yes

Yes

Used to specify information included in the message body if a sender does not select the Hide the detailed information of this delivery from the notification. check box on the Extended Options tab in the New Delivery window.

If more than one recipient is specified, the system iterates through the element the same number of times as the number of recipients.

Example:

Value:

<for-recipient-checks>

----------

Dear Mr./Ms. <to-name/>

----------

</ for-recipient-checks >

In the actual message body:

----------

Dear Mr./Ms. recipient-1

----------

----------

Dear Mr./Ms. recipient-2

----------

----------

Dear Mr./Ms. recipient-3

----------

from-part

1

Yes

Yes

Used to enclose a string containing the placeholder element <from/>.

For details about the placeholder element, see Table 3-55.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes placeholder elements available in editing the message body in the file delivery notification (expires soon).

Table 3‒55: Placeholder elements available in editing the message body in the file delivery notification (expires soon)

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-top/>

Replaced with the following system-name string:

Data Highway

body

2

<to-name/>

Replaced with the name of the recipient.

In Japanese and Chinese: Name of the recipient

In English: Name of the recipient (in English)

for-recipient-checks

3

<from-name/>

Replaced with a list of sender names.

In Japanese and Chinese: Name of the sender

In English: Name of the sender (in English)

body

for-recipient-checks

4

<check-number/>

Replaced with the following string:

delivery-date-and-time-delivery-ID(recipient-number)

for-recipient-checks

5

<from/>

Replaced with the email address of the sender.

from-part

6

<shelf-life-time/>

Replaced with the storage expiration date.

for-recipient-checks

7

<delivery-files/>

Replaced with a list of delivery files.

for-recipient-checks

8

<delivery-time/>

Replaced with the date and time of the delivery.

for-recipient-checks

9

<system-name-body-bottom/>

Replaced with the following system-name string:

Data Highway

body

3.7.10 File delivery notification (expired)

This subsection provides information about editing the email template for a file delivery notification (expired).

(1) Target file for edit

The template files for editing the file delivery notification (expired) are as follows:

For Japanese: notification_after_expired_ja.xml

For English: notification_after_expired_en.xml

For Chinese: notification_after_expired_zh.xml

(2) Editing the message subject

The structure of elements for editing the message subject of the file delivery notification (expired) is as follows:

...
  <subject>
    message-subject-in-the-file-delivery-notification-(expired)
  </subject>
...

The following table describes a relevant message subject element in the file delivery notification (expired).

Table 3‒56: Message subject element for the file delivery notification (expired)

Element

Number of elements

Edit

Omit

Description

subject

1

Yes

No

Element that indicates the message subject in the file delivery notification (expired).

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes a placeholder element available in editing the message subject in the file delivery notification (expired).

Table 3‒57: Placeholder element available in editing the message subject in the file delivery notification (expired)

No.

Placeholder element

Description

Possible parent element

1

<system-name-subject/>

Replaced with the following system-name string:

[Data Highway]

subject

(3) Editing the message body

The structure of elements for editing the message body of the file delivery notification (expired) is as follows:

...
  <body>
    message-body-in-the-file-delivery-notification-(expired)
  </body>
...

The following table describes relevant message body elements in the file delivery notification (expired).

Table 3‒58: Message body elements for the file delivery notification (expired)

Element

Number of elements

Edit

Omit

Description

body

1

Yes

No

Indicates text in the message body.

In the body of the text, the elements listed in the rows below can be included.

for-recipient-checks

1

Yes

Yes

Used to specify information included in the message body if a sender does not select the Hide the detailed information of this delivery from the notification. check box on the Extended Options tab in the New Delivery window.

If more than one recipient is specified, the system iterates through the element the same number of times as the number of recipients.

Example:

Value:

<for-recipient-checks>

----------

Dear Mr./Ms. <to-name/>

----------

</ for-recipient-checks >

In the actual message body:

----------

Dear Mr./Ms. recipient-1

----------

----------

Dear Mr./Ms. recipient-2

----------

----------

Dear Mr./Ms. recipient-3

----------

from-part

1

Yes

Yes

Used to enclose a string containing the placeholder element <from/>.

For details about the placeholder element, see Table 3-59.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes placeholder elements available in editing the message body in the file delivery notification (expired).

Table 3‒59: Placeholder elements available in editing the message body in the file delivery notification (expired)

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-top/>

Replaced with the following system-name string:

Data Highway

body

2

<to-name/>

Replaced with the name of the recipient.

In Japanese and Chinese: Name of the recipient

In English: Name of the recipient (in English)

for-recipient-checks

left-margin attribute

Specifies the left margin for a list of recipient names included in the message body by using the number of space characters.

--

3

<from-name/>

Replaced with the name of the sender.

In Japanese and Chinese: Name of the sender

In English: Name of the sender (in English)

body

for-recipient-checks

4

<check-number/>

Replaced with the following string:

delivery-date-and-time-delivery-ID(recipient-number)

for-recipient-checks

5

<from/>

Replaced with the email address of the sender.

from-part

6

<shelf-life-time/>

Replaced with the storage expiration date.

for-recipient-checks

7

<delivery-files/>

Replaced with a list of delivery files.

for-recipient-checks

8

<delivery-time/>

Replaced with the date and time of the delivery.

for-recipient-checks

9

<system-name-body-bottom/>

Replaced with the following system-name string:

Data Highway

body

3.7.11 Approval request notification

This subsection provides information about editing the email template for an approval request notification.

(1) Target file for edit

The template files for editing the approval request notification are as follows:

For Japanese: delivery_approval_notification_ja.xml

For English: delivery_approval_notification_en.xml

For Chinese: delivery_approval_notification_zh.xml

(2) Editing the message subject

The structure of elements for editing the message subject of the approval request notification is as follows:

...
  <subject>
    message-subject-in-the-approval-request-notification
  </subject>
...

The following table describes a relevant message subject element in the approval request notification.

Table 3‒60: Message subject element for the approval request notification

Element

Number of elements

Edit

Omit

Description

subject

1

Yes

No

Element that indicates the message subject in the approval request notification.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes a placeholder element available in editing the message subject in the approval request notification.

Table 3‒61: Placeholder element available in editing the message subject in the approval request notification

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-subject/>

Replaced with the following system-name string:

[Data Highway]

subject

(3) Editing the message body

The structure of elements for editing the message body of the approval request notification is as follows:

...
  <body>
    message-body-in-the-approval-request-notification
  </body>
...

The following table describes relevant message body elements in the approval request notification.

Table 3‒62: Message body elements for the approval request notification

Element

Number of elements

Edit

Omit

Description

body

1

Yes

No

Indicates text in the message body.

In the body of the text, the elements listed in the rows below can be included.

recipient-check

1

Yes

Yes

Used to specify information included in the message body if a sender does not select the Hide the detailed information of this delivery from the notification. check box on the Extended Options tab in the New Delivery window.

recipients

1

Yes

Yes

Used to include information on the recipient in the message body.

If more than one recipient is specified, the system iterates through the element the same number of times as the number of recipients.

Example:

Value: <receipts>Dear Mr./Ms. </receipts>

In the actual message body:

Dear Mr./Ms. recipient-name (1)

Dear Mr./Ms. recipient-name (2)

information

1

Yes

Yes

Used to specify information included in the message body if a sender does not select the Hide the detailed information of this delivery from the notification. check box on the Extended Options tab in the New Delivery window.

from-part

1

Yes

Yes

Used to enclose a string containing the placeholder element <from/>.

For details about the placeholder element, see Table 3-63.

file-part

1

Yes

Yes

Used to enclose a string that is included in the message body only when a file is sent.

The string enclosed in the elements is not included in the message body if only a message is sent.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes placeholder elements available in editing the message body in the approval request notification.

Table 3‒63: Placeholder elements available in editing the message body in the approval request notification

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-top/>

Replaced with the following system-name string:

Data Highway

body

2

<to-name/>

Replaced with the name of the approver.

In Japanese and Chinese: Name of the approver

In English: Name of the approver (in English)

body

Replaced with a list of recipient names.

In Japanese and Chinese: Name of the recipient

In English: Name of the recipient (in English)

body/recipient-check/recipients

left-margin attribute

Specifies the left margin for a list of recipient names included in the message body by using the number of space characters.

body/recipient-check/recipients/to-name

3

<from-name/>

Replaced with the name of the sender.

In Japanese and Chinese: Name of the sender

In English: Name of the sender (in English)

body

information

4

<user-id-suffix/>

Replaced with the name of the domain that the recipient belongs to.

body

5

<url/>

Replaced with the download URL for the recipient.

body

6

<check-number/>

Replaced with the following string:

delivery-date-and-time-delivery-ID(recipient-number)

recipient-check

7

<from/>

Replaced with the email address of the sender.

from-part

8

<shelf-life-time/>

Replaced with the storage expiration date.

information

9

<delivery-files/>

Replaced with a list of delivery files.

information

left-margin attribute

Specifies the left margin for a list of delivery files included in the message body by using the number of space characters.

--

10

<delivery-time/>

Replaced with the date and time of the delivery.

recipient-check

11

<system-name-body-bottom/>

Replaced with the following system-name string:

Data Highway

body

3.7.12 Approval request notification (reminder)

This subsection provides information about editing the email template for an approval request notification (reminder).

(1) Target file for edit

The template files for editing the approval request notification (reminder) are as follows:

For Japanese:notification_not_approved_ja.xml

For English: notification_not_approved_en.xml

For Chinese: notification_not_approved_zh.xml

(2) Editing the message subject

The structure of elements for editing the message subject of the approval request notification (reminder) is as follows:

...
  <subject>
    message-subject-in-the-approval-request-notification-(reminder)
  </subject>
...

The following table describes a relevant message subject element in the approval request notification (reminder).

Table 3‒64: Message subject element for the approval request notification (reminder)

Element

Number of elements

Edit

Omit

Description

subject

1

Yes

No

Element that indicates the message subject in the approval request notification (reminder).

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes a placeholder element relevant in editing the message subject in the approval request notification (reminder).

Table 3‒65: Placeholder element available in editing the message subject in the approval request notification (reminder)

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-subject/>

Replaced with the following system-name string:

[Data Highway]

subject

(3) Editing the message body

The structure of elements for editing the message body of the approval request notification (reminder) is as follows:

...
  <body>
    message-body-in-the-approval-request-notification-(reminder)
  </body>
...

The following table describes editable message body elements in the approval request notification (reminder).

Table 3‒66: Message body elements for the approval request notification (reminder)

Element

Number of elements

Edit

Omit

Description

body

1

Yes

No

Indicates text in the message body.

In the body of the text, the elements listed in the rows below can be included.

recipient-check

1

Yes

Yes

Used to specify information included in the message body if a sender does not select the Hide the detailed information of this delivery from the notification. check box on the Extended Options tab in the New Delivery window.

recipients

1

Yes

Yes

Used to include a list of recipients in the message body.

If more than one recipient is specified, the system iterates through the element the same number of times as the number of recipients.

Example:

Value: <receipts>Dear Mr./Ms. </receipts>

In the actual message body:

Dear Mr./Ms. recipient-name (1)

Dear Mr./Ms. recipient-name (2)

information

1

Yes

Yes

Used to specify information included in the message body if a sender does not select the Hide the detailed information of this delivery from the notification. check box on the Extended Options tab in the New Delivery window.

from-part

1

Yes

Yes

Used to enclose a string containing the placeholder element <from/>.

For details about the placeholder element, see Table 3-67.

file-part

1

Yes

Yes

Used to enclose a string that is included in the message body only when a file is sent.

The string enclosed in the elements is not included in the message body if only a message is sent.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes placeholder elements available in editing the message body in the approval request notification (reminder).

Table 3‒67: Placeholder elements available in editing the message body in the approval request notification (reminder)

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-top/>

Replaced with the following system-name string:

Data Highway

body

2

<to-name/>

Replaced with the name of the approver.

In Japanese and Chinese: Name of the approver

In English: Name of the approver (in English)

body

Replaced with a list of recipient names.

In Japanese and Chinese: Name of the recipient

In English: Name of the recipient (in English)

body/recipient-check/recipients

left-margin attribute

Specifies the left margin for a list of recipient names included in the message body by using the number of space characters.

body/recipient-check/recipients/to-name

3

<from-name/>

Replaced with the name of the sender.

In Japanese and Chinese: Name of the sender

In English: Name of the sender (in English)

body

information

4

<user-id-suffix/>

Replaced with the name of the domain that the recipient belongs to.

body

5

<url/>

Replaced with the download URL for the recipient.

body

6

<check-number/>

Replaced with the following string:

delivery-date-and-time-delivery-ID(recipient-number)

recipient-check

7

<from/>

Replaced with the email address of the sender.

from-part

8

<shelf-life-time/>

Replaced with the storage expiration date.

information

9

<delivery-files/>

Replaced with a list of delivery files.

information

left-margin attribute

Specifies the left margin for a list of delivery files included in the message body by using the number of space characters.

--

10

<delivery-time/>

Replaced with the date and time of the delivery.

recipient-check

11

<system-name-body-bottom/>

Replaced with the following system-name string:

Data Highway

body

3.7.13 Approved-delivery notification (The notification to the sender)

For sending a delivery approval notification to the sender, provides information about editing the email template for an approved-delivery notification in this section.

(1) Target file for edit

The template files for editing the approved-delivery notification are as follows:

For Japanese: delivery_accepted_confirmation_ja.xml

For English: delivery_accepted_confirmation_en.xml

For Chinese: delivery_accepted_confirmation_zh.xml

(2) Editing the message subject

The structure of elements for editing the message subject of the approved-delivery notification is as follows:

...
  <subject>
    message-subject-in-the-approved-delivery-notification
  </subject>
...

The following table describes a relevant message subject element in the approved-delivery notification.

Table 3‒68: Message subject element for the approved-delivery notification (The notification to the sender)

Element

Number of elements

Edit

Omit

Description

subject

1

Yes

No

Element that indicates the message subject in the approved-delivery notification.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes a placeholder element available in editing the message subject in the approved-delivery notification.

Table 3‒69: Placeholder element available in editing the message subject in the approved-delivery notification (The notification to the sender)

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-subject/>

Replaced with the following system-name string:

[Data Highway]

subject

(3) Editing the message body

The structure of elements for editing the message body of the approved-delivery notification is as follows:

...
  <body>
    message-body-in-the-approved-delivery-notification
  </body>
...

The following table describes editable message body elements in the approved-delivery notification.

Table 3‒70: Message body elements for the approved-delivery notification (The notification to the sender)

Element

Number of elements

Edit

Omit

Description

body

1

Yes

No

Indicates text in the message body.

In the body of the text, the elements listed in the rows below can be included.

approval-message

1

Yes

Yes

Indicates the predefined subject format text that is included in the message body.

The predefined subject format text introduced by this element is used when sending a file.

If a message is sent without any file, the predefined subject format text introduced by this element is not included in the message body.

recipients

1

Yes

Yes

Element that is used for including a list of recipients in the message body.

If more than one recipient is specified, the system iterates through the element the same number of times as the number of recipients.

Example:

Value: <receipts>Dear Mr./Ms. </receipts>

In the actual message body:

Dear Mr./Ms. recipient-name (1)

Dear Mr./Ms. recipient-name (2)

information

1

Yes

Yes

Used to specify information included in the message body if a sender does not select the Hide the detailed information of this delivery from the notification. check box on the Extended Options tab in the New Delivery window.

from-part

1

Yes

Yes

Used to enclose a string containing the placeholder element <from/>.

For details about the placeholder element, see Table 3-71.

file-part

1

Yes

Yes

Used to enclose a string that is included in the message body only when a file is sent.

The string enclosed in the elements is not included in the message body if only a message is sent.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes placeholder elements available in editing the message body in the approved-delivery notification.

Table 3‒71: Placeholder elements available in editing the message body in the approved-delivery notification (The notification to the sender)

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-top/>

Replaced with the following system-name string:

Data Highway

Body

2

<to-name/>

Replaced with a list of recipient names.

In Japanese and Chinese: Name of the recipient

In English: Name of the recipient (in English)

recipients

left-margin attribute

Specifies the left margin for a list of recipient names included in the message body by using the number of space characters.

--

3

<from-name/>

Replaced with the name of the sender.

In Japanese and Chinese: Name of the sender

In English: Name of the sender (in English)

body

4

<approver-name/>

Replaced with the name of the approver.

body

5

<approval-message-content/>

Replaced with the message text that an approver entered in the Application for Approval window when accepting an approval request.

approval-message

6

<check-number/>

Replaced with the following string:

delivery-date-and-time-delivery-ID(recipient-number)

body

7

<from/>

Replaced with the email address of the sender.

from-part

8

<shelf-life-time/>

Replaced with the storage expiration date.

body

9

<delivery-files/>

Replaced with a list of delivery files.

body

left-margin attribute

Specifies the left margin for a list of delivery files included in the message body by using the number of space characters.

--

10

<delivery-time/>

Replaced with the date and time of the delivery.

body

11

<system-name-body-bottom/>

Replaced with the following system-name string:

Data Highway

body

3.7.14 Approved-delivery notification (Notify all the sender and approver)

For sending a delivery approval notification to all the sender and approver, provides information about editing the email template for an approved-delivery notification in this section.

(1) Target file for edit

The template files for editing the approved-delivery notification are as follows:

For Japanese: delivery_acctepted_confirmation_for_approvers_ja.xml

For English: delivery_acctepted_confirmation_for_approvers_en.xml

For Chinese: delivery_acctepted_confirmation_for_approvers_zh.xml

(2) Editing the message subject

The structure of elements for editing the message subject of the approved-delivery notification is as follows:

...
  <subject>
    message-subject-in-the-approved-delivery-notification
  </subject>
...

The following table describes a relevant message subject element in the approved-delivery notification.

Table 3‒72: Message subject element for the approved-delivery notification (Notify all the sender and approver)

Element

Number of elements

Edit

Omit

Description

subject

1

Yes

No

Element that indicates the message subject in the approved-delivery notification.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes a placeholder element available in editing the message subject in the approved-delivery notification.

Table 3‒73: Placeholder element available in editing the message subject in the approved-delivery notification (Notify all the sender and approver)

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-subject/>

Replaced with the following system-name string:

[Data Highway]

subject

(3) Editing the message body

The structure of elements for editing the message body of the approved-delivery notification is as follows:

...
  <body>
    message-body-in-the-approved-delivery-notification
  </body>
...

The following table describes editable message body elements in the approved-delivery notification.

Table 3‒74: Message body elements for the approved-delivery notification (Notify all the sender and approver)

Element

Number of elements

Edit

Omit

Description

body

1

Yes

No

Indicates text in the message body.

In the body of the text, the elements listed in the rows below can be included.

approval-message

1

Yes

Yes

Indicates the predefined subject format text that is included in the message body.

The predefined subject format text introduced by this element is used when sending a file.

If a message is sent without any file, the predefined subject format text introduced by this element is not included in the message body.

recipients

1

Yes

Yes

Element that is used for including a list of recipients in the message body.

If more than one recipient is specified, the system iterates through the element the same number of times as the number of recipients.

Example:

Value: <receipts>Dear Mr./Ms. </receipts>

In the actual message body:

Dear Mr./Ms. recipient-name (1)

Dear Mr./Ms. recipient-name (2)

information

1

Yes

Yes

Used to specify information included in the message body if a sender does not select the Hide the detailed information of this delivery from the notification. check box on the Extended Options tab in the New Delivery window.

from-part

1

Yes

Yes

Used to enclose a string containing the placeholder element <from/>.

For details about the placeholder element, see Table 3-75.

file-part

1

Yes

Yes

Used to enclose a string that is included in the message body only when a file is sent.

The string enclosed in the elements is not included in the message body if only a message is sent.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes placeholder elements available in editing the message body in the approved-delivery notification.

Table 3‒75: Placeholder elements available in editing the message body in the approved-delivery notification (Notify all the sender and approver)

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-top/>

Replaced with the following system-name string:

Data Highway

Body

2

<to-name/>

Replaced with a list of recipient names.

In Japanese and Chinese: Name of the recipient

In English: Name of the recipient (in English)

recipients

left-margin attribute

Specifies the left margin for a list of recipient names included in the message body by using the number of space characters.

--

3

<to-name/>

Replaced with the name of all the sender and approver.

In Japanese and Chinese: Name of all the sender and approver

In English: Name of all the sender and approver (in English)

body

4

<approver-name/>

Replaced with the name of the approver.

body

5

<approval-message-content/>

Replaced with the message text that an approver entered in the Application for Approval window when accepting an approval request.

approval-message

6

<check-number/>

Replaced with the following string:

delivery-date-and-time-delivery-ID(recipient-number)

body

7

<from/>

Replaced with the email address of the sender.

from-part

8

<shelf-life-time/>

Replaced with the storage expiration date.

body

9

<delivery-files/>

Replaced with a list of delivery files.

body

left-margin attribute

Specifies the left margin for a list of delivery files included in the message body by using the number of space characters.

--

10

<delivery-time/>

Replaced with the date and time of the delivery.

body

11

<system-name-body-bottom/>

Replaced with the following system-name string:

Data Highway

body

3.7.15 Rejected-delivery notification (The notification to the sender)

For sending a delivery approval notification to the sender, provides information about editing the email template for a rejected-delivery notification in this section.

(1) Target file for edit

The template files for editing the rejected-delivery notification are as follows:

For Japanese: delivery_rejected_confirmation_ja.xml

For English: delivery_rejected_confirmation_en.xml

For Chinese: delivery_rejected_confirmation_zh.xml

(2) Editing the message subject

The structure of elements for editing the message subject of the rejected-delivery notification is as follows:

...
  <subject>
    message-subject-in-the-rejected-delivery-notification
  </subject>
...

The following table describes an editable message subject element in the rejected-delivery notification.

Table 3‒76: Message subject element for the rejected-delivery notification (The notification to the sender)

Element

Number of elements

Edit

Omit

Description

subject

1

Yes

No

Element that indicates the message subject in the rejected-delivery notification.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes a placeholder element available in editing the message subject in the rejected-delivery notification.

Table 3‒77: Placeholder element available in editing the message subject in the rejected-delivery notification (The notification to the sender)

No.

Placeholder element

Description

Possible parent element

1

<system-name-subject/>

Replaced with the following system-name string:

[Data Highway]

subject

(3) Editing the message body

The structure of elements for editing the message body of the rejected-delivery notification is as follows:

...
  <body>
    message-body-in-the-rejected-delivery-notification
  </body>
...

The following table describes editable message body elements in the rejected-delivery notification.

Table 3‒78: Message body elements for the rejected-delivery notification (The notification to the sender)

Element

Number of elements

Edit

Omit

Description

body

1

Yes

No

Indicates text in the message body.

In the body of the text, the elements listed in the rows below can be included.

approval-message

1

Yes

Yes

Indicates the predefined subject format text that is included in the message body.

The predefined subject format text introduced by this element is used when sending a file.

If a message is sent without any file, the predefined subject format text introduced by this element is not included in the message body.

recipients

1

Yes

Yes

Element that is used for including a list of recipients in the message body.

If more than one recipient is specified, the system iterates through the element the same number of times as the number of recipients.

Example:

Value: <receipts>Dear Mr./Ms. </receipts>

In the actual message body:

Dear Mr./Ms. recipient-name (1)

Dear Mr./Ms. recipient-name (2)

information

1

Yes

Yes

Used to specify information included in the message body if a sender does not select the Hide the detailed information of this delivery from the notification. check box on the Extended Options tab in the New Delivery window.

from-part

1

Yes

Yes

Used to enclose a string containing the placeholder element <from/>.

For details about the placeholder element, see Table 3-79.

file-part

1

Yes

Yes

Used to enclose a string that is included in the message body only when a file is sent.

The string enclosed in the elements is not included in the message body if only a message is sent.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes placeholder elements available in editing the message body in the rejected-delivery notification.

Table 3‒79: Placeholder elements available in editing the message body in the rejected-delivery notification (The notification to the sender)

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-top/>

Replaced with the following system-name string:

Data Highway

body

2

<to-name/>

Replaced with a list of recipient names.

In Japanese and Chinese: Name of the recipient

In English: Name of the recipient (in English)

recipients

left-margin attribute

Specifies the left margin for a list of recipient names included in the message body by using the number of space characters.

--

3

<from-name/>

Replaced with the name of the sender.

In Japanese and Chinese: Name of the sender

In English: Name of the sender (in English)

body

4

<approver-name/>

Replaced with the name of the approver.

body

5

<approval-message-content/>

Replaced with the message text that an approver entered in the Application for Approval window when rejecting an approval request.

approval-message

6

<check-number/>

Replaced with the following string:

delivery-date-and-time-delivery-ID(recipient-number)

body

7

<from/>

Replaced with the email address of the sender.

from-part

8

<shelf-life-time/>

Replaced with the storage expiration date.

body

9

<delivery-files/>

Replaced with a list of delivery files.

body

left-margin attribute

Specifies the left margin for a list of delivery files included in the message body by using the number of space characters.

--

10

<system-name-body-bottom/>

Replaced with the following system-name string:

Data Highway

body

3.7.16 Rejected-delivery notification (Notify all the sender and approver)

For sending a delivery approval notification to all the sender and approver, provides information about editing the email template for a rejected-delivery notification in this section.

(1) Target file for edit

The template files for editing the rejected-delivery notification are as follows:

For Japanese: delivery_rejected_confirmation_for_approvers_ja.xml

For English: delivery_rejected_confirmation_for_approvers_en.xml

For Chinese: delivery_rejected_confirmation_for_approvers_zh.xml

(2) Editing the message subject

The structure of elements for editing the message subject of the rejected-delivery notification is as follows:

...
  <subject>
    message-subject-in-the-rejected-delivery-notification
  </subject>
...

The following table describes an editable message subject element in the rejected-delivery notification.

Table 3‒80: Message subject element for the rejected-delivery notification (Notify all the sender and approver)

Element

Number of elements

Edit

Omit

Description

subject

1

Yes

No

Element that indicates the message subject in the rejected-delivery notification.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes a placeholder element available in editing the message subject in the rejected-delivery notification.

Table 3‒81: Placeholder element available in editing the message subject in the rejected-delivery notification (Notify all the sender and approver)

No.

Placeholder element

Description

Possible parent element

1

<system-name-subject/>

Replaced with the following system-name string:

[Data Highway]

subject

(3) Editing the message body

The structure of elements for editing the message body of the rejected-delivery notification is as follows:

...
  <body>
    message-body-in-the-rejected-delivery-notification
  </body>
...

The following table describes editable message body elements in the rejected-delivery notification.

Table 3‒82: Message body elements for the rejected-delivery notification (Notify all the sender and approver)

Element

Number of elements

Edit

Omit

Description

body

1

Yes

No

Indicates text in the message body.

In the body of the text, the elements listed in the rows below can be included.

approval-message

1

Yes

Yes

Indicates the predefined subject format text that is included in the message body.

The predefined subject format text introduced by this element is used when sending a file.

If a message is sent without any file, the predefined subject format text introduced by this element is not included in the message body.

recipients

1

Yes

Yes

Element that is used for including a list of recipients in the message body.

If more than one recipient is specified, the system iterates through the element the same number of times as the number of recipients.

Example:

Value: <receipts>Dear Mr./Ms. </receipts>

In the actual message body:

Dear Mr./Ms. recipient-name (1)

Dear Mr./Ms. recipient-name (2)

information

1

Yes

Yes

Used to specify information included in the message body if a sender does not select the Hide the detailed information of this delivery from the notification. check box on the Extended Options tab in the New Delivery window.

from-part

1

Yes

Yes

Used to enclose a string containing the placeholder element <from/>.

For details about the placeholder element, see Table 3-83.

file-part

1

Yes

Yes

Used to enclose a string that is included in the message body only when a file is sent.

The string enclosed in the elements is not included in the message body if only a message is sent.

Legend:

Yes: You can edit or omit the element.

No: You cannot edit or omit the element.

The following table describes placeholder elements available in editing the message body in the rejected-delivery notification.

Table 3‒83: Placeholder elements available in editing the message body in the rejected-delivery notification (Notify all the sender and approver)

No.

Placeholder element

Description

Possible parent element

1

<system-name-body-top/>

Replaced with the following system-name string:

Data Highway

body

2

<to-name/>

Replaced with a list of recipient names.

In Japanese and Chinese: Name of the recipient

In English: Name of the recipient (in English)

recipients

left-margin attribute

Specifies the left margin for a list of recipient names included in the message body by using the number of space characters.

--

3

<to-name/>

Replaced with the name of all the sender and approver.

In Japanese and Chinese: Name of all the sender and approver

In English: Name of all the sender and approver (in English)

body

4

<approver-name/>

Replaced with the name of the approver.

body

5

<approval-message-content/>

Replaced with the message text that an approver entered in the Application for Approval window when rejecting an approval request.

approval-message

6

<check-number/>

Replaced with the following string:

delivery-date-and-time-delivery-ID(recipient-number)

body

7

<from/>

Replaced with the email address of the sender.

from-part

8

<shelf-life-time/>

Replaced with the storage expiration date.

body

9

<delivery-files/>

Replaced with a list of delivery files.

body

left-margin attribute

Specifies the left margin for a list of delivery files included in the message body by using the number of space characters.

--

10

<system-name-body-bottom/>

Replaced with the following system-name string:

Data Highway

body

4 Before Installation

This chapter describes the points you need to check before installing JP1/DH - Server.

4.1 Notes on installation

This section describes the notes on installation.

4.1.1 Common notes

In Windows Server 2012, Windows Server 2012 R2 or Windows Server 2016, to use the command prompt with elevated privileges installed together with JP1/DH - Server, you need to install Microsoft .NET Framework 3.5. For details about how to install Microsoft .NET Framework 3.5, see D. Installing .NET Framework 3.5.

If a file or folder named Program exists directly under the system drive, a program does not run properly. If a file or folder named Program exists there, delete it before installing JP1/DH - Server.

In Red Hat Enterprise Linux 6, make sure that the host name and IP address of the local host are registered in the /etc/hosts file. If they are not registered, the local host name cannot be resolved and the installation fails. Edit the /etc/hosts file to register the host name and IP address of the local host.

4.1.2 Notes on new installation

You cannot install JP1/DH - Server in an environment in which PostgreSQL is already installed. Uninstall PostgreSQL first, and then install JP1/DH - Server.

You cannot install JP1/DH - Server in an environment in which the postgres user exists. Delete the postgres user, and then install JP1/DH - Server.

In Linux, also delete the home directory of the postgres user. Before deleting the home directory, check the contents in it and save the necessary files, if any.

To install JP1/DH - Server again after uninstalling it, either delete the installation folder or empty the folder before re-installation.

4.1.3 Notes on overwrite installation and upgrade installation

In a Windows OS, when you perform an overwrite or upgrade installation of JP1/DH - Server, JP1/DH - Server resets the password for the database service user to p@ssw0rd.

For this reason, if you have changed the password for the postgres user registered in the OS (database service user) or you have changed the password for the database by using the dbchangepassword.bat command, specify the passwords again after the installation as needed.

4.2 Functions provided by the installer

This section describes the functions provided by the installer for JP1/DH - Server.

4.2.1 New installation

You can newly install JP1/DH - Server.

Note that you need to edit the configuration file and change the application configuration after completing the installation.

4.2.2 Overwrite installation and upgrade installation

In any of the following cases, you can install JP1/DH - Server by overwrite installation or upgrade installation:

When you install the same version of JP1/DH - Server by overwriting existing JP1/DH - Server

When you upgrade the existing JP1/DH - Server to the newer version

When you upgrade the existing JP1/DH - Server to the newer version, if the path to the storage folder for delivery data exceeds 70 characters in length, change the folder to a different one with a name of 70 characters or shorter before the setup.

4.2.3 Uninstallation

You can uninstall JP1/DH - Server.

When you re-install JP1/DH - Server after uninstalling it, perform the following operations to prevent unexpected problems:

Delete all the folders and files under the installation folder.

Before re-installing JP1/DH - Sever, restart the machine.

5 Installation and Setup

This chapter describes how to install and set up JP1/DH - Server.

5.1 Installation for Windows

This section describes how to install JP1/DH - Server on a Windows OS.

In Windows Server 2012, Windows Server 2012 R2 or Windows Server 2016, to use the command prompt with elevated privileges installed together with JP1/DH - Server, you need to install Microsoft .NET Framework 3.5. For details about how to install Microsoft .NET Framework 3.5, see D. Installing .NET Framework 3.5.

5.1.1 New installation (in Windows)

To newly install JP1/DH - Server:

Log in to the machine on which you want to newly install JP1/DH - Server as a built-in Administrator user.

Exit all the Windows programs. (Recommended)

Start Hitachi Integrated Installer.

Insert the Hitachi Integrated Installer medium (CD-ROM) including JP1/DH - Server in the drive, and then start Hitachi Integrated Installer.

Start the JP1/DH - Server installer.

In Hitachi Integrated Installer, select JP1/Data Highway - Server, and then click the Install button. The Welcome to JP1/DH - Server Setup window appears.

Click the Next button. The User Information window appears.

Enter user information.

Enter values for User name and Company name.

User name

Specify a user name using no more than 50 characters. Any character can be specified. The user name registered in the system is displayed by default.

Company name

Specify a company name using no more than 80 characters. Any character can be specified. The company name registered in the system is displayed by default.

Click the Next button. The Installation Folder window appears.

Specify the installation folder.

To change the installation location, in the dialog box displayed by clicking the Change... button, select the installation folder#.

#

A maximum of 44 characters can be specified for the length of the path of the installation folder. You cannot specify a folder whose name contains a single-byte hash mark (#) or double-byte characters. Do not install JP1/DH - Server under the root of the system drive or under the system folder.

Click the Next button. The Ready to Install window appears.

Before starting installation, check the entered data.

In the Ready to Install window, make sure that the entered information is correct.

Start a new installation of JP1/DH - Server.

In the Ready to Install window, click the Install button. The installation of JP1/DH - Server starts.

Finish the new installation of JP1/DH - Server.

When the installation is completed, the InstallShield Wizard Complete window appears. Click the Finish button to finish the new installation of JP1/DH - Server.

Exit Hitachi Integrated Installer.

Click the Finish button to exit Hitachi Integrated Installer.

Important

After the new installation of JP1/DH - Server is completed, set up the JP1/DH - Server environment. For details about how to set up the environment, see 5.3 Setting up the JP1/DH Web application server environment.

If the installation ends due to an error, the status of the location to which JP1/DH - Server is installed is invalid. In this case, eliminate the cause of that error, start the installer again, make sure that the installer ends normally, and then complete the installation.

5.1.2 Overwrite installation (in Windows)

To perform an overwrite installation of JP1/DH - Server:

Log in to the machine in which you want to perform an overwrite installation of JP1/DH - Server as a built-in Administrator user.

Exit all the Windows programs.

If another application is using a file that is part of JP1/DH - Server, the File in Use dialog box might appear. In this case, click the Cancel button to stop the overwrite installation, exit all the Windows programs, and then perform the overwrite installation again.

Stop JP1/DH - Server.

From Windows Administrative Tools, open the Services window, and then select Stop the service for the services in the following order:

JP1_DH_WEB SVR (if the JP1/DH Web server is used)

JP1_DH_WEB CONTAINER

JP1_DH_DATABASE_SVR

Start Hitachi Integrated Installer.

Insert the Hitachi Integrated Installer medium (CD-ROM) including JP1/DH - Server in the drive, and then start Hitachi Integrated Installer.

Start the JP1/DH - Server installer.

In Hitachi Integrated Installer, select JP1/Data Highway - Server, and then click the Install button. The Welcome to JP1/DH - Server Setup window appears.

Click the Next button. The Program Maintenance window appears.

Select Repair.

In the Program Maintenance window, select Repair.

Click the Next button. The Upgrade/Overwrite window appears.

Check the details of the installed version before starting an overwrite installation.

The Upgrade/Overwrite window appears. Check the details of the installed version.

Click the Next button. The Ready to Repair Program window appears.

Check the entered data before starting an overwrite installation.

In the Ready to Repair Program window, make sure that the entered information is correct.

Start an overwrite installation of JP1/DH - Server.

In the Ready to Repair Program window, click the Install button. The overwrite installation of JP1/DH - Server starts.

Finish the overwrite installation of JP1/DH - Server.

When the overwrite installation is completed, the InstallShield Wizard Complete window appears. Click the Finish button to finish the overwrite installation of JP1/DH - Server.

Exit Hitachi Integrated Installer.

Click the Finish button to exit Hitachi Integrated Installer.

Important

After the overwrite installation of JP1/DH - Server is completed, start the database service (JP1_DH_DATABASE_SVR), and then set up the JP1/DH - Server environment. For details about how to set up the environment, see 5.3 Setting up the JP1/DH Web application server environment.

If the installation ends due to an error, the status of the location to which JP1/DH - Server is installed is invalid. In this case, eliminate the cause of that error, start the installer again, make sure that the installer ends normally, and then complete the installation.

The database-related passwords are reset to p@ssw0rd. Specify them again as needed. For details, see 4.1.3 Notes on overwrite installation and upgrade installation.

5.1.3 Upgrade installation (in Windows)

To perform an upgrade installation of JP1/DH - Server:

Note the following points when performing upgrade installation:

If you install JP1/DH - Server Version 11 in an environment where JP1/DH - Server Version 10 has been installed, the installation wizard is incorrectly displayed in English. However, continue to install Version 11.

If you install JP1/Data Highway - Server Starter Edition Version 11 in an environment where JP1/Data Highway - Server Starter Edition Version 10 has been installed, you have to manually install Version 11 by following the migration procedure. For details, see the Release Notes.

Log in to the machine in which you want to perform an upgrade installation of JP1/DH - Server as a built-in Administrator user.

Exit all the Windows programs.

If another application is using a file that is part of JP1/DH - Server, the File in Use dialog box might appear. In this case, click the Cancel button to stop the upgrade installation, exit all the Windows programs, and then perform the upgrade installation again.

Stop JP1/DH - Server.

From Windows Administrative Tools, open the Services window, select JP1_DH_WEB CONTAINER, and then click Stop the service.

Start Hitachi Integrated Installer.

Insert the Hitachi Integrated Installer medium (CD-ROM) including JP1/DH - Server in the drive, and then start Hitachi Integrated Installer.

The confirmation dialog box for upgrading appears. Click the Yes button. The Start Upgrade Installation window appears.

Click the Next button. The Upgrade/Overwrite window appears.

Check the details of the installed version before starting an upgrade installation.

Click the Next button. The Ready to Install window appears.

In the Ready to Install window, make sure that the entered information is correct.

Start an upgrade installation of JP1/DH - Server.

In the Ready to Install window, click the Install button. The upgrade installation of JP1/DH - Server starts.

Finish the upgrade installation of JP1/DH - Server.

When the upgrade installation is completed, the InstallShield Wizard Complete window appears. Click the Finish button to finish the upgrade installation of JP1/DH - Server.

Exit Hitachi Integrated Installer.

Click the Finish button to exit Hitachi Integrated Installer.

Important

After the upgrade installation of JP1/DH - Server is completed, start the database service (JP1_DH_DATABASE_SVR), and then set up the JP1/DH - Server environment. For details about how to set up the environment, see 5.3 Setting up the JP1/DH Web application server environment. If the JP1/DH Web server is used, see 5.4 Using the JP1/DH Web server.

If the upgrade installation ends due to an error, the status of the location to which JP1/DH - Server is installed is invalid. In this case, eliminate the cause of that error, start the installer again, make sure that the installer ends normally, and then complete the upgrade installation.

The database-related passwords are reset to p@ssw0rd. Specify them again as needed. For details, see 4.1.3 Notes on overwrite installation and upgrade installation.

5.1.4 Uninstallation (in Windows)

This subsection describes how to uninstall JP1/DH - Server. There are two ways to uninstall JP1/DH - Server: uninstallation using Windows Programs and Features and uninstallation using Hitachi Integrated Installer.

If the uninstallation ends due to an error, the status of the location from which JP1/DH - Server is uninstalled is invalid. In this case, eliminate the cause of that error, perform the uninstallation again, and then make sure that the uninstallation ends normally.

(1) Uninstalling JP1/DH - Server by using Windows Programs and Features

Log in to the machine from which you want to uninstall JP1/DH - Server as a built-in Administrator user#.

#

If you have Administrator permissions, you cannot uninstall JP1/DH - Server by using Windows Programs and Features. To uninstall JP1/DH - Server with Administrator permissions, use Hitachi Integrated Installer.

Exit all the Windows programs.

If another application is using a file that is part of JP1/DH - Server, the File in Use dialog box might appear. In this case, click the Cancel button to stop the uninstallation, exit all the Windows programs, and then perform the uninstallation again.

Stop JP1/DH - Server.

From Windows Administrative Tools, open the Services window, and then select Stop the service for the services in the following order:

JP1_DH_WEB SVR (if the JP1/DH Web server is used)

JP1_DH_WEB CONTAINER

JP1_DH_DATABASE_SVR

From the Windows Control Panel, open the Programs and Features window.

Start uninstalling JP1/DH - Server.

In the Programs and Features window, select JP1/DH - Server, and then click the Uninstall button. The confirmation dialog box for uninstalling JP1/DH - Server appears. To continue the uninstallation, click the Yes button.

Delete the user.

From Windows Administrative Tools, open the Computer Management window. From Local Users and Groups, manually delete the user postgres that was added when JP1/DH - Server was installed.

Delete the data folder.

Manually delete the data folder created when JP1/DH - Server was installed (JP1/DH-Server-installation-folder\PostgreSQL\9.4\data).

(2) Uninstalling JP1/DH - Server by using Hitachi Integrated Installer (in Windows)

Log in to the machine from which you want to uninstall JP1/DH - Server with Administrator permissions.

Exit all the Windows programs.

If another application is using a file that is part of JP1/DH - Server, the File in Use dialog box might appear. In this case, click the Cancel button to stop the uninstallation, exit all the Windows programs, and then perform the uninstallation again.

Stop JP1/DH - Server.

From Windows Administrative Tools, open the Services window, select JP1_DH_WEB CONTAINER, and then click Stop the service.

Start Hitachi Integrated Installer.

Insert the Hitachi Integrated Installer medium (CD-ROM) including JP1/DH - Server in the drive, and then start Hitachi Integrated Installer.

Start the JP1/DH - Server installer.

In Hitachi Integrated Installer, select JP1/Data Highway - Server, and then click the Install button. The Welcome to JP1/DH - Server Setup window appears.

Click the Next button. The Program Maintenance window appears.

Select Remove.

In the Program Maintenance window, select Remove.

Click the Next button. The Delete Program window appears.

Start uninstalling JP1/DH - Server.

In the Delete Program window, click the Remove button. The Now Uninstalling window appears.

Finish the uninstallation of JP1/DH - Server.

The InstallShield Wizard Complete window appears. Click the Finish button to finish the uninstallation of JP1/DH - Server.

Exit Hitachi Integrated Installer.

Click the Finish button to exit Hitachi Integrated Installer.

Delete the user.

From Windows Administrative Tools, open the Computer Management window. From Local Users and Groups, manually delete the user postgres that was added when JP1/DH - Server was installed.

Delete the data folder.

Manually delete the data folder created when JP1/DH - Server was installed (JP1/DH-Server-installation-folder\PostgreSQL\9.4\data).

5.2 Installation in Linux

This section describes how to install JP1/DH - Server on a Linux OS.

5.2.1 New installation, overwrite installation, and upgrade installation (in Linux)

This subsection describes how to newly install JP1/DH - Server.

In Linux, there is no distinction among new installation, overwrite installation, and upgrade installation. For details about overwrite installation and upgrade installation, see the procedure described in this subsection.

First, install Hitachi PP Installer. If Hitachi PP Installer is already installed, execute the following command to start Hitachi PP Installer:

/etc/hitachi_x64setup -i /cdrom

Note: The portion in italics is different depending on your environment.

Log in to the host on which you want to install JP1/DH - Server as a super user. Alternatively, use the su command to change the user to a super user.

For both overwrite installation and upgrade installation, stop JP1/DH - Server in the following order:

JP1_DH_WEBSVR (if the JP1/DH Web server is used)

JP1_DH_WEBCON

JP1_DH_DATABASE_SVR

Insert the CD-ROM containing JP1/DH - Server in the drive.

Mount the CD-ROM device.

In this example, the command mounts the CD-ROM onto /cdrom:

/bin/mount -r -o mode=0544device-special-file-name /mnt/cdrom

Execute the following command to install and start Hitachi PP Installer:

mnt/cdrom/X64LIN/setup /mnt/cdrom

After Hitachi PP Installer is running, install JP1/DH - Server.

After Hitachi PP Installer is running, the initial window appears.

An example of the initial window is as follows:

Hitachi PP Installer 05-16

L) List Installed Software
I) Install Software
D) Delete Software
Q) Quit

Select Procedure ===>
...

In the initial window, enter I.

A list of software programs you can install is displayed.

Move the cursor to JP1/DH - Server, and then select it by using the spacebar. Enter I.

JP1/DH - Server is installed.

When the installation is completed, enter Q. The initial window appears again.

Important

After the new, overwrite, or upgrade installation of JP1/DH - Server is completed, start the database service (JP1_DH_DATABASE_SVR), and then set up the JP1/DH - Server environment. For details about how to set up the environment, see 5.3 Setting up the JP1/DH Web application server environment. If the JP1/DH Web server is used, see 5.4 Using the JP1/DH Web server.

If the installation ends due to an error, the status of the location to which JP1/DH - Server is installed is invalid. In this case, eliminate the cause of that error, start the installer again, make sure that the installer ends normally, and then complete the installation.

For the overwrite or upgrade installation, the database-related passwords are reset to p@ssw0rd. Specify them again as needed. For details, see 4.1.3 Notes on overwrite installation and upgrade installation.

5.2.2 Uninstallation (in Linux)

To uninstall JP1/DH - Server:

Log in to the host on which you want to install JP1/DH - Server as a super user. Alternatively, use the su command to change the user to a super user.

On the local host, stop the JP1/DH - Server program and services.

Display information about services to make sure that no JP1/DH - Server service is running. If any JP1/DH - Server program and services are running on the local host, stop all of them.

Execute the following command to start Hitachi PP Installer:

/etc/hitachi_x64setup

The Hitachi PP Installer initial window appears. For details about the initial window, see 5.2.1 New installation, overwrite installation, and upgrade installation (in Linux).

In the initial window, enter D.

A list of software programs you can uninstall is displayed.

Move the cursor to JP1/DH - Server, and then select it by using the spacebar. Enter D.

JP1/DH - Server is uninstalled.

When the uninstallation is completed, enter Q. The initial window appears again.

Delete the user.

Manually delete the user postgres that was added when JP1/DH - Server was installed and the home directory. Before deleting the home directory, check the contents in it and save any necessary files.

Delete the data folder.

Manually delete the data folder created when JP1/DH - Server was installed (/opt/jp1dh/server/PostgreSQL/9.4/data).

5.3 Setting up the JP1/DH Web application server environment

This section describes how to set up the JP1/DH Web application server environment.

Before performing the following procedures, log in to the JP1/DH - Server machine as a built-in Administrator user.

5.3.1 Changing the configuration file

After a new installation, set up the environment according to the procedure described below. For an overwrite installation, set up the environment according to the procedure described below only when changing the configuration file. If there is no need to change the configuration file, go to 5.3.2 Changing the application configuration. The following describes the details of the configuration file.

(1) Editing the digikatsuwide.xml

(a) File path

installation-folder#\misc\digikatsuwide\digikatsuwide\WEB-INF\digikatsuwide.xml

#: In Linux, change installation-folder to /opt/jp1dh/server.

(b) Content of the configuration file

Edit only the items described in this subsection. If you edit the other items, the system might fail to start properly.

Specifying the server IP address

Specify the server IP address.

<end-point>
    <ip>server-IP-address</ip>
</end-point>
<end-point protocol="https">
    <ip>server-IP-address</ip>
</end-point>

Important

To make the server accessible from the Internet, specify a global IP address.

Example:

<end-point>
    <ip>192.168.0.2</ip>
</end-point>
<end-point protocol="https">
    <ip>192.168.0.2</ip>
</end-point>

Specifying the mail server

Specify the mail server information. For details about the mail server information, see 3.2.3 Mail server used by the system and 3.2.4 Sender email address.

<mail-notification>
    <mail-server>
        <host>mail-server-host-name</host>
        <port>mail-server-port-number</port>
        <user>SMTP-authentication-user-ID</user>
        <password>SMTP-authentication-password</password>
        <secure-protocol>SMTP-type#</secure-protocol>
    </mail-serer>
    <notification-from>
        <system-address>sender-email-address</system-address>
    </notification-from>
    ...
</mail-notification>

#

For the <secure-protocol> tag, specify the type of protocol used for transmission path encryption. If nothing is specified, encryption is not applied. For encryption, specify either of the following:

SMTPS: Encrypts the transmission path using SSL or TLS.

STARTTLS: Encrypts the transmission path using STARTTLS.

Important

To use SMTP authentication, specify a user ID and password for SMTP authentication for the <user> and <password> tags. If you do not use SMTP authentication, leave the <user> and <password> tags empty. The sender-email-address is used as the email address of the sender of notification emails sent from JP1/DH - Server to the users.

Example:

<mail-notification>
    <mail-server>
        <host>smtp.foo1.foo2.co.jp</host>
        <port>587</port>
        <user>user01</user>
        <password>password01</password>
        <secure-protocol>SMTPS</secure-protocol>
    </mail-serer>
    <notification-from>
        <system-address>jp1dh-system@foo1.foo2.co.jp</system-address>
    </notification-from>
    ...
</mail-notification>

Specifying the server FQDN and domain name

Specify the FQDN (Fully Qualified Domain Name) and domain name of the server.

<biz-connect id="bizconnect">
    <service>
        ...
        <bind-hostname>server-FQDN#</bind-hostname>
        <bind-domainname>server-domain-name</bind-domainname>
        <bind-sub-domainname>server-subdomain-name</bind-sub-domainname>
        ...
    </service>
</biz-connect>

#

Do not use an underscore (_) for the host name (computer name). Using an underscore for the host name causes a malfunction.

Examples of the settings are as follows:

Example 1: When the server FQDN is xxx.yyy.zzz.co.jp

Server domain name: zzz.co.jp

Server subdomain name: xxx.yyy

Example 2: When the server FQDN is xxx.yyy.zzz.com

Server domain name: zzz.com

Server subdomain name: xxx.yyy

Example:

<biz-connect id="bizconnect">
    <service>
        ...
        <bind-hostname>jp1dhserver.foo1.foo2.co.jp</bind-hostname>
        <bind-domainname>foo2.co.jp</bind-domainname>
        <bind-sub-domainname>jp1dhserver.foo1</bind-sub-domainname>
        ...
    </service>
</biz-connect>

Changing the storage folder for delivery data

Change the storage folder for delivery data# (absolute path) as needed. For details about the storage folder for delivery data, see 3.2.2 Storage folder for delivery data.

<biz-connect id="bizconnect">
    ...
    <persistence>
        <storage>
            <directory>absolute-path-of-the-storage-folder-for-delivery-data#</directory>
        </storage>
    </persistence>
    ...
</biz-connect>

#: For the storage folder for delivery data, note the following points:

Specify a folder on the local file system. If you specify a network folder, the file I/O might become a bottleneck, decreasing the transmission speed.

Specify a path in 4 to 70 characters.

Before changing the current storage folder for delivery data, create a new storage folder for delivery data in advance.

Example:

<biz-connect id="bizconnect">
    ...
    <persistence>
        <storage>
            <directory>D:\data</directory>
        </storage>
    </persistence>
    ...
</biz-connect>

Changing the network bandwidth limit

Change the network bandwidth limit as needed. For details about the network bandwidth limit, see 3.3.2 Network bandwidth limit.

<biz-connect id="bizconnect">
    <service>
        ...
        <throughput-limit>
            <upload>maximum-transmission-bandwidth-for-uploading#</upload>
            <download>maximum-transmission-bandwidth-for-downloading#</download>
        </throughput-limit>
        ...
    </service>
</biz-connect>

#: For values you can specify, note the following points:

A specified value is recognized as a value in Mbps.

Specify a value in the range from 0 to 1,000. You cannot omit the value.

means no bandwidth limit.

Example: When you specify 80 Mbps for the bandwidth limit for uploading and 100 Mbps for the bandwidth limit for downloading:

<biz-connect id="bizconnect">
    <service>
        ...
        <throughput-limit>
            <upload>80</upload>
            <download>100</download>
        </throughput-limit>
        ...
    </service>
</biz-connect>

Changing the keep-alive timeout period

Change the keep-alive timeout period as needed. For details about the keep-alive timeout period, see 3.3.3 Keep-alive timeout period.

<biz-connect id="bizconnect">
    <service>
        ...
        <keep-alive>
            <client>client-keep-alive-timeout-period#</client>
            <server>server-keep-alive-timeout-period#</server>
        </keep-alive>
        ...
    </service>
</biz-connect>

#: For values you can specify, note the following points:

A specified value is recognized as a value in seconds.

Specify a value as 0 or in the range from 30 to 7,200. You cannot omit the value.

0 means disabled timeout (no timeout).

Example: When you specify 180 seconds for the client keep-alive timeout period and 180 seconds for the server keep-alive timeout period:

<biz-connect id="bizconnect">
    <service>
        ...
        <keep-alive>
            <client>180</client>
            <server>180</server>
        </keep-alive>
        ...
    </service>
</biz-connect>

Changing the number of concurrent connections

Change the number of concurrent client-server connections as needed. For details about the number of concurrent connections, see 3.3.4 Concurrent connections.

<biz-connect id="bizconnect">
    <service>
        ...
        <service-task>
            <initial>number-of-initial-connections#</client>
            <maximum>maximum-number-of-connections#</server>
        </service-task>
        ...
    </service>
</biz-connect>

#: For values you can specify, note the following points:

Specify a value in the range from 1 to 64. You cannot omit the value.

Specify values so that the initial value is equal to or less than the maximum value.

Example: When you specify 4 for the number of initial connections and 64 for the maximum number of connections:

<biz-connect id="bizconnect">
    <service>
        ...
        <service-task>
            <initial>4</initial>
            <maximum>64</maximum>
        </service-task>
        ...
    </service>
</biz-connect>

Changing the connection queue size

Change the connection queue size as needed. For details about the connection queue, see 3.3.5 Connection queue size.

<biz-connect id="bizconnect">
    <service>
        <backlog>connection-queue-size#</backlog>
        ...
    </service>
    ...
</biz-connect>

#: Specify a value in the range from 2 to 64. You cannot omit the value.

Example: When you specify 16 for the connection queue size:

<biz-connect id="bizconnect">
    <service>
        <backlog>16</backlog>
        ...
    </service>
    ...
</biz-connect>

Specifying the block size during transfer and reception

Specify the block size for sending a file from a client to JP1/DH - Server, or for downloading a file from JP1/DH - Server as needed. For details about the block sizes during transfer and reception by default, see 3.3.7 Block size during transfer and reception.

<biz-connect id="bizconnect">
    <service>
      ...
      <communication-engine>
        <block-size>
          <send>block-size-for-transfer#</send>
          <receive>block-size-for-downloading#</receive>
        </block-size>
      </communication-engine>
      ...
    </service>
    ...
</biz-connect>

#: For the block size, specify a value as 0 or in the range from 32 to 512. A value is set in KB. If you omit the value or specify 0, the system automatically determines the size depending on the network condition when starting to send or receive a file. If you specify a value in the range from 32 to 512, regardless of the network condition, communication is performed based on the specified block size.

Example: When you specify the fixed block size during transfer and reception (512 KB):

<biz-connect id="bizconnect">
    <service>
      ...
      <communication-engine>
        <block-size>
          <send>512</send>
          <receive>512</receive>
        </block-size>
      </communication-engine>
      ...
    </service>
    ...
</biz-connect>

Specifying the buffer size during transfer and reception

Specify the buffer size used for sending a file from JP1/DH - Server to a client and receiving a file from a client. For details about the buffer size during transfer and reception by default, see 3.3.8 Buffer size during transfer and reception.

<biz-connect id="bizconnect">
    <service>
      ...
      <communication-engine>
        <server-buffer-size>
          <send>transfer-buffer-size#</send>
          <receive>reception-buffer-size#</receive>
        </server-buffer-size>
      </communication-engine>
      ...
    </service>
    ...
</biz-connect>

#: For the buffer size during transfer and reception for JP1/DH - Server, you can specify a value in the range below. A value is set in KB. If you omit the value, operation is performed in the default value, 8,192 KB (8MB).

Minimum value: 64

Maximum value: 65,536

Example: When you specify 65,536 (64 MB) for the buffer size during transfer and reception:

<biz-connect id="bizconnect">
    <service>
      ...
      <communication-engine>
        <server-buffer-size>
          <send>65536</send>
          <receive>65536</receive>
        </server-buffer-size>
      </communication-engine>
      ...
    </service>
    ...
</biz-connect>

Specifying the packet queue size of clients

Specify the packet queue size of clients as needed. For details about the packet queue size of clients by default, see 3.3.9 Packet queue size of clients.

<biz-connect id="bizconnect">
    <service>
      <communication-engine>
        <packet-queue-capacity>packet-queue-size-of-clients#</packet-queue-capacity>
      </communication-engine>
      ...
    </service>
    ...
</biz-connect>

#: For the packet queue size of clients, you can specify a value in the range below. A value is set in KB. If you omit the value or specify a value outside the range, the system assumes that the default value is specified.

Minimum value: 16,384

Maximum value: 131,072

Example: When you specify 131,072 (128 MB) for the packet queue size of clients:

<biz-connect id="bizconnect">
    <service>
      ...
      <communication-engine>
        <packet-queue-capacity>131072</packet-queue-capacity>
      </communication-engine>
      ...
    </service>
    ...
</biz-connect>

Specifying the maximum size of files available for transfer

Specify the maximum size of a single delivery attempt and the maximum file size per file as needed. For details about the maximum size of files available for transfer by default, see 3.3.10 Maximum size of files available for transfer.

The specified values are displayed in the delivery policy window. When the administrator creates or edits a delivery policy, the values specified here are applied. For this reason, even if you change the maximum size of files available for transfer, the maximum values before the change are effective for a file transfer that uses the delivery policy created by using the maximum values before the change.

<biz-connect id="bizconnect">
    <service>
      ...
      <data-capacity>
        <per-file>maximum-size-per-delivery#</per-file>
        <per-delivery>maximum-size-per-file#</per-delivery>
      </data-capacity>
      ...
    </service>
    ...
</biz-connect>

#: For the maximum size per delivery and the maximum size per file, you can specify a value in the range below. A value is set in GB. Note that if you omit the values, the JP1/DH Web application server fails to start. If you specify a value less than 1, the system assumes that 1 is specified. If you specify a value more than 1,024, the system assumes that 1,024 is specified.

Minimum value: 1

Maximum value: 1,024

Example: When you specify 1,024 GB for the maximum size of files available for transfer:

<biz-connect id="bizconnect">
    <service>
      ...
      <data-capacity>
        <per-file>1024</per-file>
        <per-delivery>1024</per-delivery>
      </data-capacity>
      ...
    </service>
    ...
</biz-connect>

Specifying the SALT string for password obfuscation

Specify as needed the SALT string for obfuscating a user password (a user password used for connecting to JP1/DH - Server). For details about how to specify the SALT string, see 3.3.11 Password obfuscation (SALT string).

<biz-connect id="bizconnect">
  ...
  <security>
    <password-salt>SALT-string#</password-salt>
  </security>
  ...
</biz-connect>

#: Specify the SALT string to be added to a JP1/DH - Server user password. If you specify an empty character or omit a value, a SALT is not added. The characters that you can use for a SALT string are the same as those used for a password. You can use no more than 20 characters for a SALT string.

Example: When you specify HITACHI1234 for the SALT string:

<biz-connect id="bizconnect">
  ...
  <security>
    <password-salt>HITACHI1234</password-salt>
  </security>
  ...
</biz-connect>

Important

Do not change the SALT string immediately after starting operation. If you change the SALT string after starting operation, you must register the registered user passwords again. Before starting operation, sufficiently consider the SALT string and then specify it.

When you specify the SALT string, you must reset the password for the system administrator. See 5.5.2 Changing the password for the system administrator, and then reset the password for the system administrator.

Specifying the maximum storage period of files

Specify the maximum file storage period as needed. For details about the maximum storage period of files, see 3.3.12 Maximum storage period of files.

<biz-connect id="bizconnect">
  ...
  <persistence>
    <storage>
      <max-storage-period>number-of-days-for-the-maximum-file-storage-period</max-storage-period>
    </storage>
  </persistence>
  ...
</biz-connect>

#: For the number of days for the maximum file storage period, specify a value in the range from 1 to 3,650 (10 years).

Important

In JP1/DH - Server 11-00 or earlier, the system treats the value specified here as the maximum value allowed for Storage period in the New Delivery Policy window and the Edit Delivery Policy window.

In JP1/DH - Server 11-10 or later, the system treats the value specified here as the maximum value allowed for Maximum storage period of files in the New Group window and the Edit Group window.

Example: When you specify 100 days for the maximum file storage period:

<biz-connect id="bizconnect">
  ...
  <persistence>
    <storage>
      <max-storage-period>100</max-storage-period>
    </storage>
  </persistence>
  ...
</biz-connect>

Specifying the maximum number of destinations

In the web window, specify the maximum number of destinations that can be specified by the user for sending as needed. For details about the maximum number of destinations for sending, see 3.3.13 Maximum number of destinations.

<digivery id="dh">
    ...
    <mail-notification>
        ...
<send-screen-maximum-destinations>maximum-number-of-destinations-for-sending#</send-screen-maximum-destinations>
        ...
    </mail-notification>
    ...
</digivery>

#: For the maximum number of destinations for sending, specify a value in the range from 1 to 500.

Example: When you specify 500 for the maximum number of destinations that can be specified for sending:

<digivery id="dh">
    ...
    <mail-notification>
        ...
<send-screen-maximum-destinations>500</send-screen-maximum-destinations>
        ...
    </mail-notification>
    ...
</digivery>

Specifying whether to enable the initial environment setup function

If necessary, specify whether to automatically create a default address book, a default delivery policy, and default delivery rules when creating a domain. For details about the default setting of the initial environment setup function, see 3.3.14 Enabling or disabling the initial environment setup function.

<digivery id="dh">
    ...
    <biz-connect id="bizconnect">
      ...
      <use-domain-initialization>whether-to-enable-the-initial-environment-setup-function</use-domain-initialization>
    </biz-connect>
    ...
</digivery>

Example: When you use the initial environment setup function:

<digivery id="dh">
    ...
    <biz-connect id="bizconnect">
      ...
      <use-domain-initialization>TRUE</use-domain-initialization>
    </biz-connect>
    ...
</digivery>

Specifying the default delivery status type for the in-box

Specify the default delivery status type for the display of the user's in-box as needed. For details about the default delivery status type for the in-box, see 3.3.15 Default setting for the processing status type of deliveries to be displayed in the in-box.

<digivery id="dh">
    ...
    <user-interface>
        ...
        <mail-box>
          <receiving-box-default-status>default-display-type-for-the-in-box#</receiving-box-default-status>
        </mail-box>
        ...
    </user-interface>
    ...
</digivery>

#: You can specify one of the types below for the default display type. The default display type is not case-sensitive.

NOTOPENED

OPENED

ALL

Example: When you specify OPENED for the default display type for the in-box:

<digivery id="dh">
    ...
    <user-interface>
        ...
        <mail-box>
          <receiving-box-default-status>OPENED</receiving-box-default-status>
        </mail-box>
        ...
    </user-interface>
    ...
</digivery>

Specifying whether to display the Compress Method options

If necessary, specify whether to display the Compress Method options in the window for creating or editing delivery policy. For details about whether to display the Compress Method options by default, see 3.3.16 Displaying the Compress Method options.

Standard and Extended are displayed as options. By using a delivery policy based on the Extended compression method, you can compress and send a file or folder exceeding 4 GB. Note that even if the system parameter settings are changed during operation, the already-set delivery policy data is not changed. The system parameter values are applied when the representative user edits the above delivery policy.

<digivery id="dh">
  ...
  <user-interface>
    <delivery-policy>
      <display-compression-method>Compress-Method-options-display</display-compression-method>
    </delivery-policy>
    ...
  </user-interface>
  ...
</digivery>

Example: When you display the Compress Method options:

<digivery id="dh">
  ...
  <user-interface>
    <delivery-policy>
      <display-compression-method>TRUE</display-compression-method>
    </delivery-policy>
    ...
  </user-interface>
  ...
</digivery>

Specifying the method for storage on the server for the Extended compression method

If necessary, specify whether to store the sending target data in an external folder on the server when sending a folder by using a delivery policy based on the Extended compression method or when sending a file or folder by selecting STRONG, MIDDLE, or WEAK for Compress Level. For details about the default method for storage on the server for the Extended compression method, see 3.3.17 External storage options for the data sent by using the extended compression method.

<digivery id="dh">
  ...
  <biz-connect id="bizconnect">
    ...
    <persistence>
      ...
      <gcp-external-file-saving-condition>
        <count-threshold>maximum-number-of-files-to-be-externally-stored-from-among-files-or-files-in-a-folder-in-a-single-delivery#1
        </count-threshold>
        <size-threshold>maximum-total-file-size-of-files-to-be-externally-stored-from-among-files-or-files-in-a-folder-in-a-single-delivery#2
        </size-threshold><!--KB-->
      </gcp-external-file-saving-condition>
    </persistence>
    ...
  </biz-connect>
  ...
</digivery>

#1: For the maximum number of files to be externally stored from among files or files in a folder in a single delivery, you can specify one of the following values:

-1: All files are externally stored without limit.

0: No files are externally stored.

1 to 262144: As many files as specified are externally stored.

#2: For the maximum total file size of files to be externally stored from among files or files in a folder in a single delivery, you can specify one of the values below. A value is set in KB.

-1: All files are externally stored without limit.

0: No files are externally stored.

1 to 1048576: Files that are smaller than the specified file size are to be externally stored.

Example: When you store files in an external folder:

<digivery id="dh">
  ...
  <biz-connect id="bizconnect">
    ...
    <persistence>
      ...
      <gcp-external-file-saving-condition>
        <count-threshold>262144</count-threshold>
        <size-threshold>1048576</size-threshold><!--KB-->
      </gcp-external-file-saving-condition>
    </persistence>
    ...
  </biz-connect>
  ...
</digivery>

Specifying whether to display the number of TCP connections

If necessary, specify whether to display the following items in a delivery policy other than the standard delivery policy: Max. TCP sessions per Connection and Always connect with Max. TCP sessions. For details about the default display of the number of TCP connections, see 3.3.18 Displaying the options related to number of TCP connections.

If you specify to display the items, you can specify the number of TCP connections for each policy.

<digivery id="dh">
  ...
  <user-interface>
    <delivery-policy>
      ...
      <display-max-tcp-connections>displaying-Max.-TCP-sessions-per-Connection</display-max-tcp-connections>
      <display-always-connect-max-tcp-connections> Always-connect-with-Max.-TCP-sessions</display-always-connect-max-tcp-connections>
    </delivery-policy>
    ...
  </user-interface>
  ...
</digivery>

Example: When you display the items for the number of the TCP connections:

<digivery id="dh">
  ...
  <user-interface>
    <delivery-policy>
      ...
      <display-max-tcp-connections>TRUE</display-max-tcp-connections>
      <display-always-connect-max-tcp-connections>TRUE</display-always-connect-max-tcp-connections>
    </delivery-policy>
    ...
  </user-interface>
  ...
</digivery>

Specifying the timeout period when using a directory server

If the directory server is used for user authentication for login to JP1/DH - Server, specify the LDAP connection timeout period and the timeout period for user searches by the directory server in milliseconds. For details about the default timeout period, see 3.3.19 Timeout period when using a directory server.

If you specify a value equal to or less than 0, the timeout period specified in the network protocol such as TCP is used.

<digivery id="dh">
  ...
  <biz-connect id="bizconnect">
    ...
    <authentication-system>
      <ldap-connection-timeout>timeout-period-for-connecting-to-the-directory-server#</ldap-connection-timeout>
      <ldap-search-timeout>timeout-period-for-searching-a-user#</ldap-search-timeout>
      </authentication-system>
      ...
  </biz-connect>
  ...
</digivery>

#: For values you can specify, note the following points:

A specified value is recognized as a value in milliseconds.

Specify a value in the range from 0 to 30,000.

Example:

When you specify 10 seconds for the timeout period:

<digivery id="dh">
  ...
  <biz-connect id="bizconnect">
    ...
    <authentication-system>
      <ldap-connection-timeout>10000</ldap-connection-timeout>
      <ldap-search-timeout>10000</ldap-search-timeout>
      </authentication-system>
      ...
  </biz-connect>
  ...
</digivery>

Specifying whether to enable the approval exclusion function

When you use JP1/Data Highway - AJE or the data transfer command, specify whether to exclude the approval processing in the specified approval route at the time of sending.

For details about the default setting of the approval processing when using JP1/Data Highway - AJE or tthe data transfer command, see 3.3.20 Approval exclusion function. If you enable the approval exclusion function, approval request emails are not sent to the approver. This makes the approval processing (accept or reject) unnecessary. In addition, a recipient can receive a file or folder without waiting for the approval processing by the approver.

<digivery id="dh">

  ...
  <biz-connect id="bizconnect">
      ...
      <use-command-approval-exclusion>approval-exclusion-function</use-command-approval-exclusion>
      ...
  </biz-connect>
  ...
</digivery>

Example:

When you exclude the approval processing:

<digivery id="dh">
  ...
  <biz-connect id="bizconnect">
      ...
      <use-command-approval-exclusion>TRUE</use-command-approval-exclusion>
      ...
  </biz-connect>
  ...
</digivery>

Specifying whether to enable the file validation disabling function

When you use JP1/Data Highway - AJE or the data transfer command, specify whether to disable file validation at the time of sending and receiving. For details about the default setting of the file validation disabling function when using JP1/Data Highway - AJE or the data transfer command, see 3.3.21 Using the file validation disabling function.

If you enable this function, file validation is not carried out when a file sent from JP1/Data Highway - AJE or the data transfer command is received in the web window. In addition, even if the specified value is changed while a file is being sent or received, the value specified at the time of sending or receiving is effective. However, if sending or receiving is suspended by the suspend command in 8.4.1 Suspension and cancellation of the active file transfer, the specified value after the change is applied when the suspended sending or receiving is resumed because the specified values are checked again when resuming the transfer.

Important

This function is enabled only when JP1/Data Highway - AJE 10-10 or later is used.

<digivery id="dh">
  ...
  <biz-connect id="bizconnect">
      ...
      <use-command-digest-validation-exclusion>file-validation-disabling-function</use-command-digest-validation-exclusion>
      ...
  </biz-connect>
  ...
</digivery>

Example:

When you enable the file validation disabling function:

<digivery id="dh">
  ...
  <biz-connect id="bizconnect">
      ...
      <use-command-digest-validation-exclusion>TRUE</use-command-digest-validation-exclusion>
      ...
  </biz-connect>
  ...
</digivery>

Specifying the maximum number of destinations

Specify the maximum number of destinations that can be specified when a file or folder is sent by using JP1/Data Highway - AJE or the data transfer command. For details about the maximum number of destinations by default when a file or folder is sent by using JP1/Data Highway - AJE or the data transfer command, see 3.3.22 Maximum number of destinations.

If you enable this function, for the maximum number of destinations when a file is sent by using JP1/Data Highway - AJE or the data transfer command, the value specified here is given priority over the value defined in the delivery policy. However, if you omit the value or specify a value equal to or less than 0, the maximum number of destinations defined in the delivery policy is applied.

<digivery id="dh">
  ...
  <user-interface>
    <delivery-policy>
      <force-command-maximum-destinations>maximum-number-of-destinations#</force-command-maximum-destinations>
    ...
    </delivery-policy>
  </user-interface>
  ...
</digivery>

#: For values you can specify, note the following points:

0: Follows the definition of a delivery policy.

1 to 500: Allows a user to specify as many destinations as specified.

Example:

When you specify 500 for the maximum number of destinations:

<digivery id="dh">
  ...
  <user-interface>
    <delivery-policy>
      <force-command-maximum-destinations>500</force-command-maximum-destinations>
      ...
    </delivery-policy>
  </user-interface>
  ...
</digivery>

Specifying whether to enable the file validation disabling function when using the web user-interface

When you use the web user-interface, specify whether to disable file validation at the time of sending and receiving. For details about the default setting of the file validation disabling function when using the web user-interface, see 3.3.23 Using the file validation disabling function when using the web user-interface.

Even if you enable this function, when you receive files sent from JP1/Data Highway - AJE or the data transfer command, the setting for the file validation disabling function when using JP1/Data Highway - AJE or the data transfer command is applied. If the setting value is changed while a file is being sent or received, the value specified when sending or receiving the file becomes effective.

Important

This function is enabled only when JP1/Data Highway - Server 11-00 or later is used.

<digivery id="dh">
  ...
  <biz-connect id="bizconnect">
      ...
      <use-web-digest-validation-exclusion>file-validation-disabling-function-when-using-the-web-user-interface</use-web-digest-validation-exclusion>
      ...
  </biz-connect>
  ...
</digivery>

Example:

When you enable the file validation disabling function in the web user-interface:

<digivery id="dh">
  ...
  <biz-connect id="bizconnect">
      ...
      <use-web-digest-validation-exclusion>TRUE</use-web-digest-validation-exclusion>
      ...
  </biz-connect>
  ...
</digivery>

Specifying the initial state of selection for choosing an approver

Specify an initial state of selection when senders choose their approver on the web window. You can specify TRUE (in which the check box is selected) or FALSE (in which the check box is not selected). When you specify a value, it is applied to the following:

Whether The sender must select the approver (except for the commands) check box in the New Delivery Rule window is selected by default

What is selected by default in the Select Approver window that is displayed when a sender chooses the approver in the New Delivery window

For details about how to specify the default settings for the initial state of selection when an approver is chosen, see 3.3.24 Initial state of selection for choosing an approver.

<digivery id="dh">
  :
  <biz-connect id="bizconnect">
      :
    <persistence>
        :
      <select-approvers-state-default-on>initial-state-of-selection-for-choosing-an-approver
      </select-approvers-state-default-on>
        :
    </persistence>
      :
  </biz-connect>
  :
</digivery>

Example:

When you specify that the check box is selected by default:

<digivery id="dh">
  :
  <biz-connect id="bizconnect">
      :
    <persistence>
        :
      <select-approvers-state-default-on>TRUE</select-approvers-state-default-on>
        :
    </persistence>
      :
  </biz-connect>
  :
</digivery>

Specifying the function to automatically delete files before the storage expiration date based on the evaluation of download completion by all recipients

This function automatically deletes files before the storage expiration date is reached if all the users specified as the recipients download all the files. With the function, the system finds out that all the users specified as the recipients already downloaded all the files and then deletes the files automatically before the storage expiration date is reached. This function can be enabled for each of the address types (TO, CC, and BCC).

The value you can specify is either TRUE (in which the system evaluates if downloads are completed) or FALSE (in which the system does not evaluate if downloads are completed).

For details about how to specify the default settings for the function to automatically delete files before the storage expiration date based on the evaluation of download completion by all recipients, see 3.3.25 Function to automatically delete files before the storage expiration date based on the evaluation of download completion by all recipients.

<digivery id="dh">
  :
  <biz-connect id="bizconnect">
    <persistence>
       <downloaded-data-auto-delete>
         <target-recipient-type>
          <to>evaluation-of-download-by-users-in-the-to-field</to>
          <cc>evaluation-of-download-by-users-in-the-cc-field</cc>
          <bcc>evaluation-of-download-by-users-in-the-bcc-field</bcc>
         </target-recipient-type>
       </downloaded-data-auto-delete>
    </persistence>
      :
  </biz-connect>
  :
</digivery>

Important

If you specify FALSE (in which the system does not evaluate if downloads are completed) for all of the to, cc, and bcc tags, this function is not available.

If all the three tags above are omitted, the system evaluates the completion of download by users specified only in the TO field to automatically delete files before the storage expiration date is reached.

Example:

When the system evaluates the completion of downloads by users specified in the TO field to automatically delete files before the storage expiration date is reached:

<digivery id="dh">
  :
  <biz-connect id="bizconnect">
    <persistence>
       <downloaded-data-auto-delete>
         <target-recipient-type>
          <to>TRUE</to>
          <cc>FALSE</cc>
          <bcc>FALSE</bcc>
         </target-recipient-type>
       </downloaded-data-auto-delete>
    </persistence>
      :
  </biz-connect>
  :
</digivery>

Specifying the window interface for the New Delivery window

Specify the window interface for the New Delivery window that is used for file transfer on the web window. The following interfaces can be used:

Java applet interface

JWS interface

Application interface

For details about how to specify the default window interface for the New Delivery window, see 3.3.26 Window interface for the New Delivery window.

<digivery id="dh">
        :
  <user-interface>
        :
    <transfer-interface>
      <transfer-application-mode-applet>whether-to-use-the-java applet -interface
      </transfer-application-mode-applet>
      <transfer-application-mode-jws>whether-to-use-the-JWS-interface
      </transfer-application-mode-jws>
      <transfer-application-mode-client-app>whether-to-use-the-Application-interface
      <transfer-application-mode-client-app>
    </transfer-interface>
        :
  </user-interface>
        :
</digivery>

The window interface to be used for the New Delivery window is determined by the settings where you specify whether you will use each interface.

The following table shows the relation between the settings and the New Delivery window:

Table 5‒1: The relation between the settings and the New Delivery window

Window interface

New Delivery window

Java applet

JWS

Application

TRUE

TRUE

TRUE

Users can select one of the following interfaces when sending data: Java applet, JWS, or Application.

TRUE

FALSE

FALSE

Java applet

FALSE

TRUE

FALSE

JWS

FALSE

FALSE

TRUE

Application

FALSE

FALSE

FALSE

Application

Important

If a value other than TRUE or FALSE is set, it is deemed that FALSE is specified.

If tags are omitted, it is deemed that TRUE is specified.

Tip

The initial values for new installations and overwrite installations are TRUE for each setting.

Example:

When you enable the Java applet interface only:

<digivery id="dh">
        :
  <user-interface>
        :
    <transfer-interface>
        <transfer-application-mode-applet>TRUE</transfer-application-mode-applet>
        <transfer-application-mode-jws>FALSE</transfer-application-mode-jws>
    </transfer-interface>
        <transfer-application-mode-client-app>FALSE</transfer-application-mode-client-app>
        :
  </user-interface>
        :
</digivery>

Setting up SAML SSO authentication

With this feature, SSO authentication can be performed per domain using JP1/DH - Server as the service provider. You set up SAML Single Sign-On (SSO) authentication.

For details about the default setting of SAML SSO authentication, see 3.3.27 SAML SSO authentication.

<digivery id="dh">
  ：
  <biz-connect id="bizconnect">
     ：
     <authentication-system>
          ：
     </authentication-system>
     <use-saml-domain>SAML-SSO-authentication</use-saml-domain>
     ：
  </biz-connect>
  ：
</digivery>

If you specify TRUE, the settings for SSO authentication are displayed in the windows for creating or editing users. If you change TRUE to FALSE, SSO authentication specified for the domain is disabled and access through SSO is no longer available. Also, the NameID(SAML) item you specified when creating the user is disabled.

Example:

When you use SAML SSO authentication:

<digivery id="dh">
  ：
  <biz-connect id="bizconnect">
     ：
     <authentication-system>
          ：
     </authentication-system>
     <use-saml-domain>TRUE</use-saml-domain>
     ：
  </biz-connect>
  ：
</digivery>

(c) Procedure for recovering digikatsuwide.xml

If the system ceases to operate normally due to reasons such as inadvertently changing the value of an item other than the above, overwrite the file described in 5.3.1 Changing the configuration file with the file shown below, and then edit the overwritten file again. Then, perform the procedures described in 5.3.2 Changing the application configuration and the subsequent subsections again.

installation-folder\template\digikatsuwide.xml.template

(2) Editing ROOT_SERVICE.srv

Edit the configuration file (ROOT_SERVICE.srv) to specify the number of days to store audit logs as needed.

(a) File path

installation-folder#\misc\digikatsuwide\digikatsuwide\WEB-INF\services\ROOT_SERVICE.srv

#: In Linux, change installation-folder to /opt/jp1dh/server.

(b) Content of the configuration file

Edit only the items described in this subsection. If you edit the other items, the system might fail to start properly.

Changing the storage period of the audit log

Specify the number of days to store the audit log as needed. For details about the storage period of the audit log, see 3.3.6 Storage period of the audit log.

log.persist-duration-days = storage-period-of-the-audit-log#

#: For values you can specify, note the following points:

A specified value is recognized as a value in days.

Specify a value as 0 or in the range from 1 to 3,650. You cannot omit the value.

0 means no time limit.

Example:When you specify 365 days for the storage period of the audit log

log.persist-duration-days = 365

(c) Procedures for recovering ROOT_SERVICE.srv

If the system ceases to operate normally due to reasons such as inadvertently changing the value of an item other than the above, overwrite the file described in 5.3.1 (2) Editing ROOT_SERVICE.srv with the file shown below, and then edit the overwritten file again. Then, perform the procedures described in 5.3.2 Changing the application configuration and the subsequent subsections again.

installation-folder\template\ROOT_SERVICE.srv.template

(3) Editing usrconf.cfg

(a) File path

installation-folder#\misc\CC\server\usrconf\ejb\jp1dh\usrconf.cfg

#: In Linux, change installation-folder to /opt/jp1dh/server.

(b) Content of the configuration file

Edit only the items described in this subsection. If you edit the other items, the system might fail to start properly.

Changing the Java heap memory size

Specify the Java heap memory size as needed. For details about the Java heap memory size, see 3.3.1 The Java heap memory size.

#------ JP1/DH - Server ---------
add.jvm.arg=-Xmsminimum-Java-heap-memory-size#m
add.jvm.arg=-Xmxmaximum-Java-heap-memory-size#m

#: For values you can specify, note the following points:

A value for the memory size is specified in MB.

For the maximum size, specify a value equal to or more than 1,024 MB.

Specify the values so that the minimum size is equal to or less than the maximum size. We recommend that you specify the same value for the minimum size and the maximum size.

Example: When you specify 1,024 MB for the minimum size and maximum size of Java heap memory:

#------ JP1/DH - Server ---------
add.jvm.arg=-Xms1024m
add.jvm.arg=-Xmx1024m

(c) Procedure for recovering usrconf.cfg

If the system ceases to operate normally due to reasons such as inadvertently changing the value of an item other than the above, overwrite the file described in 5.3.1 (3) (a) File path with the file shown below, and then edit the overwritten file again. Then, perform the procedures described in 5.3.2 Changing the application configuration and the subsequent subsections again.

installation-folder\template\usrconf.cfg.template

(4) Editing usrconf.properties

Specify the maximum number of connections between the reverse proxy server and Web clients as needed.

If the machine where the JP1/DH Web application server is installed and the reverse proxy server are different machines, you need to allow the reverse proxy server to access the machine where the JP1/DH Web application server is installed. For overwrite installation, you need to perform this procedure only when the IP address of the reverse proxy server is changed.

If there are many TCP connections (for example, 64 connections), change the maximum number of Web client connections to 1,024. For details about how to specify the number of TCP connections, see the JP1/Data Highway - Server System Administrator Guide.

(a) File path

installation-folder#\misc\CC\server\usrconf\ejb\jp1dh\usrconf.properties

#: In Linux, change installation-folder to /opt/jp1dh/server.

(b) Content of the configuration file

Edit only the items described in this subsection. If you edit the other items, the system might fail to start properly.

IP address of the reverse proxy server

Maximum number of Web client connections

Number of concurrent request handling processes

#------ JP1/DH - Server ---------
...
mwebserver.connector.inprocess_http.permitted.hosts=IP-address-of-the-reverse-proxy-server#1
webserver.connector.inprocess_http.max_connections=maximum-number-of-web-client-connections#2
webserver.connector.inprocess_http.max_execute_threads=number-of-concurrent-request-handling-processes#2

#1: Specify an IPv4 address.

#2: A maximum of 1,024 can be specified for the maximum number of Web client connections and the number of concurrent request handling processes. Note that the number of concurrent request handling processes must be equal to or less than the value specified for the maximum number of Web client connections.

Example: When you specify 192.168.0.1 for the IP address of the reverse proxy server and 1,024 for the maximum number of Web client connections and the number of concurrent request handling processes:

#------ JP1/DH - Server ---------
...
webserver.connector.inprocess_http.permitted.hosts=192.168.0.1
webserver.connector.inprocess_http.max_connections=1024
webserver.connector.inprocess_http.max_execute_threads=1024

(c) Procedure for recovering usrconf.properties

If the system ceases to operate normally due to reasons such as inadvertently changing the value of an item other than the above, overwrite the file described in 5.3.1 (4) (a) File path with the file shown below, and then edit the overwritten file again. Then, perform the procedures described in 5.3.2 Changing the application configuration and the subsequent subsections again.

installation-folder#\template\usrconf.properties.template

#: In Linux, change installation-folder to /opt/jp1dh/server.

5.3.2 Changing the application configuration

After editing the configuration file, change the application configuration by applying the edited settings to the system. Perform the procedure below to change the application configuration.

Important

For all installations other than a new installation, make sure that the database service is running. If it is not running, start it, and then perform the procedure below.

(1) Starting the JP1/DH Web application server

Execute either of the following batches:

In Windows

installation-folder\setup_util\start_webcon.bat

In Linux

/opt/jp1dh/server/setup_util/start_webcon.sh

When you execute the batch, the command prompt starts. Follow the given instructions. If the message below appears, the JP1/DH Web application server is running properly. Do not close the command prompt. Go to the next step.

...
KDJE30028-I The J2EE server has started. Server name = jp1dh

(2) Preparing to change the application configuration

Execute either of the following batches:

In Windows

installation-folder\setup_util\prepare_deploy.bat

In Linux

/opt/jp1dh/server/setup_util/prepare_deploy.sh

When you execute the batch, the command prompt starts. Follow the given instructions. When you have finished preparing to change the application configuration, go to the next step.

(3) Restarting the JP1/DH Web application server

When you are ready to change the application configuration, restart the JP1/DH Web application server. To stop the JP1/DH Web application server temporarily, execute either of the following batches:

In Windows

installation-folder\setup_util\stop_webcon.bat

In Linux

/opt/jp1dh/server/setup_util/stop_webcon.sh

When you execute the batch, the command prompt starts. Follow the given instructions. If the JP1/DH Web application server normally stops, in the command prompt started in step (1), a message appears notifying you that the JP1/DH Web application server has stopped normally.

Then, execute the operation in step (1) again to start the JP1/DH Web application server.

(4) Changing the application configuration

Execute either of the following batches:

In Windows

installation-folder\setup_util\deploy_app.bat

In Linux

/opt/jp1dh/server/setup_util/deploy_app.sh

When you execute the batch, the command prompt starts. Follow the given instructions. When you have completed the changing of the application configuration successfully, go to the next step.

(5) Stopping the JP1/DH Web application server

Execute either of the following batches:

In Windows

installation-folder\setup_util\stop_webcon.bat

In Linux

/opt/jp1dh/server/setup_util/stop_webcon.sh

When you execute the batch, the command prompt starts. Follow the given instructions. If the JP1/DH Web application server normally stops, in the command prompt started in step (3), a message appears notifying you that the JP1/DH Web application server has normally stopped.

5.3.3 Specifying the settings for the electronic certificate authentication function

Execute either of the commands below to create a root certificate used for the electronic certificate authentication function. After a new installation, specify the settings for the electronic certificate authentication function according to the procedure described below. For an overwrite installation, you do not have to perform the procedure below.

In Windows

installation-folder\setup_util\init_system_signer.bat

In Linux

/opt/jp1dh/server/setup_util/init_system_signer.sh

Enter values for the required items interactively.

CN(Common Name) : FQDN-of-the-server-host
OU(Organization Unit Name) : organization-unit-name
O(Organization Name) : organization-name
L(Locality Name) : city-or-area-name
S(State or Province Name) : state-or-province-name
C(Country Name) : 2-character-country-code (JP for Japan)

Example:

CN(Common Name) : jp1dhserver.foo1.foo2.co.jp
OU(Organization Unit Name) : Software Development
O(Organization Name) : Hitachi, Ltd.
L(Locality Name) : Shinagawa-ku
S(State or Province Name) : Tokyo
C(Country Name) : JP

5.3.4 Registering a root certificate

To encrypt communication with the linked mail server through SSL (SMTPS/STARTTLS) in mail server linkage while using the delivery notification function, you need to register a root certificate of the Certificate Authority. The root certificate of the Certificate Authority that signed the certificate for SMTPS/STARTTLS communication that is registered in the linked mail server must be registered in the Java keystore contained in the JP1/DH Web application server. In the same way, to encrypt communication with the directory server through SSL (LDAPS) in authentication using the directory server when a user logs in to this product, you need to register a root certificate of the Certification Authority. The root certificate of the Certification Authority that signed the certificate for LDAPS communication that is registered in the linked directory server must be registered in the Java keystore contained in the JP1/DH Web application server.

Use either of the commands below to register the root certificate. For the certificate alias, you can specify any root certificate name.

In Windows

installation-folder\uCPSB\jdk\jre\bin\keytool -import -alias certificate-alias
  -file path-to-the-root-certificate-file
  -keystore installation-folder\uCPSB\jdk\jre\lib\security\cacerts
  -storepass changeit

In Linux

/opt/jp1dh/server/uCPSB/jdk/jre/bin/keytool -import -alias certificate-alias
  -file path-to-the-root-certificate-file
  -keystore /opt/jp1dh/server/uCPSB/jdk/jre/lib/security/cacerts
  -storepass changeit

5.3.5 Editing the hosts file

In Windows, define the server IP address# and host name (FQDN) in the C:\WINDOWS\system32\drivers\etc\hosts file.

In Linux, define the server IP address# and host name (FQDN) in the /etc/hosts file.

For an overwrite installation, you need to perform this procedure only when the server IP address is changed.

#: For the IP address to be defined, note the following points:

Instead of the loopback address (127.0.0.1), specify a server-specific IP address.

Specify an IPv4 address.

5.3.6 Starting the JP1/DH Web application server from the service

In Windows, start JP1_DH_WEB CONTAINER. In Linux, start JP1_DH_WEBCON. For details about how to start the service, see 6. Starting and Stopping.

If you want to start the JP1/DH Web application server automatically when the system restarts, specify Automatic for Startup Type.

5.3.7 Resetting the password for the system administrator

If you specify the SALT string, reset the password for the system administrator.

In Windows

installation-folder\setup_util\init_admin_password.bat

In Linux

/opt/jp1dh/server/setup_util/init_admin_password.sh

5.4 Using the JP1/DH Web server

This section describes how to create and set a server certificate for SSL communication when using the JP1/DH Web server.

If you want to create a self-signed server certificate when testing or evaluating the JP1/DH Web server, instead of 5.4.1 Creating a secret key file for SSL communication, 5.4.2 Creating a password file, and 5.4.3 Creating a certificate file for SSL communication, see 12.3.5 selfsignedkeygen.bat (creating a secret key), 12.3.6 selfsignedcertreq.bat (creating a CSR (certificate signing request)), and 12.3.7 selfsigned.bat (creating a self-signed server certificate) to create a self-signed server certificate. Then perform the procedures in 5.4.4 Editing the settings for the JP1/DH Web server and the subsequent subsections.

Before performing the procedures described in this section, log in to the JP1/DH - Server machine as a built-in Administrator user (in Windows) or the root user (in Linux).

5.4.1 Creating a secret key file for SSL communication

By using the openssl command, create a secret key file for SSL communication. The following subsections describe the openssl command format and operands.

(1) File path

installation-folder#\uCPSB\httpsd\sbin\openssl

#: In Linux, change installation-folder to /opt/jp1dh/server.

(2) Format

In Windows

openssl.bat genrsa -rand file-name[:file-name…] [-des|-des3] -out key-file [512|1024|2048|4096]

In Linux

openssl.sh genrsa -rand file-name[:file-name…] [-des|-des3] -out key-file [512|1024|2048|4096]

(3) Operands

Important

In the case of Linux, you cannot specify an operand containing single-byte spaces.

-rand file-name

Specify any file used for generating a random number. For a file used for generating a random number, specify a sufficiently large and appropriate file.

An example of file specification is as follows:

installation-folder#\misc\digikatsuwide\digikatsuwide\WEB-INF\digikatsuwide.xml

#: In Linux, change installation-folder to /opt/jp1dh/server.

[-des|-des3]

To encrypt a secret key, specify the encryption type.

This encryption type has nothing to do with the encryption type for SSL communication between the reverse proxy server and a Web browser.

-des

When -des is specified, DES (Data Encryption Standard) is selected for the encryption type.

-des3

When -des3 is specified, Triple DES is selected.

If you specify this operand, you are required to enter your password when you create a secret key, create a certificate signing request (CSR), or start the reverse proxy server.

If you want to enable automatic password entry for starting the reverse proxy server, you have to first create a password file by using the sslpasswd.bat command. For details, see 5.4.2 Creating a password file.

You can enter a password from 4 to 64 characters#.

#

If you enter a password less than 4 characters, a message appears, prompting you to enter a password from 4 to 1,023 characters long. Even so, remember that your password must be from 4 to 64 characters long. Particular care must be exercised to ensure that your password does not exceed 64 characters because, even if it does, no error is output.

-out key-file

Specify the file to which a secret key of the reverse proxy server is output.

[512|1024|2048|4096]

Specify the bit length of a secret key of the reverse proxy server to be created. If you omit this operand, the underlined value is used.

Important

Keys with a bit length of 1024 or lower are becoming more dangerous with decreased safety. Therefore, specify 2048 or higher for the bit length.

5.4.2 Creating a password file

If you have created a secret key file with password protection in 5.4.1 Creating a secret key file for SSL communication, create a password file. If you have not created a secret key file with password protection, you do not have to perform this procedure.

(1) File path

installation-folder#\uCPSB\httpsd\sbin\sslpasswd.bat

#: In Linux, change installation-folder to /opt/jp1dh/server.

(2) Format

In Windows

sslpasswd.bat secret-key-file-name password-file-name

In Linux

sslpasswd.sh secret-key-file-name password-file-name

(3) Operands

Important

In the case of Linux, you cannot specify an operand containing single-byte spaces.

secret-key-file-name

Specify the name of the secret key file created in 5.4.1 Creating a secret key file for SSL communication.

password-file-name

Specify a file name used for password file output.

5.4.3 Creating a certificate file for SSL communication

By using the openssl.bat command, create a CSR (certificate signing request).

(1) File path

installation-folder#\uCPSB\httpsd\sbin\openssl.bat

#: In Linux, change installation-folder to /opt/jp1dh/server.

(2) Format

In Windows

openssl.bat req -new [-md5|-sha1|-sha224|-sha256|-sha384|-sha512] -key key-file -out CSR-file

In Linux

openssl.sh req -new [-md5|-sha1|-sha224|-sha256|-sha384|-sha512] -key key-file -out CSR-file

(3) Operands

Important

In the case of Linux, you cannot specify an operand containing single-byte spaces.

[-md5|-sha1|-sha224|-sha256|-sha384|-sha512]

Specify the signature algorithm used for creating a CSR. If you omit this operand, the underlined signature algorithm is used.

md5: Use md5WithRSAEncryption.

sha1: Use sha1WithRSAEncryption.

sha224: Use sha224WithRSAEncryption.

sha256: Use sha256WithRSAEncryption.

sha384: Use sha384WithRSAEncryption.

sha512: Use sha512WithRSAEncryption.

Important

The signature algorithms md5 and sha1 are becoming more dangerous with decreased safety. Therefore, specify the signature algorithms value other than.

-key key-file

Specify the name of the secret key file created in 5.4.1 Creating a secret key file for SSL communication.

-out CSR-file

Specify the file to which the created CSR is output.

Enter values for the required items interactively.

C(Country Name) : 2-character-country-code (JP for Japan)
S(State or Province Name) : state-or-province-name
L(Locality Name) : city-or-area-name
O(Organization Name) : organization-name
OU(Organization Unit Name) : organization-unit-name
CN(Common Name) : FQDN-of-the-server-host
EA(Email Address) : email-address

Example:

C(Country Name) : JP
S(State or Province Name) : Tokyo
L(Locality Name) : Shinagawa-ku
O(Organization Name) : Hitachi,Ltd.
OU(Organization Unit Name) : SoftwareDevelopment
CN(Common Name) : jp1dhserver.foo1.foo2.co.jp
EA(Email Address) : jp1dh-system@foo1.foo2.co.jp

(4) Obtaining a certificate file

Send a CSR to the CA (Certificate Authority) to obtain a signed certificate file in PEM (Privacy Enhanced Mail) format.

If creating a self-signed server certificate, follow the procedure in 12.3.7 selfsigned.bat (creating a self-signed server certificate).

5.4.4 Editing the settings for the JP1/DH Web server

The following subsections describe the details of the JP1/DH Web server settings.

(1) Editing httpsd.conf

(a) File path

installation-folder#\misc\httpsd\conf\httpsd.conf

#: In Linux, change installation-folder to /opt/jp1dh/server.

(b) Settings

Edit only the items described in this subsection. If you edit the other items, the system might fail to start properly.

Setting item

Setting value

SSLCertificateFile

Specify the path to the signed certificate file created in 5.4.3 Creating a certificate file for SSL communication.

SSLCertificateKeyFile

Specify the path to the secret key file created in 5.4.1 Creating a secret key file for SSL communication.

SSLCertificateKeyPassword

If you have created a secret key file with password protection in 5.4.1 Creating a secret key file for SSL communication, uncomment this setting item, and then specify the path to the password file created in 5.4.2 Creating a password file.

ProxyPass

Specify as follows:

ProxyPass/http://FQDN-of-the-server-host/

Specify the server host name in lower-case characters. If you specify it in other characters, the JP1/DH Web server does not operate properly.

ProxyPassReverse

Specify as follows:

ProxyPassReverse/http://FQDN-of-the-server-host/

Specify the server host name in lower-case characters. If you specify it in other characters, the JP1/DH Web server does not operate properly.

In Windows

ThreadsPerChild

This is the maximum number of request handling processes for the reverse proxy server. To allow the system to always communicate at the maximum number of TCP connections, change the value to 1,024. The maximum value that you can specify is 1,024.

For details about how to specify the number of TCP connections, see the JP1/Data Highway - Server System Administrator Guide.

In Linux

MaxClients

Note: To comment out the setting item, insert a hash mark (#) at the beginning of the relevant line. To uncomment the setting item, delete the # at the beginning of the relevant line.

(c) Applying the settings

To apply the settings edited in 5.4.4 (1) Editing httpsd.conf to the JP1/DH Web server, execute either of the following batches:

In Windows

installation-folder\setup_util\deploy_websvr.bat

In Linux

installation-folder/setup_util/deploy_websvr.sh

(d) Recovering httpsd.conf

If the system ceases to operate normally due to reasons such as inadvertently changing the value of an item other than the above, overwrite the file described in 5.4.4 (1) (a) File path with the file shown below, and then edit the overwritten file again. Then, perform the procedures described in 5.4.4 (1) (b) Settings and the subsequent subsections again.

installation-folder#\template\httpsd.conf.template

#: In Linux, change installation-folder to /opt/jp1dh/server.

5.4.5 Starting the JP1/DH Web server

Start JP1_DH_WEB SVR. For details about how to start the service, see 6. Starting and Stopping.

If you want to start the JP1/DH Web server automatically when the system restarts, specify Automatic for Startup Type.

Important

If you access JP1/DH - Server while JP1_DH_WEB SVR is running but the application server service JP1_DH_WEB CONTAINER is not running, Bad Gateway is displayed on screen. The start-up time of JP1_DH_WEB CONTAINER is longer than that of JP1_DH_WEB SVR. When you start these services, access JP1/DH - Server after a sufficient period of time has elapsed.

5.5 Operation check

Perform an operation check according to the following procedures.

5.5.1 Checking the operation of JP1/DH - Server

Check the operation of JP1/DH - Server. In Linux, perform only the procedure described in 5.5.1 (2) Checking access to JP1/DH - Server.

(1) Checking the operation of JP1/DH Web application server

Confirm that the JP1/DH Web application server is installed and set up correctly.

Start the web browser on the JP1/DH - Server machine, and then access http://localhost/#1. If the JP1/DH Web application server is set up correctly, the JP1/DH - Server login window appears. If the login window does not appear, it is possible that the environment configuration of the JP1/DH Web application server is not correct. In this case, review the settings described in 5.3 Setting up the JP1/DH Web application server environment.

After you have confirmed that the login window appears, confirm that you can log in as the following system administrator:

User ID: admin#2

Password: password#2

#1

Note that this operation check is performed through HTTP, not based on SSL communication.

#2

The above password is the initial setting. When you access the JP1/DH Web application server for the first time after its installation, the display of the window takes time.

(2) Checking access to JP1/DH - Server

Confirm that you can access JP1/DH - Server correctly based on the network configuration determined in 2.1 Network configurations.# 1 Start the web browser on the client machine accessing JP1/DH - Server, and then access https://FQDN-of-the-server-host/#2 to confirm that the JP1/DH - Server login window appears.

If the login window does not appear, it is possible that the settings of the reverse proxy server machine or other machines that exist between the client machine and the JP1/DH - Server machine in the network configuration are incorrect. Review the settings of such machines. When using the JP1/DH Web server, also review the settings specified in 5.4 Using the JP1/DH Web server.

#1

Before this confirmation, you must perform the operation check described in 5.5.1 (1) Checking the operation of JP1/DH Web application server.

#2

Note that this operation check is performed through HTTPS based on SSL communication.

5.5.2 Changing the password for the system administrator

You must change the password for the system administrator (user ID: admin) by following the procedure described in the JP1/Data Highway - Server System Administrator Guide.

6 Starting and Stopping

This chapter describes how to start and stop JP1/DH - Server.

6.1 Starting and stopping in Windows

This section describes how to start and stop JP1/DH - Server in Windows.

6.1.1 Procedure for starting (in Windows)

This subsection describes how to start JP1/DH - Server in Windows.

(1) Starting services

To start JP1/DH - Server services in Windows:

Log in as a built-in Administrator user on JP1/DH - Server machine.

Click Control Panel, and then Services.

Right-click the registered name of the desired JP1/DH - Server service, and then select Start. The following table describes the registered names of the JP1/DH - Server services.

Name

Description

JP1_DH_DATABASE_SVR

Database service

JP1_DH_WEB CONTAINER

JP1/DH Web application server service

JP1_DH_WEB SVR

JP1/DH Web server service#

#: Operate this service only when using the JP1/DH Web server.

To start all the services, operate them in the following order:

Database service (JP1_DH_DATABASE_SVR)

JP1/DH Web application server service (JP1_DH_WEB CONTAINER)

JP1/DH Web server service (JP1_DH_WEB SVR) (when using the JP1/DH Web server)

(2) Specifying the automatic startup settings of JP1/DH - Server services (in Windows)

The following table describes the automatic startup settings of JP1/DH - Server services when the system starts after a new installation.

Table 6‒1: Automatic startup settings of JP1/DH - Server services (in Windows)

Name

Setting value

JP1_DH_DATABASE_SVR

Automatic

JP1_DH_WEB CONTAINER

Automatic

JP1_DH_WEB SVR

Manual

To change the automatic startup settings:

Log in as a built-in Administrator user on JP1/DH - Server machine.

Click Control Panel, and then Services.

Right-click the registered name of the desired JP1/DH - Server service, and then select Properties.

In Startup Type, select Automatic or Manual.

If Automatic is selected, the service automatically starts when the system restarts.

If Manual is selected, the service does not automatically start when the system restarts.

6.1.2 Procedure for stopping (in Windows)

(1) Stopping services

This subsection describes how to stop JP1/DH - Server in Windows.

Log in as a built-in Administrator user on JP1/DH - Server machine.

Click Control Panel, and then Services.

Right-click the registered name of the desired JP1/DH - Server service, and then select Stop.

The following table describes the registered names of the JP1/DH - Server services.

Name

Description

JP1_DH_DATABASE_SVR

Database service

JP1_DH_WEB CONTAINER

JP1/DH Web application server service

JP1_DH_WEB SVR

JP1/DH Web server service#

#: Operate this service only when using the JP1/DH Web server.

To stop all the services, operate them in the following order:

JP1/DH Web server service (JP1_DH_WEB SVR) (when using the JP1/DH Web server)

JP1/DH Web application server service (JP1_DH_WEB CONTAINER)

Database service (JP1_DH_DATABASE_SVR)

6.2 Starting and stopping in Linux

This section describes how to start and stop JP1/DH - Server in Linux.

6.2.1 Procedure for starting (in Linux)

This subsection describes how to start JP1/DH - Server in Linux.

(1) Starting services

To start JP1/DH - Server services in Linux:

Log in as the root user on JP1/DH - Server machine.

Start the database service (JP1_DH_DATABASE_SVR).

/sbin/service JP1_DH_DATABASE_SVR start

Start the JP1/DH Web application server service (JP1_DH_WEBCON).

/sbin/service JP1_DH_WEBCON start

To use the JP1/DH Web server, start the JP1/DH Web server service (JP1_DH_WEBSVR).

/sbin/service JP1_DH_WEBSVR start

To start all the services, operate them in the following order:

Database service (JP1_DH_DATABASE_SVR)

JP1/DH Web application server service (JP1_DH_WEBCON)

JP1/DH Web server service (JP1_DH_WEBSVR) (when using the JP1/DH Web server)

(2) Specifying the automatic startup settings of JP1/DH - Server services (in Linux)

The following table describes the automatic startup settings of JP1/DH - Server services when the system starts after a new installation.

Table 6‒2: Automatic startup settings of JP1/DH - Server services (in Linux)

Name

Setting value

JP1_DH_DATABASE_SVR

Enabled (on)

JP1_DH_WEBCON

Enabled (on)

JP1_DH_WEBSVR

Disabled (off)

To change the automatic startup settings:

Log in as the root user on JP1/DH - Server machine.

Change the setting of the database service (JP1_DH_DATABASE_SVR).

To enable the automatic startup setting:

/sbin/chkconfig JP1_DH_DATABASE_SVR on

To disable the automatic startup setting:

/sbin/chkconfig JP1_DH_DATABASE_SVR off

Change the setting of the JP1/DH Web application server service (JP1_DH_WEBCON).

To enable the automatic startup setting:

/sbin/chkconfig JP1_DH_WEBCON on

To disable the automatic startup setting:

/sbin/chkconfig JP1_DH_WEBCON off

Change the setting of the JP1/DH Web server service (JP1_DH_WEBSVR).

To enable the automatic startup setting:

/sbin/chkconfig JP1_DH_WEBSVR on

To disable the automatic startup setting:

/sbin/chkconfig JP1_DH_WEBSVR off

To check the changed automatic startup setting, execute the following command:

/sbin/chkconfig --list service-name

If output results 0 to 6 are all off, the automatic startup setting is disabled. If output results 0, 1, and 6 are off and output results 2 to 5 are on, the automatic startup setting is enabled.

Execution example (when the automatic startup setting is disabled)

/sbin/chkconfig --list JP1_DH_WEBSVR
JP1_DH_WEBSVR   0:off   1:off   2:on   3:on   4:on   5:on   6:off

Execution example (when the automatic startup setting is enabled)

/sbin/chkconfig --list JP1_DH_WEBSVR
JP1_DH_WEBSVR   0:off   1:off   2:off   3:off   4:off   5:off   6:off

6.2.2 Procedure for stopping (in Linux)

This subsection describes how to stop JP1/DH - Server in Linux.

(1) Stopping services

To stop JP1/DH - Server services in Linux:

Log in as the root user on JP1/DH - Server machine.

When using the JP1/DH Web server, stop the JP1/DH Web server service (JP1_DH_WEBSVR).

/sbin/service JP1_DH_WEBSVR stop

Stop the JP1/DH Web application server service (JP1_DH_WEBCON).

/sbin/service JP1_DH_WEBCON stop

Stop the database service (JP1_DH_DATABASE_SVR).

/sbin/service JP1_DH_DATABASE_SVR stop

To stop all the services, operate them in the following order:

JP1/DH Web server service (JP1_DH_WEBSVR) (when using the JP1/DH Web server)

JP1/DH Web application server service (JP1_DH_WEBCON)

Database service (JP1_DH_DATABASE_SVR)

7 Upgrading to the JP1/DH - Server on the JP1/Data Highway - Server Starter Edition

This chapter describes how to upgrading the edition from JP1/Data Highway - Server Starter Edition to JP1/Data Highway - Server.

7.1 Upgrading to the edition

The procedure for upgrading the edition from JP1/Data Highway - Server Starter Edition to JP1/Data Highway - Server is the same as that for upgrading JP1/Data Highway - Server.

According to your OS, see 5.1.3 Upgrade installation (in Windows) or 5.2.1 New installation, overwrite installation, and upgrade installation (in Linux). In these subsections, replace "JP1/DH - Server" with "JP1/Data Highway - Server Starter Edition".

Important

If the versions of JP1/Data Highway - Server Starter Edition and JP1/Data Highway - Server are different, you cannot upgrade JP1/Data Highway - Server Starter Edition to JP1/Data Highway - Server.

8 Administrator Commands

This chapter describes the commands used by the JP1/DH - Server administrator.

8.1 Installing the JP1/DH - Server administrator commands (in Windows)

This section describes how to install the JP1/DH - Server administrator commands in Windows.

8.1.1 Checking the environment prerequisites

The JP1/DH - Server administrator commands run on a machine in which JP1/DH - Server is installed. Check if JP1/DH - Server is installed in the machine.

8.1.2 Installing the JP1/DH - Server administrator commands (in Windows)

The following shows how to install the JP1/DH - Server administrator commands:

(1) Setting the system environment variable

Set the environment variable. The procedure below describes how to set the environment variable on Windows Server 2012.

From the Start menu by right-clicking the Start window and opening All Apps

Select Advanced system settings.

The System Properties window opens.

Select the Advanced tab, and then Environment Variables...

Either select User variables for windows-user-name and then New...or System variables and then New...

Enter DW_CMD_JRE_HOME for Variable name and the JRE installation folder's path for Variable value and then click OK.

The following shows the path to the JRE installation folder when the program is installed in the default installation location:

C:\Program Files\Hitachi\jp1dh\server\uCPSB\jdk\jre

Important

You can skip this procedure if you use the commands that come with Java.

Click OK.

(2) Installing the administrator commands

Decompress the administrator command archive file in the installation folder.

The default installation folder of the administrator commands is shown below.

When you use the commands that come with Java:

C:\ProgramFiles\Hitachi\jp1dh\server\AdminClient\DWAdminClientApp.zip

When you use the commands that do not come with Java (traditional commands):

C:\ProgramFiles\Hitachi\jp1dh\server\AdminClient\DWAdminClient.zip

A DWAdminClientApp folder or DWAdminClient folder is created.

Move the folder created in step 8 to another folder.

Important

A user using the JP1/DH - Server administrator commands must have write permission to the following folders:

Installation folder for JP1/DH - Server administrator commands (DWAdminClientApp folder or DWAdminClient folder)

Temporary folder for the command executing user

(3) Setting the command property file (property.xml)

Open the command property file (property.xml), enter the following information, and then save:

URL of the server to connect to

User ID

Password

Authentication method

Proxy server authentication information

For details about the command property file, see 8.3.6 Command property file (property.xml).

8.1.3 Uninstalling the JP1/DH - Server administrator commands (in Windows)

You must have the Windows administrator rights to uninstall the JP1/DH - Server administrator commands.

(1) Exiting the command programs

Before starting uninstallation, exit all the JP1/DH - Server command programs.

(2) Deleting the folder

Delete the folder into which the JP1/DH - Server administrator commands were copied (DWAdminClientApp folder or DWAdminClient folder). Note that the registry was not used for the installation of the command program.

(3) Deleting the environment variable

Set the environment variable. The procedure below describes how to set the environment variable on Windows Server 2012.

From the Start menu by right-clicking the Start window and opening All Apps

Select Advanced system settings.

The System Properties window opens.

Select the Advanced tab, and then Environment Variables...

Select DW_CMD_JRE_HOME in User variables for windows-user-name or in System variables.

Click Delete for the corresponding section and then click OK.

Click OK.

8.1.4 Restrictions

For the JP1/DH - Server administrator commands, you cannot use surrogate pair characters. Do not use surrogate pair characters for the Windows user name, installation folder name, or argument such as the subject, message, and file path.

8.2 Installing the JP1/DH - Server administrator commands (in Linux)

This section describes how to install the JP1/DH - Server administrator commands in Linux.

8.2.1 Checking the environment prerequisites

The JP1/DH - Server administrator commands run on a machine in which JP1/DH - Server is installed. Check if JP1/DH - Server is installed in the machine.

8.2.2 Installing the JP1/DH - Server administrator commands (in Linux)

The following shows how to install the JP1/DH - Server administrator commands:

(1) Setting the system environment variable

Add the environment variable DW_CMD_JRE_HOME to the configuration file for the login shell you are using.

Set the path to the installation folder for JRE to the environment variable DW_CMD_JRE_HOME.

opt/jp1dh/server/uCPSB/jdk/jre

Important

You can skip this procedure if you use the commands that come with Java.

A setting example is shown below.

When using tcsh as the login shell, add the setting to the .../.tcshrc file.

When using bash as the login shell, add the setting to the .../.bashrc file.

(2) Installing the administrator commands

Create a directory for installing the JP1/DH - Server administrator commands. An example of a directory is as follows:

When you use the commands that come with Java:

mkdir.../DWAdminClientApp

When you use the commands that do not come with Java (traditional commands):

mkdir.../DWAdminClient

Move to the created directory.

cd.../DWAdminClientApp

or

cd.../DWAdminClient

Decompress the JP1/DH - Server administrator command archive file in the installation directory created in step 1.

tar zxvf /opt/jp1dh/server/AdminClient/DWAdminClientApp.tar.gz

or

tar zxvf /opt/jp1dh/server/AdminClient/DWAdminClient.tar.gz

(3) Setting the command property file (property.xml)

Open the command property file (property.xml), enter the following information, and then save.

URL of the server to connect to

User ID

Password

Authentication method

Proxy server authentication information

For details about the command property file, see 8.3.6 Command property file (property.xml).

8.2.3 Uninstalling the JP1/DH - Server administrator commands (in Linux)

(1) Exiting the command programs

Before starting uninstallation, exit all the JP1/DH - Server command programs.

(2) Deleting the folder

Delete the folder into which the JP1/DH - Server administrator commands were copied (DWAdminClientApp folder or DWAdminClient folder).

rm -rf .../DWAdminClientApp

(3) Deleting the environment variable

Delete the line added in 8.2.2 (1) Setting the system environment variable.

8.3 Common specifications

This section describes the common specifications for the JP1/DH - Server administrator commands. The following items are described:

Command format and grammar rules

Common options

Exit code

Log output

File path

Command property file (property.xml)

Simultaneous execution on the same computer

8.3.1 Command format and grammar rules

This subsection describes the command format, grammar rules, and how to specify values.

The following figure shows the command format:

Specify a command according to the following grammar rules:

If you specify multiple options, you can specify them in any order.

You cannot specify the same option more than once.

If you specify a non-existing option, an error occurs.

If you include a blank character in a value, surround a value with double quotation marks ("").

If you specify a command line special character such as an ampersand (&) and a circumflex accent (^), write the caret (^) before it.

You cannot use a double quotation mark (") for a value.

Specify a command so that its length does not exceed 8,191 characters.

If you specify multiple values for a single option, separate each value with a space.

If you specify multiple values for an option and when that option can have one value only, the value specified first is used. For an option that can have multiple values, all the values are used.

8.3.2 Common options

The common options for the commands are shown as follows:

Table 8‒1: List of common options

No.

Option

Description

1

-property

Specifies the path to the command property file (property.xml), where information such as user IDs and passwords for transmission and reception is written. For details about the command property file, see 8.3.6 Command property file (property.xml).

2

-concurrenttimeout

Timeout time (in seconds) to wait for another command to end if it is already executed. You can specify a value in the range from 0 to 86,400 (24 hours).

When you specify 0, the specified command ends without waiting for another command to end. If you omit specifying a value, 0 is used.

8.3.3 Exit codes

The exit codes to be output by command execution are shown below.

In Windows, you can refer to the exit code value by using the environment variable ERRORLEVEL immediately after executing a JP1/DH - Server administrator command. For example, if you execute the echo %ERRORLEVEL% by using the command prompt immediately after you executed a command, you can output the exit code to the standard output. In Linux, execute echo $? by using the console to output the exit code to the standard output.

Table 8‒2: List of exit codes

No.

Exit code

Description

1

0

Indicates that the command execution process ended normally.

2

2

Ended by suspension

3

3

Ended by delivery denial

4

4

Indicates that the command execution process ended with a warning. Indicates that an abnormal event occurred in some part of the process but the rest of the process continued.

5

8

Indicates that the command execution process was terminated because another JP1/DH - Server administrator command had already been activated.

6

12

Ended by cancellation

7

16

Indicates that the command execution process is terminated abnormally. The unfinished part of the process after the error occurrence is not executed. The error details are output to a log file.

8

32

Indicates that Java VM is terminated abnormally.

9

64

Indicates that the Java execution process failed because there was an error in the path specified for the environment variable.

8.3.4 Log output

This subsection describes application logs to be output by commands.

(1) Log level

The following table lists and describes the log levels for application logs.

Table 8‒3: List of log levels for application log

No.

Log level

ID

Severity

Description

Monitoring

1

Error

E

Requires the representative user or the system administrator to correspond.

Indicates that the command processing cannot be continued due to a problem with the execution environment such as the network environment or due to a problem with a parameter entered in the command.

This problem requires correspondence by the representative user. In some cases, correspondence by the system administrator might be required.

Logs output for the cases of exit codes 16 and 8.

Y

2

Warn

W

Temporary problem

Indicates that an abnormal event occurred during command processing.

The command processing continues.

Log output for the case of exit code 4.

C

3

Info

I

Normal event

Log that notifies normal processing on going.

N

Legend:

Y: Log level for which monitoring is required

C: Level for which necessity of monitoring is considered depending on the character of the system

N: Log level for which monitoring is not required

(2) Log file

The following table describes the specifications for log files.

Table 8‒4: Log file specifications

No.

Item

Format or value

1

File format

Text

2

Character code

UTF-8

3

Line feed

CR+LF

Log files are output to the path shown below. Storage period is 30 days.

installation-folder\log\dwc-yyyyMMddhhmmss-GUID.log

Legend:

installation-folder: Folder to which the JP1/DH - Server commands are installed

yyyyMMddhhmmss: Command execution date (yyyy: four-digit year, MM: two-digit month, dd: two-digit day, hh: two-digit hour (in 24-hour format), mm: minute, and ss: second)

GUID: Random string in GUID format

Important

Each time a command is executed, a new log is output to the predetermined output destination. If there is no log output destination, a log output destination folder is automatically created so that logs are output to it. Note that log files whose storage period has expired are automatically deleted when a command is started.

(3) Output format

The application log output format is as follows:

date delimiter-character time-of-day version-number log-level message-ID message-text

An application log output example is as follows:

2011/04/19T20:38:21.500 02-07    INFO  DWCO1001_I Command start.
2011/04/19T20:38:28.250 02-07    INFO  DWCO1602_I User information acquisition finished.
2011/04/19T20:38:28.250 02-07    INFO  DWCO1002_I Command finished.

The table below describes application log output details. For details about specific messages, see 14. Messages.

Table 8‒5: Log file output details

No.

Item

No. of digits

Output data

1

date

10

yyyy/MM/dd

yyyy: Four-digit year

MM: Two-digit month

dd: Two-digit day

2

delimiter-character

1

T

3

time-of-day

12

HH:mm:ss.SSS

HH: Two-digit hour (in 24-hour format)

mm: Minute

ss: Second

SSS: Millisecond

Note that the output time of day is the time of day at the client side.

4

version-number

8

12-00

Aligned left and filled with a blank character on the right.

5

log-level

5

Log level. Aligned left.

For details, see 8.3.4 (1) Log level.

6

message-ID

10

ID for the message.

XXXXYYYY_Z

XXXX: Product code

YYYY: Message number

Z: Log level ID (I: Info. W: Warn, E: Error)

7

message-text

Variable length

Message content.

If a stack trace in Java is included, line feed may be included.

8.3.5 File path

Specify an absolute path for a file path used in JP1/DH - Server administrator commands.

You can use both UNC format and local path format for specifying a path. However, when sending a file on the network or when receiving a file into the network folder, the transmission speed between the client and the network folder might cause a bottleneck, slowing down the total transmission speed. In such cases, to take advantage of high-speed file transmission, characteristic of JP1/DH - Server, we recommend using a local file path for a path to be specified in a command.

8.3.6 Command property file (property.xml)

The command property file is an XML file where information such as the user IDs and passwords for the users is written. Specify this file as an argument when executing a command. A password string is written as-is. Make an appropriate security setting for it such as setting access privileges. The following table describes the specifications for the command property file.

Table 8‒6: Command property file specifications

No.

Item

Format or value

1

File format

XML format

2

Character code

UTF-8

3

Line feed

CR+LF

Use the following format to write code in the command property file:

<?xml version="1.0" encoding="utf-8" ?>
<property>
    <serverUrl>value</serverUrl>
    <userId>value</userId>
    <password>value</password>
    <authenticationMethod>value</authenticationMethod>
    <certificatePath>value</certficatePath>
    <certificatePassword>value</certificatePassword>
    <useProxy>value</useProxy>
    <proxyHost>value</proxyHost>
    <proxyPort>value</proxyPort>
    <proxyId>value</proxyId>
    <proxyPassword>value</proxyPassword>
    <errorNotice>value</errorNotice>
    <errorMailSubject><![CDATA[value]]></errorMailSubject>
    <errorMailMessage><![CDATA[value]]></errorMailMessage>
    <notificationToCompanion>value</notificationToCompanion>
</property >

The following table describes the setting items.

Table 8‒7: Command property file setting items

No.

Setting item

Element name

Description

Initial value

1

URL of the server to connect to

serverUrl

Specify the URL of the server to connect to.

Example: https://jp1dh. hitachi.co.jp/

None

2

User ID

userId

Specify the login user ID for the server to connect to.

For electronic certificate authentication, you can omit specifying a value.

For standard password authentication, you must always specify this item.

Example: user@company

None

3

User password

password

Specify the login user password for the server to connect to.

For the LDAP authentication system, specify the password that is stored in the directory server to connect to.

For electronic certificate authentication, you can omit specifying a value. For standard password authentication, you must always specify this item.

Specify the password character string#1 in plain text, or specify the digest#2 of the password character string in hexadecimal format. When the LDAP authentication system is used, you cannot specify the digest form.

Example of the specification in plain text: password

When you specify this setting item in digest form, type the digest character string of 40 characters after text:HEX:. The digest character string itself is not case sensitive.

You can specify as the digest what is displayed in the password field during export.

Example of the specification in the digest:

text:HEX:5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8

In addition, you cannot specify the character string which starts with text:HEX: as the password character string of plain text.

Example: password

None

4

Authentication method

authenticationMethod

Specify the authentication method. If you omit specifying a value, operation is performed based on standard password authentication.

PASSWORD: Standard password authentication

CERTIFICATION: Certificate authentication

PASSWORD

5

Path of the certificate file

certificatePath

Specify the path to the certificate file in absolute path format.

You can omit specifying a value when using the standard password authentication as the authentication method. To use the electronic certificate authentication, you must always specify this item.

None

6

Certificate file password

certificatePassword

Specify the password for the certificate file.

You can omit specifying a value when using the standard password authentication as the authentication method. To use the electronic certificate authentication, you must always specify this item.

None

7

Proxy use flag

useProxy

Specify whether to use a proxy server.

To use a proxy server: true

Not to use a proxy server: false

This setting is not case-sensitive. If you specify a value other than specifiable values, an error occurs.

Example: true

false

8

Proxy server host name

proxyHost

Specify the host name or IP address of the proxy server.

Example 1: Proxyserver

Example 2: 192.168.0.1

None

9

Proxy server port number

proxyPort

Specify the port number of the proxy server. You can specify a value in the range from 0 to 65535.

Example: 3128

None

10

Proxy authentication ID

proxyId

Specify the authentication ID of the proxy server.

Example: user

None

11

Proxy authentication password

proxyPassword

Specify the authentication password for the proxy server.

Example: password

None

12

Need of command-error email notifications

errorNotice

Specify whether to send an email notification of an error when it occurs during command execution.

To enable notifications: true

To disable notifications: false

This item is not case-sensitive. If you specify a value other than specifiable values, an error occurs. If the item itself is omitted, it is set to false.

If more than one tag is present, the value in the last tag will be effective.

Example: true

false

13

Message subject of command-error email notifications

errorMailSubject

Specify the message subject of command-error email notifications with no more than 128 characters.

If you specify a value for this item, the subject of notifications is created with a product name added to the specified subject value.

If this tag is omitted, the system's default message subject is used to send error notification messages.

You can use characters that are available for message subjects in general.

Note that if the subject contains any &, <, or > characters, you must enter them in the form of XML escape characters, as listed in Table 8-8. If you specify a value other than specifiable values, an error occurs.

If more than one tag is present, the value in the last tag will be effective.

None

14

Message body of command-error email notifications#3

errorMailMessage

Specify the message body of command-error email notifications with no more than 512 characters.

If this tag is omitted, the system sends error notification messages with no body text.

You can use characters that are available for the message body in general.

Note that if the message body contains any &, <, or > characters, you must enter them in the form of XML escape characters, as listed in Table 8-8. If you specify a value other than specifiable values, an error occurs.

If more than one tag is present, the value in the last tag will be effective.

None

15

Need of error notification messages to senders or recipients of delivery

notificationToCompanion

Specify whether to send error notification messages upon command execution to recipient users of delivery for sending errors, or to sender users for reception errors.

Note that this tag is not for data transfer management commands.

To enable notifications: true

To disable notifications: false

This item is not case-sensitive. If you specify a value other than specifiable values, an error occurs. If the item itself is omitted, it is set to false.

If more than one tag is present, the value in the last tag will be effective.

Example: true

None

#1

You can use alphanumeric characters and symbols in a given length as defined by authentication rules.

You can use the following symbols: !"#$%&'()*+,-./:;<=>?@{\}^_`{|}~.

#2

Digest authentication is a method that JP1/DH - Server uses to store a password in the database. When this method is used, the actual password string cannot be restored from the value output for digest authentication. Password information is output in the form of digest to the password item in an exported CSV file.

#3

An error notification message looks like as follows:

JP1/DH - Server
--------------------------------------------------------------------
Command error notification
--------------------------------------------------------------------
A command error occurred.
Executed by: name-of-the-user-who-executed-the-command (email-address-of-this-user)
Command type: type-of-the-command
message-body-specified-by-the-user
Note: This is an auto-generated message. Please do not reply to this message.
                                                        JP1/DH - Server

Most portions of the notification, except for the message body specified by the user, are based on the language set for the user who executed command (in Japanese, English, or Chinese).

Enter values according to the XML conventions. Specifically, be careful when using special symbols in XML. To use any of the following characters, either replace them with their corresponding entity reference (escape characters) or use a CDATA section. In addition, save the command property file in UTF-8 encoding. If the file is encoded in a different character set, the system may fail to read it.

Table 8‒8: XML escape characters

No.

Character

Entity-referenced notations

1

<

&lt;

2

>

&gt;

3

&

&amp;

4

"

&quot;

5

'

&apos;

Note that a control character such as line feed might be displayed as an entity that follows the XML standards. For XML attributes, the order of appearance is irregular in accordance with the XML standards.

Data indicating date and time is expressed as YYYY-MM-DDThh:mm:ssTDZ in W3C-DTF format in accordance with ISO8601:2004. The time zone (TDZ) is based on the offset time according to the OS time zone. For Japan, it is +09:00.

A setting example is shown below.

<?xml version="1.0" encoding="utf-8" ?>
<property>
    <serverUrl>https://jp1dh.hitachi.co.jp/</serverUrl>
    <userId>user@company</userId>
    <password>password</password>
    <authenticationMethod>PASSWORD</authenticationMethod>
            ...
            ...
    <useProxy>true</useProxy>
    <proxyHost>proxyserver</proxyHost>
    <proxyPort>8080</proxyPort>
    <proxyId>proxyid</proxyId>
    <proxyPassword>proxypassword</proxyPassword>
    <errorNotice>true</errorNotice>
    <errorMailSubject><![CDATA[Error notification]]></errorMailSubject>
    <errorMailMessage><![CDATA[Check the command that caused the error.]]></errorMailMessage>
    <notificationToCompanion>true</notificationToCompanion>
</property >

8.3.7 Simultaneous execution on the same computer

You cannot execute more than one JP1/DH - Server administrator command simultaneously on the same computer. If you execute more than one such command simultaneously on the same computer, the commands other than the current command stay in the standby state for the period specified in the timeout option.

However, even on the same computer, if you use a separate Windows account to execute an administrator command, you can simultaneously execute an equal number of commands as the number of such accounts.

In addition, when multiple commands were in the standby state, the order of execution might be different from the order of activation. For example, if command B and command C go into the standby state while command A is being executed, the command to be executed after command A ends is either command B or command C.

8.4 List of administrator commands

The following table lists and describes administrator commands.

Table 8‒9: List of administrator commands

No.

Function

Command

Description

Related subsection

1

Suspension and cancellation of the active file transfer

DWAdminClient.bat# SUSPEND|CANCEL

Suspends or cancels the active file transfer.

8.4.1

2

Changing the delivery acceptance status for the file transfer function

DWAdminClient.bat# STOPDELIVERY|STARTDELIVERY

Changes the delivery acceptance status of the JP1/DH - Server file transfer function.

8.4.2

3

Acquisition of server status

DWAdminClient.bat# GETSERVERSTATUS

Acquires the number of connections by the clients currently executing file transfer.

8.4.3

4

Dynamic management of the server settings

DWAdminClient.bat# GETCONFIG|SETCONFIG

Refers to or changes the settings of the server without restarting JP1/DH - Server.

8.4.4

5

Copying among servers

DWAdminClient.bat# COPYTOSERVER

Copies delivery data among JP1/DH - Servers.

8.4.5

6

Audit log check

DWAdminClient.bat# GETAUDITLOG

Acquires audit logs.

8.4.6

7

Acquisition of delivery information

DWAdminClient.bat# GETDELIVERYINFO

Acquires a delivery information list containing information such as delivery IDs, files, sender/recipient user names, and dates and times.

8.4.7

8

Delivery deletion function

DWAdminClient.bat# DELETEDELIVERY

Deletes the specified delivery.

8.4.8

9

Acquisition of user information

DWAdminClient.bat# EXPORTUSERINFO

Acquires a list of user information containing such information as user IDs and mail addresses.

8.4.9

10

Importing user information

DWAdminClient.bat# IMPORTUSERINFO

Imports a list of user information containing such information as user IDs and mail addresses.

8.4.10

11

Refer to bandwidth limitation rules

DWAdminClient.bat# GETBANDWIDTHRULE

Simultaneously acquires all bandwidth limitation rules for the managed domain.

8.4.11

12

Edit of bandwidth limitation rules

DWAdminClient.bat# SETBANDWIDTHRULE

Simultaneously changes the settings of bandwidth limitation rules for the managed domain.

8.4.12

13

Eject of delivery data

DWAdminClient.bat# EXTRACTDELIVERYDATA

Extracts the sent delivery data from JP1/DH - Server in the same format as the data on the server from which the data was sent.

8.4.13

#: For Linux, replace bat with sh.

8.4.1 Suspension and cancellation of the active file transfer

This command suspends or cancels the file transfer being executed by JP1/Data Highway - AJE and the data transfer command. Note that for file transfer using a command of JP1/Data Highway - AJE 10-00, you cannot use this command to suspend and cancel the processes.

(1) Format

DWAdminClient.bat SUSPEND|CANCEL
   -property property-file
   { -deliveryid delivery-ID}
   { -receiver receiver-ID}

(2) Arguments

Table 8‒10: Arguments of the command for suspending and canceling the active file transfer

No.

Option

Description

1

SUSPEND

Suspends the file transfer being executed by JP1/Data Highway - AJE or the data transfer command.

The client executing the suspended file transfer ends the process in response to the corresponding exit code (ended by suspension).

To resume the suspended file transfer process, use the command for resuming the suspended file transfer on the client side.

2

CANCEL

Cancels the file transfer being executed by JP1/Data Highway - AJE or the data transfer command.

The client executing the canceled file transfer ends the process in response to the corresponding exit code (ended by cancellation).

The canceled file transfer cannot be resumed. If you cancel file transfer during their transmission, the delivery data in JP1/DH - Server is deleted. If you cancel file transfer during reception, the delivery data is not deleted.

Note that you cannot cancel suspended file transfer.

3

-deliveryid

Specifies the delivery ID of the target file whose transfer is suspended or canceled.

You can acquire the delivery ID by using the command for acquiring delivery information.

If you omit specifying this option, all the files whose transfer is being executed by JP1/Data Highway - AJE or the data transfer command are to be suspended or canceled.

If you specify this option and the -receiver option at the same time, you can suspend or cancel the file transfer to the user specified with the -receiver option.

4

-receiver

Specifies the user ID of the recipient to which you want to suspend or cancel the file transfer. If you specify any user ID that does not exist, the system assumes that there is no running file transfer to be suspended or canceled.

If you specify this option and the -deliveryid option at the same time, you can suspend or cancel the file transfer of the delivery ID specified with the -deliveryid option. You can acquire the delivery ID of the file that a user transfers by using the command for acquiring delivery information.

This option can be used in JP1/DH - Server 11-00 or later. If you use this option when using JP1/DH - Server whose version is earlier than 11-00, the following error occurs: DWCO1913_E The server returned an error. Server does not support this command.

5

-property

For details, see 8.3.2 Common options.

(3) Description

The details of the command for suspending and canceling the active file transfer are described as follows:

(a) Time required for command execution

After this command is executed, it might take time for the instruction to reach the client.

(b) Storage expiration date

Delivery data of suspended file transfer is also deleted automatically when its storage period defined in the delivery policy expires. For that reason, we recommend setting a sufficiently long storage period.

(c) When the server stops

When the server stops, the ongoing file transfer processes are suspended.

(4) Execution example

DWAdminClient.bat SUSPEND
 -property "C:\DWCLient\property.xml"
 -deliveryid 00000001
 -receiver receiver@domain

8.4.2 Changing the delivery acceptance status for the file transfer function

This command changes the delivery acceptance status of the JP1/DH - Server file transfer function. Even when the server restarts, the delivery acceptance status is retained. By using this command, you can change the delivery acceptance status of every file transfer including the ones to be processed by using the JP1/DH - Server web window.

(1) Format

DWAdminClient.bat {STOPDELIVERY|STARTDELIVERY}
-property property-file

(2) Arguments

Table 8‒11: Arguments of the command for changing the delivery acceptance status for the file transfer function

No.

Option

Description

1

STOPDELIVERY

Turns the delivery acceptance status for the JP1/DH - Server file transfer function to delivery denial.

When this option is specified, it becomes impossible to start new file transfer or to resume suspended file transfer, and those file transfers are ended by delivery denial.

However, if file transfer is in progress, the process is continued even when this option is specified.

2

STARTDELIVERY

Turns the delivery acceptance status for the JP1/DH - Server file transfer function to start delivery.

When this option is specified, it becomes possible to start new file transfer and to resume suspended file transfer.

3

-property

For details, see 8.3.2 Common options.

(3) Description

To resume the suspended file transfer, besides this command, use the command for resuming the suspended file transfer on the client side.

(4) Execution example

DWAdminClient.bat STOPDELIVERY
   -property "C:\DWCLient\property.xml"

8.4.3 Acquisition of server status

This command acquires the number of connections by the clients currently executing file transfer.

(1) Format

DWAdminClient.bat GETSERVERSTATUS
   -property property-file
   -result storage-destination-server-status-file

(2) Arguments

Table 8‒12: Arguments of the command for acquiring server status

No.

Option

Description

1

-result

Specifies the path to the storage destination for the server status file.

If the file does not exist in the specified location, a new server status file is created. If the file exists, the existing file is overwritten.

2

-property

For details, see 8.3.2 Common options.

(3) Description

(a) Format of the execution result file

The format of the execution result file is as follows:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
    <server-status>
        <running-sockets>3</running-sockets>
    </server-status>
</data>

The following table describes the elements.

Table 8‒13: Elements in the execution result file

Element/attribute

Number of elements

Description

data element

1

Fixed.

server-status element

1

Fixed.

running-sockets element

1

Indicates the number of connections by the clients currently executing file transfer.

(4) Execution example

DWAdminClient.bat GETSERVERSTATUS
   -property "C:\DWCLient\property.xml"
   -result C:\temp\result.xml

8.4.4 Dynamic management of the server settings

You can refer to or change the settings for the server without restarting JP1/DH - Server.

You can change the maximum number of TCP connections in the delivery rule settings (standard delivery policy) and the values for the following server parameters in the JP1/DH - Server configuration file (digikatsuwide.xml).

Network bandwidth limit

Maximum number of client connections (number of concurrent connections)

For details about the standard delivery policy, see the JP1/Data Highway - Server System Administrator Guide.

(1) Format

DWAdminClient.bat {GETCONFIG|SETCONFIG}
   -property property-file
   -config {server-parameter-file|-result storage-destination-server-parameter-file}

(2) Arguments

Table 8‒14: Arguments of the command for dynamic management of the server settings

No.

Option

Description

1

-config

When changing server parameters dynamically (SETCONFIG), specifies the server parameter file where the values after change are written.

Specify this option when selecting SETCONFIG. You cannot specify it when selecting GETCONFIG.

2

-result

When obtaining the current server parameter file (GETCONFIG), specifies the path to the server parameter file at the storage destination.

Specify this option when selecting GETCONFIG. You cannot specify it when selecting SETCONFIG.

3

-property

For details, see 8.3.2 Common options.

(3) Description

(a) Format of the server parameter file

The format of the server parameter file is as follows:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<digivery-config>
  <digivery>
    <biz-connect id="bizconnect" >
      <service>
        <throughput-limit>
          <upload>maximum-transmission-bandwidth-for-uploading</upload>
          <download>maximum-transmission-bandwidth-for-downloading</download>
        </throughput-limit>
        <service-task>
          <initial>maximum-number-of-client-connections-(initial-value)</initial>
          <maximum>maximum-number-of-client-connections-(maximum-value)</maximum>
        </service-task>
        <http-connection>
          <maximum>maximum-TCP-connections</maximum>
        </http-connection>
        </service>
    </biz-connect>
  </digivery>
</digivery-config>

The following table describes the elements.

Table 8‒15: Elements in the server parameter file

Element/attribute

Number of elements

Description

digivery-config element

1

Fixed.

digivery element

1

Fixed.

biz-connect element

1

Fixed.

id attribute

1

Fixed. Specifies bizconnect.

service

1

Fixed.

throughput-limit

1

Fixed.

upload

1

Specifies the maximum transmission bandwidth for uploading in Mbps.

You can specify a value in the range from 0 to 1,000. You cannot omit this value. When you specify 0, no limit is applied to the bandwidth.

download

1

Specifies the maximum transmission bandwidth for downloading in Mbps.

You can specify a value in the range from 0 to 1,000. You cannot omit this value. When you specify 0, no limit is applied to the bandwidth.

service-task

1

Fixed.

initial

1

Specifies the initial value for the number of concurrent connections between JP1/DH - Server and clients. You can specify a value in the range from 1 to 64.

You cannot omit this value.

maximum

1

Specifies the maximum value for the number of concurrent connections between JP1/DH - Server and clients. You can specify a value in the range from 1 to 64.

You cannot omit this value.

http-connection

1

Fixed.

maximum

1

Specifies the maximum number of TCP connections during multiplex communication per connection between JP1/DH - Server and a client.

You can specify a value in the range from 1 to 64. You cannot omit this value.

(b) Settings

The changes made here are enabled from the first connection to be established after the settings have been changed. The communication at the point of command execution is not affected by these changes.

The changes made by this command are enabled only for the settings of active JP1/DH - Server. When JP1/DH - Server is restarted, the changes made to the settings become disabled.

(4) Execution example

DWAdminClient.bat GETCONFIG
   -result C:\temp\result.xml
   -property "C:\DWCLient\property.xml"

8.4.5 Copying among servers

This command copies delivery data among multiple JP1/DH - Server systems.

Delivery data that is sent to a JP1/DH - Server system is copied to another JP1/DH - Server system. You can download the same delivery data stored in the copy source JP1/DH - Server system, from the copy destination JP1/DH - Server system.

This command is executed on the copy source JP1/DH - Server system.

(1) Format

DWAdminClient.bat COPYTOSERVER
   {{{ -to email-address {-toname name }{-todivision division}}|#
     { -cc email-address {-ccname name }{-cc division name}}|#
     { -bcc email-address {-bccname name }{-bcc division name}}}|#
    { -destinationfile the path of the Destination File}}
    -deliveryid deliveryid
   -sysconfig the pass of JP1/DH - Server configuration files (digikatsuwide.xml)
   { -title title}
   { -message message | -messagefile messagefile}
   { -openpassword openpassword}
   { -getdeliveryinfo the path of the delivary information file}
    -property the path of the Command Property File
   { -concurrenttimeout timeout time (second)}

#

Specify one or more options among these.

(2) Arguments

Table 8‒16: The argument of server to copy

No

Option

Explanation

1

-to

Specify the address to send by to. You can specify the email address#1 or the group name (English) #2. Do not distinguish a capital letter and a small letter.

When @ (atmark) is not contained in this value, it is registered as a group name.

When you specify two or more addresses, divide them with a colon (:).

You can specify to, cc, and bcc to the maximum number of the recipients set up by Data Highway - Server side in all. For more information about settings of the maximum number, refer to the manual JP1/Data Highway - Server Configuration and Administration Guide. You can also specify the email address and the group name together.

2

-toname

Specify the address name#3 which is specified to -to option with colon (:) division.

You can specify to the number which is specified to -to option. When the specified arguments are less than the number of -to option, it is considered that the specification was omitted.

When you specify the group name as the address, this option is ignored.

3

-todivision

Specify the address division#4 which is specified to -to option with colon (:) division.

You can specify to the number which is specified to -to option. When the specified arguments are less than the number of -to option, it is considered that the specification was omitted.

In addition, you cannot include the colon (:) to the division.

When you specify the group name as the address, this option is ignored.

4

-cc

Specify the address to send by cc. You can specify the email address#1 or the group name (English) #2.

The specification method is the same as that of -to option.

5

-ccname

Specify the address name#3 which is specified to -cc option with colon (:) division.

You can specify to the number which is specified to -cc option. When the specified arguments are less than the number of -cc option, it is considered that the specification was omitted.

6

-ccdivision

Specify the address division#4 which is specified to -cc option with colon (:) division.

You can specify to the number which is specified to -cc option. When the specified arguments are less than the number of -cc option, it is considered that the specification was omitted.

In addition, you cannot include the colon (:) to the division.

7

-bcc

Specify the address to send by bcc. You can specify the email address#1 or the group name (English) #2.

The specification method is the same as that of -to option.

8

-bccname

Specify the address name#3 which is specified to -bcc option with colon (:) division.

You can specify to the number which is specified to -bcc option. When the specified arguments are less than the number of -bcc option, it is considered that the specification was omitted.

9

-bccdivision

Specify the address division#4 which is specified to -bcc option with colon (:) division.

You can specify to the number which is specified to -bcc option. When the specified arguments are less than the number of -bcc option, it is considered that the specification was omitted.

In addition, you cannot include the colon (:) to the division.

10

-destinationfile

It is used when specifying recipients by CSV form file. Specify the path of the Destination File which indicated recipients. It cannot specify simultaneously with other recipients specification options shown below.

-to, -cc, -bcc

-toname, -ccname, -bccname,

-todivision, -ccdivision, -bccdivision

For more information about Destination File see 9.3.2 (1) (e) Destination File.

If the version of Data Highway - Server is 10-50 or later, this option can be used. When this option to less than 10-50 Data Highway - Server version is specified, an error of "DWCO1913_E The server returned an error. Server does not support this command. " occurs.

11

-deliveryid

Specify the delivery ID that indicates the delivery data copied among the servers.

12

-sysconfig

Specify the file path of the configuration file (digikatsuwide.xml) for the copy source JP1/DH - Server system.

13

-title

Specify the subject. You can specify to a hundred characters at the maximum. When this option is omitted, the subject is a blank. But the subject of the email is applied the system default subject.

14

-message

Specify the messages which are described on the email. You can specify to 256 characters at the maximum. When this option is omitted, the message is a blank. Cannot specify the newline.

15

-messagefile

Specify the path of the text file which is described message to write to the email.

The character code of the text file must be described with UTF-8. If the text file is not described with UTF-8, it may be displayed incorrectly.

In addition, BOM and the newline code are not cared about their existence. You can specify to 4,096 characters at the maximum. But when the file is attached BOM, you can specify to 4,095 characters at the maximum.

The newline is treated as one character.

When this option is omitted, the message is a blank. When this option is specified with -message option, the command ends with an error.

16

-openpassword

Specify the open password for sending to the unregistered address. When this option is omitted, the open password is a blank. But the command ends with an error because the open password is indispensable for sending to the unregistered address.

When you specify the open password for sending to the registered address, it is not used and ignored.

An open password must be between 6 and 32 letters, include two or more kinds of characters (numbers, small letters, big letters, symbols). You can use the following symbols.

!"#$%&'()*+,-./:;<=>?@{\}^_`{|}~

In addition, when the open password is surrounded by " (double quote), the inner character is considered as the password. For example, if the specified password is "Password01", then Password01 is the open password.

17

-getdeliveryinfo

Specify the output file path when creating a delivery information file. A delivery information file that contains delivery information of the copy destination JP1/DH - Server system is output in XML format.

When the same name folder is existed, it is overwritten. And, when this option is specified that the file or folder to copy do not exist, the delivery information file is not outputted.

For more information about the delivery information file see 8.4.5 (3) (d) Delivery information file.

18

-concurrenttimeout

For details, see 8.3.2 Common options.

For the -property option, specify the path of the property file that contains the URL of the copy destination JP1/DH - Server system, and the ID and password of the sender.

19

-property

#1

One-byte alphabet and numbers and more than 256 characters can be used to e-mail address.

You cannot use a space character or the following symbols:

/ \ ? * : | " # $ < > @ ^ { } .

#2

One-byte alphabet and numbers and more than 200 characters can be used to group name.

You cannot use a space character or the following symbols:

( / \ ? * : | " < > @ ^ )

A group name including only a space character or period cannot be specified.

#3

One-byte alphabet and numbers and more than 200 characters can be used to name.

You cannot use a space character or the following symbols:

( / \ ? * : | " < > # @ ^ { } $ )

A name including only a space character or period cannot be specified.

#4

You can enter no more than 1024 characters to division.

(3) Description

(a) Information inherited among servers

Only the delivery data is inherited among the copy source JP1/DH - Server system and the copy destination JP1/DH - Server system. To acquire the ID of the delivery to the copy destination JP1/DH - Server system, specify the -getdeliveryinfo option and output a delivery information file in XML format.

(b) Copying data among the different versions of JP1/DH - Server

You can execute the command even if the versions of the copy source JP1/DH - Server system and the copy destination JP1/DH - Server system are different.

(c) Unable to copy

In the following cases, copying data among the servers fails:

The compression method and compression level defined in the delivery policy of the copy source JP1/DH - Server system are different from those defined in the delivery policy of the copy destination JP1/DH - Server system.

The user who is specified as the destination of the message has been deleted.

Only a message is delivered.

Delivery data does not exist.

(d) Delivery information file

The meanings of the elements which are outputted to the delivery information file are as follows.

Table 8‒17: The meanings of the elements of the delivery information file

Element/Attribute

Number of elements

Explanation

data Element

1

Root Element. It is always outputted.

deliveriesElement

1

The delivery information list.

delivery Element

1

Output when delivery information exists. If there is no delivery information, no delivery element is included.

id Attribute

1

Delivery ID.

subject Attribute

1

The subject of the delivery.

message Attribute

1

The delivary massage.

total-size Attribute

1

Total data size is outputted with a number of bytes.

If the data is to be compressed, this indicates the data size before compression.

sender Element

1

The date the delivery (transfer) was completed is displayed.

id Attribute

1

Sender id.

files Element

0 or 1

A list of delivery files or folders.

file Element

1 or more

Information of the delivery file and folder.

This element is output as many as the number of files and folders to be sent in one delivery. If no delivery file or folder exists, this element is not output.

type Element

1

One of the following delivery type is output:

file: file

folder: folder

name Element

1

Name of the delivery file and folder.

size Element

1

The size of the delivary file/folder is outputted with a number of bytes.

For a folder, the total number of bytes before folder content archival is output. If the data is to be compressed, this indicates the data size before compression.

receivers Element

1

A list of recipient information.

receiver Element

1 or more

Recipient information is output. If there are multiple recipients, multiple receiver elements are output.

email Attribute

1

The receiver's email address.

to-type Attribute

1

The type of a receive.

TO: TO

CC: CC

BCC: BCC

name Attribute

1

The receiver's name.

division Attribute

1

The receiver's division.

Important

When the sender user is deleted, the files sent by that user are also deleted. In this case, empty double quotation marks ("") are displayed for the id attribute of the sender element.

(4) Execution example

DWClient.bat COPYTOSERVER
 -to "user@mailaddress.com"
 -deliveryid 100
 -sysconfig C:\Program Files\Hitachi\jp1dh\server\misc\WEB-INF\digikatsuwide.xml
 -title "title"
 -message "message"
 -getdeliveryinfo C:\deliveryinfo.xml
 -property "C:\DWCLient\property.xml"

8.4.6 Checking audit logs

You can acquire audit logs by domain. The audit logs you can acquire here are the same as the audit logs the representative user acquires on the web window.

(1) Format

DWAdminClient.bat GETAUDITLOG
   -property property-file
   -domain domain-name
   -fromdate YYYY/MM/DD
   -todate YYYY/MM/DD
   -result result-file-storage-destination

(2) Arguments

Table 8‒18: Arguments of the command for checking audit log

No.

Option

Description

1

-domain

Specifies the target domain name.

2

-fromdate

Specifies the start date for audit logs to be acquired.

3

-todate

Specifies the end date for audit logs to be acquired.

4

-result

Specifies the path to the storage destination for the audit log file.

If the file does not exist, a new audit log file is created. If the file exists, the existing file is overwritten.

5

-property

For details, see 8.3.2 Common options.

(3) Description

For details about the output format for a command execution result audit log, see the JP1/Data Highway - Server Administrator Guide.

(4) Execution example

DWAdminClient.bat GETAUDITLOG
   -property "C:\DWCLient\property.xml"
   -domain hitachi
   -fromdate 2012/01/01
   -todate 2012/12/31
   -result C:\temp\audit.log

8.4.7 Acquiring delivery information

You can acquire a delivery information list containing information such as delivery IDs, files, sender/recipient user names, and dates and times.

(1) Format

DWAdminClient.bat GETDELIVERYINFO
   -property property-file
   {-sender sender-user-ID}
   {-receiver recipient-user-ID}
-result execution-result-file

(2) Arguments

Table 8‒19: Arguments of the command for acquiring delivery information

No.

Option

Description

1

-sender

Used to acquire delivery information with a sender user ID specified.

If you omit specifying this option, all sender users are set as targets for acquiring the delivery information.

2

-receiver

Used to acquire delivery information with a recipient user ID specified.

If you omit specifying this option, all recipient users are set as targets for acquiring the delivery information.

3

-result

Specifies the path to the output destination of the execution result file.

4

-property

For details, see 8.3.2 Common options.

(3) Description

(a) Specifying options

When the -sender option and the -receiver option are specified together, the result that is filtered with AND condition for both option is returned.

(b) Delivery with the approval route specified

You cannot check whether the approval route is specified or whether approval has been made, by using the execution result file.

(c) Format of the execution result file

An output example of the execution result file is as follows:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
  <deliveries>
      <delivery id="123"
         send-status="in-progress | suspended | completed"
         send-date="2012-11-20T02:25:09+09:00"
         subject="xxx" message="Sending a document &#10;Taro Hitachi">
        <sender id="user1@domain1" email="user1@domain1.co.jp">
          <files>
                <file id="27" type="file" name="document for xx meeting.txt" size="1024524"
                path="C\digikatsuwide\data\domain1\user1\123\27\a.dat" />
                <file id="28" type="file" name="xxstudyresult.doc" size="3134562"
                  path="C\digikatsuwide\data\domain1\user1\123\28\a.dat" />
          </files>
        </sender>
        <receivers>
          <receiver id="user2@domain1" email="user2@domain1.co.jp">
            <files>
                  <file id="27" download-date="2012-11-21T10:15:33+09:00" />
                  <file id="28" download-date="" />
            </files>
          </receiver>
          <receiver id="user3@domain1" email="user3@domain1.co.jp">
            <files>
                  <file id="27" download-date="" />
                  <file id="28" download-date="" />
            </files>
          </receiver>
        </receivers>
      </delivery>
  </deliveries>
</data>

The following table describes the meanings of the elements of the execution result file.

Table 8‒20: Meanings of the execution result file

Element/attribute

Number of elements

Description

data element

1

Always output.

deliveries element

1

Always output.

delivery element

0 or more

Output when delivery information exists. If there is no delivery information, no delivery element is included.

id attribute

1

The delivery ID is output.

send-status attribute

1

The following delivery (transfer) status is displayed:

For transfer being processed, not approved, or denied: in-progress

For transfer being suspended: suspended

For transfer already sent or approved: completed

send-date attribute

1

The date the delivery (transfer) was completed is displayed.

If the delivery is not completed, empty double quotation marks ("") are displayed.

subject attribute

1

The subject of the delivery is output.

message attribute

1

The message included in the delivery is output.

sender element

1

The sender information is output.

id attribute

1

The user ID of the sender is output.

email attribute

1

The email address of the sender is output.

files element

1

A list of delivery files or folders is output.

file element

0 or more

Output when delivery file or folder information exists. If no delivery file or folder exists, this element is not output.

id attribute

1

The ID of the delivery file or folder is output.

type attribute

1

One of the following delivery type is output:

File: "file"

Folder: "folder"

name attribute

1

The name of the delivery file or folder is output.

size attribute

1

The size of the delivery file or folder is output in bytes. For a folder, the total number of bytes before archiving the contents of the folder is output.

path attribute

1

The actual file path of the delivery file or folder data stored on JP1/DH - Server is output in absolute file path format.

If the type attribute is "folder", the delivery data is an archive file created by archiving the contents of the folder.

receivers element

1

A list of recipient information is output.

receiver element

1 or more

Recipient information is output. If there are multiple recipients, multiple receiver elements are output.

id attribute

1

The user ID of the recipient is output.

email attribute

1

The email address of the recipient is output.

files element

1

A list of delivery files or folders is output.

file element

0 or more

Output when delivery file or folder information exists. If no delivery file or folder exists, this element is not output.

download-date attribute

1

The date on which the delivery file or folder download completed is output. If the downloading is not completed, empty double quotation marks ("") are displayed.

Important

When the displayed send-status attribute is in-progress and the delivery is in progress, for the file element, only files being sent and files already sent are displayed. A file whose transfer has not started is not displayed. When you acquire information about files already sent, make sure that their send-status attribute are completed.

When the sender user is deleted, the files sent by that user are also deleted. In this case, empty double quotation marks ("") are displayed for the id attribute of the sender element and for the path attribute of the file element.

The send-status attribute is displayed as suspended only when a file transmission process is stopped by a suspension instruction from JP1/DH - Server generated through execution of the command for suspending the active file transfer. If a transmission process fails due to such a cause as a communication error, in-progress is displayed for the send-status attribute.

(4) Execution example

DWAdminClient.bat GETDELIVERYINFO
   -property "C:\DWCLient\property.xml"
   -sender hitachi01
   -result C:\temp\result.xml

8.4.8 Delivery deletion function

You can delete the specified delivery.

(1) Format

DWAdminClient.bat DELETEDELIVERY
   -property property-file
   -deliveryid deliver-ID

(2) Arguments

Table 8‒21: Arguments of the command for delivery deletion

No.

Option

Description

1

-deliveryid

Specifies the delivery ID of the delivery to be deleted. You can acquire the delivery ID by using the delivery command for acquiring delivery information.

2

-property

For details, see 8.3.2 Common options.

(3) Description

(a) Abnormal termination of the command

If the send-status attribute is not completed (not sent or approved) in the acquired result of the delivery information acquisition command, the command is terminated abnormally because the system thinks the delivery is in progress.

If the specified delivery ID cannot be deleted, the command is terminated abnormally.

(4) Execution example

DWAdminClient.bat DELETEDELIVERY
   -property "C:\DWCLient\property.xml"
   -deliveryid 00000001

8.4.9 Acquisition of user information

You can acquire (export) user information. The user information you can acquire here is the same as the information the representative user acquires on the web window by selecting a domain for exporting user settings.

(1) Format

DWAdminClient.bat EXPORTUSERINFO
   -property property-file
   -result execution-result-storage-destination
   -domain target-domain-name

(2) Arguments

Table 8‒22: Arguments of the command for acquiring user information

No.

Option

Description

1

-result

Specifies the path to the storage destination of execution result file.

If the file does not exist, a new file is created. If the file exists, the existing file is overwritten.

2

-domain

Specifies the name of the target domain for acquiring user information list.

3

-property

For details, see 8.3.2 Common options.

(3) Description

(a) Information to be output to the execution result file

For details about the format for user information to be output, see 3.5.2(2)(a) Format of a CSV file for import in the JP1/Data Highway - Server Administrator Guide.

(b) User password information

For user password information in the execution result file, a string obfuscated in the format below is output. To specify an obfuscated user password in the command property file (property.xml), use a copy of the output string. An example of a string to be output is as follows:

Obfuscated string example

text:HEX:5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8

(4) Execution example

DWAdminClient.bat EXPORTUSERINFO
   -property "C:\DWCLient\property.xml"
   -result C:\temp\export_users.csv
   -domain HITACHI

8.4.10 Importing user information

You can import user information by using a CSV file.

(1) Format

DWAdminClient.bat IMPORTUSERINFO
   -property property-file
   -file import-file
   -result execution-result-storage-destination

(2) Arguments

Table 8‒23: Arguments of the command for importing user information

No.

Option

Description

1

-file

Specifies the path to the CSV file to be imported.

When a space is contained in a file path, surround that file path with double quotation marks ("").

2

-result

Specifies the path to the storage destination of execution result file.

If the file does not exist, a new file is created. If the file exists, the existing file is overwritten.

3

-property

For details, see 8.3.2 Common options.

(3) Description

(a) Available user information for import

The following table describes available user information for import.

No.

User information

Create

View

Update

Delete

1

User

Y

Y

Y

Y

2

Domain

Y

Y

N

N

3

Group

Y

Y

Y

Y#

4

User's group

Y

Y

N

N

5

Representative user authority

Y

Y

N

N

#

The specified group cannot be deleted if a user or group exists directly below it. However, it can be deleted if those users all belong to another group.

Legend:

Y: Can be imported

N: Cannot be imported

(b) Example of creating an import CSV (import_users.csv) file

An example of creating an import CSV file is shown below. For details about notes on creating this file, see 3.5.2(1) Notes on creating the CSV file used for batch management in the JP1/Data Highway - Server Administrator Guide.

{domains}
FUNCTION,NAME_EN,NAME_JA,PARENT_NAME_EN,FOR_GUEST,EXPIRE_DATE,QUOTA,
USE_USER_OPTION,USER_REGISTERABLE,MAX_DISK_SPACE,TRAFFIC_LIMIT,
LIMIT_USER_NUMBER,CUT_OFF_DAY,INPUT_ANY_ADDRESS,USE_UNREGISTERED_ADDRESS
CREATE,Hitachi xxxxxx,All Users,FALSE,,,,,51200,51200,100,31,TRUE,TRUE

{users}
FUNCTION,USER_ID,EMAIL,PASSWORD,NAME,NAME_EN,NAME_KANA,LANG,
MEMO,EXPIRE_DATE,QUOTA,USE_USER_OPTION,USE_GUEST_USERS,INPUT_ANY_ADDRESS
READ,u1@user,u1@xxx.com,passowrd,,,User1,,,en,,,2012/01/01,1024,,,
READ,u2@user,u2@xxx.com,passowrd,,,User2,,,en,,,2012/01/01,1024,,,

{groups}
FUNCTION,DOMAIN,NAME_EN,NAME_JA,PARENT_NAME_EN,FOR_GUEST,EXPIRE_DATE,QUOTA,USE_USER_OPTION,USER_REGISTERABLE,INPUT_ANY_ADDRESS
READ,domain1,Group1,group-1,Hitachi xxxxx

{binders}
USER_ID,GROUP_NAME_EN,FLAG_DELETE
u1@user,g1,FALSE
u2@user,g1,FALSE

{managers}
FUNCTION,USER_ID,GROUP_NAME_EN

Important

If you want to specify only item names, and not the contents for the {groups} definition section, you can omit the item DOMAIN.

Description of each definition section is given in the following pages. The following table describes the items you can specify for the {domains} definition section.

Table 8‒24: Setting items for the {domains} definition section

No.

Item

Meaning

Description

Omit

1

FUNCTION

Action type

Specify the type of action to be performed for the {domains} definition contents that is specified.

CREATE: Create the data

READ: Do nothing

If you specify READ, the relevant record (line) is ignored.

If no type is specified for FUNCTION, CREATE is used.

Allowed

2

NAME_EN

Group name (English)

Specify the group name (English).

Note that the value specified here is used as a domain name with the spaces between words taken away. It is the same as the value after @ of the user ID.

Not allowed

Rules for specifying a group name (English):

You can enter maximum of 200 single-byte alphanumeric characters and symbols.

You cannot use the following symbols: /\?*:|"<>@^.

You cannot use a value consisting only of spaces or periods (.).

3

NAME_JA

Group name

(Japanese/Chinese)

Specify the group name (Japanese/Chinese).

Not allowed

Rules for specifying a group name (Japanese/Chinese):

You can enter maximum of 200 characters.

You cannot use the following symbols: /\?*:|"<>@^.

You cannot use a value consisting only of spaces or periods (.).

4

PARENT_NAME_EN

Parent group name (English)

Specify the group name of the parent group (English).

Specify All Users for this item.

Not allowed

5

FOR_GUEST

Group type

Specify the group type. This item is not case-sensitive.

TRUE: Guest group

FALSE: User group (used if the value is omitted)

This item is not case-sensitive. You cannot specify a domain group as a guest group.

Allowed

6

EXPIRE_DATE

Account expiration date

Specify the account expiration date in YYYY/MM/DD or YYYY-MM-DD format. You can specify a date in the range from the current date (JST) to 2031/12/31 (Dec. 31, 2031).

If you specify the string UNLIMITED, no limit is set for time. If you omit specifying a value, no limit is set for time.

A single-byte space, line feed, and tab character in a string are ignored. Note that none of the above characters can be inserted between YYYY, MM, and DD items.

Allowed

7

QUOTA

Storage capacity

Specify the storage capacity in MB.

If you omit specifying a value, the amount of 1 GB is applied.

You can specify a value in the range from 0 to 8796093022207.

Allowed

8

USE_USER_OPTION

Permission for the use of the Options function

Specify whether to permit the use of the Options function. This item is not case-sensitive.

TRUE: Permitted (used if the value is omitted)

FALSE: Not permitted

This item is not case-sensitive.

Allowed

9

USER_REGISTERABLE

Permission for the use of the Guest Users function

Specify whether to permit the use of the Guest Users function. This item is not case-sensitive.

TRUE: Permitted

FALSE: Not permitted (used if the value is omitted)

This item is not case-sensitive.

If you specify TRUE for FOR_GUEST, specify FALSE for this item. If you specify TRUE, an error occurs.

Allowed

10

MAX_DISK_SPACE

Disk capacity

Specify the total disk capacity in MB.

You can specify a value in the range from 0 to 8796093022207.

Not allowed

11

TRAFFIC_LIMIT

Download limit

Specify the download limit in MB per month. You can specify a value in the range from 0 to 8796093022207.

Not allowed

12

LIMIT_USER_NUMBER

Maximum number of users

Specify the maximum number of users.

You can specify a value in the range from 1 to 1,000,000.

Not allowed

13

CUT_OFF_DAY

Reset date for download limit measurement

Specify the reset date for download limit measurement. You can specify a value in the range from 1 to 31.

Not allowed

14

INPUT_ANY_ADDRESS

Address input permission

Specify whether to permit inputting address by selecting either of the values below. This item is not case-sensitive.

TRUE: Permitted

FALSE: Not permitted (used if the value is omitted)

Allowed

15

USE_UNREGISTERED_ADDRESS

Address input permission

Specify whether to permit inputting address by selecting either of the values below. This item is not case-sensitive.

TRUE: Permitted

FALSE: Not permitted (used if the value is omitted)

Allowed

The following table describes the items you can specify for the {users} definition section.

Table 8‒25: Setting items of the {users} definition section

No.

Item

Meaning

Description

Omit

1

FUNCTION

Action type

Specify the type of action to be performed for the {users} definition contents that is specified.

CREATE: Create the data (used if the value is omitted)

READ: Do nothing

UPDATE: Update the data

DELETE: Delete the data

If you specify READ, the relevant record (line) is ignored.

If you specify DELETE, the items after EMAIL are ignored. In addition, an error occurs if a non-existing value is specified for USER_ID, or for users specified for an approval route, if there is only one user specified for that approval route.

Allowed

2

USER_ID

User ID

Specify the user ID.

Not allowed

Rules for specifying a user ID:

You cannot specify the same user ID for multiple records (lines).

Write a user name in the following format: any-string + @ + domain-name.

The domain name is the same as that of the representative user.

An error occurs if input string for the part after @ does not exist or if the domain does not match the domain of the representative user.

The user ID must be unique in a domain.

In Windows, a maximum of 100 single-byte alphanumeric characters and symbols can be entered, and in Linux, a maximum of 256 single-byte alphanumeric characters and symbols can be entered, both including an ID assigned to a domain.

You cannot specify the same user ID as the existing user ID.

You cannot use a space character or the following symbols: /\?*:|"<>#@^{}$.

You cannot use a value consisting only of periods (.).

3

EMAIL

Email address

Specify the email address.

If you specify CREATE for FUNCTION, you cannot omit specifying this item.

If you specify UPDATE for FUNCTION, and omit specifying this item, the email address is not changed.

Not allowed at the time of creation

Rules for specifying an email address:

You cannot specify the same email address as the existing email address.

You can enter maximum of 256 single-byte alphanumeric characters and symbols.

You cannot use a space character or the following symbols: /\?*:|"<>^.

4

PASSWORD

Password

Specify the password with a string.

If you specify CREATE for FUNCTION, you cannot omit specifying this item. If you specify UPDATE for FUNCTION, and omit specifying this item, the password is not changed.

To specify a password by using digest authentication, enter a 40-character digest string after text:HEX. The digest string portion is not case-sensitive.

For a digest string, you can use what is output in the password field of the exported file.

Note that you cannot specify a string starting with text:HEX for an unencrypted password string.

Not allowed at the time of creation

Rules for specifying a password:

You can use alphanumeric characters and symbols in a given length as defined by authentication rules. You can use the following symbols: !"#$%&'()*+,-./:;<=>?@{\}^_`{|}~.

Digest authentication is a method that JP1/DH - Server uses to store a password in the database. When this method is used, the actual password string cannot be restored from the value output for digest authentication.

Example of a password used for digest authentication: text:HEX:5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8

5

NAME

Name

(Japanese/Chinese)

Specify the name (Japanese/Chinese).

If you specify UPDATE for FUNCTION, and omit specifying this item, the name is not changed.

Allowed

Rules for specifying a name (Japanese/Chinese):

You can enter maximum of 256 characters.

You cannot use the following symbols: /\?*:|"<>#@^{}$.

You cannot use a value consisting only of spaces or periods (.).

6

NAME_EN

Name (English)

Specify the name (English).

If you specify UPDATE for FUNCTION, and omit specifying this item, the name (English) is not changed.

Allowed

Rules for specifying a name (English):

In Windows, a maximum of 100 single-byte alphanumeric characters and symbols can be entered, and in Linux, a maximum of 256 single-byte alphanumeric characters and symbols can be entered.

You cannot use the following symbols: /\?*:|"<>#@^{}$.

You cannot use a value consisting only of spaces or periods (.).

7

NAME_KANA

Name (kana)

Specify the name (kana).

If you specify UPDATE for FUNCTION, and omit specifying this item, the name (kana) is not changed.

Allowed

Rules for specifying a name (kana):

You can enter maximum of 256 characters.

You cannot use the following symbols: /\?*:|"<>#@^{}$.

You cannot use a value consisting only of spaces or periods (.).

8

LANG

User language

Specify the user language.

ja: Japanese (used if the value is omitted)

en: English

zh: Chinese

If you specify UPDATE for FUNCTION, and omit specifying this item, the user language is not changed.

Allowed

9

MEMO

Memo

Specify the memo.

If you omit specifying a value, registration is made without any information for this item. You can enter maximum of 4,096 characters.

If you specify UPDATE for FUNCTION, and omit specifying this item, the contents of the memo are not changed.

Allowed

10

EXPIRE_DATE

Account expiration date

Specify the account expiration date in YYYY/MM/DD or YYYY-MM-DD format. You can specify a date in the range from the current date to 2031/12/31 (Dec. 31, 2031).

If you omit specifying a value, depending on the type of the first group the user belongs to (specified in {binders} definition section), one of the following applies:

The user belongs to a user group:

Inherits the property of the group.

The user belongs to a guest group:

The account is valid within the day the import process is executed.

If you specify UPDATE for FUNCTION, and omit specifying this item, the account expiration date is not changed.

If you specify the string UNLIMITED, no limit is set for time. However, if the user belongs to the guest group (specified in the {binders} definition section), the same rule applies as when the value is omitted.

A single-byte space, line feed, and tab character in a string are ignored. Note that none of the above characters can be inserted between YYYY, MM, and DD items.

Allowed

11

QUOTA

Storage capacity

Specify the storage capacity in MB.

You can specify a value in the range from 0 to 8796093022207.

If you specify UPDATE for FUNCTION, and omit specifying this item, the storage capacity is not changed.

If you omit specifying a value, the property of the first group the user belongs to (specified in {binders} definition section) is inherited.

Allowed

12

USE_USER_OPTION

Permission for the use of the Options function

Specify whether to permit the use of the Options function. This item is not case-sensitive.

TRUE: Permitted

FALSE: Not permitted

If you specify UPDATE for FUNCTION, and omit specifying this item, the storage capacity is not changed.

If you omit specifying a value, the property of the first group the user belongs to (specified in {binders} definition section) is inherited.

Allowed

13

USE_GUEST_USERS

Permission for the use of the Guest Users function

Specify whether to permit the use of the Guest Users function. This item is not case-sensitive.

TRUE: Permitted

FALSE: Not permitted

If you specify UPDATE for FUNCTION, and omit specifying this item, the storage capacity is not changed.

If you omit specifying a value, the property of the first group the user belongs to (specified in {binders} definition section) is inherited.

Allowed

14

INPUT_ANY_ADDRESS

Address input permission

Specify whether to permit inputting address. This item is not case-sensitive.

TRUE: Permitted

FALSE: Not permitted

If you specify UPDATE for FUNCTION, and omit specifying this item, the storage capacity is not changed.

If you omit specifying a value, the property of the first group the user belongs to (specified in {binders} definition section) is inherited. You can omit the item itself.

Allowed

The table below describes the items you can specify for the {groups} definition section. Note that to register a parent group and a child group together, you must register a parent group first.

Table 8‒26: Setting items of the {groups} definition section

No.

Item

Meaning

Description

Omit

1

FUNCTION

Action type

Specify the type of action to be performed for the {groups} definition contents that is specified.

CREATE: Create the data

READ: Do nothing

UPDATE: Update the data

DELETE: Delete the data

If you specify READ, the relevant record (line) is ignored.

If no type is specified for FUNCTION, CREATE is used.

If you specify DELETE, the specified group cannot be deleted if a user or group exists directly below it. However, it can be deleted if those users all belong to another group.

In case the group deleted in this section is specified in the {binders} section, an error occurs during the process for {binders} section.

Allowed

2

DOMAIN

Domain name

Specify the domain name.

Specify the domain name (the value after @ of the user ID) or the group name of the domain (the value of NAME_EN for registration of the items in {domains} section).

This item is not case-sensitive.

Not allowed

3

NAME_EN

Group name (English)

Specify the group name (English).

Not allowed at the time of creation

Rules for specifying a group name (English):

In Windows, a maximum of 100 single-byte alphanumeric characters and symbols can be entered, and in Linux, a maximum of 256 single-byte alphanumeric characters and symbols can be entered.

You cannot use the following symbols: /\?*:|"<>@^.

You cannot use a value consisting only of spaces or periods (.).

You cannot specify the name of the same group in the same domain for multiple records (lines).

If you register the value with only the lower case and upper case changed when you update this item, the value is not changed because this item is not case-sensitive.

4

NAME_JA

Group name

(Japanese/Chinese)

Specify the group name (Japanese/Chinese).

Not allowed at the time of creation

Rules for specifying a group name (Japanese/Chinese):

You can enter maximum of 200 characters.

You cannot use the following symbols: /\?*:|"<>@^.

You cannot use a value consisting only of spaces or periods (.).

5

PARENT_NAME_EN

Parent group name (English)

Specify the group name of the parent group (English).

You cannot specify All Users for the value.

The rules for specifying this item are the same as the rules for specifying a value for NAME_EN.

Not allowed at the time of creation

6

FOR_GUEST

Group type

Specify the group type. This item is not case-sensitive.

TRUE: Guest group

FALSE: User group (used if the value is omitted)

This item is not case-sensitive. You cannot specify a domain group as a guest group.

If you specify UPDATE for FUNCTION, and a value different from the registered group type, an error occurs. Also in the above case, if you omit specifying this item, the group type is not changed.

Allowed

7

EXPIRE_DATE

Account expiration date

Specify the account expiration date in YYYY/MM/DD or YYYY-MM-DD format. You can specify a date in the range from the current date (JST) to 2031/12/31 (Dec. 31, 2031).

If you specify the string UNLIMITED, no limit is set for time. If you omit specifying a value, no limit is set for time.

A single-byte space, line feed, and tab character in a string are ignored. Note that none of the above characters can be inserted between YYYY, MM, and DD items.

If you specify UPDATE for FUNCTION, and omit specifying this item, the account expiration date is not changed.

Allowed

8

QUOTA

Storage capacity

Specify the storage capacity in MB.

If you omit specifying a value, the amount of 1 GB is applied.

You can specify a value in the range from 0 to 8796093022207.

If you specify UPDATE for FUNCTION, and omit specifying this item, the storage capacity is not changed.

Allowed

9

USE_USER_OPTION

Permission for the use of the Options function

Specify whether to permit the use of the Options function. This item is not case-sensitive.

TRUE: Permitted (used if the value is omitted)

FALSE: Not permitted

This item is not case-sensitive.

If you specify UPDATE for FUNCTION, and omit specifying this item, the permission setting for the use of the Options function is not changed.

Allowed

10

USER_REGISTERABLE

Permission for the use of the Guest Users function

Specify whether to permit the use of the Guest Users function. This item is not case-sensitive.

TRUE: Permitted

FALSE: Not permitted (used if the value is omitted)

This item is not case-sensitive.

If you specify TRUE for FOR_GUEST, specify FALSE for this item. If you specify TRUE at the time of group creation, an error occurs.

When the setting for guest group is updated, regardless of the entered value, FALSE is forcibly applied to this item.

If you specify UPDATE for FUNCTION, and omit specifying this item, the permission setting for the use of the Guest Users function is not changed.

Allowed

11

INPUT_ANY_ADDRESS

Address input permission

Specify whether to permit inputting address by selecting either of the values below. This item is not case-sensitive.

TRUE: Permitted

FALSE: Not permitted (used if the value is omitted)

If you specify UPDATE for FUNCTION, and omit specifying this item, the setting for the address input permission is not changed.

Allowed

The following table describes the items you can specify in the {binders} definition section.

Table 8‒27: Setting items of the {binders} definition section

No.

Item

Meaning

Description

Omit

1

USER_ID

User ID

Specify the user ID of the user whose group you want to change.

Example: user1@company

In Windows, a maximum of 100 single-byte alphanumeric characters and symbols can be entered, and in Linux, a maximum of 256 single-byte alphanumeric characters and symbols can be entered.

You cannot use a space character or the following symbols: /\?*:|"<>#@^{}$.

You cannot use a value consisting only of periods (.).

Not allowed

2

GROUP_NAME_EN

Group name (English)

Specify the name (English) of the group to include the user into or to exclude the user from.

You cannot include a user belonging to the guest group to the user group. You cannot include a user belonging to the user group in the guest group.

You can enter maximum of 200 single-byte alphanumeric characters and symbols.

You cannot use the following symbols: /\?*:|"<>@^.

You cannot use a value consisting only of spaces or periods (.).

Not allowed

3

FLAG_DELETE

Delete flag

Specify whether to include the user in the group or exclude the user from the group.

TRUE: Exclude the user from the group

FALSE: Include the user in the group

If you omit specifying a value, the user is included.

Allowed

The following table describes the items you can specify in the {managers} definition section.

Table 8‒28: Setting items of the {managers} definition section

No.

Item

Meaning

Description

Omit

1

FUNCTION

Action type

Specify the type of operation to be performed for the {managers} definition section.

CREATE: Appoint the user as a group manager (used if the value is omitted)

READ: Do nothing

If the batch process is executed by the system administrator, a representative user is created by specifying CREATE.

If you specify READ, the relevant record (line) is ignored.

Allowed

2

USER_ID

User ID

Specify the user ID of the user to be set as a representative user or group manager.

The user to be specified as a group manager must belong to the affiliated group. Note that you cannot specify one user as group managers for multiple groups.

Not allowed

Rules for specifying a user ID:

In Windows, a maximum of 100 single-byte alphanumeric characters and symbols can be entered, and in Linux, a maximum of 256 single-byte alphanumeric characters and symbols can be entered, both including an ID assigned to a domain.

You cannot use a space character or the following symbols: /\?*:|"<>#@^{}$.

You cannot use a value consisting only of periods (.).

3

GROUP_NAME_EN

Group name (English)

Specify the name (English) of the target group for managing.

Not allowed

Rules for specifying a group name (English):

You can enter maximum of 200 single-byte alphanumeric characters and symbols.

You cannot use the following symbols: /\?*:|"<>@^.

You cannot use a value consisting only of spaces or periods (.).

Important

If you specify a domain group for GROUP_NAME_EN, the user specified for USER_ID is created as a representative user.

If the batch process is executed by the system administrator, the target group is identified with the domain name (the part after @ in the specified user ID) and the group name looked up as keywords.

(c) Format of the execution result file

For details, see 3.5.2(2)(a) Format of a CSV file for import in the JP1/Data Highway - Server Administrator Guide.

(4) Execution example

DWAdminClient.bat GETSERVERSTATUS
   -property "C:\DWCLient\property.xml"
   -result C:\temp\result.xml

8.4.11 Refer to bandwidth limitation rules

You can simultaneously acquire the following items of the bandwidth limitation rules created in the managed domain: the ID, rule name, domain name, maximum transmission bandwidth for uploading and downloading, and flag that indicates whether each bandwidth limitation rule is enabled. The acquired bandwidth limitation rules are output to an XML file.

(1) Format

DWAdminClient.bat GETBANDWIDTHRULE
   -result the path of the Bandwidth Limitation Rules file
   -property property-file
   {-concurrenttimeout timeout time (second)}

(2) Arguments

Table 8‒29: Arguments of the command for refer to bandwidth limitation rules

No.

Option

Description

1

-result

Specifies the path to the Bandwidth Limitation Rules file.

If the file does not exist, a new audit log file is created. If the file exists, the existing file is overwritten.

When a space is contained in a file path, surround that file path with double quotation marks ("").

2

-concurrenttimeout

For details, see 8.3.2 Common options.

3

-property

(3) Description

(a) Format of the bandwidth limitation rules file

The format of the execution Bandwidth Limitation Rules file is as follows :

<data>
    <rules>
        <rule id="1" name="Refer to bandwidth limitation rules 01" cid="0" upload-limit="20" download-limit="17" avtive="true" create-time="2015-04-06T17:22:56+09:00" update-time="2015-04-27T13:29:52+09:00">
            <group id="1" name="All Users"/>
            <network-set id="2" name="Myself">
                <networks>
                    <network cidr="133.108.167.127/32"/>
                    <network cidr="133.108.179.0/24"/>
                </networks>
            </network-set>
        </rule>
        <rule id="2" name="Refer to bandwidth limitation rules 02" cid="0" upload-limit="100" download-limit="80" avtive="true" create-time="2015-04-20T14:38:32+09:00" update-time="2015-04-20T14:38:32+09:00">
            <group id="1" name="All Users"/>
            <network-set id="3" name="network-set 01">
                <networks>
                    <network cidr="133.108.179.127/32"/>
                </networks>
            </network-set>
        </rule>
       <rule id="3" name="Refer to bandwidth limitation rules 03" cid="0" upload-limit="100" download-limit="80" avtive="true" create-time="2015-04-27T13:31:12+09:00" update-time="2015-04-27T13:31:12+09:00">
            <group id="1" name="All Users"/>
            <network-set id="1" name="ANY">
                <networks>
                    <network cidr="0.0.0.0/0"/>
                </networks>
            </network-set>
        </rule>
    </rules>
</data>

The following table describes the elements.

Table 8‒30: Elements in the execution bandwidth limitation rules file

Element/attribute

Number of elements

Description

Abridgement propriety during file editing

data Element

1

Root Element. It is always outputted.

N

rules Element

1

The bandwidth limitation rules file lisr.

N

rule Element

0 or more

The bandwidth limitation rules.

N

id Attribute

1

The bandwidth limitation rules id.

If the value is omitted, 0 is assumed to be set. If the attribute is omitted, -1 is assumed to be set.

N

name Attribute

1

The bandwidth limitation rules name.

Y

cid Attribute

1

The system administrator's id. Specifies 0.

Y

upload-limit Attribute

1

The maximum transmission bandwidth for uploading.

If 0 is specified or if the value is omitted, there is no limit. Note that the attribute cannot be omitted.

By using a modification command for bandwidth limitation rules, you can change the maximum transmission bandwidth.

When changing the maximum transmission bandwidth, specify the value in the range of 0 to 1,000 (unit: Mbps).

N

download-limit Attribute

1

The maximum transmission bandwidth for downloading.

If 0 is specified or if the value is omitted, there is no limit. Note that the attribute cannot be omitted.

By using a modification command for bandwidth limitation rules, you can change the maximum transmission bandwidth.

When changing the maximum transmission bandwidth, specify the value in the range of 0 to 1,000 (unit: Mbps).

N

active Attribute

1

A flag indicates whether the setting of a bandwidth limitation rule is enabled (active).

true: Enabled

false: Disabled

If the value and attribute are omitted, or if a character string other than true is specified, false is assumed to be set.

By using a modification command for bandwidth limitation rules, you can change the active flag setting.

N

create-time Attribute

1

The creation date-time.

Y

update-time Attribute

1

The updated date-time.

Y

group Element

1

Limitation group of the bandwidth limitation rules.

Y

id Attribute

1

The ID of the limitation group of the bandwidth limitation rules.

The value must be 1 (fixed).

Y

name Attribute

1

The name of the limitation group of the bandwidth limitation rules.

The value must be ALL Users (fixed).

Y

network-set Element

1

The network set.

Y

id Attribute

1

The network set id.

Y

name Attribute

1

The network set name.

Y

networks Element

1

The network set list.

Y

network Element

1 or more

The network.

Y

cidr Attribute

1

The network address.

Y

Legend:

Y: Editable

N: Not Editable

(4) Execution example

DWAdminClient.bat GETBANDWIDTHRULE
   -result C:\data\band_width_limitation_rules.xml
   -property "C:\DWAdminClient\property.xml"

8.4.12 Edit of bandwidth limitation rules

By specifying an XML file that configures bandwidth limitation rules, you can simultaneously change the settings of bandwidth limitation rules for the managed domain. The following values can be changed: the maximum transmission bandwidth for uploading and downloading, and the value of the active flag.

A user creates the bandwidth limitation rule file by modifying the file that is output by the command for acquiring bandwidth limitation rules. For details about the format of the bandwidth limitation rules file, see 8.4.11 (3)(a) Format of the bandwidth limitation rules file.

(1) Format

DWAdminClient.bat SETBANDWIDTHRULE
   -result the path of the Bandwidth Limitation Rules file
   -property property-file
   {-concurrenttimeout timeout time (second)}

(2) Arguments

Table 8‒31: Arguments of the command for edit of bandwidth limitation rules

No.

Option

Description

1

-result

Specify the path of the file that configures the bandwidth limitation rules.

2

-concurrenttimeout

For details, see 8.3.2 Common options.

3

-property

(3) Description

If a value outside the range of 0 to 1,000 (unit: Mbps) is specified for the maximum transmission bandwidth, the following error message is output:

DWCO1747_E Failed to read bandwidth limitation rules file. (Details: DWCO1708_E A setting is wrong. (Setting: upload -limit, Value:-1))

For more information about the messages see 8.5 List of messages.

(4) Execution example

DWAdminClient.bat SETBANDWIDTHRULE
   -config C:\data\band_width_limitation_rules.xml
   -property "C:\DWAdminClient\property.xml"

8.4.13 Eject of delivery data

When the delivery data stored in the delivery data storage folder on JP1/DH - Server is sent, the delivery data is extracted in the same format as the data on the server from which the data is sent. The data must be sent by using the extended compression method.

Important

If you use this function, the target delivery data is deleted from JP1/DH - Server.

(1) Format

DWAdminClient.bat EXTRACTDELIVERYDATA
   -deliveryid deliveryid
   -sysconfig the pass of JP1/DH - Server configuration files (digikatsuwide.xml)
   -result destination folder
   -property property-file
   {-concurrenttimeout timeout time (second)}

(2) Arguments

Table 8‒32: Arguments of the command for eject of delivery data

No.

Option

Description

1

-deliveryid

Specify a delivery ID of the delivery data.

2

-sysconfig

Specify the file path of the configuration file (digikatsuwide.xml) for JP1/DH - Server.

3

-result

Specify the output folder where the extracted delivery data is output.

The delivery data is extracted and output in the specified folder.

An example of extraction when Folder A is sent:

Structure of the sent folders

A

├B

└C

result of eject

folder-specified-with-the--result-option

└A

├B

└C

If there is a folder with the same name in the output folder, an error occurs.

4

-concurrenttimeout

For details, see 8.3.2 Common options.

5

-property

(3) Description

(a) Stored externally a file

If files are to be delivered, all the files must be stored in an external location without compression. In addition, files that are compressed using the compression function of JP1/DH - Server cannot be extracted.

Default value of JP1/DH - Server is not stored externally.

For details about the stored externally, see 3.3.17 External storage options for the data sent by using the extended compression method in the , and5.3.1 (1) (b) Content of the configuration file.

(b) The data on JP1/DH - Server

The command for extracting delivery data deletes the delivery data saved in the storage folder for delivery data on JP1/DH - Server, and then moves them to the output folder. Therefore, you can view the delivery history on the web window, but you cannot download the corresponding delivery data.

(c) In the not eject case

In the following cases, extraction of the delivery data fails:

Files stored in an external location are missing.

Files that are not stored in an external location exist.

The sender is deleted.

The delivery of only a message is specified.

Delivery data stored with the standard compression method is specified.

(4) Execution example

DWAdminClient.bat EXTRACTDELIVERYDATA
   -deliveryid 100
   -sysconfig C:\Program Files\Hitachi\jp1dh\server\misc\WEB-INF\digikatsuwide.xml
   -result C:\data\
   -property "C:\DWAdminClient\property.xml"

8.5 List of messages

The following table describes a list of messages.

Table 8‒33: List of messages

Message ID

Message details

Description

DWCO1001_I

Command start.

Notifies that the command process is started.

DWCO1002_I

Command finished.

Notifies that the command process is completed.

DWCO1101_E

An option [{0}] must be specified only once.

Indicates that multiple options with the same name are specified for the argument of the command. Do not specify multiple options with same name.

The option specified multiple times is output to {0}.

DWCO1102_E

Arguments must be a pair of an option key and its value.

Indicates that only the key for an option or only a value is specified for the argument of the command. Specify a key and value pair.

DWCO1103_E

Option [{0}] is invalid.

Indicates that an invalid option was specified for the argument of the command. See 8.4 List of administrator commands and specify a valid option.

The specified invalid option is output to {0}.

DWCO1104_E

Please specify option [{1}].

Indicates that a mandatory option is not specified. Specify the mandatory option.

The mandatory option is output to {1}.

DWCO1105_E

Please specify option [{1}] within [{0}] characters.

Indicates that the number of characters specified for the option value exceeds the maximum characters that can be specified.

Specify the value for the option in the number of characters equal to or less than the allowed number of characters.

DWCO1109_E

The specified files/folders do not exist or cannot be read. (Path:{0})

The certificate file does not exist in the specified file or folder or cannot be read. Check if the certificate file exists in the specified file or folder, you have read permission, or the character code for the file is proper.

The path to the specified file or folder is output to {0}.

DWCO1110_E

Please specify an integer number between [{1}] to [{2}] for option [{3}]. (Value:{0})

A value other than an integer in the preset range was specified for the option. Specify an integer in the specifiable range for the option.

The value specified for the option is output to {0}. The smallest integer that can be specified for the option is output to {1}, the largest integer that can be specified for the option is output to {2}, and the option is output to {3}.

DWCO1112_E

The settings of Command Property File is wrong. (Setting:{0}, Value:{1})

There is an error in the command property file (property.xml). Confirm the following:

Either PASSWORD or CERTIFICATION is specified for the authentication method.

When the electronic certificate authentication is used as the authentication method, the path to the certificate file is specified.

When the electronic certificate authentication is used as the authentication method, the password for the certificate file is specified.

Correct the data in the item with an error, and then try again. The setting item name is output to {0}, and the set value is output to {1}.

DWCO1113_E

The selected files/folders do not exist or cannot be written. (Path:{0})

The specified file or folder does not exist or data cannot be written to it. Check if the specified file or folder exists, or if you have write permission.

The path to the specified file or folder is output to {0}.

DWCO1141_E

Please specify "now" in the [-downloaddate] option.

Specify now for the option -downloaddate.

DWCO1201_E

User authentication failed.

User authentication for JP1/DH - Server failed. Check the authentication information defined in the command property file.

DWCO1203_E

This user cannot use delivery because the user's password expired.

Unable to send or receive data because the password has expired. Set a new password.

DWCO1206_E

You do not have authority to execute.

The user does not have authority to execute the commands for system administrators.

DWCO1501_I

Log files which expires have been deleted. (File name:{0})

Notifies that the log file has been deleted.

The file name is output to {0}.

DWCO1502_I

Failed to delete log files which expires. (File name:{0})

Notifies that the deletion of the log file failed.

The file name is output to {0}.

DWCO1701_I

Got server status.

Notifies that the server status has been acquired successfully.

DWCO1702_I

Got server parameter.

Notifies that the server parameter has been acquired successfully.

DWCO1703_I

Set server parameter.

Notifies that the server parameter has been set successfully.

DWCO1704_E

Failed to read server parameter file. (Details:{0})

Check if the server parameter file exists, or if reading of the file is permitted.

The detailed reason is output to {0}.

DWCO1705_E

Failed to parse an XML. (Details:{0})

The format of the server parameter file is invalid. Check and revise the format.

The detailed reason is output to {0}.

DWCO1706_E

Failed to generate an XML. (Details:{0})

Check the detailed reason output to {0} and take necessary action.

DWCO1707_E

The XML format is invalid. (Details:{0})

The format of the server parameter file is invalid. Check and revise the format.

The detailed reason is output to {0}.

DWCO1708_E

A setting is wrong. (Setting:{0}, Value:{1})

There is an error in the setting items in the server parameter file. Check and review the settings.

The setting item name is output to {0}, and the set item is output to {1}.

DWCO1720_I

Got user information.

Notifies that the user information has been acquired successfully.

DWCO1721_E

The specified domain does not exist. (Domain:{0})

The specified domain does not exist. Check if an existing domain is specified.

The domain name is output to {0}.

DWCO1722_E

Failed to get user information. (Details:{0})

Check if writing to the user information export file is permitted.

The detailed reason is output to {0}.

DWCO1723_I

Imported user information.

Notifies that the user information has been imported successfully.

DWCO1724_E

Failed to import user information. (Details:{0})

Check the detailed reason output to {0} and try again.

DWCO1725_E

Failed to import user information. Please refer to the results file for details of the error. (Results file:{0})

Import of user information failed. Based on the detailed information output to the result file, correct the user information import file and try again.

The result file name is output to {0}.

DWCO1726_W

Failed to write a results file. (Details:{0})

Check if writing to the result file is permitted.

The detailed reason is output to {0}.

DWCO1730_I

Got audit log.

Notifies that the audit log has been acquired successfully.

DWCO1731_E

Failed to get audit log. (Details:{0})

Acquisition of the audit log failed.

See the detailed reason output to {0}, confirm that writing to the audit log file is permitted, and then try again.

DWCO1732_E

The specified date is wrong. (Date:{0})

Check that the date format is YYYY/MM/DD, and if the date is correct.

The date is output to {0}.

DWCO1735_I

Extracted a file/folder.

Notifies that delivery data has been ejects successfully.

DWCO1736_E

Failed to Extract a file/folder. (Details:{0})

Notifies that delivery data has been ejects failed.

The date is output to {0}.

DWCO1741_I

Got bandwidth limitation rules.

Notifies that the Refer to bandwidth limitation rules has been acquired successfully.

DWCO1742_E

Failed to get bandwidth limitation rules. (Details:{0})

Notifies that the Refer to bandwidth limitation rules has been acquired failed.

The date is output to {0}.

DWCO1743_E

Failed to output bandwidth limitation rules to an XML file. (PathDetails:{0})

Notifies that output of an XML file for the bandwidth limitation rules failed.

The date is output to {0}.

DWCO1745_I

Set bandwidth limitation rules.

Notifies that the Refer to bandwidth limitation rules has been set successfully.

DWCO1746_E

Failed to set bandwidth limitation rules. (Details:{0})

Notifies that the Refer to bandwidth limitation rules has been set failed.

The date is output to {0}.

DWCO1747_E

Failed to read bandwidth limitation rules file. (Details:{0})

Notifies that reading of an XML file for the bandwidth limitation rules failed.

The date is output to {0}.

DWCO1801_I

Got delivery information.

Notifies that the delivery information has been acquired successfully.

DWCO1802_E

Failed to get delivery information. (Details:{0})

Acquisition of the delivery information failed. Check and review the settings based on the detailed reason, and then try again.

The detailed reason is output to {0}.

DWCO1803_E

Failed to output delivery information to an XML file. (Path:{0})

Check if you have write permission for the specified file.

The path to the XML file is displayed in {0}.

DWCO1821_I

Updated delivery status. (Delivery ID:{0}, File ID:{1})

Notifies that the delivery status has been updated successfully.

The delivery ID is output to {0}, and the file ID is output to {1}.

DWCO1822_E

Failed to update delivery status. It might be caused by the following reasons: The delivery does not exist. The delivery expired. Uploading is not completed. The delivery was not approved. (Delivery ID:{0}, File ID:{1}, Details:{2})

Update of the delivery status failed.

Check if the relevant delivery exists, if its data storage period has expired, if its transmission was completed, and if its approval process has completed.

The delivery ID is output to {0}, the file ID is output to {1}, and the detailed reason is output to {2}.

DWCO1841_I

Deleted a delivery. (Delivery ID:{0})

Notifies that the delivery has been deleted successfully.

The delivery ID is output to {0}.

DWCO1842_E

Failed to delete a delivery. It might be caused by the following reasons: The delivery does not exist. Uploading is not completed. The delivery was not approved. (Delivery ID:{0}, Details:{1})

A non-existing delivery cannot be deleted. A delivery whose transfer is not completed cannot be deleted. For an unapproved delivery, try again after it is approved.

The delivery ID is output to {0}, and the detailed reason is output to {1}.

DWCO1843_E

Failed to delete a delivery. The delivery might be sending or downloading. (Delivery ID:{0}, Details:{1})

A delivery being in progress of transmission or reception cannot be deleted.

The delivery ID is output to {0}, and the detailed reason is output to {1}.

DWCO1901_E

An unexpected error occurred.

An unexpected exception occurred. Load might be concentrated on the server. Try again after a while.

If the same error keeps occurring even after some retries, contact our sales representative or support contact. Also, it is possible that the user executing the process might have been deleted in the middle of execution. Contact the representative user or a group manager.

DWCO1902_E

Unable to start the application because initialization of logs failed.

The settings for the log files are invalid. This problem could be solved by re-installation.

DWCO1903_E

Unable to start the application because reading message files failed.

The settings for the configuration file are invalid. This problem could be solved by re-installation.

DWCO1904_E

Unable to start the application because reading setting files failed.

The settings for the configuration file are invalid. This problem could be solved by re-installation.

DWCO1906_E

Failed to connect to the server. (Details:{0})

See the detailed reason, and then check and review the execution environment such as the network environment again.

The detailed reason is output to {0}.

DWCO1907_E

The server is busy. Please try again later.

The server is currently busy, and the HTTP status code 503 (Service Unavailable) is returned. Try again after a while.

DWCO1908_E

The session has timed out. Please try again.

The session is timed out. Log in again.

DWCO1909_E

The server returned an error. (Details:{0})

See the detailed reason, and then check and review the settings for the user, group, and delivery rules again.

The detailed reason is output to {0}.

DWCO1911_E

The operation of getting a lock for concurrent control timed out.

A command is already running in the same computer. Because more than one command cannot be executed simultaneously, try again after the active command ends.

If this error message frequently appears, the problem might be solved by setting a longer timeout time.

Also, the user might not have the write permission to the Windows temporary folder. Check that the temporary folder is set correctly.

DWCO1999_E

Unable to start the application.

The server is busy, and the service cannot be started. Try again after a while.

DWCO2002_I

Suspended running file transfers. (Delivery ID:{0})

Notifies that the file transfer process has been suspended.

The delivery ID is output to {0}.

DWCO2005_W

Running file transfers do not exist.

Notifies that there was no file transfer process.

DWCO2006_W

Running file transfers do not exist. (Delivery ID:{0})

Notifies that there was no file transfer process.

The delivery ID is output to {0}.

DWCO2007_I

The specified delivery was already suspended. (Delivery ID:{0})

Notified that the delivery you tried to suspend had already been suspended.

The delivery ID is output to {0}.

DWCO2008_E

Failed to suspend the specified delivery because it was already canceled. (Delivery ID:{0})

You cannot suspend a delivery that has been canceled.

The delivery ID is output to {0}.

DWCO2009_E

The specified delivery did not exist. (Delivery ID:{0})

Notifies that the specified delivery does not exist. Check if the specified delivery ID is correct.

The delivery ID is output to {0}.

DWCO2010_E

The specified delivery cannot be suspended. (Delivery ID:{0})

The specified delivery cannot be suspended because the delivery might already have been sent in the web window.

The delivery ID is output to {0}.

DWCO2022_I

Canceled running file transfers. (Delivery ID:{0})

Notifies that the file transfer process was canceled.

The delivery ID is output to {0}.

DWCO2025_I

The specified delivery was already canceled. (Delivery ID:{0})

Notified that the delivery you attempted to cancel has already been canceled.

The delivery ID is output to {0}.

DWCO2026_E

Failed to cancel the specified delivery because it was already suspended. (Delivery ID:{0})

You cannot cancel a delivery that has been suspended.

The delivery ID is output to {0}.

DWCO2027_E

The specified delivery cannot be canceled. (Delivery ID:{0})

The specified delivery cannot be canceled because the delivery might already have been sent in the web window.

The delivery ID is output to {0}.

DWCO2041_I

Set acceptance of the file transfer function to deny.

The delivery acceptance status of the file transfer function has been set to delivery denial.

DWCO2061_I

Set acceptance of the file transfer function to allow.

The delivery acceptance status of the file transfer function has been set to start delivery.

8.6 List of CSV error messages

The following table describes a list of CSV error messages. For details about CSV error messages other than those described below, see the JP1/Data Highway - Server Administrator Guide.

Table 8‒34: List of CSV error messages

No.

Error message

Description

1

You cannot delete this group (XXX) because some users belong to it. (DOMAIN, NAME_EN)

Output when users (including a child group) exist within the target group for deletion. Delete all the users in the group.

The group name (English) is output to XXX.

2

A group name (XXX) was delete in the input csv data.,Joint verification failures exist.

Output when you attempt to include a user in the group to be deleted. To make the user belong to a group, specify a group that is not a deletion target.

The group name (English) is output to XXX.

9 The data transfer command

This chapter describes how to use the data transfer command.

9.1 Overview of the data transfer command

Overview of the data transfer command is as follows.

9.1.1 The data transfer command

The data transfer command provides method which executes the file transfer facility of Data Highway - Server by a command line interface. Thereby, the data transfer command enables Data Highway - Server to cooperate with other systems, and to transfer files.

By using it combining the data transfer management command managing the file transfer, a flexible file transfer becomes possible.

In addition, for more information about Data Highway - Server, refer to the manual of Data Highway - Server. For more information about the data transfer management command managing the file transfer see 10.The data transfer management command.

Functions which the data transfer command provides is as follows.

The sending files

The receiving files

Resumption of the file transfer which is under suspending

9.1.2 Precondition for installation

A precondition required for client PC when using the data transfer command is shown below.

(1) Prerequisite software for client PC

Table 9‒1: Prerequisite software for client PC (In Windows)

OS

Full name or meaning

Windows

Windows(R) 7 Professional (32-bit or 64-bit) (Service Pack 1 or later)

Windows(R) 7 Enterprise (32-bit or 64-bit) (Service Pack 1 or later)

Windows(R) 7 Ultimate (32-bit or 64-bit) (Service Pack 1 or later)

Windows(R) 8.1 (32-bit or 64-bit) (with or without Update)#

Windows(R) 8.1 Pro (32-bit or 64-bit) (with or without Update) #

Windows(R) 8.1 Enterprise (32-bit or 64-bit) (with or without Update) #

Windows(R) 10 Home (32-bit or 64-bit)

Windows(R) 10 Pro (32-bit or 64-bit)

Windows(R) 10 Enterprise (32-bit or 64-bit)

Windows Server(R) 2008 R2 Standard (Service Pack 1 or later)

Windows Server(R) 2008 R2 Enterprise (Service Pack 1 or later)

Windows Server(R) 2008 R2 Datacenter (Service Pack 1 or later)

Windows Server(R) 2012 Standard

Windows Server(R) 2012 Datacenter

Windows Server(R) 2012 R2 Standard (with or without Update)

Windows Server(R) 2012 R2 Datacenter (with or without Update)

Windows Server(R) 2016 Standard

Windows Server(R) 2016 Datacenter

Linux

Red Hat Enterprise Linux(R) Server 6

Red Hat Enterprise Linux(R) Server 7

CentOS 6

CentOS 7

Oracle Linux 6

Oracle Linux 7

SUSE Linux Enterprise Server 12 (with or without Service Pack 1)

SUSE Linux Enterprise Server 15

#

Operations on Modern UI are not supported.

(2) Java software

Available Java software includes:

Java Runtime Environment Version 8.0 (32-bit) (Update 51or later)#1

Java Runtime Environment Version 8.0 (64bit) (Update 51or later)#1

Java software included in this product#2

#1: Not required if you use the Java software included in this product.

#2: You need the software when executing the data transfer command on the JP1/DH - Server machine. The software is stored in the following location:

In windows

JP1/DH-Server-installation-folder\uCPSB\jdk\jre

In Linux

/opt/jp1dh/server/uCPSB/jdk/jre

Important

You need to use JRE from Oracle when executing the data transfer command in an environment other than the JP1/DH - Server machine.

(3) Free space of hard disk

When you download a file, the system requires free space of hard disk twice as much as the file size.

And, the drive which was installed the data transfer command requires free space of hard disk more than the file size which you will download.

(4) Restriction

Cannot specify surrogate pairs in this command. Do not specify surrogate pairs for user name, installation folder name and arguments (Subject, Message, File path and so on).

9.2 Installation of the data transfer command

Installation of the data transfer command is as follows.

9.2.1 Installation of the data transfer command (In Windows)

This subsection describes how to install the data transfer command to use the command in a Windows OS.

(1) Copying the executable file (In Windows)

Before the installation, copy the executable file of the data transfer command (DWClient.zip) in any folder on the machine where the command is to be executed.

The executable file of the data transfer command is installed together with the installation of JP1/DH - Server. The storage folders of the executable file are as follows:

When JP1/DH - Server is constructed on Windows

When you use the commands that come with Java:

JP1/DH-Server-installation-folder\Client\DWClientApp.zip

When you use the commands that do not come with Java (traditional commands):

JP1/DH-Server-installation-folder\Client\DWClient.zip

When JP1/DH - Server is constructed on Linux

When you use the commands that come with Java:

/opt/jp1dh/server/Client/DWClientApp.zip

When you use the commands that do not come with Java (traditional commands):

/opt/jp1dh/server/Client/DWClient.zip

(2) Checking the prerequisite software (In Windows)

(a) Checking the prerequisite OS

See 9.1.2 Precondition for installation and make sure that the software on the machine where the data transfer command is to be installed satisfies the prerequisites of that command.

(b) Checking JRE

It's confirmed that JRE is installed.

If the OS in use is Windows 8.1, right-click the Start window and open All Apps in the procedure below, instead of using the Start menu.

Important

If you use the commands that come with Java, you do not need to check JRE.

The procedure below describes how to set the environment variable on Windows 7.

Start menu, click Control panel.

Click program.

A program and the function are clicked.

Refer to 9.1.2 Precondition for installationIt's confirmed whether JRA meets the condition.

When JRE isn't installed, or the case which doesn't satisfy the precondition install JRE of the version which satisfies the precondition, please.

(3) Installating JRE (In Windows)

How to introduction of JRE.

When JRE isn't installed or the version doesn't satisfy the precondition, it's put into effect.

Important

You do not need to install JRE when:

You run the data transfer command on the machine where JP1/DH - Server is installed.

You use the commands that come with Java.

An installation file of JRE is downloaded from the site of Oracle company.

A downloaded installation file is carried out.

Please complete the installation work in accordance with the instructions on the screen.

(4) Setting the environment variable (In Windows)

An installation folder of JRE used in the data transfer command is designated as an environment variable.

When multiple versions of JRE are installed on the system, and when the standard JRE of the system is different from the 9.1.2 Precondition for installation, you need to designate the JRE installation folder as the environment variable. You can view the version information of the standard JRE by executing java -version in the command prompt.

The procedure below describes how to set the environment variable on Windows 7.

From the Windows Start menu, right-click Computer and select Properties.

Select Advanced system settings.

The System Properties window opens.

Select the Advanced tab, and then Environment Variables....

Either select User variables for windows-user-name and then New...or System variables and then New....

Enter DW_CMD_JRE_HOME for Variable name and the JRE installation folder's path for Variable value and then click OK.

The following shows the path to the JRE installation folder when the program is installed in the default installation location:

C:\Program Files\Java\jre1.8.0_31

Click OK.

Important

If you run the data transfer command on the machine where JP1/DH - Server is installed, specify the path of JRE included in JP1/DH - Server for the Variable value. The installation path for JRE is as follows:

JP1/DH-Server-installation-folder\uCPSB\jdk\jre

(5) Installing (In Windows)

The following procedure shows how to install the data transfer command.

A user using the data transfer command must have write permission to the following folders:

Installation folder for the data transfer command

Temporary folder for the command executing user

Decompress the data transfer command archive file (DWClientApp.zip or DWClient.zip).

A DWClientApp.zip folder or DWClient folder is created.

Move the folder created in step 1 to another folder.

9.2.2 Installing the of the data transfer command (in Linux)

This subsection describes how to install the data transfer command to use the command in a Linux OS.

(1) Copying the executable file

Before the installation, copy the executable file of the data transfer command (DWClientApp.zip or DWClient.tar.gz) in any folder on the machine where the command is to be executed.

The executable file of the data transfer command is installed together with the installation of JP1/DH - Server. The storage folders of the executable file are as follows:

When JP1/DH - Server is constructed on Windows

When you use the commands that come with Java:

JP1/DH-Server-installation-folder\Client\DWClientApp.tar.gz

When you use the commands that do not come with Java (traditional commands):

JP1/DH-Server-installation-folder\Client\DWClient.tar.gz

When JP1/DH - Server is constructed on Linux

When you use the commands that come with Java:

/opt/jp1dh/server/Client/DWClientApp.tar.gz

When you use the commands that do not come with Java (traditional commands):

/opt/jp1dh/server/Client/DWClient.tar.gz

(2) Checking the environment prerequisites (in Linux)

(a) Checking the prerequisite OS

See 9.1.2 Precondition for installation and make sure that the software on the machine where the data transfer command is to be installed satisfies the prerequisites of that command.

(b) Checking JRE

It's confirmed that JRE is installed.

Important

If you use the commands that come with Java, you do not need to check JRE.

(3) Installating JRE (in Linux)

How to introduction of JRE.

When JRE isn't installed or the version doesn't satisfy the precondition, it's put into effect.

Important

You do not need to install JRE when:

You run the data transfer command on the machine where JP1/DH - Server is installed.

You use the commands that come with Java.

An installation file of JRE is downloaded from the site of Oracle company.

A downloaded installation file is carried out.

Please complete the installation work in accordance with the instructions on the screen.

(4) Setting the system environment variable (in Linux)

Add the environment variable DW_CMD_JRE_HOME to the configuration file for the login shell you are using.

Set the path to the installation folder for JRE to the environment variable DW_CMD_JRE_HOME.

A setting example is shown below.

When using tcsh as the login shell, add the setting to the .../.tcshrc file.

# .tcshrc

# User specific aliases and functions

alias rm 'rm -i'
alias cp 'cp -i'
alias mv 'mv -i'

set prompt='{%n@%m %c}# '

# Command
setenv DW_CMD_JRE_HOME /usr/java/jre

When using bash as the login shell, add the setting to the .../.bashrc file.

# .bashrc

# User specific aliases and functions

alias rm='rm -i'
alias cp='cp -i'
alias mv='mv -i'

# Source global definitions
if { -f /etc/bashrc }; then
        . /etc/bashrc
Fi

# Command
export DW_CMD_JRE_HOME=/usr/java/jre

Important

When you execute the data transfer command on the machine where JP1/DH - Server is installed, specify the path of JRE included in JP1/DH - Server for the installation directory for JRE. The installation path for JRE is as follows:

/opt/jp1dh/server/uCPSB/jdk/jre

(5) Installing (in Linux)

The following procedure shows how to install the data transfer command.

Create a directory for installing the data transfer command. An example of a directory is as follows:

mkdir /usr/bin/DWClient

Move to the created directory.

cd /usr/bin/DWClient

Copy the executable file (DWClientApp.zip or DWClient.tar.gz) that was copied to the folder you selected, to the directory where you moved in step 2.

Decompress the executable file (DWClientApp.zip or DWClient.tar.gz) stored in the installation directory created in step 1.

In DWClientApp.tar.gz

tar zxvf DWClientApp.tar.gz

In DWClient.tar.gzの場合

tar zxvf DWClient.tar.gz

9.3 Reference

This section describes commands which are provided by the data transfer command and settings.

9.3.1 Common specifications

Describe common specifications of the data transfer command. The contents are as follows.

Command format and the grammatical rule

Common options

Return code

Log outputting

File path

Configuration files

Operation at the time of the data transfer failure

The execution at the same time on the same PC

(1) Command format and the grammatical rule

Describe the format, the grammatical rule and the specification method of the data transfer command. In addition, in the case of Linux, read the extension "bat" of a command name as "sh".
DWClient.bat
 Command type
 { -Option A | Value a { Value b { Value c...}}}…(i)
 { -Option B | Value a { Value b { Value c...}}}…(i)

Call (i) "Option", and call "Argument" summarizes the (i).

Specify the data transfer command in accordance with the following grammatical rule.

A specification order is arbitrary when you specify two or more options.

Cannot specify two or more same options.

The command becomes an error when you specify the option not existing.

Enclose by double quotes the value if you specify the value including blank.

Specify an escape character (^) before the character if you specify the command line special character & (Ampersand), ^ (Circumflex accent) and so on.

Cannot specify " (double quotes).

Specify the command whose length is less than 8192 characters.

When you specify two or more values to one option, divide and specify between values by blank.

When two or more values are specified as an option, the value specified first is used as the option in which only one has a value. All the values are used as an option with two or more values.

(2) Common options

Common options of the data transfer command is as follows.

Table 9‒2: The list of common options

No

Options

Meaning

1

-property

Specify the path of the Command Property File (property.xml) which is described the information on User ID/Password to send or receive the data. For more information about the Command Property File, refer to 9.3.1(6) (a) The Command Property File (property.xml).

2

-concurrenttimeout

If the data transfer command has already been executed, this option means the timeout value (seconds) to wait the termination of other execution. Specify 0 to 86400 (24 hours). If you specify 0, the data transfer command ends without the end of execution of other data transfer commands. If you do not specify the timeout value, 0 is applied.

(3) Return code

The return code which is outputted by the execution of the data transfer command is as follows.

In Windows, if it is immediately after termination of the data transfer command, you can check the return value with environment variable "ERRORLEVEL". For example, if you execute "echo %ERRORLEVEL%" by the command line interface immediately after termination of the data transfer command, the return code can be outputted to the standard output.

Table 9‒3: The list of the return code

Return code

Explanation

0

The data transfer command ended normally.

2

The state of the suspended is ended.

3

Refusal state of the reception is ended.

4

The data transfer command ended with warning. Although some tasks ended abnormally, other tasks ended normally.

8

The data transfer command does not execute because another data transfer command has already been executed.

12

Cancellation is ended.

16

The data transfer command ended abnormally. When the error occurred, the following processing is not executed. Details of the error are outputted to log files.

32

Java VM ended abnormally.

64

Java VM could not be run because of the invalid path was specified to the environment variable.

(4) Log outputting

This section describes the application log which is outputted by the data transfer command.

(a) Log level

The list of the application log's log level is as follows.

Table 9‒4: The list of the application log's log level

No

Log level

ID

Severity level

Contents

For monitoring

1

Error

E

Need to manage by representation user or system administrator.

Processing of the data transfer command cannot be continued because of the following cause.

The problem of execution environment such as network environment.

The problem of the input parameter of the data transfer command.

This failure is required to manage by representation user. Management by a system administrator may be required. In this case, the return code 16 or 8 is outputted to log files.

Yes

2

Warn

W

Temporary failures

When you execute the data transfer command, the abnormal event has occurred. Processing of the data transfer command is continued. In this case, the return code 4 is outputted to log files.

Alternative

3

Info

I

Usual events

This log level indicates processing is executing normally.

No

(b) Log files

The specification of log files is as follows.

Table 9‒5: The specification of log files

No

Items

Format or value

1

File format

Text format

2

Character code

UTF-8

3

Newline code

CR+LF

Log files are outputted to the following path. The storage period is 30 days.

installation-folder\log\dwc-yyyyMMddhhmmss-GUID.log

(Explanatory notes)

installation-folder: The folder which was installed the data transfer command.

yyyyMMddhhmmss : The execution date-time of the data transfer command. (yyyy : 4 figures of A.D., MM : 2figures of month, dd : 2figures of day, hh : 2figures of time (24hours), mm : minute, ss : second)

GUID : The random character string of GUID format

Important

Whenever you execute the data transfer command, a new log file is outputted to the default output folder. When the log output folder does not exist, it is created automatically and the log is outputted. In addition, if you execute the data transfer command after the storage period, log files will be deleted automatically.

(c) Output format

The output format of the application log is as follows.

Date Delimiter Time Version Log level Message ID Message text

The example output of the application log is as follows.

2011/04/19T20:38:21.500 02-07    INFO  DWCO1001_I Command start.
2011/04/19T20:38:28.250 02-07    INFO  DWCO1041_I Sending files completed.
2011/04/19T20:38:28.250 02-07    INFO  DWCO1002_I Command finished.

The output contents of the application log are as follows. For concrete messages, refer to 9.4.2 Messages of the data transfer command.

Table 9‒6: The output contents of log files

No

Items

Figures

Output contents

1

Date

10

yyyy/MM/dd

yyyy : 4 figures of A.D.

MM : 2figures of month

dd : 2figures of day

2

Delimiter

1

T

3

Time

12

HH:mm:ss.SSS

HH : 2figures of time (24hours)

mm : minute

ss : second

SSS : millisecond

In addition, the output time is the time of client.

4

Version

8

02-07

Left-justification, and right-hand side is filled up with space.

5

Log level

5

Log level. This is left-justification. For more information, refer to 9.3.1(4) (a) Log level.

6

Message ID

10

ID to specify the messages.

XXXXYYYY_Z

XXXX : Product code

YYYY : Message number

Z : ID of the log level (I : Info, W : Warn, E : Error)

7

Message text

Variable length

The contents of message

Newline may be included when it includes the stack trace information on Java.

(5) File path

Specify the file path of the data transfer command with an absolute path.

The path notation can be specified in the format of both UNC format and local path format. But the transmission speed may become a low under the following condition because the transmission speed between the client and the network folder becomes a bottleneck.

When you send files on the network

When you receive files by the network folder

In such a case, we recommend you to specify the local file path which is specified as the data transfer command because the fast communication which is the feature of Data Highway - Server cannot be employed efficiently.

(6) Configuration files

The explanation about the configuration files is as follows.

Table 9‒7: The list of the configuration files

No

Configuration files

Explanation

1

The Command Property File

Specify the information on user's User ID/Password.

2

The Received List File

Received delivery information is indicated.

(a) The Command Property File (property.xml)

This is the XML file which is described the information on user's User ID/Password. Specify this file's path as an argument when you execute the data transfer command. Since the password is described with plain text, set up suitable security such as setting up the right to access.

The specification of the Command Property File is as follows.

Table 9‒8: The specification of the Command Property File

No

Items

Format or value

1

File format

XML format

2

Character code

UTF-8

3

Newline code

CR+LF

The format of the Command Property File is as follows.

<?xml version="1.0" encoding="utf-8" ?>
<property>
    <serverUrl>value</serverUrl>
    <userId>value</userId>
    <password>value</password>
    <authenticationMethod>value</authenticationMethod>
    <certificatePath>value</certificatePath>
    <certificatePassword>value</certificatePassword>
    <useProxy>value</useProxy>
    <proxyHost>value</proxyHost>
    <proxyPort>value</proxyPort>
    <proxyId>value</proxyId>
    <proxyPassword>value</proxyPassword>
    <errorNotice>value</errorNotice>
    <errorMailSubject><![CDATA[value]]></errorMailSubject>
    <errorMailMessage><![CDATA[value]]></errorMailMessage>
    <notificationToCompanion>value</notificationToCompanion>
</property>

Each setting item is as follows.

Table 9‒9: Setting items of the Command Property File

No

Setting items

Element name

Explanation

Default value

1

Connection server URL

serverUrl

Specify URL of the connection server.

(Example) https://jp1dh-hitachi.co.jp/

N/A

2

User ID

userId

Specify the User ID for login to the connection server.

When you specify "Login by Certification" as Authentication method, you can omit to specify this setting item. When you specify "Login by Password" as Authentication method, you must specify this setting item.

(Example) user@company

N/A

3

Password

password

Specify the Password for login to the connection server.

Authentication system of the login user appoints a password registered with a directory server of the connection at the time of "LDAP authentication system".

When you specify "Login by Certification" as Authentication method, you can omit to specify this setting item. When you specify "Login by Password" as Authentication method, you must specify this setting item.

Specify the password character string#1 by plain text, or specify the digest#2 of the password character string by the hexadecimal format. Use "LDAP authentication" for authentication system, cannot appoint the digest form.

Example of the specification in plain text : password

When you specify this setting item by the digest, the digest character string of 40 characters is filled in after "text:HEX:". The digest character string portion does not have distinction of a capital letter and a small letter.

The digest can be specified what is displayed on the password area at exporting.

Example of the specification in the digest : text:HEX:5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8

In addition, you cannot specify the character string which starts in "text:HEX:" as the password character string of plain text.

(Example) password

N/A

4

Authentication method

authenticationMethod

Specify the authentication method. When you omit to specify this setting item, "Login by Password" is applied.

PASSWORD : Login by Password

CERTIFICATION : Login by Certification

PASSWORD

5

Path of the certificate file

certificatePath

Specify the path of the certificate file with an absolute path. When you specify "Login by Password" as Authentication method, you can omit to specify this setting item. When you specify "Login by Certification" as Authentication method, you must specify this setting item.

N/A

6

Password of the certificate file

certificatePassword

Specify the password of the certificate file.

When you specify "Login by Password" as Authentication method, you can omit to specify this setting item. When you specify "Login by Certification" as Authentication method, you must specify this setting item.

N/A

7

Proxy use flag

useProxy

Specify whether the command uses the proxy server.

When the command uses the proxy server : true

When the command does not use the proxy server : false

This setting item does not distinguish a capital letter and a small letter.

(Example) true

false

8

Hostname of the proxy server

proxyHost

Specify the hostname or IP address of the proxy server.

(Example1) Proxyserver

(Example2) 192.168.0.1

N/A

9

Port number of the proxy server

proxyPort

Specify the port number of the proxy server. This item can be specified with the range of 0 to 65535.

(Example) 3128

N/A

10

Authentication ID of the proxy

proxyId

Specify the Authentication ID of the proxy server.

(Example) user

N/A

11

Authentication password of the proxy

proxyPassword

Specify the Authentication password of the proxy server.

(Example) password

N/A

12

Need of command-error email notifications

errorNotice

Specify whether to send an email notification of an error when it occurs during command execution.

To enable notifications: true

To disable notifications: false

This item is not case-sensitive. If you specify a value other than specifiable values, an error occurs. If the item itself is omitted, it is set to false.

If more than one tag is present, the value in the last tag will be effective.

(Example) true

false

13

Message subject of command-error email notifications

errorMailSubject

Specify the message subject of command-error email notifications with no more than 128 characters.

If you specify a value for this item, the subject of notifications is created with a product name added to the specified subject value.

If this tag is omitted, the system's default message subject is used to send error notification messages.

You can use characters that are available for message subjects in general.

Note that if the subject contains any &, <, or > characters, you must enter them in the form of XML escape characters, as listed in Table 9-10. If you specify a value other than specifiable values, an error occurs.

If more than one tag is present, the value in the last tag will be effective.

N/A

14

Message body of command-error email notifications#3

errorMailMessage

Specify the message body of command-error email notifications with no more than 512 characters.

If this tag is omitted, the system sends error notification messages with no body text.

You can use characters that are available for the message body in general.

Note that if the message body contains any &, <, or > characters, you must enter them in the form of XML escape characters, as listed in Table 9-10. If you specify a value other than specifiable values, an error occurs.

If more than one tag is present, the value in the last tag will be effective.

N/A

15

Need of error notification messages to senders or recipients of delivery

notificationToCompanion

Specify whether to send error notification messages upon command execution to recipient users of delivery for sending errors, or to sender users for reception errors.

Note that this tag is not for data transfer management commands.

To enable notifications: true

To disable notifications: false

This item is not case-sensitive. If you specify a value other than specifiable values, an error occurs. If the item itself is omitted, it is set to false.

If more than one tag is present, the value in the last tag will be effective.

(Example) true

N/A

#1

One-byte alphabet and numbers can be used. The number of letters must meet the requirements of authentication rules. The following symbols can also be used.

!"#$%&'()*+,-./:;<=>?@{\}^_`{|}~

#2

The digest is the format which Data Highway - Server stores the password in the database. It is impossible to restore an actual password character string from this value. The password information is outputted with the digest format on Password in the export CSV.

#3

An error notification message looks like as follows:

JP1/DH - Server
--------------------------------------------------------------------
Command error notification
--------------------------------------------------------------------
A command error occurred.
Executed by: name-of-the-user-who-executed-the-command (email-address-of-this-user)
Command type: type-of-the-command
message-body-specified-by-the-user
Note: This is an auto-generated message. Please do not reply to this message.
                                                        JP1/DH - Server

Most portions of the notification, except for the message body specified by the user, are based on the language set for the user who executed command (in Japanese, English, or Chinese).

Specify the value in accordance with the input rule of XML. Especially, be careful when you specify the special symbol in XML. When you specify the following character, replace it to the entity reference (escape character) or use the CDATA section. In addition, save the command property file in UTF-8 encoding. If the file is encoded in a different character set, the system may fail to read it.

Table 9‒10: Escape character of XML

No

Character

Notation by the entity refernce

1

<

&lt;

2

>

&gt;

3

&

&amp;

4

"

&quot;

5

'

&apos;

In addition, control characters such as the newline may be shown with the entity according to the standard of XML. The order of the appearance of XML's attribute does not have sequentiality according to the protocol of XML.

Example for setting is as follows.

<?xml version="1.0" encoding="utf-8" ?>
<property>
    <serverUrl>https://jp1dh-hitachi.co.jp/</serverUrl>
    <userId>user@company</userId>
    <password>password</password>
    <authenticationMethod>CERTIFICATION</authenticationMethod>
    <certificatePath>C:/hitachi/hitachi01.dat</certificatePath>
    <certificatePassword>hitachi01</certificatePassword>
    <useProxy>true</useProxy>
    <proxyHost>proxyserver</proxyHost>
    <proxyPort>8080</proxyPort>
    <proxyId>proxyid</proxyId>
    <errorNotice>true</errorNotice>
    <errorMailSubject><![CDATA[Error notification]]></errorMailSubject>
    <errorMailMessage><![CDATA[Check the command that caused the error.]]></errorMailMessage>
    <notificationToCompanion>true</notificationToCompanion>
    <proxyPassword>proxypassword</proxyPassword>
</property>

(b) The Received List File

The received list is described in this file. Specify this file's path as an argument when you execute the data transfer command. The delivery which are described in this file are treated as being received, and they are not received after that.

Do not modify this file because it is updated automatically when the command receive the data. And, it is necessary to prepare another file for every user of Data Highway - Server.

(7) Operation at the time of the data transfer failure

When a certain error occurs during execution of the data transfer command and the command fails, the data transfer is cancelled including the following processing. The retry is not executed automatically. Send or receive the data again.

If you specified the -resumestatus option to transfer or receive the data, you can resume the transferring or reception by using the RESUME command. For details, see 9.3.2 (3) Resumption of the file transfer which is under suspending.

(8) The execution at the same time on the same PC

The data transfer command cannot be executed at the same time on the same PC. When the command is executed at the same time on the same PC, it becomes in a suspended state while the timeout which is specified as options is passed. However, even if it is the case on the same PC, when OS account which executes the data transfer command is divided, it can be executed at the same time according to the number of the execution account.

However, even on the same computer, if you use a separate Windows account to execute an administrator command, you can simultaneously execute an equal number of commands as the number of such accounts.

In addition, when multiple commands were in the standby state, the order of execution might be different from the order of activation. For example, if command B and command C go into the standby state while command A is being executed, the command to be executed after command A ends is either command B or command C.

The administrator command can be executed at the same time on the same PC. The administrator command and data transfer command can be executed at the same time on the same PC.

9.3.2 The list of the data transfer command

The list of the data transfer command is as follows. In addition, in the case of Linux, read the extension "bat" of a command name as "sh".

Table 9‒11: The list of the data transfer command

No

Function

Command

Explanation

Refer to

1

The sending and receiving files

DWClient.bat UPLOAD

Send files.

9.3.2(1) The sending files

2

DWClient.bat DOWNLOAD

Receive files.

9.3.2(2) The receiving files

3

Resumption of the file transfer which is under suspending

DWClient.bat RESUME

Resume the file transfer which is under suspending.

9.3.2(3) Resumption of the file transfer which is under suspending

Important

The user who is not registered to the system cannot transfer files by using the data transfer command. You can send files to unregistered users, but you cannot receive them by the data transfer command.

(1) The sending files

Send files.

(a) Format

DWClient.batUPLOAD
   {{{-to email-address {-toname name }{-todivision division}}|#
     {-cc email-address {-ccname name }{-cc division name}}|#
     {-bcc email-address {-bccname name }{-bcc division name}}}|#
    {-destinationfile the path of the Destination File}}
    -file {file path {file path}}|{folder path {folder path}}...
   {-title title}
   {-message message | -messagefile message file}
   {-openpassword open password}
   {-resumestatus the folder which is stored the resumption information file}
   [-getdeliveryinfo the path of the delivary information file]
   -property the path of the Command Property File
   {-concurrenttimeout timeout time (second)}

#

Specify one or more options among these.

Important

Some options cannot be specified together. For details about the options, see (b) Argument.

(b) Argument

Table 9‒12: The argument of sending files

No

Option

Explanation

1

-to

Specify the address to send by to. You can specify the email address#1 or the group name (English) #2. Do not distinguish a capital letter and a small letter.

When @ (atmark) is not contained in this value, it is registered as a group name.

When you specify two or more addresses, divide them with a colon (:).

You can specify to, cc, and bcc to the maximum number of the recipients set up by Data Highway - Server side in all. For more information about settings of the maximum number, refer to the manual JP1/Data Highway - Server Configuration and Administration Guide. You can also specify the email address and the group name together.

2

-toname

Specify the address name#3 which is specified to -to option with colon (:) division.

You can specify to the number which is specified to -to option. When the specified arguments are less than the number of -to option, it is considered that the specification was omitted.

When you specify the group name as the address, this option is ignored.

3

-todivision

Specify the address division#4 which is specified to -to option with colon (:) division.

You can specify to the number which is specified to -to option. When the specified arguments are less than the number of -to option, it is considered that the specification was omitted.

In addition, you cannot include the colon (:) to the division.

When you specify the group name as the address, this option is ignored.

4

-cc

Specify the address to send by cc. You can specify the email address#1 or the group name (English) #2.

The specification method is the same as that of -to option.

5

-ccname

Specify the address name#3 which is specified to -cc option with colon (:) division.

You can specify to the number which is specified to -cc option. When the specified arguments are less than the number of -cc option, it is considered that the specification was omitted.

6

-ccdivision

Specify the address division#4 which is specified to -cc option with colon (:) division.

You can specify to the number which is specified to -cc option. When the specified arguments are less than the number of -cc option, it is considered that the specification was omitted.

In addition, you cannot include the colon (:) to the division.

7

-bcc

Specify the address to send by bcc. You can specify the email address#1 or the group name (English) #2.

The specification method is the same as that of -to option.

8

-bccname

Specify the address name#3 which is specified to -bcc option with colon (:) division.

You can specify to the number which is specified to -bcc option. When the specified arguments are less than the number of -bcc option, it is considered that the specification was omitted.

9

-bccdivision

Specify the address division#4 which is specified to -bcc option with colon (:) division.

You can specify to the number which is specified to -bcc option. When the specified arguments are less than the number of -bcc option, it is considered that the specification was omitted.

In addition, you cannot include the colon (:) to the division.

10

-destinationfile

It is used when specifying recipients by CSV form file. Specify the path of the Destination File which indicated recipients. It cannot specify simultaneously with other recipients specification options shown below.

-to, -cc, -bcc

-toname, -ccname, -bccname,

-todivision, -ccdivision, -bccdivision

For more information about Destination File see 9.3.2 (1) (e) Destination File.

If the version of Data Highway - Server is 10-50 or later, this option can be used. When this option to less than 10-50 Data Highway - Server version is specified, an error of "DWCO1913_E The server returned an error. Server does not support this command. " occurs.

11

-file

Specify the path of sending files or folders.

When you specify two or more files or folders, divide them by a half space. You can specify to ten at the maximum. But when the maximum of the number of files is specified as less than ten by the delivery policy, it can be specified to the number.

12

-title

Specify the subject. You can specify to a hundred characters at the maximum. When this option is omitted, the subject is a blank. But the subject of the email is applied the system default subject.

13

-message

Specify the messages which are described on the email. You can specify to 256 characters at the maximum. When this option is omitted, the message is a blank. Cannot specify the newline.

14

-messagefile

Specify the path of the text file which is described message to write to the email.

The character code of the text file must be described with UTF-8. If the text file is not described with UTF-8, it may be displayed incorrectly.

In addition, BOM and the newline code are not cared about their existence. You can specify to 4,096 characters at the maximum. But when the file is attached BOM, you can specify to 4,095 characters at the maximum.

The newline is treated as one character.

When this option is omitted, the message is a blank. When this option is specified with -message option, the command ends with an error.

15

-openpassword

Specify the open password for sending to the unregistered address. When this option is omitted, the open password is a blank. But the command ends with an error because the open password is indispensable for sending to the unregistered address.

When you specify the open password for sending to the registered address, it is not used and ignored.

An open password must be between 6 and 32 letters, include two or more kinds of characters (numbers, small letters, big letters, symbols). You can use the following symbols.

!"#$%&'()*+,-./:;<=>?@{\}^_`{|}~

In addition, when the open password is surrounded by " (double quote), the inner character is considered as the password. For example, if the specified password is "Password01", then Password01 is the open password.

16

-resumestatus

Specify the folder path which is stored the information to resume sending.

When the sending is suspended by the demand of the suspended from Data Highway - Server, the resumption information file is saved to the path which is specified by this option.

If the resumption information file is already existed in the specified folder, the file is overwritten. In addition, even if you specify this option, the command cannot send in the following case.

When Compress Method in the Delivery Policy is "Standard" #

When the folder is specified to the -file option

When Compress Level in the Delivery Policy is specified {STRONG} or {MIDDLE} or {WEAK}

# When Compress Method in the Delivery Policy is "Extended", or when Compress Method in the Delivery policy cannot be chosen, the command is able to send files.

When the file transfer ended normally or the file transfer is cancelled by the demand of the cancellation from Data Highway - Server, the resumption information file is deleted.

17

-getdeliveryinfo

Specify the output file path when creating a delivery information file. A delivery information file that contains delivery information about when the files were sent is output in XML format.

If a file with the same name exists in the specified file path, the file is overwritten. If you specify this option when a file or folder to be downloaded does not exist, no delivery information file is output.

For details about the format of the delivery information file, see When you specify -getdeliveryinfo option of 9.3.2(2)(c) Description.

18

-property

Refer to 9.3.1(2) Common options.

19

-concurrenttimeout

#1

One-byte alphabet and numbers and more than 256 characters can be used to e-mail address.

You cannot use a space character or the following symbols:

/ \ ? * : | " # $ < > @ ^ { } .

#2

One-byte alphabet and numbers and more than 200 characters can be used to group name.

You cannot use a space character or the following symbols:

( / \ ? * : | " < > @ ^ )

A group name including only a space character or period cannot be specified.

#3

One-byte alphabet and numbers and more than 200 characters can be used to name.

You cannot use a space character or the following symbols:

( / \ ? * : | " < > # @ ^ { } $ )

A name including only a space character or period cannot be specified.

#4

You can enter no more than 1024 characters to division.

(c) Description

The details of the sending files command is as follows.

(i) Options which cannot be specified by the sending files command

The following options which are specified when the sending files command is executed cannot be used as arguments of executing. Delivery Rules and Delivery Policy which is determined by the sender and the address is applied as well as settings by Web.

(ii) Difference from sending files by Web

The sending files command has the following difference compared with the case of operating by Web.

Cannot send the shortcut file.

Cannot deliver the message only. It is necessary to send one or more files.

(iii) The user name such as Receiver's address which is described in the Delivery Notification email

When you send files without the name of address, the name which is registered in the system is applied.

(iv) When you send files to user who is not displayed in Address List

When all of the following condition is true, the sending file command ends with failure.

You do not have the authority to send files to arbitrary email address.

You send files to user who is not displayed in Address List.

At this time, it is recorded on the audit log as "ILLEGAL_INTERFACE_CALL".

(v) Sending files for inactivated users

You can also send files for inactivated users.

(d) The example for execution

DWClient.bat UPLOAD
 -to "user@mailaddress.com"
 -file "C:\send\file.txt"
 -title "title"
 -message "message"
 -resumestatus "C:\DWCLient\temp"
 -getdeliveryinfo C:\deliveryinfo.xml
-property "C:\DWCLient\property.xml"

(e) Destination File

When you use the -destinationfile option, use a CSV-formatted file to specify destinations. The destination file should contain one destination in a single row. Use UTF-8 (without BOM) as the character code when creating the file.

The table below shows the format of the destination file. Note that the information in the file is not case sensitive.

Table 9‒13: Format of the Destination File

No

Items

Explanation

1

ADDRESS_TYPE(the type of recipients)

Specify the type of mail that sends to recipients.

Specify one from [TO], [CC], or [BCC].

This setting item does not distinguish a capital letter and a small letter.

This setting item is mandatory.

2

DESTINATION(recipients)

Specify of recipients the email address or the group name.

The character which can be specified is the same as [-to][-cc][-bcc] option.

This setting item is mandatory.

3

NAME(the name of recipients)

Specify the name of recipients.

The character which can be specified is the same as [-toname][-ccname][-bccname] option.

When you specify the group name as [DESTINATION], this option is ignored.

This setting item is not mandatory.

4

DIVISION(the division of recipients)

Specify the division of recipients.

The character which can be specified is the same as [-todivision][-ccdivision][-bccdivision] option.

When you specify the group name as [DESTINATION],, this option is ignored.

This setting item is not mandatory.

The sample of Destination File is shown below.

TO,testuser01@hitachi.co.jp,Test user 1, the 1st designing department
CC,testuser02@hitachi.co.jp,Test user 2, the 1st designing department
BCC,group01,,

You can specify recipients to the maximum number of the recipients set up by Data Highway - Server side in all. For more information about settings, refer to the manual JP1/Data Highway - Server Configuration and Administration Guide.

(2) The receiving files

Receive files or folders of the delivery which are not described on the Received List File.

In addition, you cannot receive sending to the unregistered user in the system by the receiving file command.

(a) Format

DWClient.bat DOWNLOAD
 -savedir the folder which is saved the download file
 -receivedlist file path of the Received List File
 { -makesubdir}
 { -notoverwrite}
 { -resumestatus the folder which is stored the resumption information file}
 { -getdeliveryinfo}
 { -newarrivalexitcode}
 { -deliveryid Delivery ID}
 { -reservetransferlimit}
 -property the path of the Command Property File
 {-concurrenttimeout timeout time (second)}

(b) Argument

Table 9‒14: The argument of receiving files

No

Option

Explanation

1

-savedir

Specify the folder path which is saved the download file. Specify the existing folder. When the specified folder is not existed, the command ends with an error.

2

-receivedlist

Specify the path of the Received List File.

When the specified file is not existed, it is created automatically.

3

-makesubdir

When you specify this option, the folder (Delivery ID sub-folder) is created per delivery (Delivery ID) under the folder which is specified as -savedir option, and files are divided and saved per delivery. So, if the delivery is different, you can save the same name file or folder. The folder name which is created per delivery consists of the number maximum of 19 digits like Delivery ID.

When all of the following condition is true, it is overwritten and saved by the file or folder which has new File ID.

The same name file or folder exists in the same delivery.

The -notoverwrite option is not specified.

When this option is omitted, the file or folder is downloaded to the specified folder as -savedir option.

4

-notoverwrite

When this option is specified, if the same name file or folder exists in the folder which is saved the download file, the download is skipped.

When the download is skipped, the command outputs messages and logs.

When this option is omitted, even if the same name file or folder exists in the folder which is saved the download file, it is overwritten.

5

-resumestatus

Specify the folder path which is stored the information to resume receiving. When the receiving is suspended by the demand of the suspended from Data Highway - Server, the resumption information file is saved to the path which is specified by this option.

If the resumption information file is already existed in the specified folder as this option, the file is overwritten.

In addition, when the file transfer ended normally or the file transfer is cancelled by the demand of the cancellation from Data Highway - Server, the resumption information file is deleted.

6

-getdeliveryinfo

When you specify this option, the metadata folder is created under the folder specified in the -savedir option, and a delivery information file in XML format is stored per delivery (Delivery ID) at the time of file download. The name of the file created per delivery consists of an up to 19-digit number, like Delivery ID.

When you specify this option, the metadata folder is created under the folder which is specified as -savedir option and the delivery information file which is XML format is acquired per delivery (Delivery ID) at the time of download file.

The file name which is created per delivery consists of the number maximum of 19 digits like Delivery ID.

A folder (Delivery ID sub-folder), where downloaded files are stored on a delivery basis, is created per delivery (Delivery ID) under the folder specified in the -savedir option.

Even if the download file is failure and all of the files cannot be downloaded, the status of the delivery information shows that all download are completed.

In addition, when the metadata folder already exists under the folder which is specified as -savedir option, delete it or save as another name before the command execution.

When the same name folder is existed, it is overwritten. And, when this option is specified that the file or folder to download do not exist, the delivery information file is not outputted.

7

-newarrivalexitcode

When this option is specified, the command outputs the return code which is added 128 when it received the delivery which is included files or folders.

When files or folders are not existed and the command delivers the message only, the command outputs the normal return code.

8

-deliveryid

This option is used when choosing and receiving only specific delivery from delivery in In-box.

Specify Delivery ID of the delivery to receive. You can specify 1 Delivery ID. You cannot appoint plural Delivery ID.

When this option is omitted all un received deliveries are received according to the received delivery list specified as -receivedlist option.

If the version of Data Highway - Server is 10-50 or later, this option can be used.

When this option to less than 10-50 Data Highway - Server version is specified, an error of "DWCO1913_E The server returned an error. Server does not support this command. " occurs.

9

-reservetransferlimit

When this option is specified and a file cannot be received due to the download limit, the delivery or file will not be put on the received delivery list.

If this option is omitted, a delivery or file will be put on the received delivery list if it cannot be received due to a download limit.

This option is available for servers that run JP1/DH - Server version 11-10 or later. If you specify this option for a server that runs JP1/DH - Server version 11-00 or earlier, the system generates a warning saying DWCO1914_W The specified option will not take effect because the server you are connecting to does not support this command. (Option: -reservetransferlimit).

10

-property

Refer to 9.3.1(2) Common options.

11

-concurrenttimeout

(c) Description

The details of the receiving files command is as follows.

(i) The disk space which is temporarily used at receiving files

When the receiving file command is executed, all files are downloaded to the temporary disk space (the "work" folder which is located under the folder installed the data transfer command) first. Next, they are moved to the folder which is specified as an argument when you execute the command. So, when the receiving file command is executed, it is required the temporary disk space to receive these files.

In addition, when the receiving file command is suspended or is failed, the imperfect files may be remained in the temporary disk space. In this case, delete files in the temporary disk space.

(ii) Overwrite at the receiving the same name files

The download file is saved to the folder which is specified as an argument when you execute the command. When the same name file is existed, it is overwritten by the delivery data whose date is new.

This is also applied for the folder.

Note that the overwritten file or folder is also counted for the amount of downloads.

(iii) Delivery to receive

When -deliveryid option is specified:

Only the delivery specified by -deliveryid is received. It is also possible to receive the delivery received in the past.

When -deliveryid option is omitted:

Receive the new-arrival delivery (the delivery which is not described in the Received List File) only. The receiving file command cannot receive files received in the past.

(iv) Files which cannot be received because of its' download restriction

If a file cannot be received because the download limit per month is exceeded:

When -reservetransferlimit option is specified:

The delivery or file will not be put on the received delivery list file.

If the user wants to download a file that is not on the list, the representative user eases the download limit, or the user needs to execute the reception command again after the download limit per month is cleared in the next month.

When - reservetransferlimit option is omitted:

The delivery or file will be put on the received delivery list file, and can no longer be downloaded even if the user executes the command to receive the file again later.

To download such a file, the representative user eases the download limit, followed by the user who wants the file using the web window to download it.

(v) When you specify -makesubdir option

When the download is suspended and some of files cannot be downloaded, the operation of the re-download is as follows.

When the file or folder of the delivery is different from last time

This command creates folder per delivery, and download them.

When the file or folder of the delivery is same at last time

If the folder is not created per delivery when the download is suspended, the command creates new folder per delivery and download them. When the folder is already created per delivery, the command downloads them to the same folder.

When you specify the preservation folder different from first time at re-downloading

When all of the following condition is true, the command creates new folder per delivery to the preservation folder which is specified at re-downloading and download them.

- The download is suspended in the same delivery.

- Specify the preservation folder different from first time at re-downloading.

In this case, files in the same delivery are saved to different preservation folder separately.

When the file whose name is same as the Delivery ID in the preservation folder is existed, the command occur an error because the same folder cannot be created.

Specify the preservation folder path including folder which is created per delivery whose length is less than 261 characters. When the preservation folder path is over 260 characters, the download fails.

(vi) Operation when the user is inactivated during the command execution

When the user who executes the receiving file command is invalid during the command execution, the operation of receiving is continued and is received files normally. And, after that, the operation is continued and is acquired all of the delivery. When the receiving file command is executed next time, the user cannot receive all of the delivery.

(vii) Warning log about delivery which is described on the Received List File

When the delivery which was successfully received before and is described on the Received List File is changed to the following status, the warning log is outputted when the receiving file command is executed again.

When the sender of the delivery is deleted or inactivated

There is no valid the Delivery Rules.

The delivery is deleted during the receiving file command executing

The approver who approves the delivery is deleted.

(viii) When you specify -getdeliveryinfo option

The format of the delivery information file which is outputted when you specify -getdeliveryinfo option is specified is as follows.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
    <delivery id="123" send-date=" 2012/11/20 02:25" subject="About meeting">
        <sender email="user1@domain1.co.jp">
            <files>
                <file id="27" type="file" name="Meeting materials.txt" size="1024524"/>
                <file id="28" type=" file " name="ResearchResult.doc" size="3134562"/>
            </files>
        </sender>
        <message>the sender's message</message>
    </delivery>
</data>

Important

The information at the time of the sending is outputted to the delivery information file. So, when the sender changes the email address after the sending was completed, the email address before being changed is outputted.

When the sender is deleted after the sending was completed, files which were sent are deleted together. So, the delivery information file is not outputted.

When you are going to receive the delivery in which the storage expiry date has expired, the receiving file is ended and return code 4 (end with warning). And then, the error message "DWCO1065_W Cannot receive the delivery because it expired." is displayed.

The meanings of the elements which are outputted to the delivery information file are as follows.

Table 9‒15: The meanings of the elements of the delivery information file

Element/Attribute

Number

Explanation

data Element

1

It is always outputted.

delivery Element

1

The delivery information tag.

id Attribute

1

Delivery ID is outputted.

send-date Attribute

1

Date -time when the delivery (the sending) has completed is displayed.

subject Attribute

1

The subject of the delivery is outputted.

sender Element

1

The sender information tag.

email Attribute

1

The sender's email address is outputted.

files Element

1

The delivery file/folder list tag.

file Element

1 or more

The delivery file/folder information tag.

id Attribute

1

ID of the delivery file/folder is outputted.

type Attribute

1

The type of the delivery file/folder is outputted.

File : "file"

Folder : "folder"

name Attribute

1

The name of the delivery file/folder is outputted.

size Attribute

1

The size of the delivery file/folder is outputted with a number of bytes. In folder, the total number of bytes before archiving the contents of the folder is outputted.

message Element

1

The input message of the sender.

(d) The example for execution

DWClient.bat DOWNLOAD
 -savedir "C:\receive"
 -receivedlist "C:\DWCLient\receivedlist.txt"
 -makesubdir
 -getdeliveryinfo
 -resumestatus "C:\DWCLient\temp"
 -newarrivalexitcode
 -property "C:\DWCLient\property.xml"

(3) Resumption of the file transfer which is under suspending

Resume the file transfer which is under suspending.

(a) Format

DWClient.bat RESUME
   -property the path of the Command Property File
   -resumestatus the folder which is stored the resumption information file

(b) Argument

Table 9‒16: The argument of resumption of the file transfer which is under suspending

No

Option

Explanation

1

-resumestatus

Specify the folder path which is stored the information to resume the file transfer.

2

-property

Refer to 9.3.1(2) Common options.

(c) Description

(i) When the suspended cannot be resumed

When the Compress Method of Delivery Policy is "Standard", the delivery cannot be resumed. When the Compress Method of Delivery Policy is "Extended", or when the Compress Method of Delivery Policy cannot be chosen, the delivery can be delivered.

When you specify the file which has setting that the Compress Level of Delivery Policy is except "No compression", the delivery cannot be resumed.

When the state of the reception of the file transfer function for Data Highway - Server is "Refusal state of the reception", the command outputs the return code 3 (Refusal state of the reception is ended) and ends.

(ii) When you resume the sending files

When the file which is resumed the sending was deleted from the Client PC after suspending, the resumption command of the file transfer which is under suspending ends abnormally.

When the Compress Method of Delivery Policy is "Standard", the sending cannot be resumed. When the Compress Method of Delivery Policy is "Extended", or when the Compress Method of Delivery Policy cannot be chosen, the delivery can be sent.

When you specify the file and folder which has setting that the Compress Level of Delivery Policy is except "No compression", the sending cannot be resumed.

When the file name or file size or updated date-time of the sending file is changed, the command cannot send.

When the file transfer of un-transmitted file is resumed, if the file name or file size is changed, the command cannot send.

(iii) When you resume the receiving files

When the specified file is deleted on the Data Highway - Server because the expiration date of the delivery which is specified by the representation user expires, the receiving file is skipped. And, the file which is being received and the resumption information file are deleted. The command outputs the return code 4 (end with warning) and ends.

When the specified delivery has already deleted on the Data Highway - Server and has already received, the receiving file is skipped. The command outputs the return code 4 (end with warning) and ends.

For the options which are not specified to receive, the options which were specified by the receiving file command last time are applied.

When {-deliveryid} option is being omitted by the reception to resume and when the file which is received newly after the suspended is existed, the command downloads them together.

When the resumption of the suspended is failure, the download of the file transfer which is delivered after the suspended is not executed. In this case, the resumption information file is not overwritten.

When the Compress Method of Delivery Policy is "Standard"

- When you resume the receiving file which has setting that the Compress Level of Delivery Policy is "No compression", the receiving is resumed from the continuation of the last receiving.

- When you specify the file and folder which has setting that the Compress Level of Delivery Policy is except "No compression", start to receive newly as well as the receiving command because the delivery which is being receiving cannot be resumed.

When the Compress Method of Delivery Policy is "Extended", or when the Compress Method of Delivery Policy cannot be chosen.

- When the receiving file or folder is resumed with the settings that the Compress Level of Delivery Policy is "STRONG" or "MIDDLE" or "WEAK", the receiving is resumed from the start of the last receiving file.

(d) The example for execution

DWClient.bat RESUME
 -property "C:\DWCLient\property.xml"
 -resumestatus "C:\DWCLient\temp"

9.4 Troubleshooting of the data transfer command

The solution of troubles which are occurred when the data transfer command is used is as follows.

9.4.1 FAQ of the data transfer command

FAQ of the data transfer command is as follows.

Table 9‒17: FAQ

No

Question

Answer

1

The command does not work due to the error below. What should I do?

Exception in thread "main"

java.lang.UnsupportedClassVersionError: Bad version

number in .class file

...Omit...

The version of the JRE you are using might be old.

See 9.1.2 (2) Java software to install appropriate JRE software.

2

Are there any ways that the progress of the data transfer command is displayed.

The data transfer command does not have the way of displaying its' progress.

The time concerning the file sending/receiving is almost the same as the case where it is operated from Web. Note that the sending/receiving a mass file is needed for the long time.

3

Failed to execute the code due to the occurrence of the error shown below. How do you want to proceed?

Exception in thread "main" java.lang.UnsupportedClassVersionError: Bad version number in .class file

...Omit...

The version of the JRE you are using might be old.

4

Is there an expiration date for the password specified in property.xml?

If there is, what happens when data is sent with an expired password?

If an expiration date is set for the user password specified in property.xml, the specified expiration date also applies when the data transfer command option is used. If you use the the data transfer command command option with the password expired, the JP1/DH - Server command option is closed with the following message output:

DWCO1203_E This user cannot use delivery because the user's password expired.

5

If the Java environment that comes with Cosminexus is used, data transfer commands do not work properly.

The data transfer commands only support the Java environment that comes with Oracle. Install this environment and then execute the command again.

9.4.2 Messages of the data transfer command

The list of messages of the data transfer command is as follows.

Table 9‒18: The list of messages

Message ID

Message contents

Explanation

DWCO1001_I

Command start.

Notify that the data transfer command has been started.

DWCO1002_I

Command finished.

Notify that the data transfer command was finished.

DWCO1031_I

Ready to sending is started.(Command Line Arguments:{0})

Notify that the ready to sending is started.

Command Line Arguments is outputted to {0} parameter.

DWCO1032_I

Ready to sending is ended. (Delivery ID:{0})

Notify that the ready to sending is ended.

Delivery ID is outputted to {0} parameter.

DWCO1036_I

Sending a file to the server is started. (File/Folder path:{0}, File/Folder size:{1}Byte, Last modified time:{2})

Notify that the sending a file to the server is started.

{0} : File/Folder path

{1} : File/Folder size

{2} : Last modified time

DWCO1037_I

Sending a file to the server is ended. (File ID:{0}, File/Folder size:{1}Byte, Last modified time:{2})

Notify that the sending a file to the server is ended.

{0} : File ID

{1} : File/Folder size

{2} : Last modified time

DWCO1041_I

Sending files completed.

Notify that sending files was completed.

DWCO1042_I

Calculation of the file digest was skipped.

Notify that calculation of the file digest was skipped.

DWCO1043_I

Calculation of the file digest is started. (File/Folder path:{0}, File/Folder size:{1}Byte, Last modified time:{2})

Notify that the calculation of the file digest is started.

{0} : File/Folder path

{1} : File/Folder size

{2} : Last modified time

DWCO1044_I

Calculation of the file digest is ended. (Digest:{0}, File/Folder size:{1}Byte, Last modified time:{2})

Notify that the calculation of the file digest is ended.

{0} : Digest

{1} : File/Folder size

{2} : Last modified time

DWCO1051_I

Ready to receiving is started.(Command Line Arguments:{0})

Notify that the ready to receiving is started.

Command Line Arguments is outputted to {0} parameter.

DWCO1052_I

Ready to receiving is ended. (Number of new file:{0})

Notify that the ready to receiving is ended.

Number of new file is outputted to {0} parameter.

DWCO1056_I

Receiving a file from the server is started. (Delivery ID:{0}, File ID:{1}, File/Folder path:{2}, File/Folder size:{3})

Notify that the receiving a file from the server is started.

{0} : Delivery ID

{1} : File ID

{2} : File/Folder path

{3} : File/Folder size

DWCO1057_I

Receiving a file from the server is ended. (Delivery ID:{0}, File ID:{1}, File/Folder path:{2}, File/Folder size:{3}, Last modified time:{4})

Notify that the receiving a file from the server is ended.

{0} : Delivery ID

{1} : File ID

{2} : File/Folder path

{3} : File/Folder size

{4} : Last modified time

DWCO1059_I

Moving a file is started. (Source path:{0}, Destination path:{1}, File/Folder size:{2}, Last modified time:{3})

Notify that the moving a file is started.

{0} : Source path

{1} : Destination path

{2} : File/Folder size

{3} : Last modified time

DWCO1060_I

Moving a file is ended. (Source path:{0}, Destination path:{1}, File/Folder size:{2}, Last modified time:{3})

Notify that the moving a file is ended.

{0} : Source path

{1} : Destination path

{2} : File/Folder size

{3} : Last modified time

DWCO1061_I

Received a file/folder. (Delivery ID:{0}, File ID:{1}, File/Folder name:{2})

Notify that the delivery was received.

The following contents are outputted for each parameter.

{0} : Delivery ID

{1} : File ID

{2} : File/Folder name

DWCO1062_I

A file/folder was overwritten because a file/folder with the same name already exists. (Delivery ID:{0}, File ID:{1}, File/Folder name:{2})

Notify that the file/folder was overwritten because the same name file/folder was already existed in the output folder.

The following contents are outputted for each parameter.

{0} : Delivery ID

{1} : File ID

{2} : File/Folder name

DWCO1063_W

Cannot receive a file/folder. It might be caused by the following reasons. The delivery expired. The number of times you download this file is limited. You exceeded your download limit. (Delivery ID:{0}, File ID:{1}, File/Folder name:{2}), Details:{3})

Cannot receive the delivery because of the following reasons.

The delivery expired.

The number of times you download this file is limited.

You exceeded your download limit.

Although the download of this delivery is skipped, the delivery is added to the Received List File.

If you want to receive this delivery when this limitation is cancelled, refer to Delivery ID and receive the delivery by Web.

The following contents are outputted for each parameter.

{0} : Delivery ID

{1} : File ID

{2} : File/Folder name

{3} : Details

DWCO1064_W

The delivery contains only message. (Delivery ID:{0})

Although files are not downloaded because the delivery contains only message, the delivery is treated as finishing receiving.

Delivery ID is outputted to {0} parameter.

DWCO1065_W

Cannot receive the delivery because it expired. (Delivery ID:{0})

Cannot receive the delivery because it expired. Although the download of this delivery is skipped, the delivery is added to the Received List File.

Delivery ID is outputted to {0} parameter.

DWCO1066_W

Cannot receive the delivery because the sender was deleted or inactivated or there is no available delivery rule. (Delivery ID:{0})

Cannot receive the delivery because the sender was inactivated or deleted or there is no available delivery rule. Although the download of this delivery is skipped, the delivery is added to the Received List File.

Delivery ID is outputted to {0} parameter.

DWCO1067_W

Cannot receive the delivery because the delivery was deleted just before you started downloading or the approver of the delivery was deleted. (Delivery ID:{0})

Cannot receive the delivery because the delivery was deleted just before you started downloading or the approver of the delivery was deleted. Although the download of this delivery is skipped, the delivery is added to the Received List File.

Delivery ID is outputted to {0} parameter.

DWCO1068_W

Failed to verify the file/folder. (Delivery ID:{0}, File ID:{1}, File/Folder name:{2})

Failed to verify the file/folder which was downloaded.

The downloaded file is deleted. (The file on the Server is not deleted.)

The download of this delivery is skipped.

The following contents are outputted for each parameter.

{0} : Delivery ID

{1} : File ID

{2} : File/Folder name

DWCO1069_W

Cannot receive a file/folder because the file/folder was deleted. (Delivery ID:{0}, File ID:{1}, File/Folder name:{2})

Cannot download because the file was deleted. Although the download of this delivery is skipped, the delivery is added to the Received List File.

The following contents are outputted for each parameter.

{0} : Delivery ID

{1} : File ID

{2} : File/Folder name

DWC01070_W

Cannot receive the delivery because a file/folder with the same name already exists. (Delivery ID:{0}, File ID:{1}, File/Folder name:{2})

Notify that the download was skipped because the same name file/folder was already existed in the output folder.

The following contents are outputted for each parameter.

{0} : Delivery ID

{1} : File ID

{2} : File/Folder name

DWCO1071_I

Verification of the file digest was skipped.

Notify that verification of the file digest was skipped.

DWCO1101_E

An option [{0}] must be specified only once.

Do not specify two or more same options.

Two or more specified options are outputted to {0} parameter.

DWCO1102_E

Arguments must be a pair of an option key and its value.

The option key only or value only was specified to argument of the date transfer command. Specify the pair of the option key and its value.

DWCO1103_E

Option [{0}] is invalid.

Specify the valid option.

The invalid option is outputted to {0} parameter.

DWCO1104_E

Please Specify option [{1}].

The indispensable option is not specified. Specify the indispensable option.

The indispensable option is outputted to {1} parameter.

DWCO1105_E

Please specify option [{1}] within [{0}] characters.

The number of characters of the value which is specified to the option is over the maximum number of characters of the option.

DWCO1106_E

The maximum number of email addresses you can specify to [-to|-cc|-bcc] is [{0}].

Specify the email address or group name within the maximum number of them.

The maximum number of the email address which can be specified is outputted to {0} parameter.

DWCO1107_E

An email address must be between [{1}] and [{2}] characters.

Check the number of characters of the email address.

The following contents are outputted for each parameter.

{1} : The minimum number of characters of the email address

{2} : The maximum number of characters of the email address

DWCO1108_E

The number of files you can specify to [-file] must be between [{1}] and [{2}].

Check the number of specified files.

The following contents are outputted for each parameter.

{1} : The minimum number of files which can be specified to [-file] option

{2} : The maximum number of files which can be specified to [-file] option

DWCO1109_E

The specified files/folders do not exist or cannot be read. (Path:{0})

Check the following condition.

The certificate file is existed in the specified file/folder.

The command has the permission to read the certificate file.

The character code of the certificate file is suitable.

The path of the specified file/folder is outputted to {0} parameter.

DWCO1110_E

Please specify an integer number between [{1}] to [{2}] for option [{3}].

Specify the integer number which is in the suitable range for the option.

The following contents are outputted for each parameter.

{1} : The minimum number of integer of the option which can be specified

{2} : The maximum number of integer of the option which can be specified

{3} : Option

DWCO1112_E

The settings of Command Property File is wrong. (Setting:{0}, Value:{1})

The setting of the Command Property File (property.xml) is wrong. Check the following setting.

"PASSWORD" or "CERTIFICATION" is specified for Authentication method.

When "Login by Certification" is specified for Authentication method, the path of the certificate file is specified.

When "Login by Certification" is specified for Authentication method, the password of the certificate file is specified.

Execute again after modifying the setting.

The following contents are outputted for each parameter.

{0} : The item name of the setting

{1} : The value of the setting

DWCO1113_E

The selected files/folders do not exist or cannot be read. (Path:{0})

Check the following condition.

The specified file/folder is existed.

The command has the permission to write the specified file/folder.

The path of the specified file/folder is outputted to {0} parameter.

DWCO1114_E

Failed to write to a received list. (Path:{0})

Check the command has the permission to write the specified Received List File.

The path of the specified Received List File is outputted to {0} parameter.

DWCO1115_E

Failed to read a received list. (Path:{0})

Check the command has the permission to read the specified Received List File.

The path of the specified Received List File is outputted to {0} parameter.

DWCO1116_E

Failed to create a received list. (Path:{0})

Check the command has the permission to write the path of the specified Received List File.

The path of the specified Received List File is outputted to {0} parameter.

DWCO1117_E

Please specify option either [{0}] or [{1}].

Specify option either [-message] or [-messagefile].

The following contents are outputted for each parameter.

{0} : The message ([-message] option)

{1} : The message file ([-messagefile] option)

DWC01118_E

Cannot specify an unnecessary parameter.(parameter:{0})

Cannot appoint an unnecessary value.

The unnecessary parameter is outputted to {0} parameter.

DWCO1121_E

Please specify message in a file within [{2}] characters.

Specify the message in the file within 4096 characters.

4096 is outputted to {2} parameter.

DWCO1122_E

An open password must be between [{1}] and [{2}] characters.

Check the number of characters of the open password.

The following contents are outputted for each parameter.

{1} : The minimum number of characters of the open password

{2} : The maximum number of characters of the open password

DWCO1123_E

An open password must be between [{1}] and [{2}] characters and must contain two or more types of characters.

Check the number of characters and the type of the open password.

The following contents are outputted for each parameter.

{1} : The minimum number of characters of the open password

{2} : The maximum number of characters of the open password

DWCO1124_E

An open password includes restricted strings.

The open password includes restricted strings.

DWCO1130_E

Please specify a name between [{0}] and [{1}] characters.

Check the number of characters of the name.

The following contents are outputted for each parameter.

{0} : The minimum number of characters of the name

{1} : The maximum number of characters of the name

DWCO1131_E

A name includes restricted strings.

Specify the string which can be used for the name again.

Cannot use the following symbol for the name.

/\?*:|"<>@^

In addition, the name which consists of only blanks or only period (.) cannot be used.

DWCO1132_E

You can specify options[-toname|-ccname|-bccname] up to a number of email addresses specifies in [-to|-cc|-bcc].

The number of the name which is specified to [-toname|-ccname|-bccname] option is over the number of the email address or group name which is specified to [-to|-cc|-bcc] option.

Specify the name whose number is within the number of the specified email address or group name.

DWCO1133_E

Please specify a between [{0}] and [{1}] characters.

Check the number of characters of the division.

The following contents are outputted for each parameter.

{0} : The minimum number of characters of the division

{1} : The maximum number of characters of the division

DWCO1134_E

You can specify options [-todivision|-ccdivision|-bccdivision] up to a number of email addresses specifies in [-to|-cc|-bcc].

The number of the division which is specified to [-todivision|-ccdivision|-bccdivision] option is over the number of the email address which is specified to [-to|-cc|-bcc] option.

Specify the division whose number is within the number of the specified email address.

DWCO1135_E

A group name must be between [{0}] and [{1}] characters.

Check the number of characters of the group name.

The following contents are outputted for each parameter.

{0} : The minimum number of characters of the group name

{1} : The maximum number of characters of the group name

DWCO1142_E

Please specify a address type [TO|CC|BCC]. (Path:{0}, line:{1}, Value:{2})

The address type which was appointed in the destination file is not [TO|CC|BCC].

The following contents are outputted for each parameter.

{0} : The destination file path

{1} : Line

{2} : The value specified as the address type

DWCO1143_E

Number of columns in the destination file is missing. (Path:{0}, line:{1}, Value:{2})

Number of columns of address which was appointed in the destination file is missing.

The following contents are outputted for each parameter.

{0} : The destination file path

{1} : Line

{2} : Number of columns

DWCO1144_E

An email address must be between [{0}] and [{1}] characters. (Path:{2}, line:{3}, Value:{4})

Check the number of characters of the email address which was appointed in the destination file.

The following contents are outputted for each parameter.

{0} : The minimum number of characters of the email address

{1} : The maximum number of characters of the email address

{2} : The destination file path

{3} : Line

{4} : The specified value

DWCO1145_E

A group name must be between [{0}] and [{1}] characters. (Path:{2}, line:{3}, Value:{4})

Check the number of characters of the group name which was appointed in the destination file.

The following contents are outputted for each parameter.

{0} : The minimum number of characters of the group name

{1} : The maximum number of characters of the group name

{2} : The destination file path

{3} : Line

{4} : The specified value

DWCO1146_E

Please specify a name between [{0}] and [{1}] characters. (Path:{2}, line:{3}, Value:{4})

Check the number of characters of the name which was appointed in the destination file.

The following contents are outputted for each parameter.

{0} : The minimum number of characters of the name

{1} : The maximum number of characters of the name

{2} : The destination file path

{3} : Line

{4} : The specified value

DWCO1147_E

A name includes restricted strings. (Path:{0}, line:{1}, Value:{2})

Specify the string which can be used for the name which was appointed in the destination file again.

Cannot use the following symbol for the name.

/\?*:|"<>@^

In addition, the name which consists of only blanks or only period (.) cannot be used.

The following contents are outputted for each parameter.

{0} : The destination file path

{1} : Line

{2} : The specified value

DWCO1148_E

Please specify a division between [{0}] and [{1}] characters. (Path:{2}, line:{3}, Value:{4})

Check the number of characters of the division which was appointed in the destination file.

The following contents are outputted for each parameter.

{0} : The minimum number of characters of the division

{1} : The maximum number of characters of the division

{2} : The destination file path

{3} : Line

{4} : The specified value

DWCO1149_E

The maximum number of email addresses/group names you can specify to [-destinationfile] is [{0}].

The address which was appointed in the destination file is over the maximum number of the address which can be specified.

The maximum number of the address which can be specified is outputted to {0} parameter.

DWCO1201_E

User authentication failed.

The user authentication for Data Highway - Server was failed. Check the User ID or Password which is defined in the Command Property File.

DWCO1203_E

Failed to delete log files which expires.

The data transfer command cannot be executed because the password expires. Specify the new password.

DWCO1207_E

LDAP authentication system error occurred.

An error occurred by the connection to a directory server by LDAP authentication system.

DWCO1301_E

Failed to receive a file/folder. A file/folder with the same name already exists in the destination folder and cannot be rewritten. (Delivery ID:{0}, File ID:{1}, Path:{2})

Cannot overwrite this file or folder because the same name file or folder is already existed in the specified destination folder. Check the file or folder.

The following contents are outputted for each parameter.

{0} : Delivery ID

{1} : File ID

{2} : Path

DWCO1302_E

Failed to receive a file/folder. The saved file/folder in a temporary folder cannot be moved to the destination folder. (Delivery ID:{0}, File ID:{1}, Path:{2})

Cannot move the file which was saved in the temporary disk space to the specified destination folder.

Check the permission of the destination folder to access.

The file is saved in the temporary disk space, so move it to the destination folder.

The following contents are outputted for each parameter.

{0} : Delivery ID

{1} : File ID

{2} : Path

DWCO1303_E

Failed to receive a file/folder. (Delivery ID:{0}, File ID:{1}, Details:{2})

The following reasons are considered.

The delivery was deleted just before receiving files.

The user who was executing receiving was deleted.

The other reason.

The following contents are outputted for each parameter.

{0} : Delivery ID

{1} : File ID

{2} : Details of reason

DWCO1304_E

Failed to create a folder.(Path:{0})

Check the command has the permission to create the folder, and execute the command with the user who has the permission to create the folder.

The file path is outputted to {0} parameter.

DWCO1305_E

Failed to create a folder because a file with the same name already exists in the destination folder.(Path:{0})

There is the file whose name is the same as the name of folder the command creates.

Execute the command again after deleting the file.

The folder path is outputted to {0} parameter.

DWCO1401_E

Failed to send files. (Details:{0})

Failed to send files.

Refer to the Details reason, and improve the setting of Users, Groups and Delivery Rules.

The Details reason is outputted to {0} parameter.

DWCO1402_E

Failed to get delivery rules. Please check the destinations.

Failed to get the Delivery Rules which is applied all of the specified addresses. Improve the settings of the address.

DWCO1403_E

The capacity of selected files was over the limitation. (File path:{0}, File size:{1}Byte)

Make the size of the sending file within the limitation of file size.

The following contents are outputted for each parameter.

{0} : File path of the sending file

{1} : File size of the sending file

DWCO1404_E

The total size of specified files is over the maximum size of the delivery policy. (Total size of specified files:{0}, Maximum total size:{1})

Make the total size of the sending file within the limitation of total file size.

The following contents are outputted for each parameter.

{0} : Total size of the specified sending file

{1} : Maximum total size

DWCO1405_E

The number of receivers is over the maximum number of the delivery policy. (Specified receivers:{0}, Maximum number of receivers:{1})

Make the number of the specified address within the maximum number of address.

The following contents are outputted for each parameter.

{0} : The number of the specified address

{1} : Maximum number of address

DWCO1406_E

The number of files is over the maximum number of the delivery policy. (Specified files:{0}, Maximum number of files:{1})

Make the number of the specified sending file within the maximum number of files.

The following contents are outputted for each parameter.

{0} : The number of the specified sending file

{1} : Maximum number of files

DWCO1407_E

Failed to send files. If the sender is a guest user,

Check the execution parameter is correct.

If the sender is a guest, check the Limit Number of Uses.

DWCO1408_E

The capacity of selected files was over the limitation.You can send each file up to 3.96 bytes when you use compress options. (File path:{0}, File size:{1}Byte)

The capacity of selected files was over the limitation.

When you use compress options, make each file size within 3.96 GB.

The following contents are outputted for each parameter.

{0} : File path

{1} : File size

DWCO1409_E

Open password (-openpassword option) is needed to send to unregistered addresses.

The open password ([-openpassword] option) is not specified.

Execute the command again after specifying the open password ([-openpassword] option).

DWCO1410_E

The capacity of selected folder was over the limitation.You can send each folder up to 3.96 bytes. (Folder path:{0}, Folder size:{1}Byte)

The capacity of selected folder was over the limitation.

Make each folder size within 3.96 GB.

The following contents are outputted for each parameter.

{0} : Folder path

{1} : Folder size

DWCO1411_E

A number of files and folders in a folder were over the limitation. You can send the number of files and folders in each folder up to {0}. (Folder path:{1}, Folder/File num:{2}).

A number of files and folders in a folder were over the limitation.

{0} : Maximum number of Folder/File

{1} : Folder/File path

{2} : Folder/File num

DWCO1412_E

The specified group does not exist or is not a group that can be sent.(Group name:{0})

Check the address group.

The group name is outputted to {0} parameter.

DWCO1501_I

Log files which expires have been deleted.

Notify that log files were deleted.

DWCO1502_I

Failed to delete log files which expires.

Notify that the deletion of log files was failed.

DWCO1705_E

Failed to parse a XML.(Details:{0})

The format of the Server Parameter File is invalid. Improve the format of the file.

Details reason is outputted to {0} parameter.

DWCO1706_E

Failed to generate a XML.(Details:{0})

Contact a system administrator.

Details reason is outputted to {0} parameter.

DWCO1803_E

Failed to output information of deliveries to a XML file. (Path:{0})

Check the command has the permission to write the specified file.

The path of XML file is outputted to {0} parameter.

DWCO1901_E

An unexpected error occurred.

An unexpected error occurred. The server may be busy. Execute the command again later.

If the same error occurs when you execute the command again and again, contact a technical support. And, the execution user may be deleted on executing the command. Contact a representation user or a group administrator.

DWCO1902_E

Unable to start the application because initialization of logs failed.

The contents of the Log Setting File have errors. If you re-install this application, this error may be resolved.

DWCO1903_E

Unable to start the application because reading message files failed.

The contents of the Setting File have errors. If you re-install this application, this error may be resolved.

DWCO1904_E

Unable to start the application because reading setting files failed.

The contents of the Setting File have errors. If you re-install this application, this error may be resolved.

DWCO1905_E

Cannot use a temporary folder. (Path:{0})

The data transfer command uses the temporary folder. Check the command has the permission to write files in the temporary disk space which was described in the log.

The path of the temporary folder is outputted to {0} parameter.

DWCO1906_E

An error occurred in connection with the server. (Details:{0})

Refer to the Details reason, and improve the network settings.

The Details reason is outputted to {0} parameter.

DWCO1907_E

The server is busy. Please try again later.

The server is busy and it returns the HTTP status code 503 (Service Unavailable).

Execute the command again later.

DWCO1908_E

The session have been time-out. Please try again.

The session has been timed-out. Login again.

DWCO1909_E

The server returned an error. (Details:{0})

Refer to the Details reason, and improve the setting of Users, Groups and Delivery Rules.

The Details reason is outputted to {0} parameter.

DWCO1911_E

The operation of getting a lock for concurrent control timed out.

The data transfer command has already been executed in the same PC. Since the data transfer command cannot be executed at the same time, execute it again after the executing data transfer command is finished.

And, the command may have not the permission to write to temporary folders. Check the suitable temporary folder is specified.

When the command is cooperated with JP1/DH - AJE, check the existence and writing permission of the folder which is specified at SendRecvTemp tag in the Environment Setting File (config.xml).

DWCO1912_E

The connection with the server for communication of a file/folder failed. The server is busy. Please try again later.

Since the server is busy, the connection with the server for communication is failed. Execute the command again later.

DWCO1913_E

The server returned an error. Server does not support this command.

The command or command option that the server does not support is used. Check support of the server.

DWCO1999_E

Unable to start the application.

Failed in start of The data transfer command. Contact a system administrator.

DWCO2201_W

The file transfer was suspended by the server command. When the [-resumestatus] option is specified, it may be able to resume by a [RESUME] command.

The command was suspended by the server command. When you resume the file transfer, execute the RESUME command.

DWCO2202_E

The file transfer was canceled by the server command.

The command was canceled by the server command. Cannot resume the file transfer. When you want to send/receive files again, send/receive newly.

DWCO2203_E

The file transfer was canceled because the function of file transfer is invalid.

Contact a system administrator, and request the permission to transfer files.

DWCO2206_E

Cannot specify [-resumestatus] option because the compress method is set to delivery policy.

Specify "No compression" for Compress Level of Delivery Policy.

DWCO2207_E

Cannot specify [-resumestatus] option because of including folders. (Path:{0})

Remove any folder from the file to be sent, and specify the file again.

The file path is outputted to {0} parameter.

DWCO2221_E

Failed to read a resuming status file. (Path:{0})

Check whether the resumption information file is existed and readable.

The file path is outputted to {0} parameter.

DWCO2222_E

Failed to write a resuming status file. (Path:{0})

Check whether the resumption information file is existed and writable. In the case, the command may be unable to resume the sending/receiving. When the command cannot resume, send/receive newly.

The file path is outputted to {0} parameter.

DWCO2301_I

Resuming sending files was completed.

Resuming sending files was completed.

DWCO2302_E

Failed to resume sending. (Details:{0})

Correspond according to the Details reason. In the case, the command may be unable to resume the sending. When the command cannot resume the sending, send with the UPLOAD command newly.

The Details reason is outputted to {0} parameter.

DWCO2303_E

Failed to resume sending because of changing the file. (Path:{0})

Cannot resume the sending because the file has been changed. When you want to send again, send with the UPLOAD command newly.

The file path is outputted to {0} parameter.

DWCO2304_E

Failed to resume sending because the delivery is not exist. (Delivery ID:{0})

Cannot resume the sending because the delivery is not existed. Send with the UPLOAD command newly.

The Delivery ID is outputted to {0} parameter.

DWCO2305_E

Failed to resume sending because the delivery is not send by command. (Delivery ID:{0})

Cannot resume the delivery which is not sent with the sending command.

Send with the UPLOAD command newly.

The Delivery ID is outputted to {0} parameter.

DWCO2306_E

Failed to resume sending.It may be that the delivery has been cancelled or the sending has already been completed. (Delivery ID:{0})

The sending has been canceled or completed. When you want to send again, send with the UPLOAD command newly.

The Delivery ID is outputted to {0} parameter.

DWCO2307_E

Failed to resume sending. It may be that the delivery rule or the delivery policy is changed / deleted.

Delivery Rules, Delivery Policy and Address User which were used at sending newly may be changed or deleted. Execute again after returning the setting of them.

DWCO2308_E

Failed to resume sending because the compress method is set to delivery policy.

Specify "No compression" to Compress Level of Delivery Policy.

DWCO2309_W

Failed to resume sending because the previous sending process is ongoing. Please try again later. (Delivery ID:{0})

Cannot resume the sending because the previous sending process is ongoing on the server. Execute the command again later.

The Delivery ID is outputted to {0} parameter.

DWCO2310_E

Failed to resume sending because the delivery was expired. (Delivery ID:{0})

Cannot resume the sending because the delivery was expired. When you want to send again, send with the UPLOAD command newly.

The Delivery ID is outputted to {0} parameter.

DWCO2321_I

Resuming a receiving file was completed.

Resuming a receiving file was completed.

DWCO2322_E

Failed to resume receiving. (Details:{0})

Correspond according to the Details reason. In the case, the command may be unable to resume the receiving. When the command cannot resume the sending, send with the UPLOAD command newly.

The Details reason is outputted to {0} parameter.

DWCO2401_E

This operation is not permitted.

Please check that a user is right. (Details:{0})

Execute again by a suitable user.

The Details reason is outputted to {0} parameter.

10 The data transfer management command

This chapter describes how to use the data transfer management command.

10.1 Overview of the data transfer management command

Overview of the data transfer management command is as follows.

10.1.1 The data transfer management command

The data transfer management command provides method which executes the file transfer management facility of Data Highway - Server by a command line interface. Thereby, using the data transfer management command, you can control file transfer.

By using it combining the data transfer command which performs sending and receiving files, a flexible file transfer becomes possible.

For more information about the data transfer command which performs sending and receiving files see 9.The data transfer command.

Functions which the data transfer management command provides is as follows.

Out-box list acquisition

In-box list acquisition

Delivery cancellation

Delivery deletion

10.1.2 Precondition for installation

A precondition required for client PC when using the data transfer management command is the same as the data transfer command. Refer to 9.1.2 Precondition for installation .

10.2 Installation of the data transfer management command

Installation of the data transfer management command is the same as the data transfer command. Refer to 9.2 Installation of the data transfer command.

10.3 Reference

This section describes commands which are provided by the data transfer management command and settings.

10.3.1 Common specifications

Common specifications of the data transfer management command are the same as the data transfer command. Refer to 9.3.1 Common specifications.

However, the administrator command can be executed at the same time on the same PC. The administrator command and data transfer command can be executed at the same time on the same PC.

10.3.2 The list of the data transfer management command

The list of the data transfer management command is as follows. In addition, in the case of Linux, read the extension "bat" of a command name as "sh".

Table 10‒1: The list of the data transfer management command

No

Function

Command

Explanation

Refer to

1

Message Box list acquisition

DWClientUtil.bat GETOUTBOX

Acquire the list of delivery of Out-box.

10.3.2(1) Out-box list acquisition

2

DWClientUtil.bat GETINBOX

Acquire the list of delivery of In-box.

10.3.2(2) In-box list acquisition

3

Delivery cancellation

DWClientUtil.bat CANCEL

Cancel the executing transmission and reception.

10.3.2(3) Delivery cancellation

4

Delivery deletion

DWClientUtil.bat DELETEDELIVERY

Specify specific delivery which transmission completed and delete it.

10.3.2(4) Delivery deletion

5

Resource usage acquisition

DWClientUtil.bat GETRESOURCEINFO

Acquire resource usage (disk usage and the amount of downloads per month).

10.3.2(5) Resource usage acquisition

Important

When you carry out the data transfer management command (DWClientUtil.bat) to 10-50 or less Japanese version Data Highway - Server, the command becomes an error.

(1) Out-box list acquisition

Acquire the list of delivery of Out-box and output it to the execution result file. In the following cases etc, this is used.

When you confirm the situation of delivery (transmitting) with status of delivery.

When you identify delivery ID to appoint in "delivery cancellation" command or "delivery deletion" command.

(a) Format

DWClientUtil.bat GETOUTBOX
   [-recieverid the user ID of the address for delivery | -receivermailz the email address of the user of the address for delivery]
   [-detail]
   [-inprogress]
    -fromdate the start date to acquire information of deliveries
    -todate the end date to acquire information of deliveries
    -result the path of the execution result file
    -property the path of the Command Property File

(b) Argument

Table 10‒2: The argument of Out-box list acquisition

No

Option

Explanation

1

-receiverid

When you acquire delivery in Out-box, you appoint the user ID of the address for delivery that you want to limit. When you specify an unregistered user, you specify "anonymous".

When this option is omitted, all delivery that the execution user (the user who was listed in the property file which you appointed with the -property option) of this command performed, including the unregistered address, will be acquired.

-receivermail options and this can't be specified at the same time.

2

-receivermail

When you acquire delivery in Out-box, you appoint the email address of the user of the address for delivery that you want to limit. You can also specify an unregistered user.

When this option is omitted, all delivery that the execution user (the user who was listed in the property file which you appointed with the -property option) of this command performed, including the unregistered address, will be acquired.

-receiverid options and this can't be specified at the same time.

3

-detail

You acquire detailed information. File information is included in detailed information in addition to the delivery information.

When this option is omitted, you acquire the information that does not contain the file information.

4

-inprogress

Acquire only delivery of "The transfer is proceeding".

"The transfer is proceeding" is "being forwarded" and "suspended", and "not approved" does not include it.

When this option is omitted, all delivery that the execution user (the user who was listed in the property file which you appointed with -property option) of this command delivered becomes a target of the acquisition.

5

-fromdate

When you acquire delivery, you appoint the creation date of delivery (create-date) # that you limit.

You specify the starting date of the period when you want to acquire delivery, in the form of Data Highway - Server local thyme and YYYY/MM/DD.

6

-todate

When you acquire delivery, you appoint the creation date of delivery (create-date) # that you limit.

You specify the ending date of the period when you want to acquire delivery, in the form of Data Highway - Server local thyme and YYYY/MM/DD. The delivery information outputted contains the specified date.

7

-result

Specify the path of the execution result file.

The file is outputted in XML format.

8

-property

Refer to 9.3.1(2) Common options.

#

The creation date of delivery is the day when the user started transmission.

(c) Description

(i) When you specify -detail option

The format of the execution result file which is outputted when you specify -detail option is specified is as follows.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
    <deliveries>
        <delivery id="154" send-status="on-approving" create-date="2014/07/29 11:40" send-date="" shelf-life-time="2014/08/29 23:59" subject="XX development project" message="I send the documents." total-size="2364662">
            <sender id="user1@domain1" email="user1@domain1.co.jp">
                <files>
                    <file id="130" type="file" name="XX_Report.doc" size="266752"/>
                    <file id="131" type="file" name="set_of_XX_development_documents.zip" size="2097910"/>
                </files>
            </sender>
            <receivers>
                <receiver id="user2@domain1" to-type="TO" url="https://jp1dhserver.co.jp/receipt.jspx?servlet-action=receipt&amp;id=389&amp;cc=8014d12f457e410b09bffdfbd629dcc821d2896e" email="user2@domain1.co.jp">
                    <files>
                        <file id="130" download-date=""/>
                        <file id="131" download-date=""/>
                    </files>
                </receiver>
            </receivers>
            <approvers>
                <approver email="approver01@domain1.co.jp" id="approver01@domain1"/>
            </approvers>
        </delivery>
    </deliveries>
</data>

(ii) When you do not specify -detail option

The format of the execution result file which is outputted when you do not specify -detail option is specified is as follows. Unlike the case where -detail option is specified, file Element, approvers Element, and message Attribute are not outputted. In addition, the receiver information outputs only the email address.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
    <deliveries>
        <delivery id="154" send-status="on-approving" create-date="2014/07/29 11:40" send-date="" shelf-life-time="2014/08/29 23:59" subject="XX development project" total-size="2364662">
            <sender id="user1@domain1" email="user1@domain1.co.jp"/>
            <receivers>
                <receiver email="user2@domain1.co.jp"/>
            </receivers>
        </delivery>
    </deliveries>
</data>

(iii) Details of the execution result file format

The meanings of the elements which are outputted to the delivery information file are as follows. In addition, the special symbol in XML is transposed to the entity reference (escape character) and outputted.

Table 10‒3: The meanings of the elements of the execution result file

Element/Attribute

Number

Explanation

data/deliveries Element

1

It is always outputted.

delivery Element

n

The delivery information tag.

id Attribute

1

Delivery ID is outputted.

It is used to identify delivery.

send-status Attribute

1

The status of the delivery is outputted.

in-progress : The transfer is proceeding

failed : The transfer is failed

suspended : The transfer is suspended

on-approving : The transfer is not approved

rejected : The transfer is not denied

completed : The transfer is already sent

create-date Attribute

1

The creation date-time of delivery is outputted.

send-date Attribute

1

The sending date-time of delivery is outputted.

In the case of unapproved, it is not output.

subject Attribute

1

The subject of the delivery is outputted.

message Attribute

1

The input message of the sender outputted.

shelf-life-time Attribute

1

The storage expiry date is outputted.

total-size Attribute

1

Total data size is outputted with a number of bytes.

sender Element

1

The sender information tag.

id Attribute

1

The sender's user ID is outputted.

email Attribute

1

The sender's email address is outputted.

files Element

1

The send file/folder information tag.

file Element

n

The send file/folder information tag of the send file/folder unit.

id Attribute

1

ID of the send file/folder is outputted.

type Attribute

1

The type of the file/folder is outputted.

File : "file"

Folder : "folder"

name Attribute

1

The name of the file/folder is outputted.

size Attribute

1

The size of the file/folder is outputted with a number of bytes.

receivers Element

1

The receiver information tag.

receiver Element

n

The receiver is outputted. When two or more receivers exist in delivery, all the receivers that exist in delivery are outputted. Also when -receiverid option is used, all the receivers are outputted.

id Attribute

1

The receiver's user ID is outputted.

url Attribute

1

"URL for opening delivery" of the recipient outputs it.

to-type Attribute

1

The receiver's address type (TO|CC|BCC) is outputted.

email Attribute

1

The receiver's email address is outputted.

files Element

1

The receive file/folder information tag.

file Element

n

The receive file/folder information tag of the receive file/folder unit.

id Attribute

1

ID of the file/folder is outputted.

download-date Attribute

1

The date which downloaded the file/folder is outputted.

approvers Element

1

The approver information tag (when there is no approver this tag is not outputted).

approver Element

n

The approver information tag of the approver unit.

id Attribute

1

The approver's user ID is outputted.

email Attribute

1

The approver's email address is outputted.

Important

When the receiver's user is deleted, the attribute which shows an applicable user's information may not be outputted.

(d) The example for execution

DWClientUtil.bat GETOUTBOX
 -fromdate "2014/06/01"
 -todate "2014/06/30"
 -result "C:\DWCLient\OUTBOX-result.xml"
 -property "C:\DWCLient\property.xml"

(2) In-box list acquisition

Acquire the list of delivery of In-box and output it to the execution result file. In the following cases etc, this is used.

When you confirm the situation of delivery (reception) with status of delivery.

When you identify delivery ID to appoint in "the receiving files".

(a) Format

DWClientUtil.bat GETINBOX
   [ - senderid the user ID of the sender | - sendermail the email address of the user of the sender]
   [ -detail]
   [ -inprogress]
    -fromdate the start date to acquire information of deliveries
    -todate the end date to acquire information of deliveries
    -result the path of the execution result file
    -property the path of the Command Property File

(b) Argument

Table 10‒4: The argument of In-box list acquisition

No

Option

Explanation

1

-senderid

When you acquire delivery in In-box, you appoint the user ID of the sender user that you want to limit. When this option is omitted, all send user becomes a target of the acquisition.

-sendermail options and this can't be specified at the same time.

2

-sendermail

When you acquire delivery in In-box, you appoint the email address of the sender user that you want to limit. When this option is omitted, all sender user becomes a target of the acquisition.

-senderid options and this can't be specified at the same time.

3

-detail

You acquire detailed information. File information is included in detailed information in addition to the delivery information. After the detailed information is acquired, the receipt process for the delivery will be performed.

The status before the receipt of the delivery is output to the execution result file.

In the receipt process, the audit log is output, and an email notification is sent if the receipt notification is enabled, changing the status of In-box to Opened.

When this option is omitted, you acquire the information that does not contain the file information.

4

-inprogress

You acquire unreceived delivery. When this option is omitted, you acquire all delivery to the execution user.

Unreceived delivery here points out not delivery which is not written in the Received List File, but delivery to which the reception record of the applicable user does not exist in Data Highway - Server side.

5

-fromdate

When you acquire delivery, you appoint the send date of delivery (send-date) that you limit. You specify the starting date of the period when you want to acquire delivery, in the form of Data Highway - Server local thyme and YYYY/MM/DD.

6

-todate

When you acquire delivery, you appoint the send date of delivery (send-date) that you limit. You specify the ending date of the period when you want to acquire delivery, in the form of Data Highway - Server local thyme and YYYY/MM/DD. The delivery information outputted contains the specified date.

7

-result

Specify the path of the execution result file.

The file is outputted in XML format.

8

-property

Refer to 9.3.1(2) Common options.

(c) Description

(i) When you specify -detail option

The format of the execution result file which is outputted when you specify -detail option is specified is as follows.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
    <deliveries>
        <delivery id="154" download-status="downloaded" send-date="2014/07/29 11:43" shelf-life-time="2014/08/29 23:59" subject="XX development project" total-size="2364662">
            <sender id="user1@domain1" email="user1@domain1.co.jp">
                <files>
                    <file id="130" type="file" name="XX_Report.doc" size="266752"/>
                    <file id="131" type="file" name="set_of_XX_development_documents.zip" size="2097910"/>
                </files>
            </sender>
            <message>I send the documents.</message>
        </delivery>
    </deliveries>
</data>

(ii) When you do not specify -detail option

The format of the execution result file which is outputted when you do not specify -detail option is specified is as follows. Unlike the case where -detail option is specified, file Element, message Attribute, and total-size Attribute are not outputted.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
    <deliveries>
        <delivery id="154" download-status="downloaded" send-date="2014/07/29 11:43" shelf-life-time="2014/08/29 23:59" subject="XX development project">
            <sender id="user1@domain1" email="user1@domain1.co.jp"/>
        </delivery>
    </deliveries>
</data>

(iii) Details of the execution result file format

The meanings of the elements which are outputted to the delivery information file are as follows. In addition, the special symbol in XML is transposed to the entity reference (escape character) and outputted.

Table 10‒5: The meanings of the elements of the execution result file

Element/Attribute

Number

Explanation

data Element

1

It is always outputted.

delivery Element

n

Delivery information tag of delivery unit.

id Attribute

1

Delivery ID is outputted.

It is used to identify delivery.

download-status Attribute

1

The status of the delivery is outputted.

not-opened : The delivery is not opened

opened : The delivery is opened

downloaded : The delivery is downloaded files

send-date Attribute

1

The sending date-time is outputted.

shelf-life-time Attribute

1

The storage expiry date is outputted.

subject Attribute

1

The subject of the delivery is outputted.

total-size Attribute

1

Total data size is outputted with a number of bytes.

sender Element

1

The sender information tag.

id Attribute

1

The sender's user ID is outputted.

email Attribute

1

The sender's email address is outputted.

files Element

1

The send file/folder information tag.

file Element

n

The send file/folder information tag of the send file/folder unit.

id Attribute

1

ID of the file/folder is outputted.

type Attribute

1

The type of the file/folder is outputted.

File : "file"

Folder : "folder"

name Attribute

1

The name of the file/folder is outputted.

size Attribute

1

The size of the file/folder is outputted with a number of bytes.

message Attribute

1

The input message of the sender outputted.

Important

When the sender's user is deleted, the attribute which shows an applicable user's information may not be outputted.

(d) The example for execution

DWClientUtil.bat GETINBOX
 -fromdate "2014/06/01"
 -todate "2014/06/30"
 -result "C:\DWCLient\INBOX-result.xml"
 -property "C:\DWCLient\property.xml"

(3) Delivery cancellation

Target specific delivery by specifying delivery ID and cancel the executing delivery (sending files/receiving files).

(a) Format

DWClientUtil.bat CANCEL
   [-deliveryid delivery ID]
   -property the path of the Command Property File

(b) Argument

Table 10‒6: The argument of delivery cancellation

No

Option

Explanation

1

-deliveryid

You appoint delivery ID of the delivery that you want to cancel. The number of delivery ID which can be specified is one. You cannot appoint plural delivery ID. You acquire delivery ID to appoint in this option using Out-box list acquisition (GETOUTBOX) or In-box list acquisition (GETINBOX) of the data transfer management command.

When this option is omitted, all the sending/receiving that the execution user (the user who was listed in the property file which you appointed with -property option) of this command delivered becomes a target of the cancellation.

2

-property

Refer to 9.3.1(2) Common options.

(c) Description

(i) Precondition

When you cancel the delivery using this function, the execution user of transfer specified by delivery ID needs to be the same user as the execution user (the user who was listed in the property file which you appointed with -property option) of this command. When it is not the same user, it becomes the error.

When the user ID is the same, the execution terminal of the sending/receiving command and the execution terminal of the delivery cancellation command do not need to be the same.

Important

The delivery which carried out delivery cancellation cannot be resumed.

If delivery cancellation which omitted delivery ID during execution of the sending/receiving command is performed, an error may occur. In this case, please perform delivery cancellation again.

(4) Delivery deletion

Target specific delivery by specifying delivery ID and delete delivery which transmission completed.

For example, when you delete the transmission data which you delivered by mistake, you use this.

(a) Format

DWClientUtil.bat DELETEDELIVERY
   [-deliveryid delivery ID]
    -property the path of the Command Property File

(b) Argument

Table 10‒7: The argument of delivery deletion

No

Option

Explanation

1

-deliveryid

You appoint delivery ID of the delivery that you want to delete. The number of delivery ID which can be specified is one. You cannot appoint plural delivery ID. You acquire delivery ID to appoint in this option using Out-box list acquisition (GETOUTBOX) of the data transfer management command.

2

-property

Refer to 9.3.1(2) Common options.

(c) Description

(i) Precondition

When you delete the delivery using this function, the delivery specified by delivery ID needs to be the same user as the execution user (the user who was listed in the property file which you appointed with -property option) of this command. When it is not the same user, it becomes the error.

When the user ID is the same, the execution terminal of the sending files command and the execution terminal of the delivery deletion command do not need to be the same.

Important

When Data Highway - Server is the Windows version, in the middle of the downloading, you can't delete the delivery. When Data Highway - Server is the Linux version, in the middle of the downloading, you can delete the delivery, but the downloading is continued.

When delivery ID does not exist or when there isn't authority to delete delivery of specified delivery ID, it becomes the error.

(5) Resource usage acquisition

Acquire resource usage (disk usage and the amount of downloads per month).

This command is used to check the disk usage and verify whether or not the download limit per month is exceeded.

(a) Format

DWClientUtil.bat GETRESOURCEINFO
    -result the path of the execution result file
    -property the path of the Command Property File

(b) Argument

Table 10‒8: The argument of resource usage acquisition

No

Option

Explanation

1

-result

Specify the path of the execution result file.

The file is outputted in XML format.

2

-property

Refer to 9.3.1(2) Common options.

(c) Description

(i) Format of the execution result file

The format of the execution result file is as follows:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<information>
      <user>
            <disk-space>
                  <used>1002000000</used>
                  <limit>2000000000</limit>
            </disk-space>
      </user>
      <domain>
            <disk-space>
                  <used>10000000002</used>
                  <limit>20000000000</limit>
            </disk-space>
            <download-transfer>
                  <used>150000000000</used>
                  <limit>200000000000</limit>
            </download-transfer>
      </domain>
</information>

(ii) Details of the execution result file format

The meanings of the elements which are output to the execution result file are shown below. In addition, the special symbol in XML is transposed to the entity reference (escape character) and output.

Table 10‒9: The meanings of the elements of the execution result file

Element/Attribute

Number

Explanation

information Element

1

It is always outputted.

user Element

1

The user information tag

disk-space Element

1

The disk information tag

used Element

1

The disk usage of the user (in bytes) is output.

limit Element

1

The disk space available to the user (in bytes) is output.

domain Element

1

The domain information tag

disk-space Element

1

The disk information tag

used Element

1

The disk usage of the entire domain (in bytes) is output.

limit Element

1

The disk space of the entire domain (in bytes) is output.

download-transfer Element

1

The download information tag

used Element

1

The amount of downloads of the entire domain in the current month (in bytes) is output.

limit Element

1

The download limit per month (in bytes) is output.

(d) The example for execution

DWClientUtil.bat GETRESOURCEINFO
 -result "C:\DWCLient\RESOURCEINFO-result.xml"
 -property "C:\DWCLient\property.xml"

10.4 Troubleshooting of the data transfer management command

The solution of troubles which are occurred when the data transfer management command is used is as follows.

10.4.1 FAQ of the data transfer management command

FAQ of the data transfer management command is the same as the data transfer command. Refer to 9.4.1 FAQ of the data transfer command.

10.4.2 Messages of the data transfer management command

Messages of the data transfer management command has message in common with the data transfer command, and peculiar messages of the data transfer management command. For more information about common messages see 9.4.2 Messages of the data transfer command.

The list of peculiar messages of the data transfer management command is as follows.

Table 10‒10: The list of messages

Message ID

Message contents

Explanation

DWCO1732_E

The specified date is wrong.(Date:{0})

Check that the form of the date is YYYY/MM/DD, or that the date is right.

Date is outputted to {0} parameter.

DWCO1801_I

Got information of deliveries.

Notify that the acquisition of information of deliveries was successful.

DWCO1802_E

Failed to get information of deliveries. (Details:{0})

Failed to get information of deliveries. Refer to the details reason, improve the setting, and perform again.

The Details reason is outputted to {0} parameter.

DWCO1803_E

Failed to output information of deliveries to a XML file. (Path:{0})

Check the command has the permission to write the specified file.

Pass of a XML file is outputted to {0} parameter.

DWCO1841_I

Deleted a delivery.(Delivery ID:{0})

Notify that the deletion of a delivery was successful.

Delivery ID is outputted to {0} parameter.

DWCO1843_E

Failed to delete a delivery. It might be caused by the following reasons. The delivery is sending or downloading. (Delivery ID:{0}, Details:{1})

Notify that the deletion of a delivery was failed.

The following contents are outputted for each parameter.

{0} : Delivery ID

{1} : The Details reason

DWCO1850_I

Resource information was obtained.

Notify that the acquisition of resource usage (disk space and the amount of downloads per month) was successful.

DWCO1851_E

Resource information could not be obtained. (Path: {0})

Notify that the acquisition of resource usage (disk space and the amount of downloads per month) failed.

Path to the XML file is output to the {0} parameter.

DWCO2005_W

Running transfers of files do not exist.

Notify that the running transfers of files did not exist.

DWCO2006_W

Running transfers of files do not exist. (Delivery ID:{0})

Notify that the running transfers of files did not exist with the specified delivery ID.

Delivery ID is outputted to {0} parameter.

DWCO2009_E

The specified delivery was not exist. (Delivery ID:{0})

Notify that the specified delivery did not exist.

Check that the specified delivery ID is right.

Delivery ID is outputted to {0} parameter.

DWCO2022_I

Canceled running transfers of files. (Delivery ID:{0})

Notify that the canceled running transfers of files.

Delivery ID is outputted to {0} parameter.

DWCO2025_I

The specified delivery has already cancelled. (Delivery ID:{0})

Notify that the delivery that you are trying to cancel has been already cancelled.

Delivery ID is outputted to {0} parameter.

DWCO2026_E

Failed to cancel the specified delivery because it has already suspended. (Delivery ID:{0})

Cannot cancel delivery that became the suspended state.

Delivery ID is outputted to {0} parameter.

DWCO2027_E

The specified delivery cannot be cancelled. (Delivery ID:{0})

Cannot cancel except delivery which self transmitted.

Delivery ID is outputted to {0} parameter.

11 User Count Command

This chapter describes how to use the user count command.

11.1 Overview of the user count command

The user count command counts the number of users registered in JP1/DH - Server.

Note that the number of users is counted only if the database service (JP1_DH_DATABASE_SVR) is running.

11.2 Details of the user count command

This section describes the form of the user count command.

11.2.1 Executable form

The executable form of the user count command is as follows:

jp1dhnodecount [ -m]

Table 11‒1: Setting items of the user count command

No

Option

Explanation

1

-m

Outputs the number of users registered in JP1/DH - Server running on the host where the user count command is executed to the standard output.

If this option is omitted, the usage is output.

11.2.2 Output format

The user count command output format is as follows:

The number of registered users

Table 11‒2: The user count command output format

No

Output value

Explanation

1

The number of registered users

The number of users registered in JP1/DH - Server is output. This number includes guest users.

Regardless of the user status (whether the user is activated or inactivated and whether the account is valid or expired), all the registered users are counted and the result is output.

11.2.3 The save location for the commands

The user count command is stored in the following directories at the time of JP1/DH - Server installation:

In Windows

installation-folder \bin\

In Linux

/opt/jp1dh/server/bin/

11.2.4 Exit codes

The exit codes to be output by command execution are shown below.

Table 11‒3: Return code of the user count command output format

No

Exit code

Description

1

0

Indicates that the command execution process ended normally.

2

84

An argument is invalid.

3

86

Communication error.

The file in which the number of registered users is recorded cannot be accessed.

4

127

Internal error.

11.2.5 Message

The list of peculiar messages of the user count command is as follows.

If the exit code is 0, a message is output to the standard output. If the exit code is other than 0, a message is output to the standard error output.

(1) Output format

The output format of the message is as follows.

Message ID_Message

(2) Format of message explanations

Messages are explained in the following format in this command.

Message ID

Message text: message text

(S)

System action

(O)

Operator action at message output

(3) The list of messages

KJDH7001-E

A command argument is incorrect.

(S)

The processing of the command will stop.

(O)

Specify the correct argument, and then re-execute the command.

KJDH7002-E

Acquisition of the number of users failed.

(S)

The processing of the command will stop.

(O)

Perform the following operations, and then execute the command again:

If the database service (JP1_DH_DATABASE_SVR) is not running, start the database service.

Write the password for the database into the JP1/DH - Server configuration file (digikatsuwide.xml). Then, change the application configuration by following the instructions in 5.3.2 Changing the application configuration.

If the same error continues to occur even after the operations 1 and 2 above are performed, collect data by using the data collection tool and then contact the system administrator.

KJDH7003-E

An internal error occurred.

(S)

The processing of the command will stop.

(O)

Change the application configuration by following the instructions in 5.3.2 Changing the application configuration. Then, execute the command again.

If the same error continues to occur even after the application configuration is changed, collect data by using the data collection tool and then contact the system administrator.

Extract data by using a data extraction tool, and then contact a system administrator.

11.2.6 Usage

If the user count command is executed with no argument specified or if the specified argument is invalid, an error message is output and then the usage is subsequently output in the following format:

usage jp1dhnodecount [ -m]

11.2.7 Log

The output format of the user count command log is as follows.

Table 11‒4: The output format of the user count command log

No

Item

Description

1

Log output

In Windows

installation-folder \log\operation\

In Linux

/opt/jp1dh/server/log/operation/

2

Log file name

license_count0.log

license_count1.log

3

File size

1MB

4

Number of log files

2

5

Output details

date time result details

The output contents of the user count command are as follows.

Table 11‒5: The output contents of the user count command

No

Date time

Result

Details

1

yyyy/mm/dd hh:mm:ss

SUCCESS

Registered users: number-of-registered-users

2

ERROR

details-of-the-error

3

ARG_ERROR

None

4

INTERNAL_ERROR

The resource file does not exist. (path-to-the-file-that-does-not-exist)

The configure file does not exist.(path-to-the-file-that-does-not-exist)

12 Operation and Failure Corrective Actions

This chapter describes the commands used for operation of and failure corrective actions for JP1/DH - Server.

12.1 List of commands

The following tables describe commands for acquiring failure information acquisition and operations management provided by JP1/DH - Server.

Table 12‒1: Commands for acquiring failure information provided by JP1/DH - Server

No.

Command name

Function

1

In Windows

getlog_server.bat

Acquires the failure information without the database backup from the server.

In Linux

getlog_server.sh

2

In Windows

getdetaillog_server.bat

Acquires the failure information with the database backup from the server.

In Linux

getdetaillog_server.sh

3

In Windows

getlog_client.bat

Acquires the failure information from a client.

In Linux

getlog_client.sh

Table 12‒2: Commands for operations management provided by JP1/DH - Server

No.

Command name

Function

1

In Windows

dbbackup.bat

Backs up the database.

In Linux

dbbackup.sh

2

In Windows

dbrestore.bat

Restores the database.

In Linux

dbrestore.sh

3

In Windows

dbchangepassword.bat

Changes the database password.

In Linux

dbchangepassword.sh

4

In Windows

regist_users_number.bat

Registers the number of purchased user licenses.

In Linux

regist_users_number.sh

5

In Windows

selfsignedkeygen.bat

Creates a secret key.

In Linux

selfsignedkeygen.sh

6

In Windows

selfsignedcertreq.bat

Creates a CSR (certificate signing request).

In Linux

selfsignedcertreq.sh

7

In Windows

selfsigned.bat

Creates a self-signed server certificate.

In Linux

selfsigned.sh

The save location for the commands is as follows:

installation-folder #\bin\

#: In Linux, change installation-folder to /opt/jp1dh/server.

12.2 Commands for acquiring failure information

This section describes the commands for acquiring the failure information of JP1/DH - Server.

Important

In Linux, ".bat" of the command name change to ".sh".

12.2.1 getlog_server.bat (acquiring the failure information without the database backup from the server)/getdetaillog_server.bat (acquiring the failure information with the database backup from the server)/getlog_client.bat (acquiring failure information from a client)

(1) Function

Acquire failure information of JP1/DH - Server from the server or client machine. These commands enable you to acquire the following information in the machine environment where JP1/DH - Server operates:

OS information

Hardware information

Running process

Network configuration

Installed application

Event logs (For applications and system)

Setting information for Internet Explorer

Setting information for Java

Log information for linked products

Configuration files for JP1/DH - Server

Database information

Before using the getlog_client.bat command, change the following item in the batch file:

rem ----------------------------
rem  User-set items
rem ----------------------------
set SERVERNAME=FQDN-of-JP1/DH-Server-machine

Example:

rem ----------------------------
rem  User-set items
rem ----------------------------
set SERVERNAME= jp1dhserver.foo1.foo2,co.jp

(2) Executor

A user with a built-in Administrator account or with Administrator permissions executes the command from the command prompt.#

#

Do not execute a command directly. Use the command prompt to execute a command.

(3) Format

To acquire failure information from the server machine:

getlog_server.bat or getdetaillog_server.bat DB-password

To acquire failure information from a client machine:

getlog_client.bat

(4) Arguments

DB-password

Specify the database password.

The default value for the database password is set to p@ssw0rd.

(5) Execution results

The files with the command execution results are stored in the logdata folder created immediately below the current directory where the command is executed.

The following figures show the configuration of output files.

Figure 12‒1: Example of the output files (When the command is executed on the server)

Figure 12‒2: Example of the output files (When the command is executed on a client)

Note that some of the files to be output in Linux are different from those in Windows. Files with differences are as follows:

Output destination of registry information

logdata/reg/.HTC_xxxx.inf

Note: xxxx represents a value output differently depending on your product.

Output destination of \logdata\netstat\ipconfigall.txt (a file that includes TCP/IP configuration for all adapters)

logdata/reg/ifconfiga.txt

\logdata\netstat\ipconfigdisplaydns.txt (a file that includes DNS cache) is not output.

Output destination of the event log data

logdata/event/messages

logdata/event/messages-yyyymmdd

In Linux, corresponding system log data is acquired.

(6) Return codes

Return code

Description

Operation after an event occurrence

Occurrence condition

0

Normal

--

Information is collected successfully.

4

Warning (information level)

Interrupts command processing.

Execution of command is canceled during permission confirmation response for collecting information.

Execution of command is canceled during folder deletion confirmation response.

8

Error

Interrupts command processing.

Information collection failed.

16

Error

Interrupts command processing.

A command is executed without the database password specified as the argument.

The backup of the database by using the backup command failed (only when the getdetaillog_server.bat command is executed).

(7) Output message (Output destination: stdout)

No.

Message

Return code

Operation after an event occurrence

Action to be taken by the operator

Occurrence condition

1

Failure information will be collected.

--

Starts command execution.

None

When a command is executed

2

Successfully collected the failure information. Press any key.

0

Terminates command execution.

None

When information is collected successfully

3

Did not successfully collect the failure information. Check the following items:

Does the user who executed the command have Administrator permissions?

Does the user who executed the command have write permission for the output folder?

8

Terminates command execution.

Check the following and re-execute the command:

The user executing the command has Administrator permissions.

The user executing the command has write permission to the output destination folder.

When collecting information failed

4

Did not successfully collect the failure information. Could not find the configuration file to be copied.

8

Terminates command execution.

Make sure that the collection target file exists.

When the collection target configuration file is not found

5

An output folder for the collected information exists. Overwrite the output information? (y/n)

--

Waits for user response.

Select y to continue execution, or n to cancel execution.

When a log output destination folder already exists

6

Canceled command execution. Press any key.

4

Terminates command execution.

If you selected n in No. 5, delete or move the log output destination folder, and then re-execute the command.

When n is selected in No. 5

7

Specify the DB password in the argument. Press any key and try again.

16

Terminates command execution.

Specify the database password as the argument, and then re-execute the command.

When a command is executed without the database password specified as the argument

8

Did not successfully collect the failure information. Press any key and try again.

16

Terminates command execution.

Check the following and re-execute the command:

The database service (JP1_DH_DATABASE_SVR) is running.

The password specified in the command is correct.

The content of the database error message that was output immediately before this message is checked and the cause of the error is removed.

When backing up the database with the backup command failed

(Only when the getdetaillog_server.bat command is executed)

Note: If an error occurs within the database, the error message described above is output after an error message is output by the database.

(8) Notes on using the command

Do not execute a command directly. Use the command prompt to execute a command.

If you have enabled UAC (User Account Control) in the operating system, use one of the following ways to execute a command:

Log in as a built-in Administrator user, start the command prompt, and then execute a command.

Log in as a user with Administrator permissions, start the command prompt by clicking Run as Administrator, and then execute a command.

Execute a command from a shortcut for the command prompt with the elevated privileges created at the time of JP1/DH - Server installation.#

#

If you use a command prompt in this way in Windows Server 2012, Windows Server 2012 R2 or Windows Server 2016, you need to install Microsoft .NET Framework 3.5. For details about how to install Microsoft .NET Framework 3.5, see D. Installing .NET Framework 3.5.

If the command is interrupted due to an error in the database, a backup file with a size of 0 bytes is created.

In an execution environment such as the ones described below, acquiring failure information might take a while.

Where there are many connections to the network

If the machine has many definitions of network connections, acquiring network configuration information might take time.

Where there are many output logs

If you execute the getlog_client.bat command in the 32-bit command prompt on a client with a 64-bit operating system, you cannot acquire the information about the 64-bit application. Make sure that you execute the command in the 64-bit command prompt.

Simultaneous executions of commands on the same machine are not supported.

12.3 Commands for operations management

This section describes the commands for operations management of JP1/DH - Server.

Note that the default value for the database password is set to p@ssw0rd.

Important

In Linux, ".bat" of the command name change to ".sh".

12.3.1 dbbackup.bat (backing up the database)

(1) Function

Logically backs up the database used by JP1/DH - Server.

(2) Executor

A user with a built-in Administrator account or with Administrator permissions executes the command from the command prompt.#

#

Do not execute a command directly. Use the command prompt to execute a command.

(3) Format

dbbackup.bat DB-password backup-destination-folder [backup-file-name]

(4) Arguments

DB-password

Specify the database password.

backup-destination-folder

Specify the destination folder to output the database backup file with an absolute path.

Specify the absolute path length no more than 200 bytes.

backup-file-name (optional)

Specify the name of the database backup file with an absolute path.

If you omit this argument, the backup file is created with the name of dbbackup.dump.

(5) Execution results

A backup file is output in the specified destination folder.

(6) Return codes

Return code

Description

Operation after an event occurrence

Occurrence condition

0

Normal

--

Backup succeeded.

4

Warning

Interrupts command processing.

Execution of command is canceled during overwrite-confirmation response.

8

Warning

Interrupts command processing.

A command is executed without the argument specified.

A command is executed without the database password specified.

The folder specified as the argument does not exist.

16

Error

Interrupts command processing.

Backup failed.

(7) Output message (Output destination: stdout)

No.

Message

Return code

Operation after an event occurrence

Action to be taken by the operator

Occurrence condition

1

The backup will start.

--

Starts command execution.

None

When a command is executed

2

Successfully finished the backup. Press any key.

0

Terminates command execution.

None

When backup succeeded

3

Specify the DB password in the argument. Press any key and try again.

8

Terminates command execution.

Specify the database password as the argument, and then re-execute the command.

When a command is executed without the database password specified as the argument

4

Specify the backup folder in the argument.

8

Terminates command execution.

Specify the backup destination folder as the argument, and then execute the command.

When a command is executed without the argument specified

5

The specified folder does not exist. Press any key and try again.

8

Terminates command execution.

Make sure that the specified backup destination folder is correct.

When an incorrect folder is specified as the argument

6

Did not successfully finish the backup. Press any key and try again.#

16

Terminates command execution.

Check the following and re-execute the command:

The database service (JP1_DH_DATABASE_SVR) is running.

The password specified in the command is correct.

The content of the database error message that was output immediately before this message is checked and the cause of the error is removed.

When backup failed

7

******* exists in the backup folder. Overwrite the output information? (y/n)

--

Waits for user response.

Select y to continue execution, or n to cancel execution.

When a backup file already exists in the backup destination folder

8

Canceled command execution. Press any key.

4

Terminates command execution.

If you selected n in No. 7, agree to the confirmation item and then press any key.

When n is selected in No. 7

#: If an error occurs within the database, this error message is output after an error message is output by the database.

(8) Notes on using the command

Do not execute a command directly. Use the command prompt to execute a command.

If you have enabled UAC (User Account Control) in the operating system, use one of the following ways to execute a command:

Log in as a built-in Administrator user, start the command prompt, and then execute a command.

Log in as a user with Administrator permissions, start the command prompt by clicking Run as Administrator, and then execute a command.

Execute a command from a shortcut for the command prompt with the elevated privileges created at the time of JP1/DH - Server installation.#

#

If you use a command prompt in this way in Windows Server 2012, Windows Server 2012 R2 or Windows Server 2016, you need to install Microsoft .NET Framework 3.5. For details about how to install Microsoft .NET Framework 3.5, see D. Installing .NET Framework 3.5.

If the command is interrupted due to an error in the database, a backup file with a size of 0 bytes is created.

Simultaneous executions of commands on the same machine are not supported.

12.3.2 dbrestore.bat (restoring the database)

(1) Function

Restores the database used by JP1/DH - Server from the backup file. Before executing this command, shut down the JP1/DH Web application server (Cosminexus J2EE server).

(2) Executor

A user with a built-in Administrator account or with Administrator permissions executes the command from the command prompt.#

#

Do not execute a command directly. Use the command prompt to execute a command.

(3) Format

dbrestore.bat DB-password restore-source-folder [restore-file-name]

(4) Arguments

DB-password

Specify the database password.

restore-source-folder

Specify the destination folder where the database backup file is stored with an absolute path.

Specify the absolute path length no more than 200 bytes.

restore-file-name (optional)

Specify the name of the backup file to be used for restoring the database.

If you omit this argument, dbbackup.dump is used for restoration.

(5) Execution results

The data in the specified backup file is restored to the database.

(6) Return codes

Return code

Description

Operation after an event occurrence

Occurrence condition

0

Normal

--

Restoration succeeded.

4

Warning

Interrupts command processing.

A command is executed without the argument specified.

A command is executed without the database password specified.

The folder specified as the argument does not exist.

8

Error

Interrupts command processing.

Restoration failed.

16

Warning

Interrupts command processing.

Execution of the command is canceled during confirmation response for shutting down the JP1/DH Web application server (Cosminexus J2EE server).

(7) Output message (Output destination: stdout)

No.

Message

Return code

Operation after an event occurrence

Action to be taken by the operator

Occurrence condition

1

The restoration will start.

--

Starts command execution.

None

When a command is executed

2

Successfully finished the restoration. Press any key.

0

Terminates command execution.

None

When restoration succeeded

3

Specify the DB password in the argument. Press any key and try again.

4

Terminates command execution.

Specify the database password as the argument, and then re-execute the command.

When a command is executed without the database password specified as the argument

4

Specify the restore source folder in the argument.

4

Terminates command execution.

Specify the restore source folder as the argument, and then re-execute the command.

When a command is executed without the argument specified

5

The specified folder does not exist. Press any key and try again.

8

Terminates command execution.

Make sure that the specified restore source folder is correct.

When an incorrect folder is specified as the argument

6

******* does not exist in the specified folder.

8

Terminates command execution.

Make sure that the specified restore source folder and restore file name are correct.

When an incorrect folder or restore file name is specified as the argument

7

Did not successfully finish the restoration. Press any key and try again.#

8

Terminates command execution.

Check the content of the output error message, remove the cause of the error, and then re-execute the command.

When restoration failed

8

Confirm that the DH Web application server is suspended before continuing. Continue? (y/n)

--

Waits for user response.

Select y to continue execution, or n to cancel execution.

When a command is executed

9

Canceled command execution. Press any key.

16

Terminates command execution.

If you selected n in No. 8, agree to the confirmation item and then press any key.

When n is selected in No. 8

#: If an error occurs within the database, this error message is output after an error message is output by the database.

(8) Notes on using the command

Do not execute a command directly. Use the command prompt to execute a command.

If you have enabled UAC (User Account Control) in the operating system, use one of the following ways to execute a command:

Log in as a built-in Administrator user, start the command prompt, and then execute a command.

Log in as a user with Administrator permissions, start the command prompt by clicking Run as Administrator, and then execute a command.

Execute a command from a shortcut for the command prompt with the elevated privileges created at the time of JP1/DH - Server installation.#

#

If you use a command prompt in this way in Windows Server 2012, Windows Server 2012 R2 or Windows Server 2016, you need to install Microsoft .NET Framework 3.5. For details about how to install Microsoft .NET Framework 3.5, see D. Installing .NET Framework 3.5.

Simultaneous executions of commands on the same machine are not supported.

12.3.3 dbchangepassword.bat (changing the database password)

(1) Function

Changes the password for the database that is used by JP1/DH - Server.

You can use alphanumeric characters and the following symbols in this command:#

& | < > ( ) % ^ ; , ' \ ! ? # $ ~ - = @ + * . /

#

Do not use any characters or symbols except the ones described above in a password. If you use any characters or symbols other than the ones described above, you might not be able to change the password any more.

Also, make sure that you make changes to the following configuration file and batch file after changing the password:

digikatsuwide.xml

File path

installation-folder\misc\digikatsuwide\digikatsuwide\WEB-INF\digikatsuwide.xml

Description of changes

<persistence>
      <database>
            <password>password-after-change</password>
      </database>

Example:

<persistence>
      <database>
            <password>Dh8%7uK0(z$a</password>
      </database>

dbcreate.bat

File path

installation-folder\setup_util\dbcreate.bat

Description of changes

set PGPASSWORD=password-after-change

Example:

set PGPASSWORD=Dh8%7uK0(z$a

(2) Executor

A user with a built-in Administrator account or with Administrator permissions executes the command from the command prompt.#

#

Do not execute a command directly. Use the command prompt to execute a command.

(3) Format

dbchangepassword.bat password-before-change password-after-change

(4) Arguments

password-before-change

Specify the current password.

If you use any of the following symbols, append a caret (^) escape character to the symbol, and then enclose the caret and symbol in double quotation marks:

& | < > ( ) % ^ ; , ' \

password-after-change

Specify a new password.

If you use any of the following symbols, append a caret (^) escape character to the symbol, and then enclose the caret and symbol in double quotation marks:

& | < > ( ) % ^ ; ,

In addition, if you use one of the following symbols, append a backslash (\) escape character to the symbol:

' \

(5) Execution results

The database password is changed.

(6) Return codes

Return code

Description

Operation after an event occurrence

Occurrence condition

0

Normal

--

The password is changed successfully.

4

Warning

Interrupts command processing.

Execution of the command is canceled during password change confirmation response.

8

Warning

Interrupts command processing.

No argument is specified.

16

Warning

Interrupts command processing.

The number of specified arguments is incorrect.

32

Error

Interrupts command processing.

The password change failed.

(7) Output message (Output destination: stdout)

No.

Message

Return code

Operation after an event occurrence

Action to be taken by the operator

Occurrence condition

1

The DB password will be changed to ******. Are you sure? (y/n)

--

Waits for user response.

Select y to continue execution, or n to cancel execution.

When a command is executed

2

The password will be changed.

--

Starts command execution.

None

When y is selected in No. 1

3

Successfully changed the password. Press any key.

0

Terminates command execution.

None

When the password is changed successfully

4

Specify an argument. Press any key and try again.

8

Terminates command execution.

Specify the current database password and new database password as the arguments, and then re-execute the command.

When no argument is specified

5

The number of arguments is invalid. Press any key and try again.

16

Terminates command execution.

Specify the current database password and new database password as the arguments, and then re-execute the command.

When the number of specified arguments is incorrect

6

Did not successfully change the password. Press any key and try again.#

32

Terminates command execution.

Check the content of the output error message, remove the cause of the error, and then re-execute the command.

When the password change failed

7

Canceled command execution. Press any key.

4

Terminates command execution.

If you selected n in No. 1, specify the new password, and then execute the command.

When n is selected in No. 1

#: If an error occurs within the database, this error message is output after an error message is output by the database.

(8) Notes on using the command

Do not execute a command directly. Use the command prompt to execute a command.

If you have enabled UAC (User Account Control) in the operating system, use one of the following ways to execute a command:

Log in as a built-in Administrator user, start the command prompt, and then execute a command.

Log in as a user with Administrator permissions, start the command prompt by clicking Run as Administrator, and then execute a command.

Execute a command from a shortcut for the command prompt with the elevated privileges created at the time of JP1/DH - Server installation.#

#

If you use a command prompt in this way in Windows Server 2012, Windows Server 2012 R2 or Windows Server 2016, you need to install Microsoft .NET Framework 3.5. For details about how to install Microsoft .NET Framework 3.5, see D. Installing .NET Framework 3.5.

Simultaneous executions of commands on the same machine are not supported.

12.3.4 regist_users_number.bat (registering the number of purchased user licenses)

(1) Function

Registers the number of purchased users of JP1/DH - Server.

(2) Executor

A user with a built-in Administrator account or with Administrator permissions executes the command from the command prompt.#

#

Do not execute a command directly. Use the command prompt to execute a command.

(3) Format

regist_users_number.bat DB-password number-of-purchased-users

(4) Arguments

DB-password

Specify the database password.

number-of-purchased-users

Specify the number of purchased users (a number from 0 to 2,147,483,647).

(5) Execution results

The number of purchased users is registered in the system.

(6) Return codes

Return code

Description

Operation after an event occurrence

Occurrence condition

0

Normal

--

The number of purchased users is registered successfully.

4

Warning

Interrupts command processing.

Execution of the command is canceled during confirmation response for registering the number of purchased users.

8

Warning

Interrupts command processing.

No argument is specified.

The number of specified arguments is incorrect.

16

Error

Interrupts command processing.

The registration of the number of purchased users failed.

(7) Output message (Output destination: stdout)

No.

Message

Return code

Operation after an event occurrence

Action to be taken by the operator

Occurrence condition

1

The number of purchased users to be registered is ******. Are you sure? (y/n)

--

Waits for user response.

Select y to continue execution, or n to cancel execution.

When a command is executed

2

The number of purchased users will be registered.

--

Starts command execution.

None

When y is selected in No. 1

3

Successfully registered the number of purchased users. Press any key.

0

Terminates command execution.

None

When the number of purchased users is registered successfully

4

Specify an argument. Press any key and try again.

8

Terminates command execution.

Specify the database password and the number of purchased users as the arguments, and then re-execute the command.

When no argument is specified

When the number of purchased users is specified with characters other than the single-byte numbers

5

The number of arguments is invalid. Press any key and try again.

8

Terminates command execution.

Specify the database password and the number of purchased users as the arguments, and then re-execute the command.

When the number of specified arguments is incorrect

6

Did not successfully register the number of purchased users. Press any key and try again.#

16

Terminates command execution.

Check the content of the output error message, remove the cause of the error, and then re-execute the command.

When the registration of the number of purchased users failed

7

Canceled command execution. Press any key.

4

Terminates command execution.

If you selected n in No. 1, specify the number of purchased users to be registered, and then execute the command.

When n is selected in No. 1

#: If an error occurs within the database, this error message is output after an error message is output by the database.

(8) Notes on using the command

Do not execute a command directly. Use the command prompt to execute a command.

If you have enabled UAC (User Account Control) in the operating system, use one of the following ways to execute a command:

Log in as a built-in Administrator user, start the command prompt, and then execute a command.

Log in as a user with Administrator permissions, start the command prompt by clicking Run as Administrator, and then execute a command.

Execute a command from a shortcut for the command prompt with the elevated privileges created at the time of JP1/DH - Server installation.#

#

If you use a command prompt in this way in Windows Server 2012, Windows Server 2012 R2 or Windows Server 2016, you need to install Microsoft .NET Framework 3.5. For details about how to install Microsoft .NET Framework 3.5, see D. Installing .NET Framework 3.5.

Simultaneous executions of commands on the same machine are not supported.

12.3.5 selfsignedkeygen.bat (creating a secret key)

(1) Function

Creates a secret key to be used for immediate use of JP1/DH - Server for purposes such as testing and evaluation.

(2) Executor

A user with a built-in Administrator account or with Administrator permissions executes the command from the command prompt.#

#

Do not execute a command directly. Use the command prompt to execute a command.

(3) Format

selfsignedkeygen.bat
  -out secret-key-file
  [-bits {512|1024|2048|4096}]

(4) Arguments

Important

In the case of Linux, you cannot specify an argument containing single-byte spaces.

-out secret-key-file

Specify the file to which the created secret key is output.

[-bits {512|1024|2048|4096}]

Specify the bit length of a secret key to be created.

If you omit this operand, the underlined value is used.

Important

Keys with a bit length of 1024 or lower are becoming more dangerous with decreased safety. Therefore, specify 2048 or higher for the bit length.

(5) Execution results

A secret key file is created in the folder specified for -out.

(6) Notes on using the command

Do not execute a command directly. Use the command prompt to execute a command.

If you have enabled UAC (User Account Control) in the operating system, use one of the following ways to execute a command:

Log in as a built-in Administrator user, start the command prompt, and then execute a command.

Log in as a user with Administrator permissions, start the command prompt by clicking Run as Administrator, and then execute a command.

Execute a command from a shortcut for the command prompt with the elevated privileges created at the time of JP1/DH - Server installation.#

#

If you use a command prompt in this way in Windows Server 2012, Windows Server 2012 R2 or Windows Server 2016, you need to install Microsoft .NET Framework 3.5. For details about how to install Microsoft .NET Framework 3.5, see D. Installing .NET Framework 3.5.

Simultaneous executions of commands on the same machine are not supported.

12.3.6 selfsignedcertreq.bat (creating a CSR (certificate signing request))

(1) Function

Creates a CSR (certificate signing request) file to be used for immediate use of JP1/DH - Server for the purposes such as testing and evaluation.

(2) Executor

A user with a built-in Administrator account or with Administrator permissions executes the command from the command prompt.#

#

Do not execute a command directly. Use the command prompt to execute a command.

(3) Format

selfsignedcertreq.bat
  -key key-file
  -out CSR-file
  -subject "subject"

(4) Arguments

Important

In the case of Linux, you cannot specify an argument containing single-byte spaces.

-key key-file

Specify the secret key created in 12.3.5 selfsignedkeygen.bat (creating a secret key).

-out CSR-file

Specify the name of the CSR (certificate signing request) file to be created.

-subject "subject"

Specify the subject name of the certificate in the format described below. The values that you can specify are as follows:

"/C=2-character-country-code(JP for Japan)/ST=state-or-province-name/L=city-or-area-name/O=organization-name/OU=organization-unit-name/CN=FQDN-of-the-server-host"

An example of specification is as follows:

"/C=JP/ST=Tokyo/L=Shinagawa-ku/O=Hitachi.Ltd./OU=SoftwareDevelopment/CN=p1dhserver.foo1.foo2.co.jp"

Important

You can specify values with alphanumeric characters and the following symbols:

A half# space, period (.), hyphen (-), and a half comma (,)

You cannot use a forward slash (/).

#: You can specify a single-byte space with Windows only.

(5) Execution results

A CSR (certificate signing request) file is created with the name specified for -out.

(6) Notes on using the command

Do not execute a command directly. Use the command prompt to execute a command.

If you have enabled UAC (User Account Control) in the operating system, use one of the following ways to execute a command:

Log in as a built-in Administrator user, start the command prompt, and then execute a command.

Log in as a user with Administrator permissions, start the command prompt by clicking Run as Administrator, and then execute a command.

Execute a command from a shortcut for the command prompt with the elevated privileges created at the time of JP1/DH - Server installation.#

#

If you use a command prompt in this way in Windows Server 2012, Windows Server 2012 R2 or Windows Server 2016, you need to install Microsoft .NET Framework 3.5. For details about how to install Microsoft .NET Framework 3.5, see D. Installing .NET Framework 3.5.

Simultaneous executions of commands on the same machine are not supported.

12.3.7 selfsigned.bat (creating a self-signed server certificate)

(1) Function

Creates a self-signed server certificate to be used for immediate use of JP1/DH - Server for the purposes such as testing and evaluation.

(2) Executor

A user with a built-in Administrator account or with Administrator permissions executes the command from the command prompt.#

#

Do not execute a command directly. Use the command prompt to execute a command.

(3) Format

selfsigned.bat
  -in CSR-file
  -out certificate-file
  [-sign {MD5|SHA1|SHA224|SHA256|SHA384|SHA512}]
  -signkey key-file
  -days number-of-days-of-validity

(4) Arguments

Important

In the case of Linux, you cannot specify an argument containing single-byte spaces.

-in CSR-file

Specify the CSR file created in 12.3.6 selfsignedcertreq.bat (creating a CSR (certificate signing request)).

Important

You can use the CSR file created in 5.4.3 Creating a certificate file for SSL communication. In this case, specify the secret key created in 5.4.3 Creating a certificate file for SSL communication for the -signkey argument.

-out certificate-file

Specify the name of the self-signed server certificate file to be created.

[-sign {MD5|SHA1|SHA224|SHA256|SHA384|SHA512}]

Specify the signature algorithm used for creating a self-signed server certificate. If you omit this operand, the underlined signature algorithm is used.

MD5: Use md5WithRSAEncryption.

SHA1: Use sha1WithRSAEncryption.

SHA224: Use sha224WithRSAEncryption.

SHA256: Use sha256WithRSAEncryption.

SHA384: Use sha384WithRSAEncryption.

SHA512: Use sha512WithRSAEncryption.

If you omit this operand, the underlined signature algorithm is used.

Important

The signature algorithms MD5 and SHA1 are becoming more dangerous with decreased safety. Therefore, specify a value other than them.

-signkey key-file

Specify the secret key created in 12.3.5 selfsignedkeygen.bat (creating a secret key).

Important

You can use the secret key created in 5.4.3 Creating a certificate file for SSL communication. In this case, specify the CSR file created in 5.4.3 Creating a certificate file for SSL communication for the -in argument.

-days number-of-days-of-validity

Specify the period for which the created certificate is valid in units of days. Note that the command execution day is automatically set as the starting day of the valid period and you cannot change the starting day.

(5) Execution results

A self-signed server certificate is created in the following folder:

installation-folder\bin\

(6) Notes on using the command

Do not execute a command directly. Use the command prompt to execute a command.

If you have enabled UAC (User Account Control) in the operating system, use one of the following ways to execute a command:

Log in as a built-in Administrator user, start the command prompt, and then execute a command.

Log in as a user with Administrator permissions, start the command prompt by clicking Run as Administrator, and then execute a command.

Execute a command from a shortcut for the command prompt with the elevated privileges created at the time of JP1/DH - Server installation.#

#

If you use a command prompt in this way in Windows Server 2012, Windows Server 2012 R2 or Windows Server 2016, you need to install Microsoft .NET Framework 3.5. For details about how to install Microsoft .NET Framework 3.5, see D. Installing .NET Framework 3.5.

Simultaneous executions of commands on the same machine are not supported.

13 Troubleshooting

This chapter describes troubleshooting for JP1/DH - Server.

13.1 Troubleshooting

The following table describes problems that can occur and actions to be taken for these problems.

Table 13‒1: List of troubleshooting tips

No.

Problem

Possible cause

Action to be taken

1

The login window is not displayed during the operation check described in 5.5.1(1) Checking the operation of JP1/DH Web application server.

The IP address of the machine with JP1/DH - Server or the sender email address specified in the JP1/DH Web application server settings might be incorrect.

See 5.3 Setting up the JP1/DH Web application server environment and confirm that the IP address of the server and the sender email address specified in the mail server settings are specified correctly. Neither of these settings can be omitted.

2

When you attempt to access the login window of JP1/DH - Server, the window is not displayed, and the message Page cannot be displayed. The session may have been timed-out. is displayed.

IPv6 protocol might be given priority to be selected or used in the configuration settings for the operating system of the computer where JP1/DH - Server is installed.

In an operating system that supports both IPv6 protocol and IPv4 protocol, if the IPv6 protocol is given priority, the problem described to the left might occur. In such a case, see the support information for your operating system and change the configuration settings so that IPv4 protocol has priority to be used.

3

The login window is not displayed when you attempt to access JP1/DH - Server via the URL, https://FQDN-of-the-server-host/, described in 5.5.1(2) Checking access to JP1/DH - Server. If you access JP1/DH - Server via the URL, https://FQDN-of-the-server-host/index.html, the login window is displayed.

The JP1/DH Web server settings might be incorrect.

See 5.4.4 Editing the settings for the JP1/DH Web server and confirm that the host name of the server is entered in lower case for the setting items ProxyPass and ProxyPassReverse in the httpsd.conf configuration file.

14 Messages

This chapter describes the messages output when errors occur during installation and setup of JP1/DH - Server, and how to respond to these errors.

14.1 Message format

The format of a message to be output by JP1/DH - Server when an error occurs during installation and setup of JP1/DH - Server is described in the following subsection.

14.1.1 Output format of a message

A message to be output consists of a message ID and message text.

KJDHnnnn-Z message-text

Each element of a message ID indicates the following items:

K

Indicates the system identifier.

JDH

Indicates that the message is output by JP1/DH - Server.

nnnn

Indicates the serial number of the message.

Z

Indicates one of the following message types:

E: Error

The processing is interrupted after the message is output.

W: Warning

The processing is continued after the message is output.

I: Information

The user is notified of the information.

14.1.2 Description format of a message

This subsection describes the description format of a message in this manual. Italic characters indicate a placeholder for some actual text to be provided by the system when a message is displayed. Also, messages are listed in ascending order of message IDs. An example of the description format of a message is as follows:

message-ID

message-text

Message description

(S) Indicates how the system handles the error.

(O) Indicates the actions to be taken by the operator when the message is output.

14.2 List of messages

The list of messages output by JP1/DH - Server when errors occur during installation and setup of JP1/DH - Server is as follows:

KJDH5000-W

This platform is not supported. Installation is canceled.

Installation is interrupted because an attempt to install the product to a platform that does not satisfy the prerequisites for the OS was made.

(S) Interrupts the installation.

(O) Check the prerequisites for the OS, and then install the product to a machine with the requisite OS.

KJDH5001-W

The login account does not have the permissions needed for installation or uninstallation. Use the Administrator account.

Installation is interrupted because the user performing installation or uninstallation does not have administrator rights.

(S) Interrupts the installation.

(O) Install or uninstall the product by using the user account with administrator rights.

KJDH5002-W

The path for the installation folder is too long. Re-specify the installation folder.

The path to the installation folder is too long. Change the installation folder.

(S) Waits for user action.

(O) Change the installation destination.

KJDH5003-W

There is not enough free space for installation. At least 2 GB of free space is required for setup.

Installation is interrupted because there is not sufficient free space on the installation drive.

(S) Interrupts the installation.

(O) Secure enough free space on the installation drive, and then install the product again.

KJDH5004-E

Failed to set up the database. Installation is canceled.

Installation is interrupted because the database setup failed.

(S) Interrupts the installation, and rolls back the system to the state at the start of installation.

(O) Check the Hitachi Integrated Installer log#, remove the problem according to the output error information, and then install the product again.

#: A log file for Hitachi Integrated Installer is output in the following location: C:\Windows\Temp\HCDINST

KJDH5005-E

Failed to configure the database. Installation is canceled.

Installation is interrupted because the database construction failed.

(S) Interrupts the installation, and rolls back the system to the state at the start of installation.

(O) Check the Hitachi Integrated Installer log#, remove the problem according to the output error information, and then install the product again.

#: A log file for Hitachi Integrated Installer is output in the following location: C:\Windows\Temp\HCDINST

KJDH5006-E

Failed to set up the application server. Installation is canceled.

Installation is interrupted because the application server setup failed.

(S) Interrupts the installation, and rolls back the system to the state at the start of installation.

(O) Check the Hitachi Integrated Installer log#, remove the problem according to the output error information, and then install the product again.

#: A log file for Hitachi Integrated Installer is output in the following location: C:\Windows\Temp\HCDINST

KJDH5007-E

Failed to install the application configuration file. Installation is canceled.

Installation is interrupted because the installation of the application configuration file failed.

(S) Interrupts the installation, and rolls back the system to the state at the start of installation.

(O) Check the Hitachi Integrated Installer log#, remove the problem according to the output error information, and then install the product again.

#: A log file for Hitachi Integrated Installer is output in the following location: C:\Windows\Temp\HCDINST

KJDH5008-E

Could not install the product because the latest version %s is already installed.

Installation is interrupted because a newer version of the product is already installed.

(S) Interrupts the installation.

(O) Uninstall the installed version, and then install the desired version of the product again.

KJDH5009-E

Failed to overwrite install the application server. Could not suspend the application server. Installation is canceled.

Overwrite installation is interrupted because the overwrite installation of the application server failed.

(S) Interrupts the overwrite installation, and rolls back the system to the state at the start of the overwrite installation.

(O) Manually stop the services of the JP1/DH Web application server and JP1/DH Web server. If you can stop the services, perform the overwrite installation again.

KJDH5010-E

Failed to overwrite install the database. Could not suspend the database. Installation is canceled.

Overwrite installation is interrupted because the overwrite installation of the database failed.

(S) Interrupts the overwrite installation, and rolls back the system to the state at the start of the overwrite installation.

(O) Manually stop the database service (JP1_DH_DATABASE_SVR). If you can stop the service, perform the overwrite installation again.

KJDH5011-E

Failed to overwrite install the application server. Installation is canceled.

Overwrite installation is interrupted because the overwrite installation of the application server failed.

(S) Interrupts the overwrite installation, and rolls back the system to the state at the start of the overwrite installation.

(O) Check the Hitachi Integrated Installer log#, remove the problem according to the output error information, and then perform the overwrite installation again.

#: A log file for Hitachi Integrated Installer is output in the following location: C:\Windows\Temp\HCDINST

KJDH5012-E

Failed to overwrite install the database. Installation is canceled.

Overwrite installation is interrupted because the overwrite installation of the database failed.

(S) Interrupts the overwrite installation, and rolls back the system to the state at the start of the overwrite installation.

(O) Check the Hitachi Integrated Installer log#, remove the problem according to the output error information, and then perform the overwrite installation again.

#: A log file for Hitachi Integrated Installer is output in the following location: C:\Windows\Temp\HCDINST

KJDH5013-E

Failed to overwrite install the application configuration file. Installation is canceled.

Overwrite installation is interrupted because the overwrite installation of the application configuration file failed.

(S) Interrupts the overwrite installation, and rolls back the system to the state at the start of the overwrite installation.

(O) Check the Hitachi Integrated Installer log#, remove the problem according to the output error information, and then perform the overwrite installation again.

#: A log file for Hitachi Integrated Installer is output in the following location: C:\Windows\Temp\HCDINST

KJDH5014-E

Failed to overwrite install the application server. Could not start the application server. Installation is canceled.

Overwrite installation is interrupted because the overwrite installation of the application server failed.

(S) Interrupts the overwrite installation, and rolls back the system to the state at the start of the overwrite installation.

(O) Check the Hitachi Integrated Installer log#, remove the problem according to the output error information, and then perform the overwrite installation again.

#: A log file for Hitachi Integrated Installer is output in the following location: C:\Windows\Temp\HCDINST

KJDH5015-E

Failed to overwrite install the database. Could not start the database. Installation is canceled.

Overwrite installation is interrupted because the overwrite installation of the database failed.

(S) Interrupts the overwrite installation, and rolls back the system to the state at the start of the overwrite installation.

(O) Check the Hitachi Integrated Installer log#, remove the problem according to the output error information, and then perform the overwrite installation again.

#: A log file for Hitachi Integrated Installer is output in the following location: C:\Windows\Temp\HCDINST

KJDH5016-E

Failed to uninstall the application server. Uninstallation is canceled.

Uninstallation is interrupted because the uninstallation of the application server failed.

(S) Interrupts the uninstallation, and rolls back the system to the state at the start of the uninstallation.

(O) Check the Hitachi Integrated Installer log#, remove the problem according to the output error information, and then uninstall the product again.

#: A log file for Hitachi Integrated Installer is output in the following location: C:\Windows\Temp\HCDINST

KJDH5017-E

Failed to uninstall the database. Uninstallation is canceled.

Uninstallation is interrupted because the uninstallation of the database failed.

(S) Interrupts the uninstallation, and rolls back the system to the state at the start of the uninstallation.

(O) Check the Hitachi Integrated Installer log#, remove the problem according to the output error information, and then uninstall the product again.

#: A log file for Hitachi Integrated Installer is output in the following location: C:\Windows\Temp\HCDINST

KJDH5018-E

Failed to uninstall the application configuration file. Uninstallation is canceled.

Uninstallation is interrupted because the uninstallation of the application configuration file failed.

(S) Interrupts the uninstallation, and rolls back the system to the state at the start of the uninstallation.

(O) Check the Hitachi Integrated Installer log#, remove the problem according to the output error information, and then uninstall the product again.

#: A log file for Hitachi Integrated Installer is output in the following location: C:\Windows\Temp\HCDINST

KJDH5019-E

You cannot install this product in an environment where PostgreSQL is already installed. Uninstall PostgreSQL to proceed.

Installation is interrupted because PostgreSQL is already installed in the installation destination environment.

(S) Interrupts the installation.

(O) Uninstall PostgreSQL existing in the installation destination, and then install JP1/DH - Server again.

KJDH5020-E

You cannot install this product in an environment where Windows user "postgres" already exists. Delete that user to proceed.

Installation is interrupted because the Windows user, postgres, already exists in the installation destination environment.

(S) Interrupts the installation.

(O) Delete the Windows user, postgres, and then install the product again.

KJDH5021-E

Could not install the database because folder %1 exists. Delete or move %1 to proceed.

Installation is interrupted because the folder %1# already exists in the installation destination environment.

(S) Interrupts the installation.

(O) Delete the folder %1#, and then install the product again.

#: The PostgreSQL database folder that was created in the previous installation of the product

KJDH5022-E

You cannot specify a path that includes '#' for the installation folder name.

Installation is interrupted because a path to the installation folder including # is specified for the installation folder name.

(S) Interrupts the installation.

(O) Change the installation folder name, and then install the product again.

KJDH5023-E

Failed to uninstall the application server. Could not suspend the application server. Uninstallation is canceled.

Uninstallation is interrupted because the uninstallation of the application server failed.

(S) Interrupts the uninstallation, and rolls back the system to the state at the start of the uninstallation.

(O) Manually stop the following services in the Windows Service Manager, and then uninstall the product again:

JP1_DH_WEB SVR

JP1_DH_WEB CONTAINER

KJDH5024-E

Failed to uninstall the database. Could not suspend the database. Uninstallation is canceled.

Uninstallation is interrupted because the uninstallation of the database failed.

(S) Interrupts the uninstallation, and rolls back the system to the state at the start of the uninstallation.

(O) Manually stop the following service in the Windows Service Manager, and then uninstall the product again:

postgresql-x.x (x.x: PostgreSQL version number)

KJDH5025-E

Failed to overwrite install the application server. Could not start the application server. Overwrite installation is canceled.

Overwrite installation is interrupted because the overwrite installation of the application server failed.

(S) Interrupts the overwrite installation, and rolls back the system to the state at the start of the overwrite installation.

(O) Check the Hitachi Integrated Installer log#, remove the problem according to the output error information, and then perform the overwrite installation again.

#: A log file for Hitachi Integrated Installer is output in the following location: C:\Windows\Temp\HCDINST

KJDH5026-E

Failed to overwrite install the database. Could not start the database. Overwrite installation is canceled.

Overwrite installation is interrupted because the overwrite installation of the database failed.

(S) Interrupts the overwrite installation, and rolls back the system to the state at the start of the overwrite installation.

(O) Check the Hitachi Integrated Installer log#, remove the problem according to the output error information, and then perform the overwrite installation again.

#: A log file for Hitachi Integrated Installer is output in the following location: C:\Windows\Temp\HCDINST

KJDH5027-E

Could not install the product because %s is already installed.

Installation is interrupted because %s is already installed.

(S) Interrupts the installation.

(O) Uninstall the installed %s, and then install the desired version of the product again.

KJDH5028-E

Could not install the product because the overwrite unsupported product installed.

It cannot be installed because a product that does not support version-upgrade installation or upgrade installation has been installed.

(S) Interrupts the installation.

(O) Check the installation procedure for the version that is used for overwrite installation.

Appendixes

A. List of Files and Folders

The following table lists files and folders used in JP1/DH - Server.

Table A‒1: List of files and folders

File or folder

Path to the file or folder

Log file for the new fixing patch#

DH_Path\PATCHLOG.TXT

Backup folder for the new fixing patch#

DH_Path\patch_backup_dir

Batch file for collecting failure information from the servers (except for the database)

DH_Path\bin\getlog_server.bat

Batch file for collecting failure information from the servers (including the database)

DH_Path\bin\getdetaillog_server.bat

Batch file for collecting failure information from a client

DH_Path\bin\getlog_client.bat

Batch file for backing up the database

DH_Path\bin\dbbackup.bat

Batch file for restoring the database

DH_Path\bin\dbrestore.bat

Batch file for changing the database password

DH_Path\bin\dbchangepass.bat

Batch file to register the number of purchased users

DH_Path\bin\regist_users_number.bat

Batch file to update What's new information

DH_Path\bin\reload_app.bat

Storage folder for delivery file

DH_Path\data

Folder containing some shortcuts to manuals

DH_Path\doc

Storage folder for containing documents and manuals

DH_Path\uCPSB\CC\web\containers\jp1dh\webapps\digikatsuwide\pdf

JDBC driver for database access

DH_Path\lib\postgresql-9.4-1200.jdbc41.jar

Logs output destination folder

DH_Path\log

Temporary folder for the application configuration file

DH_Path\misc

Installation folder for the database

DH_Path\PostgreSQL

Data folder for the database

DH_Path\PostgreSQL\9.4\data

Storage folder for system commands and utilities

DH_Path\sbin

Storage folder for batch files for building the system

DH_Path\setup_utl

Storage folder for JP1/DH - Server configuration template files

DH_Path\template

Installation folder for the JP1/DH Web application server and JP1/DH Web server

DH_Path\uCPSB

Configuration file

DH_Path\uCPSB\CC\web\containers\jp1dh\webapps\digikatsuwide\digikatsuwide.xml

Definition file for the JP1/DH Web server

DH_Path\uCPSB\httpsd\conf\httpsd.conf

Legend:

DH_Path: Installation folder for JP1/DH - Server

#

This file or folder is created when a fixing patch is applied.

B. Changing the Database Communication Port Number

This appendix describes how to change the database communication port number.

Before performing the following steps, you must log in to the JP1/DH - Server machine as a built-in Administrator user (for Windows) or a root user (for Linux).

Stop JP1/DH - Server.

Stop the services of the JP1/DH Web application server and database, as described in 6. Starting and Stopping.

Change the communication port number that the database uses.

File path

installation-folder#\PostgreSQL\9.4\data\postgresql.conf

#

In Linux, change installation-folder to /opt/jp1dh/server.

Setting database communication port number

Change the communication port number that the database uses.

port = port-number           # (change requires restart)

Example: To set the port number to 56789

port = 56789               # (change requires restart)

Start the database.

Start the database, as described in 6. Starting and Stopping.

Change the environment configuration of the JP1/DH Web application server.

Edit the configuration file of the JP1/DH Web application server to change the port number that the application server uses to communicate with the database.

File path

installation-folder#\misc\digikatsuwide\digikatsuwide\WEB-INF\digikatsuwide.xml

#

In Linux, change installation-folder to /opt/jp1dh/server.

Setting the port number that is used to communicate with the database

Change the port number used by the application server to communicate with the database.

<biz-connect id="bizconnect">
    <persistence>
        <database >
            ...
            <url>jdbc:postgresql://localhost:communication-port-number/bcdb</url>
        </database>
    </persistence>
</biz-connect>

Example: To set the port number to 56789

<biz-connect id="bizconnect">
    <persistence>
        <database >
            ...
            <url>jdbc:postgresql://localhost:56789/bcdb</url>
        </database>
    </persistence>
</biz-connect>

Start the JP1/DH Web application server.

Follow the steps in 5.3.2 (1) Starting the JP1/DH Web application server.

Prepare for changing the application configuration.

Follow the steps in 5.3.2 (2) Preparing to change the application configuration.

Restart the JP1/DH Web application server.

Follow the steps in 5.3.2 (3) Restarting the JP1/DH Web application server.

Change the configuration of the application.

Start the command prompt (in Windows) or console (in Linux), and then perform the following:

In Windows:

set PGPORT=database-communication-port-number
installation-folder\setup_util\deploy_app.bat

In Linux (if tcsh is used as a login shell):

setenv PGPORT=database-communication-port-number
/opt/jp1dh/server/setup_util/deploy_app.sh

In Linux (if bash

is used as a login shell):

export PGPORT=database-communication-port-number
/opt/jp1dh/server/setup_util/deploy_app.sh

Follow the given instructions.

Stop the JP1/DH Web application server.

Follow the steps in 5.3.2 (5) Stopping the JP1/DH Web application server.

Start the service of the JP1/DH Web application server.

Start the service of the JP1/DH Web application server, as described in 6. Starting and Stopping.

Important

If you change the database communication port number from the initial value, you must set the new database communication port number in the environment variable before executing the following commands:

installation-folder/setup_util/deploy_app.bat

installation-folder/bin/dbbackup.bat

installation-folder/bin/dbchangepassword.bat

installation-folder/bin/dbrestore.bat

installation-folder/bin/getdetaillog_server.bat

installation-folder/bin/regist_users_number.bat

Important

In Linux, change installation-folder to /opt/jp1dh/server and the extension .bat to .sh.

C. Configurations for Clustered System Operations

This appendix provides information about configurations necessary for operations of a clustered JP1/DH - Server system.

C.1 Overview of a cluster system

A cluster system consists of multiple server systems that work together so that they can operate as a single system. If one server fails in a cluster, another can take over the task.

The cluster system is made of one host that processes tasks and another that is waiting so that it can take over in the event of failure. The former host is called an active node, and the latter, a standby node. If a failure occurs on the active node, the standby node takes over the processing to continue tasks. This takeover action is called failover.

A failover is performed based on a logical node, which is a logical host. Applications in a cluster system must run within a logical host environment in order to fail over to continue tasks. When the applications run on a logical host, they are independent of a physical server machine, allowing them to run on any server machine.

A logical host consists of three components: applications running as a service or daemon, shared disk, and a logical IP address. The applications, such as JP1/DH - Server services, store their data in the shared disk and use the logical IP address to communicate with other applications.

The following table lists and describes each component of the logical host.

Table C‒1: Components of a logical host

No.

Logical host component

Description

1

Service or daemon

JP1/DH - Server applications running in a cluster system. If an active logical host fails, a standby logical host starts the services or daemons with the same name and takes over.

2

Shared disk

Disk unit connected to both the active and standby systems. It contains information for failover operations, such as definitions and operating status. In the event of a failure in an active logical host, the standby logical host is connected to the shared disk as the active host.

3

Logical IP address

An IP address allocated to a running logical host. If the active node fails, then the same logical IP address is allocated to the standby node. Therefore, clients can continue access via the same IP address as if only one node is always running.

C.2 Supported clustering software

To run the JP1/DH - Server system in a cluster environment, you must use a specific clustering software product for each operating system on which the system runs.

The following table lists clustering software supported by JP1/DH - Server.

Table C‒2: Clustering software supported by JP1/DH - Server

No.

OS

Clustering software

1

Windows Server 2012 Standard

WSFC#

2

Windows Server 2012 Datacenter

WSFC#

3

Windows Server 2012 R2 Standard

WSFC#

4

Windows Server 2012 R2 Datacenter

WSFC#

5

Windows Server 2016 Standard

WSFC#

6

Windows Server 2016 Datacenter

WSFC#

7

Red Hat Enterprise Linux(R) Server 6 (64-bit x86_64)

HA Monitor

#

Every node must be running the same version of Windows Server and be a member of the same Active Directory domain.

We recommend that you have a different server machine to run Active Directory, instead of using a clustered JP1/DH - Server machine. For details, see the documentation provided by your clustering software product.

C.3 Prerequisites for the cluster system

To run the JP1/DH - Server system in a cluster environment, two or more server machines with the shared disk connected must be configured to form a cluster. The following table lists and describes the prerequisites for the cluster system.

Table C‒3: Prerequisites for the cluster system

No.

Item

Description

1

System configuration

The system must consist of two or more server machines that share a disk.

A JP1/DH - Server machine in the cluster must be accessible to clients via a logical IP address, which must be able to be shared between servers.

The shared disk must be set up with common data. For details about data stored in the shared disk, see C.6 Data stored on the shared disk.

2

Shared disk

The shared disk must be shared between the active and standby system nodes.

The shared disk must be under exclusive control so that it cannot be concurrently accessed by multiple servers.

Data written to files must be consistent and inherited by the standby node during a failover.

If the shared disk is in use by a process during a failover, the failover must be forced to be completed.

The shared disk must meet the hardware requirements.

3

Hardware

The hardware must comply with the hardware requirements for your clustering software.

For details about the clustering software supported by JP1/DH - Server, see C.2 Supported clustering software.

4

Software

The software must comply with the software requirements for your clustering software.

For details about the clustering software supported by JP1/DH - Server, see C.2 Supported clustering software.

5

Setup

JP1/DH -Server cluster setup instructions must be followed to set up your JP1/DH - Server environment.

C.4 Redundant components in a cluster

The following table lists and describes redundant components in the JP1/DH - Server cluster configuration.

Table C‒4: Redundant components in the cluster

No.

Component

Description

Clustered

1

NIC

Used to provide a host address and an IP address for accepting service requests.

Yes

2

NIC (for heartbeats)

Used for the alive monitoring of the machine.

No

3

Clustering software

Clustering software that provides redundancy.

For details about the clustering software supported by JP1/DH - Server, see C.2 Supported clustering software.

Yes

4

IP address for accepting service requests

An IP address, which is allocated to a clustered JP1/DH - Server environment, accessible to clients.

Service requests reach the NIC on the machine running the clustering software.

Yes

5

Runtime libraries for managed applications

A set of files necessary to run applications managed by your clustering software. In a Windows environment, these are mainly services.

Yes

6

Managed applications

Applications managed by your clustering software.

In a Windows environment, these are mainly services.

Yes

7

Other non-managed applications

A set of applications installed in your operating system by default.

No

8

Shared disk

(for application data)

A shared disk that stores application data, specified by the runtime libraries for the managed applications.

--

9

Shared disk

(for cluster management)

A set of files for managing the cluster configuration used by your clustering software (WSFC-specific).

--

10

Domain controller

A domain controller used for managing an account that your clustering software uses (WSFC-specific).

No

Legend:

Yes: It is included in the cluster.

No: It is not included in the cluster.

--: It is not supported by the clustering software.

C.5 Licenses

The following table lists and describes licenses required to run your JP1/DH - Server system in the cluster.

Table C‒5: Licenses

No.

Item

Description

1

OS

The operating system must comply with licensing structure of your operating system.

2

Clustering software

The clustering software must comply with the licensing structure of your clustering software.

For any use of software that the clustering software requires, the software must comply with the licensing structure of your clustering software.

3

JP1/DH - Server

The active and standby systems must have their own full package licenses.

Also, the number of user licenses that comes with the full package license (100 licenses) will be invalid. You must purchase as many additional user licenses as you use in your cluster environment.

C.6 Data stored on the shared disk

In the cluster configuration, the information that needs to be shared by every cluster node must be stored on the shared disk. The following table lists and describes data to be stored on the shared disk in the JP1/DH - Server cluster configuration.

Table C‒6: Data to be stored on the shared disk

No.

Item

Description

1

Storage folder for delivery data

A folder to store data sent and received by JP1/DH - Server.

The <directory></directory> element in the configuration file digikatsuwide.xml specifies this folder.

2

Audit log folder

A folder to store the JP1/DH - Server audit log file.

The log.file directive in the configuration file ROOT_SERVICE.srv specifies this folder.

3

Data area in the database

Data area in the database.

The startup option D of the database service specifies this value.

4

A complete set of certificates and keystore

Certificates and keystores used in the JP1/DH - Server system over SSL connections.

C.7 How to access the cluster environment

When WSFC is used, clients must access the cluster environment via a logical IP address managed by your clustering software. The clustering software converts the logical IP address into a physical server address so that the clients do not need to be aware of the physical address.

When HA Monitor is used, multiple IP addresses are allocated to a single physical NIC.

C.8 Failover limitation

In the cluster configuration, your clustering software detects any failed application and resource failure. When the clustering software detects the failure, it provides failover. However, different clustering software can detect different ranges and types of failures. This means that a user operation upon the failure cannot always be continued after the failover process.

C.9 Use of WSFC

(1) Accounts used in the cluster configuration

For WSFC, you can use a Local System account for services even in the cluster configuration. The account of each service is not changed in this configuration. The following table lists and describes accounts used in the JP1/DH - Server system.

Table C‒7: Accounts used in the cluster configuration

No.

Account

Description

1

Local System (or System)

Used as an account to run the JP1/DH - Server application and reverse proxy processes.

This account must have full control permissions for the installation folder and shared disk.

2

User account used to create a cluster

Used when a WSFC cluster is set up.

This account must belong to the Domain Admins group.

3

Cluster account

Computer account for the cluster itself.

4

Computer account for clustered services or applications

Computer account used for clustered services or applications.

5

postgres

Used as an account to run the database. This account must have read or write permission for the shared disk.

(2) Registry key used in the cluster configuration

In the default JP1/DH - Server configuration, the startup option D of the database is stored in the registry key. You must change the value of the following registry key from the installation drive to the shared disk:

\HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\services\JP1_DH_DATABASE_SVR\ImagePath

An example is shown as follows:

From

C:/Program Files/Hitachi/jp1dh/server/PostgreSQL/9.4/bin/pg_ctl.exe runservice -N "JP1_DH_DATABASE_SVR" -D " C:/Program Files/Hitachi/jp1dh/server/PostgreSQL/9.4/data" -w

To

C:/Program Files/Hitachi/jp1dh/server/PostgreSQL/9.4/bin/pg_ctl.exe runservice -N "JP1_DH_DATABASE_SVR" -D "I:/PostgreSQL/9.4/data" -w

(3) Settings for each generic service

All JP1/DH - Server applications are installed as Windows services. The following tables list and describe the settings for each service.

Table C‒8: Database service settings

No.

Category

Item

Value

1

General

Resource Name

JP1_DH_DATABASE_SVR

2

Resource type

Generic Service

3

Service name

JP1_DH_DATABASE_SVR

4

Startup parameters

"JP1/DH-Server-installation-folder\PostgreSQL\9.4\bin\pg_ctl.exe" runservice -N "JP1_DH_DATABASE_SVR" -D "I:\PostgreSQL\9.4\data" -w

5

Use Network Name for computer name

Selected

6

Dependencies

Service name and conditions

Cluster disk name AND cluster network name

7

Policies

Response to resource failure

If resource fails, attempt restart on current node

8

Period for restarts (mm:ss)

15:00 (default)

9

Maximum restarts in the specified period

1 (default)

10

If restart is unsuccessful, fail over all resources in this service or application

Selected (default)

11

If all the restart attempts fail, begin restarting again after the specified period (hh:mm)

01:00 (default)

12

Pending timeout (mm:ss)

03:00 (default)

13

Advanced Policies

Possible Owners

Node 001

Node 002

14

Basic resource health check interval

Use standard time period for the resource type

15

Thorough resource health check interval

Use standard time period for the resource type

16

Run this resource in a separate Resource Monitor

Not selected

17

Registry Replication

Not specified

Table C‒9: Service settings for the JP1/DH Web application server

No.

Category

Item

Value

1

General

Resource Name

JP1_DH_WEB CONTAINER

2

Resource type

Generic Service

3

Service name

JP1_DH_WEBCON

4

Startup parameters

"JP1/DH-Server-installation-folder\sbin\jp1dhwebcon.exe" -start

5

Use Network Name for computer name

Not selected

6

Dependencies

Service name and conditions

JP1_DH_DATABASE_SVR

7

Policies

Response to resource failure

If resource fails, attempt restart on current node

8

Period for restarts (mm:ss)

15:00 (default)

9

Maximum restarts in the specified period

1 (default)

10

If restart is unsuccessful, fail over all resources in this service or application

Selected (default)

11

If all the restart attempts fail, begin restarting again after the specified period (hh:mm)

01:00 (default)

12

Pending timeout (mm:ss)

03:00 (default)

13

Advanced Policies

Possible Owners

Node 001

Node 002

14

Basic resource health check interval

Use standard time period for the resource type

15

Thorough resource health check interval

Use standard time period for the resource type

16

Run this resource in a separate Resource Monitor

Not selected

17

Registry Replication

Not specified

Table C‒10: Service settings for the JP1/DH Web server

No.

Category

Item

Value

1

General

Resource Name

JP1_DH_WEB SVR

2

Resource type

Generic Service

3

Service name

JP1_DH_WEBSVR

4

Startup parameters

Not specified

5

Use Network Name for computer name

Not selected

6

Dependencies

Service name and conditions

JP1_DH_WEB CONTAINER

7

Policies

Response to resource failure

If resource fails, attempt restart on current node

8

Period for restarts (mm:ss)

15:00 (default)

9

Maximum restarts in the specified period

1 (default)

10

If restart is unsuccessful, fail over all resources in this service or application

Selected (default)

11

If all the restart attempts fail, begin restarting again after the specified period (hh:mm)

01:00 (default)

12

Pending timeout (mm:ss)

03:00 (default)

13

Advanced Policies

Possible Owners

Node 001

Node 002

14

Basic resource health check interval

Use standard time period for the resource type

15

Thorough resource health check interval

Use standard time period for the resource type

16

Run this resource in a separate Resource Monitor

Not selected

17

Registry Replication

Not specified

(4) Notes on the cluster configuration

A cluster configuration managed by WSFC requires Active Directory.

If your JP1/DH - Server applications run on Windows Server 2012, Windows Server 2012 R2 or Windows Server 2016, a domain controller must be running on a separate machine.

When you restart a clustered system, do not restart multiple machines at the same time. They must be restarted one by one.

(5) Setup

This subsection describes how to set up a WSFC cluster configuration.

For this configuration, every node must be running the same version of Windows Server and be a member of the same Active Directory domain.

Prepare a set of hardware components used to configure the cluster. The necessary set of components is as follows:

More than one machine

Shared disk (SCSI-connected)

Switch

Network interface card (NIC)

Except for the shared disk, prepare as many hardware devices as the number of the machines. In addition, one machine requires two or more network interface cards.

Determine the Active Directory domain that your cluster belongs to.

Consider joining the existing Active Directory domain if you have one. If the existing domain cannot be used, or if one does not exist, create a new Active Directory domain for your cluster configuration.

If you create a new Active Directory domain, determine where Active Directory will be installed.

Prepare a dedicated machine for Active Directory and then install Active Directory.

Important

Although running Active Directory on a different node from the JP1/DH - Server node in the cluster configuration is possible, we do not recommend this.

Install the Failover Clustering feature in all nodes so that they can join the cluster configuration.

For details about the Failover Clustering feature, see the Windows Help.

C.10 Using HA Monitor

(1) Failure detection

To detect server failures by using HA Monitor, you must write some monitoring commands in C language or shell language.

The commands are activated by HA Monitor, and they remain active while the server is up and running. When any of the commands terminates, HA Monitor assumes that a failure has occurred and starts a failover process.

An example monitoring command provided by HA Monitor is shown below. This example command checks for the process of the target program, and if no process exists, then you can assume that a failure occurred on the server.

#!/bin/sh
SERVER=/home/xxxx/yyyy   # Name of the program running on your server
while true                # Main loop
do
    # Use the ps command to check for the process of the program.
    CHECK=`ps -ef | grep $SERVER | grep -v grep`

    # If no process is found, exit the command.
    if [ "$CHECK" = "" ]
    then
        exit 0
    fi

    # If the process is found, keep monitoring.
done

JP1/DH - Server uses the Linux standard ps command to monitor daemons. It checks the output of the command to determine whether the daemons associated with the JP1/DH - Server system are running.

C.11 Non-redundant functions

The following table lists and describes functions that are not redundant even in the clustered JP1/DH - Server configuration.

Table C‒11: Non-redundant functions

No.

Function

Description

1

What's new function

The same configuration is required for both the active and standby nodes.

2

Dynamic changes in system parameters

After every switchover between the active and standby nodes, system parameters must be set by using the dynamic change function.

C.12 Building the cluster system

(1) General procedure for installing JP1/DH - Server on the cluster system

After you make sure that the prerequisites are met, you can install JP1/DH - Server on each of the active and standby nodes.

Make sure that the installation prerequisites are met.

Install JP1/DH - Server.

(2) Installation prerequisites

To install JP1/DH - Server on the cluster system, you need to have the required installation environment, and the environment must be configured appropriately.

(a) Operating system and clustering software

Your operating system and clustering software must match one of the clustering software products listed in C.2 Supported clustering software.

Any patches, updates, and service packs that JP1/DH - Server and your clustering software require must be applied.

(b) Configuration

Each node must have the same environment so that the standby node can take over the existing task after a failover.

A cluster must contain two or more nodes.

(c) Disk

Files must be protected by an appropriate means, such as a journaling file system, to avoid file loss due to a system down.

(d) Network

IP addresses that correspond to host names (returned by the hostname command) must be used for communications. Your clustering software and any other software must not block traffic.

Your clustering software and name server must not change the mapping of a host name to an IP address while the JP1/DH - Server system is running.

The NIC corresponding to the host name must have the highest priority in the network binding setting. Other NICs, such as a NIC for heartbeats, must have a lower priority.

(e) Shared disk

You need to make sure that all the criteria below are fulfilled, so that data written by the active node is not corrupted during failover. If they are not fulfilled, the JP1/DH - Server system might experience problems, such as an error, data loss, and failed startup, resulting in a malfunction of the system.

JP1/DH - Server must not be installed on the shared disk.

The shared disk must be shared between the active and standby nodes.

The shared disk must be allocated to the JP1/DH - Server system before the system starts.

The shared disk must not be unallocated while the JP1/DH - Server system is running.

The shared disk must be under exclusive control so that it cannot be concurrently accessed by multiple servers.

Files must be protected by an appropriate means, such as a journaling file system, to avoid file loss due to a system down.

Data written to files must be consistent and inherited by the standby node during a failover.

If the shared disk is in use by a process during a failover, the failover must be forced to be completed.

Your clustering software must have the ability to start and stop the JP1/DH - Server processes for recovery if necessary, when a failure is detected on the shared disk.

(f) Logical host name and IP address

You need to make sure that the criteria below must be fulfilled, so that a recovery action is performed after one of the NICs is failed. If they are not fulfilled, a communication error occurs and the JP1/DH - Server system might malfunction until the NIC is switched over or the active node is failed over to the standby node by, for example, the clustering software.

The logical host name must contain only alphanumeric characters and hyphens (-).

A logical IP address that can be inherited by the standby node is available for communications.

A logical host name must have a one-to-one relationship with a logical IP address.

The logical host name must be in the hosts file or in the name server so that TCP/IP communication is possible.

The logical IP address must be allocated to JP1/DH - Server before the system starts.

The logical IP address must not be removed while the JP1/DH - Server system is running.

The mapping of the logical host name to the logical IP address must not be changed while the JP1/DH - Server system is running.

Your clustering software or other software must be responsible for a recovery action when a network failure is detected, and the JP1/DH - Server system does not have to be conscious about it. Also, the clustering software must have the ability to start and stop the JP1/DH - Server processes in the process of the recovery action, if necessary.

(g) Port management

The active and standby nodes must have the same port number configured for connecting to the Web server. If they have different port numbers set, a Web browser cannot display the JP1/DH - Server web windows after a failover. When you change the port number, set the same port number for both the active and standby nodes.

(3) Installing JP1/DH - Server on clustered nodes

The steps below describe how to install JP1/DH - Server on the active and standby nodes.

In conditional steps with "In WSFC" or "In HA Monitor", perform those steps only for your matching clustering software.

Make sure that JP1/DH - Server is not installed on the active and standby nodes. If the product is installed on any of the nodes, uninstall it.

Install JP1/DH - Server on the active and standby nodes.

In WSFC:

Log in to JP1/DH - Server as a built-in Administrator user.

In HA Monitor:

Log in as the root user.

JP1/DH - Server must be installed to the same folder on the drive with the same name on each of the active and standby nodes.

To install JP1/DH - Server in the cluster system, you need to perform the new installation procedure. For details, see 5. Installation and Setup.

On the active node, move the database data folder to the shared disk. If the database is up and running, shut down the database before moving the folder.

From: JP1/DH-Server-installation-folder\PostgreSQL\9.4\data

To: shared-disk\PostgreSQL\9.4\data

After the data folder is moved, set permission to access the moved folder.

In WSFC:

Grant the full control permission to the postgres account.

In HA Monitor:

Use the following commands to change the owner and group to postgres:

>chown -R postgres /shared-disk/PostgreSQL/9.4/data
>chgrp -R postgres /shared-disk/PostgreSQL/9.4/data

Change the path to the data folder specified in the database startup option. The path must be changed on both the active and standby nodes. You need to perform different steps to change the startup option depending on your clustering software.

In WSFC:

The startup option is defined in the registry key. So you will change the value of the corresponding registry key. For details about the path to the registry key and changes to be made, see C.9 (2) Registry key used in the cluster configuration.

In HA Monitor:

The startup option is defined in the JP1_DH_DATABASE_SVR script file to start and stop the service. In the cluster configuration, a separate file, with the shared disk specified in the startup option, is used to start and stop the service.

The file used in the cluster configuration is stored in the following folder:

/opt/jp1dh/server/sbin/cluster/

Change the value of the PGSQLDIR_D variable in the JP1_DH_DATABASE_SVR file to the path to the database data folder on the shared disk.

After you changed the path, perform the following command on the active node:

>/JP1/DH-Server-installation-folder/sbin/cluster/JP_DH_DATABASE_SVR start

The database starts by using the modified JP1_DH_DATABASE_SVR file.

Configure the active and standby server environments. Follow the steps described in 5.3.1 Changing the configuration file. In the cluster configuration, however, some of the configuration steps are different from those in the non-cluster configuration. You must be aware of the following:

Specify the logical IP address for the server IP address, instead of the IP address of the host machine. The element in the configuration file is <ip>.

Specify the FQDN corresponding to the logical address for the server FQDN, instead of the FQDN of the host machine. The elements in the configuration file are <bind-hostname>, <bind-domainname>, and <bind-sub-domainname>.

Specify the path on the shared disk for the storage folder for delivery data. The element in the configuration file is <directory>.

Change the audit log output destination folder to the path on the shared disk. Define this folder in the following file:

installation-folder\misc\digikatsuwide\digikatsuwide\WEB-INF\services\ROOT_SERVICE.srv

Change the value of the log.file directive in the configuration file to the path on the shared disk.

log.file = shared-disk\log\jp1dh-audit.log

On the active node, change the JP1/DH - Server application configuration. The configuration on the standby node will be changed in a later step. In this step, only change the configuration of the active node.

In WSFC:

In the Start menu for the Windows machine, right-click Command Prompt and select Run as Administrator in the context menu. Perform the steps described in 5.3.2 Changing the application configuration.

In HA Monitor:

Perform the steps described in 5.3.2 Changing the application configuration.

Before changing the application configuration on the standby node, change the current owner of resources, including the shared disk and network, from the active node to the standby node.

In WSFC:

As described in step 6, change the JP1/DH - Server application configuration on the standby node.

After the change is done on the standby node, change the current owner of the resources from the standby node to the active node.

In HA Monitor:

On the active node, run the following command to shut down the database.

>/JP1/DH-Server-installation-folder/sbin/cluster/JP_DH_DATABASE_SVR stop

When the database is stopped, the shared disk needs to be mounted to the standby node so that the standby node can use the disk. To mount the disk to the standby node, use the umount command on the active node, and then use the mount command on the standby node.

When the task is completed, run the following command on the standby node to start the database.

>/JP1/DH-Server-installation-folder/sbin/cluster/JP_DH_DATABASE_SVR start

When all the tasks are completed on the standby node, use the same command described above to shut down the database on the standby node. Then, unmount the shared disk from the standby node and mount it back to the active node. Finally, start the database on the active node.

On the active node, configure settings for the electronic certificate authentication function. Follow the steps described in 5.3.3 Specifying the settings for the electronic certificate authentication function.

Register the root certificate in the active and standby nodes. Follow the steps described in 5.3.4 Registering a root certificate.

You need to perform this step to encrypt mail server traffic via SSL (SMTPS/STARTTLS) when the delivery notification function is used. Also, perform this step to encrypt directory server traffic via SSL when a directory server is used to authenticate users who try to log in to the system.

Edit the hosts file on the active and standby nodes. Follow the steps described in 5.3.5 Editing the hosts file.

On the active node, create a certificate file used for SSL communication. Follow the steps described in 5.4.1 Creating a secret key file for SSL communication, 5.4.2 Creating a password file, and 5.4.3 Creating a certificate file for SSL communication.

In the cluster configuration, however, some of the configuration steps are different from those in the non-cluster configuration. Specify the host name (FQDN) corresponding to the logical address for the server host name (FQDN), instead of the IP address of the host machine.

Store all the files created in step 10 in the shared disk.

Edit your JP1/DH Web server configuration files on the active and standby nodes. Follow the steps described in 5.4.4 Editing the settings for the JP1/DH Web server.

In the cluster configuration, however, some of the configuration steps are different from those in the non-cluster configuration. Specify the host name (FQDN) corresponding to the logical address for the server host name (FQDN), instead of the IP address of the host machine. Also, store the certificate in the shared folder, and set the path to the certificate folder to the path on the shared folder.

In WSFC:

To run the batch file deploy_websvr.bat, in the Start menu, find and right-click Command Prompt, select Run as Administrator in the context menu, and run the batch file in the displayed command prompt.

In HA Monitor:

Log in as the root user to edit the file.

C.13 Registering services to cluster software

Register the JP1/DH - Server services to your clustering software.

(1) In WSFC:

Register the following services by using the Failover Cluster Manager. All the services must be created as a Generic Service Resource.

JP1_DH_DATABASE_SVR

For details about the settings, see Table C-8 Database service settings.

JP1_DH_WEB_CONTAINER

For details about the settings, see Table C-9 Service settings for the JP1/DH Web application server.

JP1_DH_WEB SVR

For details about the settings, see Table C-10 Service settings for the JP1/DH Web server.

(2) In HA Monitor:

Specify the following paths to files used by HA Monitor in the server configuration file servers.

Each file can be found in the /opt/jp1dh/server/sbin/cluster directory.

Server program (which is the startup command)

Set the name directive in the servers file to /opt/jp1dh/server/sbin/cluster/JP1_DH_CLUSTER_START.

Command to shut down the server

Set the termcommand directive in the servers file to /opt/jp1dh/server/sbin/cluster/JP1_DH_CLUSTER_STOP.

Monitoring command

Set the patrolcommand directive in the servers file to /opt/jp1dh/server/sbin/cluster/JP1_DH_CLUSTER_PATROL.

In the cluster configuration, HA Monitor starts and stops the services. Thus, the automatic service startup mechanism, which is used in the non-cluster configuration, must be turned off by executing the following commands:

>/JP1/DH-Server-installation-folder/sbin/chkconfig JP1_DH_DATABASE_SVR off
>/JP1/DH-Server-installation-folder/sbin/chkconfig JP1_DH_WEBCON off

C.14 JP1/DH - Server operations in the cluster

In a cluster system managed by clustering software, usually the software is responsible for detecting failure and switching the system.

What failures can be detected is determined by each clustering software and its settings. In this appendix, a failure is determined by checking whether service processes are running, as described in C.9 (3) Settings for each generic service and C.10 (1) Failure detection.

This approach might be a less accurate way of monitoring services. Sometimes an application cannot service its users even when its process is still running.

You can identify failures with higher accuracy by using the JP1/DH - Server commands.

To identify failures with higher accuracy, a system administrator must perform either of the following:

Change how your clustering software identify failures.

Customize monitoring scripts used by the clustering software for detecting failures. This means that JP1/DH - Server commands are used in the monitoring script. A successful command will allow processing to proceed, and a failed command will raise an error.

Note that different clustering software have different monitoring script functions. For details, see the documentation of your clustering software.

Monitoring and detecting failures separately of the monitoring functionality of the clustering software.

Use the JP1/DH - Server commands to create scripts. These scripts can execute the JP1/DH - Server commands, and send an email notification to a system administrator if the script fails. The scripts must be run on a regular basis by using, for example, a task scheduler.

The major difference between the two approaches above is whether the clustering software switches the system when a JP1/DH - Server command fails.

In the first approach, the software switches the system immediately after the JP1/DH - Server command fails. However, even if the command fails, the application might be able to provide its service (including changing the configuration for authentication rules and delivery rules). Any operation during system switchover causes an error, which might result in a shorter service time.

In the second approach, the software does not switch the system. Thus, when receiving the notification, a system administrator must check what type of error exists, and manually switch the system if a failure actually occurs. This procedure takes some time to switch the system, but the switchover can be performed only when the service is unavailable.

However, the system administrator is unaware of a failure occurring, without email notifications sent by a script or some other means. If you employ the second approach, make sure that the system administrator is notified of any failure in a way such as email notification.

For the first approach, the system administrator must be familiar with the specifications of monitoring scripts provided by the clustering software. Therefore, we recommend the second approach in a clustered JP1/DH - Server configuration if you need a higher accuracy of failure detection.

In a cluster configuration described in this appendix, the clustering software detects a failure by checking whether JP1/DH - Server application processes are running. What is necessary for failure detection depends on how you operate your system. See the documentation of your clustering software to configure failure detection suitable for your operations.

D. Installing .NET Framework 3.5

If you are using Windows Server 2012, Windows Server 2012 R2 or Windows Server 2016, you must install Microsoft .NET Framework 3.5 to open a command prompt with the elevated privileges. You can use Add Roles and Features Wizard to install .NET Framework 3.5 Features.

E. Version Changes

This appendix describes the changes in each version.

E.1 Changes in version 12-00

The application (App) that is used to send and receive files and messages is now supported. Accordingly, the Application window interface is added to the New Delivery window.

SAML Single Sign-on (SSO) authentication is now supported.

Notes on using Java software included in the product were added.

The following OSs are now supported:

SUSE Linux Enterprise Server 15

The following OSs are no longer supported:

Windows Server 2008 R2

The following required software is no longer supported for the data transfer command:

Java Runtime Environment Version 6.0

E.2 Changes in version 11-50

The commands were changed to be used when creating a server certificate for SSL communication.

The default bit length for the creation of a secret key was changed.

The subject name format specified for the certificate was changed.

The default bit length for the creation of a self-signed server certificate was changed.

E.3 Changes in version 11-10

The following OSs are now supported:

Windows Server 2016

The following OSs are no longer supported:

Windows 8

Notes on the JP1/DH Web server have been added.

The setting for the optional parameter Maximum storage period of files is now treated differently depending on the version.

The function to specify the initial state of selection for choosing an approver has been added to the optional parameters.

The function to automatically delete files before the storage expiration date based on the evaluation of download completion by all recipient users has been added to the optional parameters.

The function to specify the window interface for the New Delivery window has been added to the optional parameters.

An error notification message can now be sent when a command error occurs.

SUSE Linux Enterprise Server 12 with Service Pack 1 is now supported.

The option -reservetransferlimit has been added, so that if a file cannot be received due to the download limit, the corresponding delivery or file will not be put on the received delivery list.

FAQs about data transfer commands have been added.

The GETRESOURCEINFO command that can be used to acquire resource usage, such as disk usage and the amount of downloads per month, has been added as a data transfer management command.

The following messages of data transfer management commands have been added:

DWCO1850_I

DWCO1851_E

E.4 Changes in version 11-00

The following OSs are now supported:

Windows 10

The following OSs are not supported:

Red Hat Enterprise Linux(R) Server 5

The version of Postfix has been changed.

nginx-1.6.2 has been added to a proven reverse proxy server, other than the JP1/DH Web server.

The file validation disabling function when using the web window has been added to the optional parameters.

The email templates that enable an approved-delivery notification or rejected-delivery notification to be sent to a sender and all the approvers when data is delivered using an approval rout are now supported.

Add a note at the time of upgrade installation.

An upgrade procedure to JP1/DH - Server was added from JP1/Data Highway - Server Starter Edition.

A procedure to upgrade from JP1/Data Highway - Server Starter Edition has been added.

By using the command for suspending and canceling the active file transfer, a file transfer of a specified user ID now can be suspended or canceled.

The command for copying delivery data among multiple JP1/DH - Server systems is now supported. And removed the messages associated with it.

The command for referring the bandwidth limitation rules that you use to simultaneously acquire the bandwidth limitation rules is now supported.

The command for modifying the bandwidth limitation rules that you use to specify the limit values for a file transfer and to enable or disable the rules is now supported.

The command for extracting delivery data that extracts the sent data from JP1/DH - Server in the same format as the data on the server from which the data is sent is now supported.

The following messages of administrator commands have been added:

DWCO1735_I, DWCO1736_E, DWCO1741_I, DWCO1742_E, DWCO1743_E, DWCO1745_I, DWCO1746_E, DWCO1747_E

The following commands that you can use from the command line interface are now supported: the data transfer command that uses the file transfer function on JP1/DH - Server and the data transfer management command that manages a file transfer.

Creation of the storage folder for delivery data and logs has been added to the JP1/DH Web application server settings.

The following messages:

KJDH5028-E

F. Reference Material for This Manual

This appendix provides reference information, including various conventions, for this manual.

F.1 Related publications

This manual is part of a related set of manuals. The manuals in the set are listed below (with the manual numbers):

JP1 Version 12 JP1/Data Highway - Server System Administrator Guide (3021-3-D42(E))

JP1 Version 12 JP1/Data Highway - Server Administrator Guide (3021-3-D43(E))

JP1 Version 12 JP1/Data Highway - Server User's Guide (3021-3-D44(E))

JP1 Version 11 JP1/Data Highway - Automatic Job Executor (3021-3-B46(E))

F.2 Conventions: Abbreviations for product names

This manual uses the following abbreviations for product names:

Full name or meaning

Abbreviation

JP1/Data Highway - Automatic Job Executor

JP1/Data Highway - AJE

JP1/Data Highway - Server

JP1/DH - Server

Red Hat Enterprise Linux(R) Server 6 (64-bit x86_64)

Linux 6 (x64)

Linux

Red Hat Enterprise Linux(R) Server 7 (64-bit x86_64)

Linux 7 (x64)

F.3 Conventions: Acronyms

This manual also uses the following acronyms:

Acronym

Full name or meaning

DB

Database

DMZ

De-Militarized Zone

FQDN

Fully Qualified Domain Name

JDK

Java Development Kit

JWS

Java Web Start

NIC

Network Interface Card

OS

Operating System

SQL

Structured Query Language

SSL

Secure Socket Layer

RPM

Redhat Package Manager

SCSI

Small Computer System Interface

WSFC

Windows Server Failover Clustering

WSH

Windows Script Host

F.4 Default installation folder

JP1/DH - Server is installed in the following folder by default:

In Windows:

system-drive:\Program Files\Hitachi\jp1dh\server

In Linux:

/opt/jp1dh/server

F.5 Meaning of "Administrator permissions" in this manual

The term user with Administrator permissions in this manual refers to a user who is a member of the Administrators group on the local PC only.

Index

A

acquiring delivery information[1]

acquisition of server status[1]

acquisition of user information[1]

address book capacity[1]

administrator commands[1]

alive monitoring[1]

B

backup and restore[1]

before installation[1]

block size during transfer and reception[1]

buffer size during transfer and reception[1]

building cluster system[1]

C

changing application configuration[1]

changing configuration file[1]

changing database communication port number[1]

changing delivery acceptance status for file transfer function[1]

changing password for system administrator[1]

checking audit logs[1]

checking environment prerequisites

Linux[1]

Windows[1]

checking operation of JP1/DH - Server[1]

client machines[1]

cluster system

building[1]

clustering software[1]

data stored on shared disk[1]

failover limitation[1]

how to access cluster environment[1]

JP1/DH - Server operations[1]

licenses[1]

non-redundant functions[1]

overview[1]

prerequisites[1]

redundant components[1]

registering services to cluster software[1]

use of WSFC[1]

using HA monitor[1]

commands

acquiring failure information[1]

acquiring failure information from client (getlog_client.bat)[1]

acquiring failure information with database backup from server (getdetaillog_server.bat)[1]

acquiring failure information without database backup from server (getlog_server.bat)[1]

backing up database (dbbackup.bat)[1]

changing database password (dbchangepassword.bat)[1]

creating CSR (certificate signing request) (selfsignedcertreq.bat)[1]

creating secret key (selfsignedkeygen.bat)[1]

creating self-signed server certificate (selfsigned.bat)[1]

list[1]

operation and failure corrective actions[1]

operations management[1]

registering number of purchased user licenses (regist_users_number.bat)[1]

restoring database (dbrestore.bat)[1]

commands for acquiring failure information[1]

getdetaillog_server.bat[1]

getlog_client.bat[1]

getlog_server.bat[1]

commands for operations management[1]

dbbackup.bat[1]

dbchangepassword.bat[1]

dbrestore.bat[1]

regist_users_number.bat[1]

selfsigned.bat[1]

selfsignedcertreq.bat[1]

selfsignedkeygen.bat[1]

Common specifications[1], [2]

concurrent connections[1]

configurations for clustered system operations[1]

connection queue size[1]

conventions

fonts and symbols[1]

version numbers[1]

creating certificate file for SSL communication[1]

creating password file[1]

creating secret key file for SSL communication[1]

D

data stored on shared disk[1]

dbbackup.bat[1]

dbchangepassword.bat[1]

dbrestore.bat[1]

default setting for processing status type of deliveries to be displayed in in-box[1]

delivery deletion function[1]

Delivery information file[1]

description format of message[1]

directory server using by system[1]

displaying compress method options[1]

displaying options related to number of TCP connections[1]

dynamic management of server settings[1]

E

editing hosts file[1]

editing settings for JP1/DH Web server[1]

Edit of bandwidth limitation rules

Edit[1]

Eject of delivery data

Eject[1]

emergency login[1]

enabling or disabling initial environment setup function[1]

ensuring network bandwidth[1]

example configuration

for working with a reverse proxy with SSL traffic analyzer[1]

for working with a reverse proxy with SSL traffic forwarding[1]

where JP1/DH - Server machine acting as access point[1]

external storage options for data sent by using extended compression method[1]

F

failover limitation[1]

FAQ of the data transfer command[1], [2]

font conventions[1]

functions provided by installer[1]

new installation[1]

overwrite installation[1]

uninstallation[1]

upgrade installation[1]

G

getdetaillog_server.bat[1]

getlog_client.bat[1]

getlog_server.bat[1]

group capacity[1]

H

hardware equipment[1]

client machines[1]

JP1/DH - Server machine[1]

how to access cluster environment[1]

I

import/export control on files sent or received[1]

importing user information[1]

installation and setup[1]

messages[1]

installation folder[1]

installation for Windows[1]

new installation[1]

overwrite installation[1]

uninstallation[1]

upgrade installation[1]

installation in Linux[1]

new installation[1]

overwrite installation[1]

uninstallation[1]

upgrade installation[1]

Installation of the data transfer command[1]

Installation of the data transfer management command[1]

installing .NET Framework 3.5[1]

installing JP1/DH - Server administrator commands

Linux[1], [2]

Windows[1], [2]

installing JP1/DH - Server administrator commands in Linux[1]

installing JP1/DH - Server administrator commands in Windows[1]

J

Java heap memory size[1]

JP/DH - Server administrator commands

bandwidth limitation rules[1], [2]

delivery data[1]

JP1/DH - Server[1]

features[1]

overview[1]

software[1]

software configuration[1]

JP1/DH - Server administrator commands[1]

acquiring delivery information[1]

acquisition of server status[1]

acquisition of user information[1]

changing delivery acceptance status for file transfer function[1]

checking audit logs[1]

command format[1]

command property file (property.xml)[1]

common options[1]

common specifications[1]

CSV error messages[1]

delivery deletion function[1]

dynamic management of server settings[1]

exit codes[1]

file path[1]

grammar rules[1]

importing user information[1]

list[1]

log output[1]

messages[1]

simultaneous execution same computer[1]

suspension and cancellation of active file transfer[1]

JP1/DH - Server administrator commands in Linux

checking environment prerequisites[1]

installing[1], [2]

uninstalling[1]

JP1/DH - Server administrator commands in Windows

checking environment prerequisites[1]

installing[1], [2]

uninstalling[1]

JP1/DH - Server machine[1]

JP1/DH - Server operations in cluster[1]

JP1/DH - Server software[1]

JP1/DH Web application server environment

changing application configuration[1]

changing configuration file[1]

editing hosts file[1]

registering root certificate[1]

resetting password for system administrator[1]

setting up[1]

specifying settings for electronic certificate authentication function[1]

starting JP1/DH Web application server from service[1]

JP1/DH Web server

creating certificate file for SSL communication[1]

creating password file[1]

creating secret key file for SSL communication[1]

editing settings for JP1/DH Web server[1]

starting JP1/DH Web server[1]

using[1]

K

keep-alive timeout period[1]

L

licenses[1]

list of administrator commands[1]

list of commands[1]

list of files and folders[1]

list of messages

CSV error[1]

installation and setup[1]

JP1/DH - Server administrator commands[1]

Log files[1]

Log level[1]

M

mail server using by system[1]

maintaining log files[1]

maintenance[1]

backup and restore[1]

emergency login[1]

maintaining log files[1]

registering number of purchased user licenses[1]

time clock synchronization of server[1]

what's new function[1]

maximum number of destinations[1]

maximum size of files available for transfer[1]

maximum storage period of files[1]

message format[1]

description format[1]

output format[1]

messages[1]

CSV error[1]

format[1]

installation and setup of JP1/DH - Server[1]

JP1/DH - Server administrator commands[1]

Messages of the data transfer command[1], [2]

monitoring mail server[1]

N

network bandwidth limit[1]

network configurations[1]

notes[1]

new installation[1]

Linux[1]

notes[1]

Windows[1]

non-redundant functions[1]

notes on installation[1]

common notes[1]

new installation[1]

overwrite installation[1]

upgrade installation[1]

O

operational details[1]

operational parameters[1]

optional parameters[1]

required parameters[1]

operational tasks[1]

alive monitoring[1]

import/export control on files sent or received[1]

monitoring mail server[1]

resource monitoring[1]

secure operations[1]

operation and failure corrective actions[1]

operation check[1]

changing password for system administrator[1]

checking operation of JP1/DH - Server[1]

operations with system capacity in mind[1]

address book capacity[1]

group capacity[1]

other objects capacity[1]

user capacity[1]

Optional paramaters

Approval exclusion function[1]

optional parameters[1]

block size during transfer and reception[1]

buffer size during transfer and reception[1]

concurrent connections[1]

connection queue size[1]

default setting for processing status type of deliveries to be displayed in in-box[1]

displaying compress method options[1]

displaying options related to number of TCP connections[1]

enabling or disabling initial environment setup function[1]

external storage options for data sent by using extended compression method[1]

Java heap memory size[1]

keep-alive timeout period[1]

maximum number of destinations[1], [2]

maximum size of files available for transfer[1]

maximum storage period of files[1]

network bandwidth limit[1]

packet queue size of clients[1]

password obfuscation (SALT string)[1]

storage period of audit log[1]

timeout period when using a directory server[1]

using file validation disabling function[1]

using file validation disabling function when using the web user-interface[1]

other objects capacity[1]

Output format[1]

output format of message[1]

overview of cluster system[1]

Overview of the data transfer command[1]

Overview of the data transfer management command[1]

overwrite installation[1]

Linux[1]

notes[1]

Windows[1]

P

packet queue size of clients[1]

password obfuscation (SALT string)[1]

Precondition for installation[1]

prerequisite products[1]

prerequisite products for specific function or with conditions[1]

prerequisites[1]

prerequisites for cluster system[1]

procedure for starting

Linux[1]

Windows[1]

procedure for stopping

Linux[1]

Windows[1]

R

redundant components in cluster[1]

Reference[1], [2]

Refer to bandwidth limitation rules

Refer[1]

regist_users_number.bat[1]

registering number of purchased user licenses[1]

registering root certificate[1]

registering services to cluster software[1]

required parameters[1]

directory server using by system[1]

installation folder[1]

mail server using by system[1]

sender email address[1]

storage folder for delivery data[1]

resetting password for system administrator[1]

resource monitoring[1]

reverse proxy server[1]

notes[1]

roubleshooting of the data transfer command[1], [2]

S

secure operations[1]

selfsigned.bat[1]

selfsignedcertreq.bat[1]

selfsignedkeygen.bat[1]

sender email address[1]

setting up JP1/DH Web application server environment[1]

software[1]

JP1/DH - Server[1]

reverse proxy server[1]

specifying settings for electronic certificate authentication function[1]

starting and stopping[1]

Linux[1]

Windows[1]

starting and stopping in Linux[1]

procedure for starting[1]

procedure for stopping[1]

starting and stopping in Windows[1]

procedure for starting[1]

procedure for stopping[1]

starting JP1/DH Web application server from service[1]

starting JP1/DH Web server[1]

storage folder for delivery data[1]

storage period of audit log[1]

supported clustering software[1]

suspension and cancellation of active file transfer[1]

symbol conventions[1]

system configuration[1]

T

The Command Property File (property.xml)[1]

The data transfer command[1], [2]

The data transfer management command[1], [2]

The list of the data transfer command[1]

The list of the data transfer management command[1]

The Received List File[1]

time clock synchronization of server[1]

timeout period when using a directory server[1]

troubleshooting[1]

U

uninstallation[1]

Linux[1]

Windows[1]

uninstalling JP1/DH - Server administrator commands

Linux[1]

Windows[1]

upgrade installation[1]

Linux[1]

notes[1]

Windows[1]

use of WSFC[1]

user capacity[1]

User Count Command[1]

using file validation disabling function when using web user-interface[1]

using HA monitor[1]

using JP1/DH Web server[1]

V

version number conventions[1]

W

what's new function

notes[1]