1. Before Use

This document describes how to install and setup the new version of DataSpider Servista 4.3.

Refer "DataSpider Servista Upgrade Guide" for the upgrade from the existing version.

1.1. Precautions

1.1.1. Copyright Notice

  • The copyright of this software is owned by Saison Information Systems Co., Ltd. or its licensors.

  • Unauthorized copy, reprinting of this software and this manual is prohibited.

  • While preparing this manual every effort has been taken to ensure its correctness but in case of any mistakes, mismatch, and suggestions please contact us.

  • Please use this software by user’s responsibility. As a result, with regard to any trouble and the lawsuit, etc. occurs by any chance, damage or loss caused directly or indirectly, our company doesn’t at all assume any responsibilities. This is for your information beforehand.

  • The contents described in this manual and software specifications are subject to change for betterment, without prior notification.

  • The software licensing agreement is necessary for the use of this software, which includes trade secrets and proprietary information critical to Saison Information Systems Co., Ltd. or its licensors, and it is protected by the Copyright Law of the Japanese national administration. The unauthorized use of Saison Information Systems Co., Ltd. or the licenser’s software and this manual is subject to compensation and criminal proceedings.

1.1.2. Trademarks

  • DataSpider, the DataSpider logo, DataSpider Servista and the names of their associated products or services are trademarks or registered trademarks of Saison Information Systems Co., Ltd.

  • The names of other companies, products and services are trademarks or registered trademarks of their respective companies.

  • The duplication or diversion of information, such as trademarks, shown on the pages of this document is strictly prohibited.

1.2. About the mark of this document

The rules of the notations in this document are as follows.

  • Menu name, tab name, property item name, value, and button name displayed on screen are enclosed with [] and in bold letters. Moreover, the one without title of screens and other function names are enclosed with "" and distinguished from the former.

  • "$DATASPIDER_HOME" shows the directory where DataSpider Servista is installed.
    In default, it is "C:\Program Files\DataSpiderServista" for Windows version and "<HOME>/DataSpiderServista" for UNIX/Linux version.

  • x86 version means 32bit OS.
    x64 version means 64bit OS of 64bit CPU (Intel 64/AMD64).

  • Name enclosed with < > is variable value.
    Example: $DATASPIDER_HOME/server/logs/<Date directory>

  • URLs of the Web sites shown in this document are as of December 2020, and are subject to change without notice due to reasons of the Web site.

  • "Studio" means "DataSpider Studio", and "Studio for Web" means "DataSpider Studio for Web".

  • The descriptions of the Windows and UNIX/Linux versions of DataSpiderServer have been standardized.
    Please replace descriptions of operating system dependent items (such as path delimiter characters) as necessary.

  • The numbers beginning with "DSS-" are unique IDs for controlling each corresponding problem.

1.3. About the Icons Used in This Guide

This Guide uses the following icons in its explanation.

Icon Description

lightbulb_on

Indicates that there are hints about operations or configurations.

warning

Indicates that there are warnings about operations or configurations.

about

Indicates that there are detailed descriptions in other resources.

2. About end of sales and support

When you install DataSpider Servista, refer to https://www.hulft.com/support/dss-lifecycle (Japanese only) to check the end dates of sales and support for the supported platforms, databases for repository DB, and adapters.

3. About DataSpider Servista

DataSpider Servista is a data linkage middleware that allows you to create processes for transferring data between different kinds of systems or applications easily with a GUI base, which are normally done by developing programs or by manually inputting or transferring the data.

This middleware expresses the linkages with various data sources as batches of transactions, and describes the entire operation graphically by tying these batches with flows. You can publish a flow of a series of processes as a service and run it from tools such as Trigger.

DataSpider Servista provides not only data linkage functions but also development assisting functions for users or groups, and management functions such as log output and various triggers.

3.1. Composition of DataSpider Servista

DataSpider Servista consists of the following application.

Name Description

DataSpider Studio

GUI based IDE for designing, developing and operating the services.

DataSpiderServer

Service execution environment.

ScriptRunner

Application interface for the external invocation of service.

CLI Console

Application for operating and managing services, which is used by command line.

The following applications can be used on web browser after DataSpiderServer is installed.

Name Description

DataSpider Studio for Web

GUI based IDE for designing, developing and operating the services.

Browser Help

Referable help by using browser.

4.1. Server and Client for Execution

Following OS of both Japanese and English version are supported. For more details, refer to "Language in Support Platform".

  • Windows

    • Microsoft Windows Server 2012 Essentials/Standard/Datacenter (x64 version) (*1)

    • Microsoft Windows Server 2012 R2 Essentials/Standard/Datacenter (x64 version) (*1)

    • Microsoft Windows Server 2016 Essentials/Standard/Datacenter (x64 version) (*2)

    • Microsoft Windows Server 2019 Essentials/Standard/Datacenter (x64 version) (*2)

    (*1) Supports full installation, minimum server interface, and Server Core.
    (*2) Supports Server Core and Server with Desktop Experience.

  • UNIX/Linux

    • Red Hat Enterprise Linux Server 6.x (x64 version)

    • Red Hat Enterprise Linux Server 7.x (x64 version)

    • Red Hat Enterprise Linux Server 8.x (x64 version)

    • CentOS 7.x (x64 version)

    • Oracle Linux 7.x (x64 version) (*3)

    • Oracle Linux 8.x (x64 version) (*3)

    • Amazon Linux 2

    (*3) For kernel, "Unbreakable Enterprise Kernel" is supported.

4.2. Client for Development

Following OS of both Japanese and English version are supported. For more details, refer to "Language in Support Platform".

  • Windows

    • Microsoft Windows Server 2012 Essentials/Standard/Datacenter (x64 version) (*1)

    • Microsoft Windows Server 2012 R2 Essentials/Standard/Datacenter (x64 version) (*1)

    • Microsoft Windows Server 2016 Essentials/Standard/Datacenter (x64 version) (*2)

    • Microsoft Windows Server 2019 Essentials/Standard/Datacenter (x64 version) (*2)

    • Microsoft Windows 8.1 Pro/Enterprise (x86 version, x64 version)

    • Microsoft Windows 10 Pro/Enterprise (x86 version, x64 version)

    (*1) Supports full installation, minimum server interface, and Server Core.
    (*2) Supports Server Core and Server with Desktop Experience.

lightbulb_onRefer to "DataSpider Studio for Web" page of help for the supported OS of DataSpider Studio for Web.

The language in support platform varies by existence of language setting of DataSpider Servista. Set the language with platform which is subject to support.

platform which is subject to support

OS of Japanese
version

OS of English
version

The state is "possible to show Japanese"
in OS of English version

Language in DataSpider Servista

Japanese

Yes

No

Yes

English

Yes

Yes

Yes

In above table, "Yes" means supported, "No" means not supported.

lightbulb_on"possible to show Japanese" means environment to which language packs (Multilingual User Interface Pack) is applied and user interface is changed into Japanese for Windows. For Linux, it means environment in which OS can show Japanese and language setting of DataSpider Servista User is Japanese.

warningWhen "English" is set for DataSpider Servista language, to use Japanese at configurable / inputtable fields on DataSpider Servista, the DataSpider Servista operating OS should be "OS of Japanese version" or "The state is" possible to show Japanese" in OS of English version".

4.3.1. About Windows language packs (Multilingual User Interface Pack)

Environment with Japanese user interface is supported to use DataSpider Servista in Japanese in an environment for which Windows language pack (Multilingual User Interface Pack) is applied.

" Environment with Japanese user interface " indicates the environment with the following settings. (In the case of Windows Server 2012 R2)

  • In "All Control Panel Items" – "Region" of Windows

    • Select "Japanese(Japan)" in "Format" of "Formats" tab

    • Select "Japan in "Home location" of "Location" tab

    • Select "Japanese (Japan) " in "Administrative" – "Current language for non-Unicode programs"

  • In "All Control Panel Items" – "Language" of Windows

    • Select "Japanese(Japan)" in "Advanced settings" – "Override for Windows display language"

warning To register DataSpiderServer in Windows services, the user setting that starts the service should be in Japanese.

4.4. Specification Limits / Precautions

4.4.1. Specification Limits / Precautions for language settings

In DataSpider Servista 4.3, language can be set in server and client respectively. In that case, following specification limits and precautions exist when "English" is set for server language and when different languages are selected between the server and the client.

  • When "English" is set for server language

    • Help pages of following adapters are not able to open. (DSS-23034)

      • NeoCore, Sedue, ListCreator

    • Following help pages do not exist. (DSS-23067)

      • Reverse lookup reference, SAP adapter tutorial

  • When different languages are set between server and client

    • When the language is "English" in server and "Japanese" in client

      • Part of XML log is output in Japanese. (DSS-22573)

      • Part of error message might be output in English. (DSS-22811、DSS-22515)

      • The specification of Studio for Web is output in English. (DSS-22930)

    • When the language is "Japanese" in server and "English" in client

      • Part of XML log is output in English. (DSS-22573)

      • Part of error message might be output in Japanese. (DSS-22811、DSS-22515)

      • The specification of Studio for Web is output in Japanese. (DSS-22930)

4.4.2. Restriction for timezone in platform

Timezone in server and client are different, the timezone in client is required to be synchronized with the timezone in server.

(lightbulb_onUsually, timezone is gotten from operating OS, but if user.timezone of system.properties is set, the setting is prior.)

about The server timezone can be checked by the following procedure.

  1. Select [DataSpiderServer Settings] in Control Panel of DataSpider Studio.

  2. Select [General] tab and click [System properties] button.

  3. Confirm the value of "user.timezone".

Setting way of timezone for client is as follows.

  1. Stop each application in DataSpider Servista.

  2. Open system.properties in text editor under $DATASPIDER_HOME/client/conf.

  3. Delete "#" in "#user.timezone=Asia/Tokyo" and specify timezone of DataSpiderServer operating OS after "=" and save it.

  4. Launch DataSpiderServer and DataSpider Studio.

aboutFor more details of user.timezone properties, refer to page "Property reference" in help of DataSpider Servista.

warningIn the case of Studio for Web, timezone setting of Studio for Web operating OS is required to be set to the same setting as the timezone of DataSpiderServer operating OS.

4.5. Supported virtualization system

If you use DataSpider Servista in a virtual environment, all of the following conditions must be satisfied.

  • OS where DataSpider Servista is running is included in "Supported Platforms" in this document.

  • OS where DataSpider Servista is running supports virtual environment.

  • The virtual environment is host-based type or hypervisor-based type.

If all of the above conditions are satisfied, it is supported.

warningHowever, if the problem that depends on the specific virtual environment occurs, not only DataSpider Servista but also the virtual environment may need to be changed.

5. System requirements

