DataSpiderServer Settings

Refer to here for more information about Web Console edition.

DataSpiderServer Settings

DataSpiderServer Settings is a tool to configure DataSpider settings such as port number settings, security settings, restarting and stopping DataSpiderServer, and so on.

Functions provided by DataSpiderServer Settings

DataSpiderServer Settings Settings provides following functions.

Description of Functions

Name of functions	Tab	Description	Remarks
Display basic information of DataSpiderServer	General	Displays basic information of DataSpiderServer. Displayed when DataSpiderServer Settings starts.
Display system properties	General	Displays system properties of Java.
Edit port number	Port	Edits port number.	This tab is displayed as [Port and Security] on Studio for Web.
HTTPS communication settings	Security	Changes HTTPS Communication settings.	This tab is displayed as [Port and Security] on Studio for Web.
Display license information	License information	Displays license information.
DataSpider log settings	Logging Configurator	Configures the behavior for rotating the logs files placed under the $DATASPIDER_HOME/server/logs/<date directories>	For Studio for Web only
Server migration (Export)	Server migration	Exports DataSpiderServer settings to migrate the current settings to other server.
Server migration (Import)	Server migration	Imports the DataSpider settings exported to the server to migrate.
Team development settings	Team development	Configures team development settings.
Cleanup temporary directory	Other	Deletes all the temporary file under the temporary directory.
Reboot DataSpiderServer		Reboots DataSpiderServer
Shutdowns DataSpiderServer		Shutdowns DataSpiderServer

Display basic information of DataSpiderServer

Description of items

Item name	Description	Remarks
Hostname	OS host name / IP address which DataSpiderServer is running is displayed.	If there are multiple IP addresses assigned to OS which DataSpiderServer is running, the IP address displayed will be saved to native API specification of OS.
VMID	The Unique identifier of JVM which DataSpiderServer is running is displayed.	The unique identifier is allocated to each JVM.
Region/Lang	The language of DataSpiderServer and the region of OS DataSpiderServer running on are displayed.
CPUs	The number of processors identified by OS which DataSpiderServer is running is displayed.

Display system properties

Property Action

Item name	Description	Remarks
System properties	Open "System properties list" screen.

System properties list

Description of items

Item name	Description	Remarks
Property name	A system property name in Java.	According to DataSpider Servista versions or DataSpiderServer operating OS, the contents of system properties may vary. These property values can also be viewed from script by using Mapper logic.
Value	A value specified in the system property.

Edit port number

This is administrative function and can only be performed by administrators.

DataSpiderServer takes effect after restarting.

Studio settings are not changed automatically. It must be changed manually.

For more information on how to set up, refer to "Property Reference".

Description of items

Item name	Description	Remarks
Port number	Set port number that DataSpiderServer needs for establish connection with Studio. You can specify number from 1 to 65535, but number of 1024 or more is recommended.	The default value is "7700". When you change a port number, check as follows. The well-known ports cannot be specified. Ports used by the OS on which DataSpiderServer runs cannot be specified.

This is administrative function and can only be performed by administrators.
In order to activate HTTPS communication, public key and private key to encrypt/decrypt communication data and server certificate must be restored in key which DataSpiderServer reference to.

About how to generate keys and certificates, refer to "HTTPS Settings".

Valid after DataSpiderServer is restarted.

Description of items

Item name	Description	Remarks
Enable HTTPS	Enable HTTPS communication. [Checked]: Change HTTP Communication between DataSpiderServer and component to HTTPS communication. [Not Checked]: (default) HTTP communication between DataSpiderServer and component is communicated by HTTP.	Components which communicate between DataSpiderServer and HTTP communication are as below. CLI Console WebConsole Studio for Web Studio HTTP trigger Web services trigger SAP BC trigger ScriptRunner ScriptRunnerProxy
Port number	Set port number that DataSpiderServer needs for establish HTTPS connection with Studio. You can specify number from 1 to 65535, but number of 1024 or more is recommended.	The default value is "8443". When you change a port number, check as follows. The well-known ports cannot be specified. The port number specified in [Port number] in [Port] tab cannot be specified. Ports used by the OS on which DataSpiderServer runs cannot be specified. If an invalid number for a port number such as a negative number or "65535" or more is specified, DataSpiderServer is not able to start.
Password of keystore	Password of the keystore in which a key and a certificate to use HTTPS are stored.	The default value is "changeit".

