DataSpiderServer Settings

DataSpiderServer Settings

DataSpiderServer settings is a tool to configure DataSpiderServer settings such as the port number settings, security settings, server migration, and reboot / shutdown DataSpiderServer.

Functions Provided in DataSpiderServer Settings

The following functions are provided In DataSpiderServer settings.
Description of functions
Function name Tab Description Remarks
Display basic information of DataSpiderServer General The basic information of DataSpiderServer is displayed. Displayed when DataSpiderServer Settings is opened.  
Display system properties The system properties of Java are displayed.  
Edit port number Port Edit the port number.
  • The tab name in Studio for Web is [Port and security].
HTTPS communication settings Security Configure HTTPS communication.
  • The tab name in Studio for Web is [Port and security].
Display license information License information The license information is displayed.  
DataSpider log settings Log settings Perform the compression or deletion settings of the log file group that is output under $DATASPIDER_HOME/server/logs/<date directories>.
  • Item only for Studio for Web.
Server migration (Export) Server migration Export the current settings of DataSpiderServer to migrate the settings to another server.  
Server migration (Import) Import exported settings of DataSpiderServer to migrate the settings to the operating server.  
Team development settings Team development Configure team development functions.  
Cleanup tmp directory Others Delete the temporary files under the temporary directory.  
Reboot DataSpiderServer Reboot the DataSpiderServer.  
Shutdown DataSpiderServer Shutdown the DataSpiderServer.  

Display basic information of DataSpiderServer

Description of items
Item name Description Remarks
Host name The host name / IP address of the OS in which DataSpiderServer operates are displayed.
  • When multiple IP addresses are allocated to the OS in which DataSpiderServer operates, the IP address displayed depends on the native API specifications of OS.
VMID The unique identifier of JVM in which DataSpiderServer operates is displayed.
  • A unique identifier is assigned to every JVM process.
Language/Region The language of DataSpiderServer and the region of the OS in which it operates is displayed.
  • It is displayed in language_REGION format. It is displayed as ja_JP when the language is Japanese and the region is Japan.
Number of processors The number of processors recognized by the OS in which DataSpiderServer operates is displayed.  

Display system properties

Property actions
Item name Description Remarks
System properties Open "System property list" screen.  

System property list

Description of items
Item name Description Remarks
Name The system property name of Java.
  • The contents of system properties may vary depending on DataSpider Servista versions and the OS in which DataSpiderServer operates.
  • System property value can be referred from scripts using Mapper logic.
Value The value set to the property key.

Edit port number

Only users with administrator rights can perform.
The settings is enabled after rebooting the DataSpiderServer.
Studio settings will not be changed automatically. It has to be changed manually.
Refer to “Property Reference” for more details.
Description of items
Item name Description Remarks
Port number The port number used when connecting to DataSpiderServer from Studio.
1-65535 can be specified for port number (1024 or upper is recommended).
  • Default value is 7700.
  • When changing the port number, check the following.
    • Port number after change should be other than the well-known ports
    • Port number after change should not be used in the OS in which DataSpiderServer operates

HTTPS communication settings

Only users with administrator rights can perform.
Public and private keys to encrypt/decrypt communication data and a server certification are stored in the keystore referred by DataSpiderServer.
For more details on how to generate the server certification and key, refer to “HTTPS settings”.
The settings is enabled after rebooting the DataSpiderServer.
Description of items
Item name Description Remarks
Enable HTTPS Enable HTTPS communication.
  • [Checked]:
    HTTP communication between DataSpiderServer and components is performed through HTTPS.
  • [Not checked]: (default)
    HTTP communication between DataSpiderServer and components is performed through HTTP.
Port number The port number used when connecting to DataSpiderServer from Studio through HTTPS communication.
1-65535 can be specified for port number (1024 or upper is recommended).
  • Default value is 8443.
  • When changing the port number, check the following.
    • Port number after change should be other than the well-known ports
    • Port number after change should not be used in [Port number] of [Port] tab
    • Port number after change should not be used in the OS in which DataSpiderServer operates
  • DataSpiderServer cannot be started when invalid value (negative value or value greater than 65535) is set.