System requirements is the minimum configuration which allows DataSpider Servista to operate. The optimal configuration varies depending on number and contents of operations, number of concurrent processings, size of data to be handled, and so on. Determine your configuration in accordance with requirements and operations of the service to be developed.

5.1. Both Server and Client

  • Color: 24 bit color

  • Resolution: 1024x768 pixels or more

lightbulb_onRefer to "DataSpider Studio for Web" page of help for the system requirements of DataSpider Studio for Web.

5.2. Server

lightbulb_onThe described system requirements are product independent.

  • Windows x64 version/Linux x64 version

    • CPU: Processor that meets 64bit(x64) system requirement that OS recommends

    • Memory: 2GB or more

    • HDD: Free space of 2GB or more

5.3. Client for development

lightbulb_onThe described system requirements are product independent.

  • Windows x86 version

    • CPU: Processor that meets system requirement that OS recommends

    • Memory: 512MB or more

    • HDD: Free space of 1GB or more

  • Windows x64 version

    • CPU: Processor that meets 64bit(x64) system requirement that OS recommends

    • Memory: 512MB or more

    • HDD: Free space of 1GB or more

5.4. Client for Execution

lightbulb_onThe described system requirements are product independent.

  • Windows x64 version/Linux x64 version

    • CPU: Processor that meets 64bit(x64) system requirement that OS recommends

    • Memory: 256MB or more

    • HDD: Free space of 500MB or more

6. About Java Runtime Environment

Since Java Runtime Environment (JRE) is bundled in each installer of DataSpider Servista 4.3, no need to install JRE.

And, JRE version bundled in each installer is as given below.

  • Windows version, Linux version

    • 1.8.0_265

To operate JRE on each platform, the patch to the operating system might be necessary. Refer to operating system for details.

7. Repository DB settings

7.1. What is a Repository DB?

A Repository DB is a system which manages services, user information, and various setting data in the repository area configured in a RDB (relational data base). Until a Repository DB is set up, you cannot use the user management system or the file access control functions.

However, DataSpider Servista can be installed even if a Repository DB has not been set up. Depending on your development requirements, determine whether you should set up a Repository DB or not.

7.1.1. Repository DB settings

Repository DB is set up during installation. You can modify the settings through the Control Panel.

about Refer to this document for the settings during installation, and refer to the [Repository DB Management] page of Help for the settings after installation.

Repository DB specification restrictions and precautions

warning Set up one Repository DB per DataSpiderServer. More than one DataSpiderServer cannot be connected to the same Repository DB.

warning The database instances should be used only for Repository DB and not for any other system.

warning The database instances specified for Repository DB should have an encoding system allowing multibyte characters. For example, a database instance encoded with US-ASCII cannot be used as a Repository DB.

7.1.2. Creating a Repository DB

Repository DB create a dedicated table in which the repository area is configured, and save data into it. This table is created during startup of DataSpiderServer. If a dedicated table already exists, a new table is not created and the existing table is used.

7.1.3. Operation with / without a Repository DB

Operation with or without a Repository DB is as follows.

  • If using a Repository DB (If a repository exists)

    • You can create multiple user groups and control their access privileges.

    • You can hold Meta information of various files in the repository.

    • You can save various settings in the repository.

  • If not using a Repository DB (If a Repository DB does not exist)

    • You can use only one type of user group.

    • The Meta information of various files and various settings are held in the file system of the OS.

DataSpider Servista supports the following databases as Repository DB.

  • DB2 for Linux, UNIX, and Windows

    • Supported versions: V11.1 / V10.5

  • MySQL

    • Supported versions: 8.0 / 5.7

  • Oracle Database

    • Supported versions: 19c / 18c / 12c

  • Oracle Database Cloud Service

    • Supported versions: Oracle Database 18c

  • Oracle Cloud Infrastructure Database

    • Supported versions: Oracle Database 19c

  • PostgreSQL

    • Supported versions: 12 / 11 / 10 / 9.6

  • Microsoft SQL Server

    • Supported versions: 2019 / 2017 / 2016 / 2014 / 2012

  • MySQL on Amazon RDS

    • Supported versions: 8.0 / 5.7

  • Oracle Database on Amazon RDS

    • Supported versions: 19c / 12c Release 2 / 12c

  • PostgreSQL on Amazon RDS

    • Supported versions: 11 / 10

  • Microsoft SQL Server on Amazon RDS

    • Supported versions: 2017 / 2016 / 2014 / 2012

  • Azure SQL Database

When you use a Repository DB, ensure that one of the above databases is running before installing DataSpider Servista.

7.3. Setting up each database

7.3.1. When using DB2 for Linux, UNIX, and Windows

To use DB2 for Linux, UNIX, and Windows as a Repository DB, the following information is needed.

  • Host name or IP address of DB2 for Linux, UNIX, and Windows

  • Port number used for providing services (Default port is "50000")

  • Name of the database

  • Path of the supported JDBC driver

  • V11.1

    • Required library: db2jcc4.jar

    • Version of the driver: IBM Data Server Driver for JDBC and SQLJ (for V11.1)

  • V10.5

    • Required library: db2jcc4.jar

    • Version of the driver: IBM Data Server Driver for JDBC and SQLJ (for V10.5)

User settings

You should add a new user in the database and set up a DBA role for the user. Settings of the user name and the password defined here are used when setting up the Repository DB. Before installing DataSpider Servista, ensure that you can access it externally using these setting values.

To use MySQL as a Repository DB, the following information is needed

  • Host name or IP address of MySQL

  • Port number used for providing services (Default port is "3306")

  • Name of the database

  • Path of the supported JDBC drive

  • 8.0

    • Required library: mysql-connector-java-8.0.<version>.jar

    • Version of the driver: MySQL Connector/J 8.0.<version>

  • 5.7

    • Required library: mysql-connector-java-5.1.<version>-bin.jar

    • Version of the driver: MySQL Connector/J 5.1.<version>

lightbulb_on<version> indicates the latest version.

User settings

You should add a new user in the database and set up a DBA role for the user. Settings of the user name and the password defined here are used when setting up the Repository DB. Before installing DataSpider Servista, ensure that you can access it externally using these setting values.

Specification restrictions / Precautions

  • warning When you use MySQL, configure by the following procedure without setting during installation.

    • Setting procedure

      1. Select "Do not use repository" in the installer and perform the installation.

      2. Launch DataSpiderServer and DataSpider Studio.

      3. Set from [Connection Wizard] in [Repository DB Management]-[Connection Settings] tab in the Control Panel.
        about For details, refer to "Repository DB Management" in DataSpider Servista Help.

  • warning "1" should be configured as default [lower_case_table_names] of the database.

  • warning "utf8" should be configured as the [default-character-server] for the database.

  • warning You must set the transaction isolation level of database as "READ-COMMITTED".

  • warning When DataSpider Servista communicates large data with the repository database (*), you must set a large number to "max_allowed_packed" of the database.

    * The following shows examples.

    • Creation of a project with many icons

    • Uploading large files

7.3.3. When using Oracle Database

To use Oracle Database as a Repository DB, the following information is needed.

  • Host name or IP address of Oracle Database

  • Port number used for providing services (Default port is "1521")

  • System identifier (SID)

  • Path of the supported JDBC driver

  • 19c

    • Required library: ojdbc8.jar

    • Version of the driver: Oracle JDBC Driver 19

  • 18c

    • Required library: ojdbc8.jar

    • Version of the driver: Oracle JDBC Driver 18

  • 12c

    • Required library: ojdbc7.jar

    • Version of the driver: Oracle JDBC Driver 12.1.0

User settings

You should add a new user in the database and set up a DBA role for the user. Settings of the user name and the password defined here are used when setting up the Repository DB. Before installing DataSpider Servista, ensure that you can access it externally using these setting values.

Specification restrictions / Precautions

  • warning When the version is 19c, "AL32UTF8 - Unicode UTF-8 Universal character set" should be configured as the [Database character set] for the database.

To use Oracle Database Cloud Service as a Repository DB, the following information is needed.

  • Host name or IP address of Oracle Database Cloud Service

  • Port number used for providing services (Default port is "1521")

  • Service name

  • Path of the supported JDBC driver

  • Oracle Database Cloud Service(Oracle Database 18c)

    • Required library: ojdbc8.jar

    • Version of the driver: Oracle JDBC Driver 18

User settings

You should add a new user in the database and set up a DBA role for the user. Settings of the user name and the password defined here are used when setting up the Repository DB. Before installing DataSpider Servista, ensure that you can access it externally using these setting values.

Specification restrictions / Precautions

warning When using Oracle Database Cloud Service, the service name cannot be set in the installer. Configure the setting by the following procedure.

  • Setting procedure

    1. Select "Do not use repository" in the installer and perform the installation.

    2. Launch DataSpiderServer and DataSpider Studio.

    3. Directly specify the URL in [Repository DB Management] in the Control Panel.
      Example: "jdbc:oracle:thin:@<Host name>:<Port number>/<Service name>"

To use Oracle Cloud Infrastructure Database as a Repository DB, the following information is needed.

  • Host name or IP address of Oracle Cloud Infrastructure Database

  • Port number used for providing services (Default port is "1521")

  • Service name

  • Path of the supported JDBC driver

  • Oracle Cloud Infrastructure Database(Oracle Database 19c)

    • Required library: ojdbc8.jar

    • Version of the driver: Oracle JDBC Driver 19

User settings

You should add a new user in the database and set up a DBA role for the user. Settings of the user name and the password defined here are used when setting up the Repository DB. Before installing DataSpider Servista, ensure that you can access it externally using these setting values.

Specification restrictions / Precautions

warning When using Oracle Cloud Infrastructure Database, the service name cannot be set in the installer. Configure the setting by the following procedure.

  • Setting procedure

    1. Select "Do not use repository" in the installer and perform the installation.

    2. Launch DataSpiderServer and DataSpider Studio.

    3. Directly specify the URL in [Repository DB Management] in the Control Panel.
      Example: "jdbc:oracle:thin:@<Host name>:<Port number>/<Service name>"

7.3.6. When using PostgreSQL

To use PostgreSQL as a Repository DB, the following information is needed.

  • Host name or IP address of PostgreSQL

  • Port number used for providing services (Default port is "5432")

  • Name of the database

  • Path of the supported JDBC driver

  • 12

    • Required library: postgresql-42.<version>.jar

    • Version of the driver: PostgreSQL JDBC 4.2 (<version>)

  • 11

    • Required library: postgresql-42.<version>.jar

    • Version of the driver: PostgreSQL JDBC 4.2 (<version>)

  • 10

    • Required library: postgresql-42.<version>.jar

    • Version of the driver: PostgreSQL JDBC 4.2 (<version>)

  • 9.6

    • Required library: postgresql-9.4-<version>.jar

    • Version of the driver: PostgreSQL 9.4 JDBC4.2 (build <version>)