Error when password of keystore is invalid

In case of the wrong password, the following message is displayed.

Description of the error message

Message	Cause
keystore was tampered with, or password is incorrect.	Password is tampered or incorrect.
$DATASPIDER_HOME/server/system/common/classes/.keystore (specified file not found.)	$DATASPIDER_HOME/server/system/common/classes/.keystore dose not exist
Invalid keystore format.	Keystore is not"JKS". DataSpiderServer handle keystore of "JKS" only.

Display license information

List of Server components / Optional components

Description of items

Item name		Description
Package type		The type of package. One of the following will be displayed. "Advanced Server" "Basic Server" "Select"
Server component	Component	The name of server component, "DataSpiderServer" will appear.
	Version	The version number of server component.
	Type	The type of license. "Product" will appear.
Optional component	Component	The name of optional component.
	Version	The version number of optional component.
	Type	The type of license. "Product" will appear.

Detail of license

Description of items

Item name		Description	Remarks
Component		The name of the component.
Version		The version number of the component.
Type		The license type of the component. "Product" will appear.
License publisher	Organization	The organization name of the license publisher.
	Department	The department name of the license publisher.
	Name	The name of the license publisher.
License owner	Organization	The organization name of the license owner.
	Department	The department name of the license owner.
	Name	The name of the license owner.
Limitation	From	The license is effective from this date.	For server component only.
	To	The license is effective until this date.	For server component only.
	Number of development clients	The number of the maximum client for development to connect to the server simultaneously.	For server component / Studio for Web only.
	Number of CPU	The number of CPUs permitted to use.	For server component only.
	Resource count	The number of global resources permitted to define.	For optional component only.
Operation		Restrictions of optional components. [READ]:Provides read functions. [WRITE]:Provides write functions. [READ/WRITE]:Provides both read and write functions. [No Limitations]:Provides all functions.	For optional component only.

Server migration (Export)

DataSpiderServer settings ZIP file format as a "client OS local filesystem" to output.

This is administrative function and can only be performed by administrators.

Before performing the migration server, make sure that scripts are not running, other users are not using DataSpiderServer.

Server migration can be used only among DataSpiderServer which have all the following: same version, service pack, and applicable simple patch.

Besides the settings existing in the export items, are all other settings not covered in export. Please set in DataSpiderServer in the import source as necessary.

Property Action

Item name	Description	Remarks
Export	Starts the export of settings.

Select item to export

You can select each item in the right pane when you can select a category in the left pane on "Select item to export" dialog.

Description of items

Item name	Description	Remarks
Select All	Check all items.
Deselect All	Uncheck all items.
User Accounts / Groups	Export groups.
User Accounts / Users	Export users.
Deployed Projects	Export services.
Global Resources	Export global resources.
Environment Variables	Export environment variables.
Triggers	Export triggers.
Calendars	Export calendars.
Project Files	Export project files.	Projects Local save is performed will not be exported.
Application Log Settings	Export application log settings.
Mount Settings	Export mount settings.
Global Schema	Export global schema.

Option settings for export

Description of items

Item name	Description	Remarks
Export triggers as following state	If checked, you can specify a status of triggers to export. If not checked, you can export triggers without modification of their status.	Appears if triggers is selected in "Select item to export" screen. Defaults to "Not Checked".
Enabled	Export triggers as enabled state.	Enable when [Export triggers as following state] is checked.
Disabled	Export triggers as disabled state.	Enable when [Export triggers as following state] is checked.
Export projects with	[All versions]:(Default) Export all the versions of project files. [Only latest version]: Export only the latest version of the project file.	Appears if project files is selected in "Select item to export" screen.

Select Export Destination

Item Description

Item	Description	Remarks
Export Destination	Specifies directory path of export destination.	It is necessary to specify export file name in Studio for Web.

When exporting is finished, export results will be displayed. If an error occurs, the error information is also output.

DataSpider file system of global resources in an illegal state if present, the export fails to export and global resources.

Notes when Exporting

When the repository database is enabled, if you export projects whose name is case sensitive, the project whose name is in lowercase is only exported.

Server migration (Import)

Imports the exported DataSpider settings.

This is administrative function and can only be performed by administrators.

After importing, must restart DataSpiderServer.