Password The password of the keystore where the key and the certificate used for HTTPS encryption are saved.
  • Default value is “changeit”.

Error when keystore password is invalid

When the entered keystore password is invalid, the following message is displayed.
Description of error messages
Message Cause
keystore was tampered with, or password is incorrect. Password is either tampered with or incorrect.
$DATASPIDER_HOME/server/system/common/classes/.keystore (the specified file is not found.) $DATASPIDER_HOME/server/system/common/classes/.keystore does not exist.
Invalid keystore format. The keystore type is not “JKS”. Only “JKS” keystore type can be handled by DataSpiderServer.

Display license information

List of server/optional components

Description of items
Item name Description Remarks
Package type Package type. One of the following is displayed.
  • “Advanced Server”
  • “Basic Server”
  • “Select”
  
Server component Component The server component name.
“DataSpiderServer” is displayed. 		 
Version The version number of server component.  
Type The license type.
“Product” is displayed. 		 
Option component Component The name of optional component.  
Version The version number of optional component.  
Type The license type.
“Product” is displayed. 		 

License details

Description of items
Item name Description Remarks
Component The component name.  
Version The version number of the component.  
Type The license type of the component.
“Product” is displayed. 		 
License publisher Organization The organization name of license publisher.  
Department The department name of license publisher.  
Name The name of license publisher.  
License owner Organization The organization name of license owner.  
Department The department name of license owner.  
Name The name of license owner.  
Limitation Valid since The date when the license started to be valid.
  • It is specific to server component.
Valid until The date when the license will be invalidated.
  • It is specific to server component.
Number of clients for development The maximum number of clients for development that can be connected to the server simultaneously.
  • It is specific to server component / Studio for Web.
Number of CPUs The number of CPUs that the server can use.
  • It is specific to server component.
Operation Function limitation details of optional components.
  • [READ]: Only read permission is granted.
  • [WRITE]: Only write permission is granted.
  • [READ/WRITE]: Both read and write permissions are granted.
  • [No limitations]: Component without functional limits.
  • It is specific to optional component.

Server migration (Export)

Output the DataSpiderServer settings into “Client OS Local File System” as a ZIP file.
This ZIP file contains the file in which the following information are described. Do not edit the exported file.

Only users with administrator rights can perform.
Before performing server migration, check that no script is running and no other user is using DataSpiderServer.
Server migration can be performed only among DataSpiderServers for which all the version / service pack / unit patch application are same.
The settings not existing in the export items will not be exported. If necessary, configure them manually in the import destination DataSpiderServer.
Property actions
Item name Description Remarks
Export settings Start to export the settings.  

Select items to export

In "Select items to export" screen, select categories in the left pane and select individual items in the right pane.
Description of items
Item Description Remarks
Select all Check all the items.  
Clear all Clear all the check boxes.  
User accounts/Groups Export groups.  
User accounts/Users Export users.  
Services Export services.  
Global resources Export global resources.  
Environment variables Export environment variables.  
Triggers Export triggers.  
Calendars Export calendars.  
Project files Export project files.
Application log output settings Export application log output settings.  
Mount settings Export mount settings.  
Global schemas Export global schemas.  
Global custom logics Export global custom logics.
  • All groups are exported.

Export option settings

Description of items
Item Description Remarks
Export triggers in following state When checked, state of the triggers to be exported can be specified.
When not checked, the triggers will be exported in the same state as the export source.
  • Displayed when a trigger is selected in "Select items to export" page.
  • Default is “Not checked”.
Enabled Export triggers in enabled state.
  • Enabled when [Export triggers in following state] is checked.
Disabled Export triggers in disabled state.
  • Enabled when [Export triggers in following state] is checked.
Export project files in following state
  • [All versions]: (default)
    Export all versions of project files.
  • [Only latest version]:
    Export only the latest version of project files.
  • Displayed when a project file is selected in "Select items to export" page.

Select export destination

Description of items
Item Description Remarks
Export destination Specify the directory path of export destination.
  • In Studio for Web, you need to specify a file name.

When exporting is finished, the results are displayed. When an error occurs, also the error information is output.
When “a global resource in invalid state” exists in DataSpider File System, exporting global resources fails.