lightbulb_on<version> indicates the latest version.

User settings

You should add a new user in the database and set up a DBA role for the user. Settings of the user name and the password defined here are used when setting up the Repository DB. Before installing DataSpider Servista, ensure that you can access it externally using these setting values.

7.3.7. When using Microsoft SQL Server

To use Microsoft SQL Server as a Repository DB, the following information is needed.

  • Host name or IP address of SQL Server

  • Port number used for providing services (Default port is "1433")

  • Name of the database

  • Path of the supported JDBC driver

  • 2019

    • Required library: mssql-jdbc-8.4.<version>.jre8.jar

    • Version of the driver: Microsoft JDBC Driver 8.4 for SQL Server

  • 2017

    • Required library: mssql-jdbc-8.4.<version>.jre8.jar

    • Version of the driver: Microsoft JDBC Driver 8.4 for SQL Server

  • 2016

    • Required library: mssql-jdbc-8.4.<version>.jre8.jar

    • Version of the driver: Microsoft JDBC Driver 8.4 for SQL Server

  • 2014

    • Required library: mssql-jdbc-8.4.<version>.jre8.jar

    • Version of the driver: Microsoft JDBC Driver 8.4 for SQL Server

  • 2012

    • Required library: mssql-jdbc-6.2.<version>.jre8.jar

    • Version of the driver: Microsoft JDBC Driver 6.2 for SQL Server

User settings

You should add a new user in the database and set the db_owner role for the user. Settings of the user name and the password defined here are used during setting up the Repository DB. Before installing DataSpider Servista, ensure that you can access it externally using these setting values.

Specification restrictions/Precautions

  • warning The collating sequence in the database should be configured to be not casesensitive.

  • warning Connecting using Windows Integrated Authentication is impossible.

To use MySQL on Amazon RDS as a Repository DB, the following information is needed.

  • Host name of MySQL on Amazon RDS

  • Port number used for providing services (Default port is "3306")

  • Name of the database

  • Path of the supported JDBC driver

  • 8.0

    • Required library: mysql-connector-java-8.0.<version>.jar

    • Version of the driver: MySQL Connector/J 8.0.<version>

  • 5.7

    • Required library: mysql-connector-java-5.1.<version>-bin.jar

    • Version of the driver: MySQL Connector/J 5.1.<version>

lightbulb_on<version> indicates the latest version.

User settings

You should add a new user in the database and set up a DBA role for the user. Settings of the user name and the password defined here are used when setting up the Repository DB. Before installing DataSpider Servista, ensure that you can access it externally using these setting values.

Specification restrictions / Precautions

  • warningWhen you use MySQL on Amazon RDS, configure by the following procedure without setting during installation.

    • Setting procedure

      1. Select "Do not use repository" in the installer and perform the installation.

      2. Launch DataSpiderServer and DataSpider Studio.

      3. Set from [Connection Wizard] in [Repository DB Management]-[Connection Settings] tab in the Control Panel.
        about For details, refer to "Repository DB Management" in DataSpider Servista Help.

  • warning"1" should be configured as default [lower_case_table_names] of the database.

  • warning"utf8" should be configured as the [default-character-server] for the database.

7.3.9. When using Oracle Database on Amazon RDS

To use Oracle Database on Amazon RDS as a Repository DB, the following information is needed.

  • Host name of Oracle Database on Amazon RDS

  • Port number used for providing services (Default port is "1521")

  • System identifier (SID)

  • Path of the supported JDBC driver

  • 19c

    • Required library: ojdbc8.jar

    • Version of the driver: Oracle JDBC Driver 19

  • 12c Release 2

    • Required library: ojdbc8.jar

    • Version of the driver: Oracle JDBC Driver 12.2.0

  • 12c

    • Required library: ojdbc7.jar

    • Version of the driver: Oracle JDBC Driver 12.1.0

User settings

You should add a new user in the database and set up a DBA role for the user. Settings of the user name and the password defined here are used during setting up the Repository DB. Before installing DataSpider Servista, ensure that you can access it externally using these setting values.

Specification restrictions / Precautions

  • warning When the version is 19c, "AL32UTF8" should be configured as the [Character set name] for the database.

7.3.10. When using PostgreSQL on Amazon RDS

To use PostgreSQL on Amazon RDS as a Repository DB, the following information is needed.

  • Host name of PostgreSQL on Amazon RDS

  • Port number used for providing services (Default port is "5432")

  • Name of the database

  • Path of the supported JDBC driver

  • 11

    • Required library: postgresql-42.<version>.jar

    • Version of the driver: PostgreSQL JDBC 4.2 (<version>)

  • 10

    • Required library: postgresql-42.<version>.jar

    • Version of the driver: PostgreSQL JDBC4.2 (<version>)

lightbulb_on<version> indicates the latest version.

User settings

You should add a new user in the database and set up a DBA role for the user. Settings of the user name and the password defined here are used when setting up the Repository DB. Before installing DataSpider Servista, ensure that you can access it externally using these setting values.

7.3.11. When using Microsoft SQL Server on Amazon RDS

To use Microsoft SQL Server on Amazon RDS as a Repository DB, the following information is needed.

  • Host name of Microsoft SQL Server on Amazon RDS

  • Port number used for providing services (Default port is "1433")

  • Name of the database

  • Path of the supported JDBC driver

  • 2017

    • Required library: mssql-jdbc-8.4.<version>.jre8.jar

    • Version of the driver: Microsoft JDBC Driver 8.4 for SQL Server

  • 2016

    • Required library: mssql-jdbc-8.4.<version>.jre8.jar

    • Version of the driver: Microsoft JDBC Driver 8.4 for SQL Server

  • 2014

    • Required library: mssql-jdbc-8.4.<version>.jre8.jar

    • Version of the driver: Microsoft JDBC Driver 8.4 for SQL Server

  • 2012

    • Required library: mssql-jdbc-6.2.<version>.jre8.jar

    • Version of the driver: Microsoft JDBC Driver 6.2 for SQL Server

User settings

You should add a new user in the database and set up a db_owner role for the user. Settings of the user name and the password defined here are used when setting up the Repository DB. Before installing DataSpider Servista, ensure that you can access it externally using these setting values.

Specification restrictions / Precautions

  • warning The collating sequence in the database should be configured to be not casesensitive.

  • warning Connecting using Windows Integrated Authentication is impossible.

7.3.12. When using Azure SQL Database

To use Azure SQL Database as a Repository DB, the following information is needed.

  • Host name of Azure SQL Database

  • Port number used for providing services (Default port is "1433")

  • Name of the database

  • Path of the supported JDBC driver

  • Azure SQL Database

    • Required library: mssql-jdbc-8.4.<version>.jre8.jar

    • Version of the driver: Microsoft JDBC Driver 8.4 for SQL Server

User settings

You should add a new user in the database and set up a db_owner role for the user. Settings of the user name and the password defined here are used when setting up the Repository DB. Before installing DataSpider Servista, ensure that you can access it externally using these setting values.

Specification restrictions / Precautions

  • warning The collating sequence in the database should be configured to be not casesensitive.

8. Specifications and Limitations at Installation

8.1. General

  • You cannot install multiple DataSpider Servista of different versions on the same platform.

  • You cannot install multiple DataSpider Servista of the same version on the same platform.
    However, exclude the following cases.

    • It is possible to install a server and a client of the same version independently (select [Client only] or [Server only] on the [Select Component] screen). However, the limitations are given below.

      • The uninstaller should be run by selecting $DATASPIDER_HOME/Uninstall/Uninstall.exe.

      • When you uninstall them, be sure to uninstall all servers and clients installed on the same platform

    • It is possible to install multiple clients for same version of DataSpider Servista development in the same platform. However, the limitations are given below.

      • Run the exe file under $DATASPIDER_HOME/client/bin for each client application.

      • The uninstaller should be run by selecting DATASPIDER_HOME/Uninstall/Uninstall.exe

      • When you uninstall them, be sure to uninstall all servers and clients installed on the same platform.

  • Language of DataSpiderServer is set when installing. It is not able to change after installation. (DSS-22577)

  • For Windows version, install them as an administrator user.

    • When installed as the user without administrator rights, it is not registered as the application in Windows [Add or Remove Programs]. (DSS-6271)

    • After installing, when the general user starts the DataSpider, assign the general user rights for all the directories under the installation directory. (DSS-7217)

8.2. Installer

  • For all installer screens, input field cannot be scrolled sideways. (DSS-896)

8.3. Select Component

  • When you select [Client only] or [Server only] on the [Select Component] screen and install them, the value may not be reflected in the URL of [DataSpider Studio for Web], [Help] menu of Windows start menu. (DSS-11359)

    Configure the proper URL through the properties on the [DataSpider Studio for Web], [Help] menu of Windows start menu.

8.4. Select Repository DB

  • On "Select JDBC driver" screen of installer, if you press [Choose] button and Specify long path, [Restore Default] button and [Choose] button might disappear. (DSS-1539)

  • On "Select JDBC driver" screen of installer, if JDBC driver path contains "#" or "%", DataSpiderServer is unable to load the driver at starting. (DSS-4635)

    Don’t use "#" and "%" for JDBC driver path.

8.5. Register Windows Service

  • If DataSpiderServer is registered as Windows service by the user account of following conditions, the service of DataSpiderServer is not displayed in Windows service list. (DSS-1356)

    • The user is not belonging to Administrators group.

    • The user doesn’t have full control permission of C: drive.

  • When registering DataSpiderServer in Windows Service name, multi byte characters are not allowed in the Windows Service name of the DataSpiderServer. (DSS-11335)

8.6. Installation Directory Settings

  • Following characters are not available for install directory. (DSS-22963、DSS-12834、DSS-9044, DSS-8718)

    • multi byte

    • equals sign

    • percent sign

    • single byte space (only for UNIX/Linux version)

  • In UNIX/Linux version, after installing as root user, the user and group belonging to $DATASPIDER_HOME/jre directory are displayed as "500". (DSS-7952)

8.7. Installation Complete

  • Folder name (DataSpider Servista installation directory) cannot be changed after installation.(DSS-7463)

9. Notes concerning Windows

If you install DataSpider Servista on Windows OS, read the following notes.

9.1. Notes when Installing DataSpider Servista

  • If you install DataSpider Servista in C drive (installation drive of Windows OS), the following issues may occur.

    • DataSpiderServer: When starting as unauthorized user, if you don’t Launch DataSpiderServer by "Run as administrator", DataSpiderServer might not be restarted from DataSpider Studio and command prompt.

    • DataSpider Studio: When starting as unauthorized user, if you don’t start DataSpider Studio by "Run as administrator", it might be unable to connect with DataSpiderServer.

  • If you install DataSpider Servista in D drive in which Windows OS is not installed, the following issues may occur.

    • DataSpiderServer: When starting as unauthorized user, if you don’t Launch DataSpiderServer by "Run as administrator", DataSpiderServer might not be restarted from DataSpider Studio and command prompt.