Property Action

Item name	Description	Remarks
Import	Start the import of settings.

Description of items

Item name	Description	Remarks
Import file(ZIP form)	Specify a file path of a zip file to import. The file path needs to be on the client local filesystem. Click [Browse] button to activate the file Selectr and Select the file.	Refer to "OS Local Filesystem" for more information about client OS local filesystem.
Differential import of projects	Do differential import of projects.	Defaults to "Not Checked".
Import triggers as following state	Specify a status of triggers to import. [Enabled]:(Default) Imports triggers with enabled status regardless of their status in the exported zip file. [Disabled]: Imports triggers with disabled status regardless of their status in the exported zip file.	Defaults to "Not Checked".

Once the import finished, imported results will be displayed. If an error occurs, the error information is also output.

Import operation

There are 2 types of import operation in setting. They are: registration "overwrite" newly after deleting the content set in import destination and "update delta" the content which is not set after update the content which is set in import destination.
Operations of Setting are as follows.

Set name	Import operation	Remarks
Groups	Incremental updates
Users	Incremental updates
Services	Incremental updates
Global Resources	Incremental updates
Environment Variables	Overwrite
Triggers	Incremental updates
Calendars	Incremental updates
Project Files	Overwrite Differential import	If [Differential import of projects] is checked, then import the difference only.
Application Log Output Settings	Incremental updates
Mount Settings	Incremental updates
Global Schemas	Incremental updates

The Difference of "Incremental updates", "Overwrite" "Differential import of projects" when importing the setting is as follows.

Incremental updates
	Existing configuration	Imported Content	Imported Results
	A B -	A' - C'	A'(overwrite) B(same) C'(add)
Overwrite
	Existing configuration	Imported Content	Imported Results
	A B -	A' - C'	A'(overwrite) -(delete) C'(add)
Differential import of projects
	Existing configuration	Imported Content	Imported Results
	A B -	A' - C'	A(same) B(same) C'(add)

Notes of Import

If there is no user mapping to import destination, the project file is not imported.
Please export the corresponding user and group or create the corresponding user to DataSpiderServer of import destination in advance.
In server migration, user permission information of the following are migrated as well: Service, Global resource, Trigger, Application log output setting, Mount setting and Global schema.
If there is no corresponding user to DataSpiderServer of import destination, the user to perform importing will be owner of these setting.
When you run the script or the viewing setting is required to exist in import destination. (if trigger then service or global resource holidays setting; if script then global resource or environmental variables).Please import before performing script or trigger.
In you import by overwriting project, project not included in imported file will be deleted from my project list and project file under /home/<username>/projects / project files will remain.
Before importing, please delete the project which is not included in imported file from my project.
To execute [Differential import of projects], the "projects" directory under the user home directory (/home/<user name>) needs to exist.
To create the "projects" directory, log in and create a project.

Team development settings

This is administrative function and can only be performed by administrators.

To reflect the configuration, re-login is required.

Description of items

Item name	Description	Remarks
Enable team development	Enable team development function. [Checked]: Team development features are available. [Not Checked]: (default) Team development features are not available.	Related functions are as follows . My Projects Designer

Delete temporary directory

This is administrative function and can only be performed by administrators.

Before executing deleting temporary directory, make sure that any services are not running and other users are not operating the client.

Property Action

Item name	Description	Remarks
Cleanup temporary directory	Delete temporary files from the temporary directory($DATASPIDER_HOME/server/tmp).

Reboot DataSpiderServer

This is administrative function and can only be performed by administrators.

While restarting DataSpiderServer, you cannot operate the client.

Property Action

Item name	Description	Remarks
Reboot	Send a request to reboot DataSpiderServer	After restarting DataSpiderServer, execute [Reconnect to server] from Studio menu, then reconnect DataSpiderServer. After restarting DataSpiderServer, log in to the client again.

Shutdown DataSpiderServer

This is administrative function and can only be performed by administrators.

Property Action

Item name	Description	Remarks
Shutdown	Send the request to shutdown (stop) DataSpiderServer.	After sending the request to shutdown, logout from all client.

Specification Limits

In migration server between Windows-UNIX (Linux), if 2 bytes character is included in setting name then after migrating, character corruption will occur.
Because encode of file name follows OS, please note the encode when migrating server between platform in which file name encode is different to each other.