Notes for exporting

Server migration (Import)

Import DataSpiderServer settings which have been exported.
Only users with administrator rights can perform.
To import the following settings, you need to reboot DataSpiderServer.Reboot DataSpiderServer after importing, if requested.
If you have operated the DataSpiderServer in cluster configuration and shared the settings or the data to be imported, you need to restart in passive node after import. For more details on cluster configuration, refer to "DataSpider Servista Cluster Configuration Guide" of PDF document.

Before executing the server migration, check the following:
Property actions
Item name Description Remarks
Import Start to import the settings.  
Description of items
Item Description Remarks
File to be imported (ZIP format) Enter a ZIP file to be imported as the file path in the client OS local file system.

You can click [Browse] button to launch file chooser and find the file.
Differential import of projects Perform differential import of project.
  • [Checked]:(default)
    The import operation is “Differential import”.
  • [Not checked]:
    The import operation is “Overwrite”.
Differential update of environment variables Perform differential update of environment variables.
  • [Checked]:(default)
    The import operation is “Differential update”.
  • [Not checked]:
    The import operation is “Overwrite”.
Import triggers in following state Specify trigger state to be imported.
  • [Enable]:
    Select the trigger state from [Enable] or [Disable].
  • [Not Checked]: (default)
    Trigger state cannot be selected.
    Import the trigger in the same state as the trigger in the ZIP file.
 In the case of [Checked], select the state from [Enable] or [Disable].
  • [Enable]: (default)
    Import all the triggers in enabled state regardless of the trigger state in the ZIP file.
  • [Disable]:
    Import all the triggers in disabled state regardless of the trigger state in the ZIP file.

When importing is finished, the results are displayed. When an error occurs, also the error information is output.

Import operation

There are three types of import operations as follows:

The following table shows the setting names and the applicable import operations for these settings.

Setting name Import operation
Differential update Overwrite Differential import
Group Yes - -
User Yes - -
Services Yes - -
Global resources Yes - -
Environment variables Yes Yes -
Triggers Yes - -
Calendars Yes - -
Project files - Yes Yes
Application log output settings Yes - -
Mount settings Yes - -
Global schemas Yes - -
Global custom logics(*) Yes - -
* When there is a global custom logic with the same name and the different entity in the import destination,
 the global custom logic to be imported will be renamed.
 The global custom logic will be imported with adding an underscore and a number at the end of the name.

The example of an import operation

The following explains the differences of import operations by using example:
State before importing
Settings in the import destination A B -
(no target item)
The contents of
the imported file
 A’
(modified from the setting
in the import destination)		 -
(no target item)		 C
State after importing
In the case of
“Differential update”		 A' B C
In the case of
“Overwrite”		 A' -
(*1)		 C
In the case of
“Differential import”		 A
(*2)		 B C
*1 Deletes the settings in the import destination.
*2 Retains the project registered in the import destination.

Notes on import

Team development settings

Only users with administrator rights can perform.
To reflect the configuration, re-login is required.
Description of items
Item name Description Remarks
Enable team development Enable team development functions.
  • [Checked]:
    Enable team development functions.
  • [Not checked]: (default)
    Do not enable team development functions.

Cleanup tmp directory

Only users with administrator rights can perform.
Before cleaning up temporary directory, make sure that no service is running and no other user is operating a client.
Property actions
Item name Description Remarks
Delete tmp directory Delete the temporary files under the temporary directory ($DATASPIDER_HOME/server/tmp directory).  

Reboot DataSpiderServer

Only users with administrator rights can perform.
While rebooting DataSpiderServer, you cannot operate your client.
Property actions
Item name Description Remarks
Reboot Send a reboot request to DataSpiderServer.
  • After rebooting, execute [Reconnect to server] of Studio menu and reconnect to the DataSpiderServer.
  • Re-login after rebooting DataSpiderServer.

Shutdown DataSpiderServer

Only users with administrator rights can perform.
Property actions
Item name Description Remarks
Shutdown Send a shutdown request to DataSpiderServer.
  • Close the client after a shutdown request.

Specification Limits