lightbulb_on Above-mentioned "Unauthorized user" refers to users other than built-in Administrator account when UAC is valid and when UAC is invalid, it refers to the general user.

10. Installation of DataSpider Servista

This chapter explains the installation procedure of DataSpider Servista. The installer file that supports each platform is used for installation.

10.1. Installation

Run the installer file that supports each platform, and start the installer.

The following table shows the file name of each installer and the supported Platforms.

  • Windows

    File name Supported Platforms

    DSS43_WIN_X64.exe

    Windows x64 version

    DSS43_WIN_X86.exe

    Windows x86 version

  • UNIX/Linux

    File name Supported Platforms Installation method

    DSS43_LNX_X64.bin

    UNIX/Linux x64 version

    GUI method

    DSS43_LNX_X64_CUI.bin

    UNIX/Linux x64 version

    CUI method

    warningTo install DataSpider Servista by using GUI method, start X Windows System in advance.

    lightbulb_onThe installer contains both the server and the client. The installation target is selected during the installation process.

10.1.1. Select Language

Select a language by which operate the product.

warning DataSpiderServer and Server CLI Console will start by the language you select here. You cannot change the language after completing the installation.

lightbulb_onClient (DataSpider Studio, DataSpider Studio for Web, Client CLI Console) execute first boot in selected language. The language can be changed after.

10.1.2. Introduction

In the introduction screen, read through the displayed content, and then press [Next] button.

10.1.3. Select Package

Select the package you purchased, then press [Next] button. Available packages are as follows.

  • [Advanced Server Package]

  • [Basic Server Package]

  • [Select]

warningThe product configurations between above packages and the terms and conditions of their contracts are different. Be sure to select the correct one you purchased.

Select the component to install. Select the option, then press [Next] button.

  • [Server and Client]: Both server and client are installed.

  • [Server only]: Only server is installed.

  • [Client only]: Only client is installed.

The following table shows the installation target components for server and client.

Installed
application

Server

Client

Clients for development

Clients for execution

DataSpider Studio for Web

Yes

Yes

Yes

Help Document

Yes

Yes

Yes

DataSpiderServer

Yes

No

No

ScriptRunner

Yes

No

No

Server CLI Console

Yes

No

No

DataSpider Studio

No

Yes

No

Client ScriptRunner

No

Yes

Yes

Client CLI Console

No

Yes

Yes

Yes: It is installed.
No: It is not installed.
*: It depends on the settings on the [Select Client Environment] screen.

warningThe server and the client are supported by different platforms.
For more details, refer to "OS supporting DataSpider Servista".

warningTo install a server and a client on the same platform, select [Server and Client]. On the same platform, when you independently install a server and a client of the same version, and if you uninstall one of them, all Windows menus will be deleted.

Select the client environment to install. Select the option, then press [Next] button.

  • Client for development

  • Client for execution

lightbulb_onIt is displayed when you select [Server and Client] or [Client only] on the [Select Component] screen.

For details on the applications to be installed, refer to the section "Select Component".

warningNotes on the clients for development

  • Cannot be installed on UNIX/Linux environment.

  • For Windows environment, use the installer with "exe" extension to install.

10.1.6. Administrator Password Settings

Enter the password of administrator (root user), then press [Next] button.

lightbulb_onThis setting is available only when you select [Server and Client] or [Server only] on the [Select Component] screen.

lightbulb_onAfter installation, you can change administrator password from [User Accounts] of Control Panel of DataSpider Studio.

lightbulb_onThis setting is available only when you select [Server and Client] or [Server only] on the [Select Component] screen.

Select whether to use Repository DB or not. Select the option, then press [Next] button.

  • [Use repository]: It builds a DataSpider file system on the database.

  • [Do not use repository]: It builds a DataSpider file system on the file system of the OS where DataSpiderServer is running.

aboutIf you select [Do not use repository], it is not necessary to make the settings described in the next "Select Database Product" and after the section. Refer to "Register Windows Service" for details.

warning If you use one of the following database as a repository DB, you cannot configure by using the installer. Select [Do not use repository] and configure the settings after installation.

  • MySQL

  • Oracle Database Cloud Service

  • Oracle Cloud Infrastructure Database

  • MySQL on Amazon RDS

For more details, refer to the following.

lightbulb_on[Select Database Product] screen is not available when you select [Do not use repository] at [Select Repository Database] screen.

Select a database product to use as repository DB. Select the option, then press [Next] button.
Available database products are as follows.

  • [DB2]: Selects when DB2 for Linux, UNIX, and Windows is used in repository DB.

  • [MySQL]: When you use MySQL or MySQL on Amazon RDS, do not select [MySQL], but select [Do not use repository] after getting back to [Select Repository Database] screen.

    aboutFor more details, refer to "Specification restrictions / Precautions" in "When using MySQL" and "When using MySQL on Amazon RDS".

  • [Oracle]: Selects when Oracle Database or Oracle Database on Amazon RDS is used in repository DB.

  • [PostgreSQL]: Selects when PostgreSQL or PostgreSQL on Amazon RDS is used in repository DB.

  • [SQL Server]: Selects when Microsoft SQL Server, Microsoft SQL Server on Amazon RDS or Azure SQL Database is used in repository DB.

After selecting database product, by the following procedure, select a JDBC driver and set database connection information.

  1. Specify the file path of JDBC driver, then press [Next] button.

  2. Enter the connection information of database, then press [Next] button.

For more details about the supported versions of each database and JDBC driver, refer to the following table.

Database,
JDBC driver		 Referred to

DB2

Database

"DB2 for Linux,Supported versions of DB2 for Linux, UNIX, and Windows"

JDBC driver

"Supported JDBC driver of DB2"

MySQL

Database

"Supported versions of MySQL"
"Supported versions of MySQL on Amazon RDS"

JDBC driver

"Supported JDBC driver of MySQL"
"Supported JDBC driver of MySQL on Amazon RDS"

Oracle

Database

"Supported versions of Oracle Database"
"Supported versions of Oracle Database on Amazon RDS"

JDBC driver

"Supported JDBC driver of Oracle Database"
"Supported JDBC driver of Oracle Database Cloud Service"
"Supported JDBC driver of Oracle Cloud Infrastructure Database"
"Supported JDBC driver of Oracle Database on Amazon RDS"

Postgre
SQL

Database

"Supported versions of PostgreSQL"
"Supported versions of PostgreSQL on Amazon RDS"

JDBC driver

"Supported JDBC driver of PostgreSQL"
"Supported JDBC driver of PostgreSQL on Amazon RDS"

SQL Server

Database

"Supported versions of Microsoft SQL Server"
"Supported versions of SQL Server on Amazon RDS"
"Supported versions of Azure SQL Database"

JDBC driver

"Supported JDBC driver of Microsoft SQL Server"
"Supported JDBC driver of SQL Server on Amazon RDS"
"Supported JDBC driver of Azure SQL Database"

For Windows version, select whether to register DataSpider Servista as the Windows service, then press [Next] button.

lightbulb_onIn the installer for UNIX/Linux version, this screen is not displayed.

lightbulb_onIt is displayed when you select [Server and Client] or [Server only] on the [Select Component] screen.

warningAfter checking [Register the server as Windows Service], if you omit the service name, it is not registered as the Windows Service.

warningPrecautions when you register a DataSpiderServer with a repository DB on a Windows service

If both the DataSpiderServer with a repository DB and the repository DB are started from a Windows service, repository DB may not yet be started when DataSpiderServer is started.

In such case, you should set the appropriate times and cycles of Test connect count in [Repository DB Management] - [Reconnection settings] tab in control panel of DataSpider Studio.

10.1.10. Connection Information Settings

Enter the host name and the IP address of the OS where DataSpiderServer is running and the port number of DataSpiderServer, then press [Next] button.

lightbulb_onIf [Host name/IP address] is omitted, "localhost" will be set.

lightbulb_onIf [Port number] is omitted, "7700" will be set.

warningIn the UNIX/Linux version, administrative rights are necessary for the numerical value "1023" or less. Specify the number other than "0" to "1023" for starting DataSpiderServer as a general user.

10.1.11. Installation Directory Settings

Set the installation directory of DataSpider Servista, then press [Next] button.

warningIf DataSpider Servista already exists in the destination directory specified in destination folder, a warning dialog appears. Do not overwrite the existing DataSpider Servista.

10.1.12. Select License File

Specify the file path of DataSpider Servista license (license.lic), then press [Next] button.

lightbulb_onThis screen is displayed when you select [Server and Client] or [Server only] on the [Select Component] screen.

The license file specified is copied under the directory $DATASPIDER_HOME/server/lic.

lightbulb_onYou can also apply license file even after installation.

10.1.13. Heap Size Settings

Specify the heap size of DataSpiderServer, then press [Next] button.

lightbulb_onThis screen is displayed when you select [Server and Client] or [Server only] on the [Select Component] screen.

The unit of megabytes is specified as "m" or "M", and gigabytes is specified as "g" or "G".

lightbulb_onIf you omit this setting, the following value is set.

Install target platform [Initial(bytes)] [Maximum(bytes)]

Windows x64/ Linux x64 version

1G

2G

10.1.14. Summary of Installation

Summary of installation is displayed. Confirm a displayed content of settings. Press [Install] button for GUI method, or press [Enter] button for CUI method, and then installation begins.

10.1.15. Installation Complete

When installation executed successfully, "Installation Complete" screen is displayed. Press [Done] button for GUI method, or press [Enter] button for CUI method to end installer.

lightbulb_on Setting data for DataSpiderServer and the Repository DB are written into the below location.

  • $DATASPIDER_HOME/server/conf/dsserver.xml

When there are mistakes in the settings of the repository DB or you want to change the connected repository DB, you can modify the settings through [Repository DB Management] in the DataSpider Studio’s Control Panel.

10.2. Work after Installation

This chapter explains the procedure necessary to perform after installation.

10.2.1. License file settings

If you did not configure the license file (license.lic) in installer, copy the license file to the license file storage directory manually.

  • License file storage directory
    $DATASPIDER_HOME/server/lic

    warningNotes on the license file

  • License file name should be "license.lic" or "LICENSE.LIC".

  • Only one license file can be placed in the license file storage directory. If it is required to overwrite the license file such as the case of purchasing additional adapter, perform the following procedure.

    1. Save the existing license file to another directory.

    2. Store the new license file to the license file storage directory.

10.2.2. Setting the font file for UNIX/Linux version

In UNIX/Linux version, if the font file used to operate the product by the language in use is not installed in the OS, store the font file of the language in use in $DATASPIDER_HOME/jre/lib/fonts/fallback directory.

10.2.3. Application Log Output Settings

To add the application log to the NT event log system, store the following library file to the directory where it is included in the environment variable "PATH" of Windows system.

  • Library file
    $DATASPIDER_HOME/server/lib/NTEventLogAppender.dll

aboutFor more details, refer to the page "Application Log Output Settings" of DataSpider Servista help.

10.2.4. About Windows start menu

In Windows version, start menus created at installation differ according to the settings in the [Select Component] screen and the [Select Client Environment] screen during installation.

The settings of the screen during installation and created start menus are as follows.

[Select Component] screen

[Server and Client]

[Server only]

[Client only]

[Select client environment] screen

[Clients for
development]

[Clients for
execution]

*

[Clients for
development]

[Clients for execution]

Client CLI Console

Yes

Yes

No

Yes

Yes

DataSpider Studio

Yes

No

No

Yes

No

DataSpider Studio for Web

Yes

Yes

Yes

Yes

Yes

DataSpiderServer

Yes

Yes

Yes

No

No

Help Document

Yes

Yes

Yes

Yes

Yes

Server CLI Console

Yes

Yes

Yes

No

No

Shutdown

Yes

Yes

Yes

No

No

Uninstall

Yes

Yes

Yes

Yes

Yes

Yes: Start menu item is created
No: Start menu item is not created
*: If [Server only] is selected on the [Select Component] screen, the [Select Client Environment] screen is not displayed.

11. Pre-setting of Adapters

For using each adapter, pre-setting might be necessary such as installation of the library etc.
about For more details, refer to the following descriptions or DataSpider Servista Help.

11.1. Access Adapter

11.1.1. Access 2013 adapter

Library installation is not necessary in Access adapter.

11.2. DB2 Adapter

11.2.1. DB2 V11.1 adapter

  • Required library

    • db2jcc4.jar

  • Supported driver version

    • IBM Data Server Driver for JDBC and SQLJ (for V11.1)

  • How to get library

    • If you installed DB2 at default directory, they are placed under sqllib/java directory below DB2 installation directory.

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/db2_111_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.2.2. DB2 V10.5 adapter

  • Required library

    • db2jcc4.jar

  • Supported driver version

    • IBM Data Server Driver for JDBC and SQLJ (for V10.5)

  • How to get library

    • If you installed DB2 at default directory, they are placed under sqllib/java directory below DB2 installation directory.

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/db2_105_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.2.3. DB2 for i 7.4 / 7.3 / 7.2 adapter

  • Required library

    • jt400.jar

  • How to get library

    • In default settings, it is placed under /QIBM/ProdData/HTTP/Public/jt400/lib directory.

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy required library group under the directory $DATASPIDER_HOME/server/plugin/data_processing/modules/db2udb_iseries<version>_adapter.
      lightbulb_on <version> indicates the version of DB2 for iSeries. It will be "72" for 7.2, "73" for 7.3, and "74" for 7.4.

    3. Launch DataSpiderServer and DataSpider Studio.

11.3. MySQL Adapter

lightbulb_on<version> shows the latest version.

11.3.1. MySQL 8.0 adapter

  • Required library

    • mysql-connector-java-8.0.<Version>.jar

  • Supported driver version

    • MySQL Connector/J 8.0.<Version>

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/mysql80_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.3.2. MySQL 5.7 adapter

  • Required library

    • mysql-connector-java-5.1.<Version>-bin.jar

  • Supported driver version

    • MySQL Connector/J 5.1.<Version>

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/mysql57_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.4. Oracle Adapter

11.4.1. Oracle 19c Adapter

  • Required library

    • ojdbc8.jar

    • orai18n.jar

  • Supported driver version

    • Oracle JDBC Driver 19

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/oracle19c_adapter directory and $DATASPIDER_HOME/server/plugin/data_processing/modules/xa_oracle19c_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.4.2. Oracle 18c Adapter

  • Required library

    • ojdbc8.jar

  • Supported driver version

    • Oracle JDBC Driver 18

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/oracle18c_adapter directory and $DATASPIDER_HOME/server/plugin/data_processing/modules/xa_oracle18c_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.4.3. Oracle 12c Adapter

  • Required library

    • ojdbc7.jar

  • Supported driver version

    • Oracle JDBC Driver 12.1.0

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/oracle12c_adapter directory and
      $DATASPIDER_HOME/server/plugin/data_processing/modules/xa_oracle12c_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.5. PostgreSQL Adapter

In PostgreSQL adapter, it is not necessary to install library.

11.6. SQL Server Adapter

11.6.1. SQL Server 2019 Adapter

  • Required library

    • mssql-jdbc-8.4.<version>.jre8.jar

    • mssql-jdbc_auth-8.4.<version>.x64.dll (when using Windows authentication)

  • Supported driver version

    • Microsoft JDBC Driver 8.4 for SQL Server

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy mssql-jdbc-8.2.0.jre8.jar directly under the directory $DATASPIDER_HOME/server/plugin/data_processing/modules/sqlserver2019_adapter

    3. When you use Windows authentication, copy mssql-jdbc_auth-8.2.0.x64.dll to a directory included in Windows system paths of the computer where the JDBC driver is installed.

    4. Launch DataSpiderServer and DataSpider Studio.

11.6.2. SQL Server 2017 Adapter

  • Required library

    • mssql-jdbc-8.4.<version>.jre8.jar

    • mssql-jdbc_auth-8.4.<version>.x64.dll (when using Windows authentication)

  • Supported driver version

    • Microsoft JDBC Driver 8.4 for SQL Server

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy mssql-jdbc-8.4.<version>.jre8.jar directly under the directory $DATASPIDER_HOME/server/plugin/data_processing/modules/sqlserver2017_adapter

    3. When you use Windows authentication, copy mssql-jdbc_auth-8.4.<version>.x64.dll to a directory included in Windows system paths of the computer where the JDBC driver is installed.

    4. Launch DataSpiderServer and DataSpider Studio.

11.6.3. SQL Server 2016 Adapter

  • Required library

    • mssql-jdbc-8.4.<version>.jre8.jar

    • mssql-jdbc_auth-8.4.<version>.x64.dll (when using Windows authentication)

  • Supported driver version

    • Microsoft JDBC Driver 8.4 for SQL Server

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy mssql-jdbc-8.4.<version>.jre8.jar to $DATASPIDER_HOME/server/plugin/data_processing/modules/sqlserver2016_adapter directory.

    3. When you use Windows authentication, copy mssql-jdbc_auth-8.4.<version>.x64.dll to a directory included in Windows system paths of the computer where the JDBC driver is installed.

    4. Launch DataSpiderServer and DataSpider Studio.

11.6.4. SQL Server 2014 Adapter

  • Required library

    • mssql-jdbc-8.4.<version>.jre8.jar

    • mssql-jdbc_auth-8.4.<version>.x64.dll (when using Windows authentication)

  • Supported driver version

    • Microsoft JDBC Driver 8.4 for SQL Server

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy mssql-jdbc-8.4.<version>.jre8.jar to $DATASPIDER_HOME/server/plugin/data_processing/modules/sqlserver2014_adapter directory.

    3. When you use Windows authentication, copy mssql-jdbc_auth-8.4.<version>.x64.dll to a directory included in Windows system paths of the computer where the JDBC driver is installed.

    4. Launch DataSpiderServer and DataSpider Studio.

11.6.5. SQL Server 2012 JDBC Adapter

  • Required library

    • mssql-jdbc-6.2.<version>.jre8.jar

    • sqljdbc_auth.dll (when using Windows authentication)

  • Supported driver version

    • Microsoft JDBC Driver 6.2 for SQL Server

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy mssql-jdbc-6.2.<version>.jre8.jar to $DATASPIDER_HOME/server/plugin/data_processing/modules/sqlserver2012_adapter directory.

    3. When you use Windows authentication, copy sqljdbc_auth.dll to a directory included in Windows system paths of the computer where the JDBC driver is installed.

    4. Launch DataSpiderServer and DataSpider Studio.

11.7. JDBC Adapter

  • Required library

    • Inquire DBMS vendor connected with JDBC adapter.

  • How to get library

    • Inquire DBMS vendor connected with JDBC adapter.

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy required library group under the directory $DATASPIDER_HOME/server/plugin/data_processing/modules/jdbc_adapter

    3. Launch DataSpiderServer and DataSpider Studio.

11.8. ODBC Adapter

In ODBC adapter, it is not necessary to install library.

11.9. MongoDB Adapter

In MongoDB adapter, it is not necessary to install library.

11.10. NeoCore Adapter

11.10.1. NeoCore 3.1 adapter

  • Required library

    • xmsclient.jar

  • How to get library

    • If NeoCore 3.1 is installed with default settings, the corresponding library is located under the directory C:\NeoCore\API\Java\lib.

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/neocore31_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.10.2. NeoCore 3.0 adapter

  • Required library

    • xmsclient.jar

  • How to get library

    • If NeoCore 3.0 is installed with default settings, the corresponding library is located under the directory C:\NeoCore\API\Java\lib.

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/neocore30_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.10.3. NeoCore 2.9 adapter

  • Required library

    • neoHTTPConnection.jar

  • How to get library

    • If NeoCore 2.9 is installed with default settings, the corresponding library is located under the directory C:\NeoCore\API\Java\lib.

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/neocore29_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.11. Thunderbus DB Agent Adapter

In Thunderbus DB Agent adapter, it is not necessary to install library.

11.12. DataSpider BPM Adapter

In DataSpider BPM adapter, it is not necessary to install library.

11.13. Dr.Sum Adapter

In 11.12. Dr.Sum Adapter, it is not necessary to install library.

11.14. Dynamics 365 for Customer Engagement Adapter

In Dynamics 365 for Customer Engagement Adapter, it is not necessary to install library.

11.15. IBM Domino Adapter

warningYou cannot use multiple versions of Lotus Domino adapter at the same time.

11.15.1. IBM Domino 9.0 Adapter

  • Required libraries

    • NCSO.jar

    • Notes.jar

  • To get a library

    • If IBM Domino 9.0 is installed with default settings in Windows environment, the corresponding library is located under the directories below.

      • <Installation directory of Domino>/data/domino/java/NCSO.jar

      • <Installation directory of Domino>/jvm/lib/ext/Notes.jar

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required library group under the directory $DATASPIDER_HOME/server/plugin/data_processing/share/lib.

    3. Launch DataSpiderServer and DataSpider Studio.

11.16. IBM Notes Adapter

11.16.1. IBM Notes 9.0 Adapter

  • Required software

    • To use IBM Notes adapter, IBM Notes (below Notes client) must be installed on system that DataSpiderServer is running.

  • Setting up system environment variable "PATH"

    • After installing Notes client, add path of Notes client installation directory to Windows system variable.

  • Setting Notes port

    • To connect from IBM Notes adapter to Notes client, Notes port is required. If the connection setting has been made from Notes client to Domino server, the Notes port setting is not necessary. If Notes port does not exist, add the TCP or NETBIOS port.

warningThe user access from IBM Notes adapter to the database of Domino server is fixed as the user set in Notes client.
Moreover, as the user password needs to be cleared, clear the password from Notes client.

Notes users who are configured on the client, "Password quality scale" please allow the setting without a password.

11.17. SAP Adapter

To use SAP adapter, you need to install SAP EICS.
about For more details, refer to "DataSpider Servista SAP EICS Install Guide" bundled to installer.

11.18. SAP BC Adapter

In SAP BC adapter, it is not necessary to install library.

11.19. SAP Table Query Adapter

In SAP Table Query adapter, it is not necessary to install library.

11.20. Sedue Adapter

In Sedue adapter, it is not necessary to install library.

11.21. Tableau Adapter

Output Hyper File and Output TDE File require different libraries.
Refer to "Output Hyper File" or "Output TDE File" to install.

  • Required library

    boost_chrono-vc140-mt-1_60.dll
    boost_date_time-vc140-mt-1_60.dll
    boost_filesystem-vc140-mt-1_60.dll
    boost_system-vc140-mt-1_60.dll
    boost_thread-vc140-mt-1_60.dll
    concrt140.dll
    icudt44.dll
    icuin44.dll
    icuio44.dll
    icuuc44.dll
    libpq.dll
    metrics2.dll
    msvcp140.dll
    TableauCommon.dll
    TableauHyperExtract.dll
    tablibeay32.dll
    tabssleay32.dll
    tabsys.dll
    tbb.dll
    ucrtbase.dll
    vccorlib140.dll
    vcruntime140.dll
    hyper/hyperd.exe
    hyper/hyperd_sse2.exe
    hyper/hyperdstarter.exe
    hyper/icudt44.dll
    hyper/icuin44.dll
    hyper/icuio44.dll
    hyper/icuuc44.dll
    hyper/jemalloc.dll
    hyper/tablibeay32.dll
    hyper/tabssleay32.dll
    hyper/tabsys.dll
    hyper/tabz.dll
    hyper/tbb.dll
    hyper/zstd.dll

  • Directory where a library stored

    The required libraries are stored in $DATASPIDER_HOME/server/lib/tableau_adapter/windows_hyper/bin.

  • Installation procedure

    warningThe library for Output TDE File and that for Output Hyper File cannot be used simultaneously. If you have installed the libraries for Output TDE File, delete the libraries stored under $DATASPIDER_HOME/server/bin directory before installing libraries for Output Hyper File.

    1. Stop DataSpiderServer and DataSpider Studio.

    2. Download Visual C++ Redistributable Packages from Microsoft Download Center.

    3. Add $DATASPIDER_HOME/server/lib/tableau_adapter/windows_hyper/bin to the environment variable "PATH" of OS on which DataSpiderServer is running.
      Example: When $DATASPIDER_HOME is set as C:\Program Files\DataSpiderServista, add C:\Program Files\DataSpiderServista\server\lib\tableau_adapter\windows_hyper\bin to the environment variable "PATH".

    4. Launch DataSpiderServer and DataSpider Studio.

  • Required library

    boost_chrono-vc100-mt-1_55.dll
    boost_date_time-vc100-mt-1_55.dll
    boost_system-vc100-mt-1_55.dll
    boost_thread-vc100-mt-1_55.dll
    DataExtract.dll
    icudt44.dll
    icuin44.dll
    icuuc44.dll
    metrics2.dll
    msvcp100.dll
    msvcr100.dll
    tbb.dll
    tdeserver64.exe

  • Directory where a library stored

    The required libraries are stored in $DATASPIDER_HOME/server/lib/tableau_adapter/windows.

  • Installation procedure

    1. Stop DataSpiderServer and DataSpider Studio.

    2. Copy the required library group under the $DATASPIDER_HOME/server/bin directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.22. Universal Connect/X Adapter

In Universal Connect/X adapter, it is not necessary to install library.

11.23. Report Director Enterprise Adapter

In Report Director Enterprise adapter, it is not necessary to install library.

11.24. List Creator Adapter

11.24.1. List Creator V9.1 Adapter

To output the form using List Creator adapter, settings must be configured in the property file of DataSpiderServer "DataSpiderServer.lax". Configure the settings with the below procedure.

  • Setting procedure

    1. Stop DataSpider Servista and various client applications.

    2. Open $DATASPIDER_HOME/server/bin/DataSpiderServer.lax in text editor.

    3. Add the library path of the following List Creator with the delimiter ";" and without a line feed in the key "lax.class.path".
      lightbulb_onUse "/" for file delimiter.

      <ListCreator installation directory >/classes/fjoajif.jar
<ListCreatorinstallation directory>/classes/fjoaweb.jar
<ListCreatorinstallation directory>/remoteprint/requester/lib/ardus.jar
<ListCreatorinstallation directory>/remoteprint/requester/lib/ardusobj.jar
<ListCreatorinstallation directory>/remoteprint/requester/lib/ArdusRepository.jar
<ListCreatorinstallation directory>/remoteprint/requester/lib/jomcli.jar
<ListCreatorinstallation directory>/remoteprint/requester/lib/jomrequester.jar

    4. Save changes of DataSpiderServer.lax.

    5. Launch DataSpiderServer and DataSpider Studio.

  • Settings during remote connection

    To output the form from the form output server, the following product needs to be installed on OS that DataSpiderServer operates.

    • Interstage List Creator Connector

    Also, environment settings must be done so that the connector link function of the above connector is used in DataSpiderServer operating OS.
    For more details on the environment settings of connector link function, refer to "Environment settings/Edit form" in the Interstage List Creator Manual.

11.25. DataRobot Adapter

In DataRobot adapter, it is not necessary to install library.

11.26. FTP Adapter

In FTP adapter, it is not necessary to install library.

11.27. JMS Adapter

It is necessary to install the class library provided by each JMS provider in $DATASPIDER_HOME/server/plugin/data_processing/modules/jms_adapter.

Location directory of the class library provided by each JMS provider varies depending on each JMS provider.

11.28. Rest Adapter

In REST adapter, it is not necessary to install library.

11.29. Web Adapter

In Web adapter, it is not necessary to install library.

11.30. Web Services Adapter

In Web Services adapter, it is not necessary to install library.

warningWhen using both Web Services adapter and SAP adapter in the same environment, SOAP requests of Web Services adapter are sent through HTTP 1.0.

If SOAP request is sent through HTTP 1.1 in SAP EICS installed environment, perform back up for eics-client.jar which is found under $DATASPIDER_HOME/server/system/common/lib, save it and then, reboot DataSpiderServer.

11.31. Mail adapter

In Mail adapter, it is not necessary to install library.

11.32. Active Directory Adapter

In Active Directory adapter, it is not necessary to install library.

11.33. Amazon Web Services Adapter

11.33.1. Amazon Aurora for MySQL 5.7 Adapter

In Amazon Aurora for MySQL 5.7 adapter, it is not necessary to install library.

11.33.2. Amazon DynamoDB Adapter

In Amazon DynamoDB adapter, it is not necessary to install library.

11.33.3. Amazon EC2 Adapter

In Amazon EC2 adapter, it is not necessary to install library.

11.33.4. Amazon RDS for MySQL 8.0 Adapter

  • Required library

    • mysql-connector-java-8.0.<Version>.jar

  • Supported driver version

    • MySQL Connector/J 8.0.<Version>

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/amazon_rds80_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.33.5. Amazon RDS for MySQL 5.7 Adapter

  • Required library

    • mysql-connector-java-5.1.<Version>-bin.jar

  • Supported driver version

    • MySQL Connector/J 5.1.<Version>

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/amazon_rds57_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.33.6. Amazon RDS for Oracle 19c Adapter

  • Required library

    • ojdbc8.jar

    • orai18n.jar

  • Supported driver version

    • Oracle JDBC Driver 19

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/amazon_rds_oracle19c_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.33.7. Amazon RDS for Oracle 12cR2 Adapter

  • Required library

    • ojdbc8.jar

  • Supported driver version

    • Oracle JDBC Driver 12.2.0

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/amazon_rds_oracle12cr2_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.33.8. Amazon RDS for Oracle 12c Adapter

  • Required library

    • ojdbc7.jar

  • Supported driver version

    • Oracle JDBC Driver 12.1.0

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/amazon_rds_oracle12c_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.33.9. Amazon RDS for PostgreSQL 11 / 10 Adapter

In Amazon RDS for PostgreSQL adapter, it is not necessary to install library.

11.33.10. Amazon RDS for SQL Server 2017 Adapter

  • Required library

    • mssql-jdbc-8.4.<version>.jre8.jar

  • Supported driver version

    • Microsoft JDBC Driver 8.4 for SQL Server

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy mssql-jdbc-8.4.<version>.jre8.jar directly under the directory $DATASPIDER_HOME/server/plugin/data_processing/modules/amazon_rds_sqlserver2017_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.33.11. Amazon RDS for SQL Server 2016 Adapter

  • Required library

    • mssql-jdbc-8.4.<version>.jre8.jar

  • Supported driver version

    • Microsoft JDBC Driver 8.4 for SQL Server

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy mssql-jdbc-8.4.<version>.jre8.jar directly under the directory $DATASPIDER_HOME/server/plugin/data_processing/modules/amazon_rds_sqlserver2016_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.33.12. Amazon RDS for SQL Server 2014 Adapter

  • Required library

    • mssql-jdbc-8.4.<version>.jre8.jar

  • Supported driver version

    • Microsoft JDBC Driver 8.4 for SQL Server

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy mssql-jdbc-8.4.<version>.jre8.jar to $DATASPIDER_HOME/server/plugin/data_processing/modules/amazon_rds_sqlserver2014_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.33.13. Amazon RDS for SQL Server 2012 Adapter

  • Required library

    • mssql-jdbc-6.2.<version>.jre8.jar

  • Supported driver version

    • Microsoft JDBC Driver 6.2 for SQL Server

  • How to get library

  • Installation procedure

    1. Stop DataSpider Servista and various client applications.

    2. Copy mssql-jdbc-6.2.<version>.jre8.jar to $DATASPIDER_HOME/server/plugin/data_processing/modules/amazon_rds_sqlserver2012_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.33.14. Amazon Redshift Adapter

  • Required library

    • RedshiftJDBC42-no-awssdk-1.<version>.jar

  • Supported driver version

    • Amazon Redshift JDBC Driver 1.<version> (JDBC 4.2-compatible driver)

  • To get a library

  • Installation procedure

    1. Stop DataSpiderServer and various client applications.

    2. Copy the required libraries under $DATASPIDER_HOME/server/plugin/data_processing/modules/amazon_redshift802_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.33.15. Amazon S3 Adapter

In Amazon S3 adapter, it is not necessary to install library.

11.33.16. Amazon SimpleDB Adapter

In Amazon SimpleDB adapter, it is not necessary to install library.

11.33.17. Amazon SQS Adapter

In Amazon SQS adapter, it is not necessary to install library.

11.34. G Suite Adapter

11.34.1. Gmail Adapter

In Gmail adapter, it is not necessary to install library.

11.34.2. Google Drive Adapter

In Google drive adapter, it is not necessary to install library.

11.34.3. Google Sheets Adapter

In Google Sheets adapter, it is not necessary to install library.

11.35. Google Cloud Platform Adapter

11.35.1. Google BigQuery Adapter

In Google BigQuery adapter, it is not necessary to install library.

11.35.2. Google Cloud Storage Adapter

In Google Cloud Storage adapter, it is not necessary to install library.

11.36. kintone Adapter

In kintone adapter, it is not necessary to install library.

11.37. Microsoft Azure Adapter

11.37.1. Azure SQL Database Adapter

  • Required library

    • mssql-jdbc-8.4.<version>.jre8.jar

  • Supported driver version

    • Microsoft SQL Server JDBC Driver 8.4

  • How to get library

  • Installation procedure

    1. Stop DataSpiderServer and various client applications.

    2. Copy mssql-jdbc-8.4.<version>.jre8.jar to $DATASPIDER_HOME/server/plugin/data_processing/modules/sqlazure_adapter directory.

    3. Launch DataSpiderServer and DataSpider Studio.

11.37.2. Azure BLOB Storage Adapter

In Azure BLOB Storage adapter, it is not necessary to install library.

11.37.3. Azure Cosmos DB Adapter

In Azure Cosmos DB adapter, it is not necessary to install library.

11.37.4. Azure HDInsight Adapter

In Azure HDInsight adapter, it is not necessary to install library.

11.37.5. Azure Machine Learning Adapter

In Azure Machine Learning adapter, it is not necessary to install library.

11.37.6. Azure Queue Storage Adapter

In Azure Queue Storage adapter, it is not necessary to install library.

11.38. Tegaki Adapter

In Tegaki Adapter, it is not necessary to install library.

11.39. Box Adapter

In Box adapter, it is not necessary to install library.

11.40. Log Manager for Salesforce Adapter

In Log Manager for Salesforce adapter, it is not necessary to install library.

11.41. Salesforce Adapter

11.41.1. Salesforce Adapter

In Salesforce adapter, it is not necessary to install library.

11.41.2. Salesforce Bulk Adapter

In Salesforce Bulk adapter, it is not necessary to install library.

11.41.3. Salesforce Metadata Adapter

In Salesforce Metadata adapter, it is not necessary to install library.

11.42. Hadoop HDFS Adapter

In Hadoop HDFS adapter, it is not necessary to install library.

11.43. HULFT Adapter

11.43.1. HULFT8 / HULFT7 Adapter

In HULFT adapter, it is not necessary to install library.

DataSpider Servista uses a port for RMI communication (RMI port) as well as a port for HTTP communication (HTTP port) configured during installation.

These ports are used for communication between the DataSpiderServer and the DataSpider Studio.

Usually, a RMI port uses multiple ports randomly, but when a firewall or port filtering functions is configured, the RMI port should be static.

about See also: "DataSpider Studio cannot be connected to DataSpiderServer (3)" "My project takes too long to start up in DataSpider Studio (2)"

A RMI port is specified as follows.

  • Config file

    • Server side

      • $DATASPIDER_HOME/server/conf/system.properties

    • Client side

      • $DATASPIDER_HOME/client/conf/system.properties

  • Property key

    • ds.rmi.port

  • Description of the values

    • Specify the TCP port number used by each server/client

  • Setting example

    • ds.rmi.port=7001

lightbulb_onThe firewall and/or the filtering functions corresponding to the specified port number should be configured so that the port can operate in the used environmental conditions.

warningBe sure to specify an unused port number.

13. Launch and Stop of DataSpiderServer

13.1. Launch DataSpiderServer

After installation of DataSpiderServer, you can Launch DataSpiderServer by following procedure.

  1. Confirm Repository DB service is operating. (When Repository DB is enabled).

  2. In UNIX/Linux version, when the environment variable CLASSPATH is set, delete it.

  3. Launch DataSpiderServer.

    • Windows Version

      • In "DataSpider Servista <Version> Select "DataSpiderServer" from "Windows start menu".

      • (If DataSpiderServer is installed as Windows service) Start Windows service.

      • Run $DATASPIDER_HOME/server/bin/DataSpiderServer.exe.

    • UNIX/Linux Version

      • Run $DATASPIDER_HOME/server/bin/DataSpiderServer

    warningIt may take a few minutes to start the DataSpiderServer for the first time because the Server makes the index of the help.

  4. When DataSpiderServer starts successfully, following messages are output to server.log and DataSpiderServer console.

    startconsole

13.2. ReLaunch DataSpiderServer

To reLaunch DataSpiderServer, execute either of following procedures.

  • Common to Windows Version & UNIX/Linux Version

    • Press [Reboot] button in [Others] tab of [DataSpiderServer Settings], Control Panel, DataSpider Studio.

  • Windows Version

    • In command prompt, move to $DATASPIDER_HOME/server/bin and run "shutdown -r".

    • (When registered as Windows service) Restart Windows service.

  • UNIX/Linux Version

    • In console, move to "$ DATASPIDER_HOME / server / bin" and run the command "shutdown -r".

13.3. Stop DataSpiderServer

To stop DataSpiderServer, execute either of following procedures.

  • Windows Version

    • In "DataSpider Servista <Version>" Select "Shutdown" from the start menu.

    • Press [Shutdown] button in [Others] tab of [DataSpiderServer Settings], Control Panel, DataSpider Studio.

    • (When registered as Windows service) Stop Windows service.

  • UNIX/Linux Version

    • Run $DATASPIDER_HOME/server/bin/Shutdown

This chapter explains how to launch and exit DataSpider Studio. For details on launching and exiting DataSpider Studio for Web, refer to "Launch and Exit DataSpider Studio for Web".

14.1. Launch DataSpider Studio

Launch DataSpider Studio by either of the following ways.

  • Select "DataSpider Servista <version>" - "DataSpider Studio" from Windows Start menu.

  • Run $DATASPIDER_HOME/client/bin/DataSpiderStudio.exe directly.

lightbulb_onWhen DataSpider Studio launches first time, it synchronizes modules with DataSpiderServer. After synchronization, you need to restart DataSpider Studio.

warningDepending on network conditions, synchronization of modules may take much time when DataSpider Studio is launched for the first time. Do not restart DataSpider Studio until "100%" is shown in the synchronization progress display dialog.

14.1.1. Login

Login dialog is displayed if succeeded in launching DataSpider Studio.
Enter user name and password, then press [Login] button. If succeeded to log in, desktop screen of DataSpider Studio is displayed.

lightbulb_onLanguage which is used in Studio is selected from [Language].

warningWhen the user with administrator rights tries to log in while users cannot log in because the maximum number of licenses is exceeded, "Exceeds the maximum number of clients connected" dialog displays. Make the user logging in to the clients for development log out, or close the session from the displayed session list, after that, log in again.

14.1.2. Edit Server List

If you want to change connection destination, select [Edit server list] from [Server list] of login dialog and open "Edit server list" screen.

Select connection destination to be edited in server list area, edit setting and press [Apply] button. Return to login dialog with applying edited contents.

In login dialog, select server to be connected from [Server list] and log in. When server that will try to log in is different from server connected when Studio launches, you need to restart DataSpider Studio so that module may synchronize. After pressing [Login] button, exit DataSpider Studio and launch again.

Moreover, multiple connection destinations can be saved. If you add new connection destination, press [Add] button and configure according to displayed screen.

lightbulb_onConnection destination "Last setting" cannot be saved. When "Last setting" is in [Server list] as the name of connection destination, change the name of connection destination so that [Apply] button will be enabled.

14.1.3. When Failed to Connect to Server

If Studio fails to connect to DataSpider Server, "Failed to connect to server" dialog is displayed. Press [OK] and following "Edit connection destination information" screens are displayed.

If host name or IP address is wrong, change the setting and press [Save] button. If you save setting, you need to restart DataSpider Studio.
Exit DataSpider Studio according to screen and launch again.

If you press [Cancel] button, the setting isn’t modified and Studio tries to reconnect to DataSpiderServer.

lightbulb_onIf you switch display to other applications before the dialog is displayed, the dialog might be hidden behind other applications. Minimize all other displayed applications or switch application by Alt + Tab key.

lightbulb_onSettings set on "Edit connection destination information" screen are not added to [Server list]. If the setting set on "Edit connection destination information" screen already exists, display the setting on top of [Server list].

If the setting doesn’t exist in [Server list], it is added to [Server list] by a set name "Last setting" when being started next time. However, because the setting "Last setting" cannot be saved in [Server list], next, when you change Server list, you need to change connection destination name "Last setting".

14.2. Exit DataSpider Studio

After selecting [Exit/logoff Studio] of Studio menu, press [Exit] button or close login dialog by pressing [x] button and press [Exit] button by displayed exit confirmation dialog, you can exit Studio.

This chapter explains how to launch and exit DataSpider Studio for Web. For details on launching and exiting DataSpider Studio, refer to "Launch and Exit DataSpider Studio".

15.1. Execution environment of DataSpider for Web

To use DataSpider Studio for Web, the following execution environments are needed. Before launching DataSpider Studio for Web for the first time, install the following.

  • Microsoft .NET Framework later than 4.7

    • Download .NET Framework 4.7 from Microsoft Download Center.

  • StudioLauncher

    • StudioLauncher can be downloaded from the following URL.
      "http://<the host name of the machine on which DataSpiderServer is running or IP address>:<the port number of DataSpiderServer>/WebStudio/StudioLauncherSetup.exe"

15.2. Launch DataSpider Studio for Web

Launch DataSpider Studio for Web by either of the following ways.

  • Access the website of DataSpider Studio for Web from the browser.

    1. Access the following URL.
      "http://<the host name of the machine on which DataSpiderServer is running or IP address>:<the port number of DataSpiderServer>/WebStudio/"

    2. Press [Start Studio for Web] button.

  • Launch from Windows Start menu

    1. Select "DataSpider Studio for Web" from Windows Start menu.

    2. Press [Start Studio for Web] button.

15.2.1. Login

When launching DataSpider Studio for Web succeeds, displays login dialog.

Enter user name and password, then press [Login] button. When you succeed to log in, then displays start screen of DataSpider Studio for Web.

lightbulb_onLanguage which is used in DataSpider Studio for Web is selected from [Language].

warningWhen the user with administrator rights tries to log in while users cannot log in because the maximum number of licenses is exceeded, "Exceeds the maximum number of clients connected" dialog displays. Make the user logging in to the clients for development log out, or close the session from the displayed session list, after that, log in again.

15.3. Exit DataSpider Studio for Web

Exit DataSpider Studio for Web by either of the following ways.

  1. Press [x] button in DataSpider Studio for Web.

  2. In confirmation dialog, press [OK] button.

16. Start DataSpider Servista Help

You can refer help by a web browser.

Method of starting DataSpider Servista help is as follows.

warning DataSpiderServer must be started first.

  1. Launch DataSpiderServer.

  2. Start the browser Help with one of the following methods.

    • Common to Windows Version & UNIX/Linux Version

      • In Web Browser
        Access to "http://<The host name or the IP address of the OS where DataSpiderServer is running>:<The port number of DataSpiderServer>/dataspider/doc/help/index.html".

    • Windows Version

      • Select "DataSpider Servista <version>" - "Help Document" from Windows Start menu.

17. Service Development

The basic knowledge related to the concept are function, script creating procedures, development and application necessary for developing the services in DataSpider Servista is described in the below document.

  • Concepts, functions, terms and simple scripting procedure.

    • In the page "Basic knowledge of the service" of DataSpider Servista Help.

  • Practical concepts and functions of service development.

    • In the page "Development of Service" of DataSpider Servista Help.

  • Various concepts and tools of service operation.

    • In the page "Service Operations" of DataSpider Servista Help.

And, tutorial has been prepared for the user assumed to develop the services. If you are using DataSpider Servista for the first time, read the below.

  • "DataSpider Servista tutorial guide"

18. Specifications and Limitations at Uninstallation

18.1. General

  • In Windows version, short cut menu might remain in Windows start menu after uninstall. (DSS-2691)

    Delete manually.

  • If you have uninstalled it using the x86 version uninstaller, $DATASPIDER_HOME/server/samples directory is not deleted. (DSS-14899).

  • Uninstall might not be successfully executed, and file might remain. Delete manually. (DSS-14791)

19. Uninstall DataSpider Servista

Use uninstaller when you uninstall DataSpider Servista. For details, refer to "Uninstallation procedure of DataSpider Servista".

When you uninstall DataSpider Studio for Web, you must uninstall DataSpider Servista Studio Launcher. For details, refer to "Uninstallation procedure of DataSpider Servista Studio Launcher".

warningBefore uninstallation, ensure that the various applications of DataSpider Servista have been stopped.

  1. Start uninstaller in following way.

    • In Windows version, start uninstaller by either of the following ways.

      • In "DataSpider Servista <version>" Select "Uninstall" from Windows Start menu.

      • Run $DATASPIDER_HOME/Uninstall/Uninstall.exe.

    • In UNIX/Linux version, start uninstaller by the following way.

      • Run $DATASPIDER_HOME/Uninstall/Uninstall

  2. On "Introduction" screen, press [Uninstall] button for GUI method or press [Enter] button for CUI method.

  3. If some directories could not be deleted, they are displayed on the screen. After completing uninstallation, confirm the directories and files under $DATASPIDER_HOME and delete them manually.
    In Gui method, press [Done] button on "Uninstall Complete" screen to end uninstaller.

lightbulb_onIn the environment Repository DB, if you do not use the Repository DB after uninstalling, also delete the database instance for the Repository DB.

  1. From "Programs and Features" of Windows, select [DataSpider Servista Studio Launcher].

  2. Press [Uninstall].

  3. Uninstall according to the displayed dialog.

  4. Confirm the contents of the following directories and deletes them manually.

    • %LocalAppData%/APPRESSO K.K/DataSpider Servista
      %LocalAppData/% is the environment variable of Windows system.

20. Troubleshooting

20.1. Junk character in installer

  • Phenomenon
    Junk characters are displayed when the installer is started in the Japanese environment of Red Hat Enterprise Linux. (It is displayed as "□")

  • Possible causes
    The installer may not correctly refer to the font file of the OS.

  • Counter-measure
    Start the installer after creating the symbolic link for the font file of the OS.

    • /usr/share/fonts/ja/TrueType/kochi-gothic-subst.ttf

    • /usr/share/fonts/ja/TrueType/kochi-mincho-subst.ttf

  • Creation procedure

    1. Create a symbolic link as /usr/share/fonts/ja/TrueType/kochi-gothic-subst.ttf. Execute the command in console as follows.

      # ln -s /usr/share/fonts/ja/TrueType/kochi-gothic-subst.ttf
      /usr/share/fonts/ja/TrueType/kochi-gothic.ttf

    2. Create a symbolic link as /usr/share/fonts/ja/TrueType/kochi-mincho-subst.ttf. Execute the command in console as follows.

      # ln -s /usr/share/fonts/ja/TrueType/kochi-mincho-subst.ttf
      /usr/share/fonts/ja/TrueType/kochi-mincho.ttf

20.2. Installing or uninstalling DataSpider Servista by using CUI installer fails

  • Event
    When you try to install or uninstall DataSpider Servista by using CUI installer, after selecting the language, displays the following error and the operation fails.

    • "Installer User Interface Mode Not Supported"

  • Possible causes
    The possible cause of this error is existing both of the following packages, by the operation such as installing JDK1.7.0.

    • xorg-x11-fonts-Type1

    • stix-fonts

  • Counter-measure
    Delete one of, or both of the following packages, after that, install or uninstall DataSpider Servista again.

    • xorg-x11-fonts-Type1

    • stix-fonts

20.3. DataSpiderServer cannot be started

20.3.1. The "License file could not be found" error occurs and DataSpiderServer cannot be started

  • Event
    At startup of DataSpiderServer, "com.appresso.ds.common.license.LicenseException: License file cannot be found" error is output in server.log and DataSpiderServer fails to start.

  • Possible causes
    Following causes are possible.

    • The license file is not in $DATASPIDER_HOME/server/lic.

    • The license file in $DATASPIDER_HOME/server/lic is not correct.

    • The name of the file in $DATASPIDER_HOME/server/lic is not "license.lic".

  • Counter-measure
    Place the correct license file in $DATASPIDER_HOME/server/lic and Launch DataSpiderServer.

20.3.2. When restarting DataSpiderServer, "LifecycleException: Protocol handler initialization failed" error occurs and it fails to restart

  • Event
    At reboot of DataSpiderServer, "LifecycleException: Protocol handler initialization failed: java.net.BindException: Address already in use: JVM_Bind:<port number of DataSpiderServer>" error occurs and DataSpiderServer fails to reboot.

  • Possible causes
    DataSpiderServer process may not have stopped correctly.

  • Counter-measure

    • Windows version

      • Run $DATASPIDER_HOME/server/bin/Shutdown.exe first, and then Launch DataSpiderServer.

    • UNIX/Linux version

      • Run $DATASPIDER_HOME/server/bin/Shutdown first, and then Launch DataSpiderServer.

20.4. DataSpider Studio cannot be connected

20.4.1. DataSpider Studio cannot be connected to DataSpiderServer (1)

  • Event
    DataSpider Studio fails to connect to DataSpiderServer that is installed in Red Hat Enterprise Linux.

  • Possible causes
    IP address bound with host name might be loopback address (127.0.0.1). If loopback address is specified, RMI that is used by communication of DataSpiderServer and DataSpider Studio does not work normally.

    If you installed Red Hat Enterprise Linux by default setting, contents of /etc/hosts file is as follows.

    # Do not remove the following line、 or various programs
# that require network functionality will fail.
127.0.0.1               myserver localhost.localdomain localhost

    "myserver" is specified value as host name by installer. By above-mentioned setting, host name is bound with local loopback address.

  • Counter-measure
    To the following, specify pair of IP address that can be communicated from OS that operates DataSpider Studio and host name.

    # Do not remove the following line、 or various programs
# that require network functionality will fail.
127.0.0.1               localhost.localdomain localhost
192.168.0.1        myserver

    In the above example, "myserver" is bounded to the IP address "192.168.0.1".

20.4.2. DataSpider Studio cannot be connected to DataSpiderServer (2)

  • Event
    DataSpider Studio fails to connect to DataSpiderServer.

  • Possible causes
    If multiple network cards are installed in the machine that DataSpiderStudio operates or IP address of the machine is allocated by DHCP, the machine in which DataSpiderServer operates might not refer to DataSpiderStudio properly.

  • Counter-measure
    Specify available IP address of client host machine by "java.rmi.server.hostname" key in system.properties file of DataSpider Studio and reboot Studio.

    If multiple network cards are installed in the machine that DataSpiderServer operates, specify available IP address of server host machine by "java.rmi.server.hostname" key in system.properties file of DataSpiderServer and reboot DataSpiderServer.

    aboutFor details about setting method, etc., refer to "Property Reference" page of DataSpider Servista Help.

  • Phenomenon
    DataSpider Studio fails to connect to DataSpiderServer.

  • Possible causes
    The RMI port used for communications between the server and the client may be restricted by a firewall or the port filtering functions of the OS where DataSpiderServer is running.

  • Counter-measure
    Fix the RMI port in [System property] for the server side system.
    aboutRefer to "About the port used by DataSpider Servista" for details about configurations.

20.5. It takes long time to open My Project

20.5.1. My project takes too long to start up in DataSpider Studio (1)

  • Event
    If multiple network cards are installed in operating system that DataSpiderClient operates, if you start opening My Projects of DataSpider Studio, it takes long time.

  • Possible causes
    If multiple network cards are installed in operating system that DataSpiderClient operates or if IP address of the machine is allocated by DHCP, DataSpiderClient might not be able to connect to DataSpiderServer.

  • Remedies
    Specify available IP address of client host machine by "java.rmi.server.hostname" key in system.properties file of DataSpider Studio and restart Studio.

    If multiple network cards are installed in operating system that DataSpiderClient operates, specify available IP address of server host machine by "java.rmi.server.hostname" key in system.properties file of DataSpiderServer and reLaunch DataSpiderServer.

    aboutRefer to "Property Reference" of DataSpider Servista help for details such as setting method etc.

  • Event
    The following events occur in an environment where a firewall and/or port filtering functions are configured.

    • After startup of Studio, Studio is not operable when opening My Project.

    • No response is returned after debugging in Designer.

  • Possible causes
    The RMI port functions used for communication between the server and the client may be restricted by a firewall and/or port filtering functions of the OS where DataSpiderServer or DataSpider Studio is running.

  • Remedies
    Fix the RMI port in [System property] for the server side and the client side.
    aboutRefer to, "About the port used by DataSpider Servista", for details about configurations.





























DataSpider Servista
4.3 Install Guide  

The 1st edition: April 6 2021
SAISON INFORMATION SYSTEMS CO., LTD.