ADMINISTER A DEFINIENS SYSTEM
Many functions for managing a Definiens system are available via a web browser, using the Definiens Administration Console to maintain software, hardware, users, and storage. You can also monitor processing activities.
Log into the Definiens Administration Console
You will need to log on to the Definiens Administration Console as an administrator to manage a Definiens system.
- To open the Definiens Administration Console, go to the Windows Start menu and navigate to Start > All Programs > Definiens Grid > Admin Console. Your web browser displays the log in page of the Definiens Administration Console. Alternatively, you may start a web browser and point it to the address http://localhost:4002/.
- Log-in:
- When setting up a new Definiens system and logging in for the first time, enter the default password admin. We recommend that you change the default password later on.
- In other cases, log in using the username set up by the Definiens system administrator.
- The Manage Hardware page displays (this may take a few seconds to load)
Manage Definiens eCognition® Life Server Hardware
Use the Definiens Administration Console for installation and management of processing nodes of the Definiens eCognition® Life Server.
- Log into the Definiens Administration Console.
- Choose Hardware > Nodes. The Manage Hardware page displays a list of existing processing nodes.
Figure 33: Manage Hardware page.
- You may wish to proceed to one of the following sections:
- Manage Processing Nodes on page 45
- Manage Installation Scripts on page 51
Manage Processing Node
Select Hardware > Nodes to display a list of existing processing nodes. By default, the primary node hosts a configured processing unit that is listed as a node. Processing nodes can display a number of states:
- New: A new processing node before the installation of Grid Node software.
- Starting Services: The Administration Console starts the installed services. That means the processing node prepares its processing ability and gets activated. This status will change to online. If activation is not possible the status will switch to unavailable after 60 seconds.
- Service Stopped: The Administration Console stops the running services. That means the processing node terminates its processing ability.
- Online: The processing node is active. That means the processing node is connected and ready to process jobs. The installed services cannot be stopped until currently processing jobs are completed.
- Offline: The processing node is inactive. That means the processing node is disconnected and thus not ready to process jobs. However, services are still running.
- Unavailable: The processing node is not available. You may check the network connection and the activity of the Configuration Service. If this does not help, check the installation log.
- Already in Use: The processing node is not available because the installed services are blocked, for example by another Definiens eCognition® Grid.
Add New Processing Node
To enable distributed image analysis processing, define and add new processing nodes to the Definiens eCognition® Life Server. By default, the primary node already hosts a configured processing unit that is listed as a node called localhost. After a minimal setup of a Definiens system, it can be used for a minimal processing environment without adding new processing nodes.
If you want to extend your processing capacities you can configure additional processing nodes, which compute the distributed high-throughput image analysis. That way you prepare your Definiens system for distributed processing on multiple machines within a Definiens eCognition® Grid. Distributed processing requires the availability of adequate licenses.
- To add a new processing node, choose Hardware > Nodes > Add New Node. The Create New Grid Node dialog displays.
- Define the properties:
- Name: Enter the machine name or IP address of the computer you want to define as processing node.
- IP Address: Enter the IP address of the computer you indicated in the Name field according to the following pattern′ ’: 127.0.0.1. If the Name field already contains the IP address, you can leave this field empty.
- Install: Select an installation script. By default an installer for your operating system is available.
- Drive: Enter the letter of the drive where the Definiens eCognition® Node Software is going to be installed, for example C.
- Path: Enter the installation path where the Definiens eCognition® Node Software is going to be installed, for example Program Files\Definiens Grid. Non-existing folders are created.
- Number of Engines: You can enter a number of instances of Analysis Engine Software, if you want to run more than one instance on this processing node. Typically, you run one instance per processor/core.
- Temp Path: You can enter a path used for Definiens cache files. During image analysis, the temp folder is used to store working files that may consume large amounts of disk space.
- Click the Create Grid Node button. The new processing node is listed on the Manage Hardware page.
Edit Properties of a Processing Node
Display and edit the properties of a processing node.
- To display, choose Hardware > Nodes. The Manage Hardware page displays a list of processing nodes.
- Click the Edit button of a processing node. The Properties of Node dialog displays.
Figure 34: Properties dialog of the Manage Hardware page.
- You can edit the same properties as when adding processing nodes.
Alternatively, these and other properties can be modified using the Configuration dialog. To access, click Config. However, we recommend using the Properties of Node dialog for changing the above properties.
- Click the Save Changes button to return to the Manage Hardware page.
Install Grid Node Software to New Processing Nodes
Install the Grid Node Software to new processing nodes – only the Control Service and the Configuration Service are installed. The complete Definiens eCognition® Node Software still requires the Analysis Engine Software.
By minimal installation, this Analysis Engine Software is available in one version on the Deployment Server. However, it can be provided in different versions. The Deployment Server automatically deploys and installs it in the correct version to the processing nodes. This happens in the moment the Analysis Engine Software in a specific version is requested for the first time by the Configuration Service of a processing node (which must be defined before installation).
- To install Grid Node Software to new processing nodes choose Hardware > Nodes > Install Nodes. The Install Grid Node Software to New Nodes dialog displays a list of uninstalled processing nodes.
Figure 35: Install Grid Node Software to New Nodes dialog of the Manage Hardware page.
- Select the checkboxes of processing nodes you want to install.
- Enter the login information for the installation user and service user:
- The installation user is the user who provides the software installation rights for the processing node
- The service user is the user who provides the service rights for the processing node.
- Click the Run Installation button. The changes may take some time. After installation of all selected nodes, you will be redirected to the Manage Hardware page. All changes are displayed in its Status column (the status should be Online). That means the processing node is connected and ready to process jobs. If not, check the installation log. You may want to modify the properties or the configuration. Afterwards you can start the installed services manually.
Display Installation Log
In case of installation problems, display the installation log.
- To display the installation log choose Hardware > Nodes. The Manage Hardware page displays a list of processing nodes.
- Select a processing node by clicking on its name. The Installation Log For dialog displays all available installation logs.
- To delete the installation log choose the Clear button. After confirmation the available installation logs are deleted.
Review and Edit Configuration of a Node
Display and edit the configuration of the primary or a processing node. You can edit a configuration if you want to change settings like the number of instances of Analysis Engine software or to the path of the temp folder.
- To display a configuration, choose Hardware > Nodes. The Manage Hardware page displays a list of nodes.
- Do one of the following:
- Click the Edit button of a node. The Properties of Node dialog displays.
- Select a node by clicking on its name. The Installation Log For dialog opens.
- Choose Config to open the Configuration of Grid Node dialog.
Figure 36: Configuration of Grid Node dialog of the Manage Hardware page.
- If needed, edit the configuration parameters in the form.
- Click the Apply Changes button. The configuration is saved as eCognition.cfg file in the installation of each node.
- Stop and restart the Control Service of the related nodes to make sure the changes are updated.
Restarting the Control Service on the Primary Node
Restarting the Control Service on the primary node of the Definiens eCognition® Grid terminates all jobs currently processed by this Definiens eCognition® Grid. This includes currently processing jobs and those that are pending in the job queue.
The Control Service on the primary node is responsible for starting all other components of the Definiens eCognition® Grid architecture. That means that all components on the primary node will be stopped and restarted. Consequently all jobs will be lost and will need to be resubmitted. Therefore, we strongly recommend that you schedule the restart of the Control Service at a time when no jobs are processed.
Stop the Control Service
Stopping the services on a processing node will terminate its activity.
When the configuration of a node is changed, the Control Service must be restarted to enable this change. In addition, you must to stop the Control Service before uninstalling a processing node. Any jobs that are currently being processed must be deactivated before the services of a processing node are terminated. To stop a service:
- Go to Hardware > Nodes > Stop Service. The Stop Control Service for Grid Nodes dialog displays a list of processing nodes with active services. Any nodes that you wish to stop must be deactivated beforehand
- Select the checkboxes of processing nodes whose services you want to stop
- Click the Stop Service button. The changes are displayed in the status column of the Manage Hardware page. The status should be “service stopped”.
Start the Control Service
Start the Control Service in one of the following situations:
- If the state of a processing node is “unavailable”.
After the installation of Grid Node software, the status of all processing nodes should be online by default. That means the services should be started and the processing node should be connected and ready to process jobs. If the status is unavailable, you can change the configuration and try to restart the services.
- After changing the configuration of a node you must stop and restart the Control Service of the related nodes.
- To start the services, go to Hardware > Nodes > Start Service. The Start Control Service for Grid Nodes dialog displays a list of processing nodes whose services are not active. Nodes must be stopped before they are restarted
- Select the checkboxes of processing nodes you want to start the services.
- Click the Start Service button. The changes are displayed in the Status column of the Manage Hardware page. The status should change to “starting services” then “online”. That means the processing node is connected and ready to process jobs. If activation is not possible, the state will switch to “unavailable” after 60 seconds.
Deactivate Processing Nodes
Deactivate a processing node to disconnect it. This is required before you stop the services of a processing node to ensure completion of a currently processing job.
- To deactivate a processing node, choose Hardware > Nodes > Deactivate. The Deactivate Grid Nodes dialog displays a list of active processing nodes.
- Select the checkboxes of processing nodes you want to deactivate.
- Click the Deactivate button. The changes are displayed in the status column of the Manage Hardware page. The status should be “offline” – the processing node is disconnected and not ready to process jobs. However, services are still running.
Activate Processing Nodes
After installation of Grid Node software, the status of the processing node should be online. That means the services should be started and the processing node should be connected and ready to process jobs. If the status is not online, you can change the configuration and try to reactivate the processing node:
(Restarting the control service of a processing node will also activate it; a separate activation, as described below, is unnecessary.)
- To activate a processing node, choose Hardware > Nodes > Activate. The Activate Grid Nodes dialog displays a list of inactive processing nodes with running services.
- Select the checkboxes of the processing nodes you want to activate.
- Click the Activate button. The changes are displayed in the status column of the Manage Hardware page. The status should be online, meaning that the processing node is connected and ready to process jobs.
Uninstall Definiens eCognition® Node Software from Processing Node
To uninstall software from a processing node, the processing node must first be deactivated, then the service stopped. Then perform the following steps:
- To uninstall, choose Hardware > Uninstall Nodes. The Manage Hardware page displays the list of processing nodes.
- Click the Delete button of a processing node.
- Reconfirming will update the Manage Hardware page. The affected processing nodes display the status “new”.
Delete Processing Node
To delete unwanted processing nodes from a Definiens eCognition® Grid:
- Go to Hardware > Nodes. The Manage Hardware page displays a list of processing nodes.
- Click the Delete button of a processing node.
- Reconfirm and the list on the Manage Hardware page is updated.
Note
It is not possible to delete the localhost processing node, as it is part of the default minimal processing environment.
Manage Installation Scripts
Installation scripts are used as installers of processing nodes within a Definiens eCognition® Grid. Select Hardware > Installers to display a list of existing installers on the Manage Installation Scripts page.
Figure 37: Manage Installation Scripts page.
By default, an installer for the current standard operating system is listed.
Add a New Installer
To create a new installer, load an installation script from file:
- To create a new installer, choose Hardware > Installers > Add New Installer. The Create New Installer dialog displays.
- Click the Browse button and select a script file.
- Enter a name to overwrite auto naming.
- Click the Create Installer button. The new installer is listed on the Manage Installations Scripts page.
Edit Installation Script
To modify an installer by editing the installation script or loading a script file:
- To modify an installer, choose Hardware > Installers. The Manage Installation Scripts page displays a list of available installers.
- Select an installer by clicking on its name. The Properties Of dialog displays.
- You can edit the name and script or load a script file.
- Alternatively, click Download to save the installation script (the script can then be edited using a text editor.
- Click the Apply Changes button. The time of change is displayed in the Updated At column on the Manage Installation Scripts page.
Delete Installation Script
To delete an unwanted installer:
- Go to Hardware > Installers to list available installers
- Click the Delete button of the installer.
- Reconfirm and the list on the Manage Installation Scripts page is updated.
Prepare Different Software Packages for Deployment
Use the Definiens Administration Console to manage Analysis Engine software, which is contained in software packages. Software packages are managed by the Deployment Server to prepare them for deployment to the processing nodes of the Definiens eCognition® Grid.
A software package contains a version of the Analysis Engine Software. A version can be either a version released by Definiens or a version customized using the Software Development Kit (SDK).
By default, the primary node hosts a preconfigured processing unit that is included in the automatic deployment of software packages. In some cases you may want to use other software packages, for example:
- A Definiens Developer XD software package to support analysis of multidimensional image data
- Older versions of software packages are required for processing old rule sets
- Bug fixes of the Analysis Engine software
- Customized software packages
To enable the automatic distribution of the contained Analysis Engine software to processing nodes of the Definiens eCognition® Grid, you need to load and install them on the Deployment Server.
- Log-in to the Definiens Administration Console.
- Choose Software > Packages > List Packages. The Manage Software page displays a list of existing software packages.
Figure 38: Manage Software page.
Load and Install Software Packages on the Deployment Server
Load and install software packages on the Deployment Server to enable the automatic distribution of the contained Analysis Engine software to processing nodes of the Definiens eCognition® Grid. This requires a Server Version? and build number.dpk file, containing a Definiens software package (for example, XD Life Server?.1.0.0.1083.dpk).
- To load and install a new software package, choose Software > Packages > Upload New Package. The Upload New Software Package dialog displays.
Figure 39: Upload New Software Package dialog of the Manage Software page.
- Click the Browse button and browse to the installation folder you received from Definiens. Select a .dpk file containing a Definiens software package.
- Click the Upload Software button. The new package is listed on the Manage Software page with status “installed”.
Loading Only
Follow the first steps described in Load and Install Software Packages on the Deployment Server on page 52. Clicking the Upload Software button should return the status “available”.
If you want to install the new software package later, you can clear the Install Package checkbox.
Installing Only
Install loaded software packages on the Deployment Server to prepare the software included for deployment. At least one software package must be loaded on the Deployment Server.
- To install software packages on the Deployment Server choose Software > Packages > Install Packages. The Install Packages dialog displays a list of loaded but not installed packages.
Figure 40: Install Packages dialog of the Manage Software page.
- Select the checkboxes of packages you want to install.
- Click the Run Installation button. The Installation date is displayed in the status column on the Manage Software page.
Uninstall Software Packages
Uninstalling software packages from the Deployment Server stops deployment of software but does not delete software packages; they can be installed again without being reloading
- To uninstall software packages from the Deployment Server choose Software > Packages > Uninstall Package. The Uninstall Packages dialog displays a list of installed packages.
- Select the checkboxes of the packages you want to uninstall.
- Click the Uninstall Selected Packages button. The changes are displayed in the status column of the Manage Software page. The uninstalled packages are listed as New. This is because they again are ready for installation as if they just had been loaded.
Delete Software Packages
Delete software packages from the Deployment Server to disable further installation. However, if you want to use a deleted software package again, you can reload and install it as usual. At least one software package is loaded, but not installed on the Deployment Server.
- To delete software packages from the Deployment Server choose Software > Packages > Delete Packages. The Delete Packages dialog displays a list of loaded but uninstalled packages.
- Select the checkboxes of packages you want to delete.
- Click the Remove Selected Packages button. The changes are displayed on the Manage Software page.
Manage Users of Data Management and Administrators
The Administration Console manages the user authentication for a Definiens system. This includes user rights management for the Definiens system administration and the use of the Definiens Data Management extension.
A user only can work with Definiens Data Management after he or she has been defined as a user by a Definiens system administrator. Users are managed in groups. Each group has defined access rights.
- Log-in to the Administration Console.
- Choose Users > Users. The Manage Users page displays a list of existing users.
Figure 41: Manage Users page.
- Select any the of the following tasks:
- Edit User
- Manage Users in Groups
- Manage Groups Rights in Access Types
Edit User
To assign personal user rights to users you can add and edit users. Choose Users > Users to display a list of existing users on the Manage Users page.
Add New Data Management User
To connect to Definiens Data Management, each user needs to have an active user account with appropriate user rights in the Definiens Administration Console. We recommend that you create separate user accounts for all users who want to work with Definiens Data Management.
- To add a new user, choose Users > Users > Add New User. The Create New User dialog displays.
Figure 42: Create New User dialog.
- Clear the Active checkbox if you want to activate the user status later. In most cases, you should not select the Access Right to Admin Console checkbox because it assigns administrator rights for the Definiens system. Administrators do not need to define a password at this stage; new administrators log in for the first time with an empty password and then specify a password afterwards.
- Click the Create User button. The new user is listed on the Manage Users page. By default, the new user is part of the All Users user group. You can add users to defined user groups.
Add New Administrator
To add new users as administrators of the Definiens system.
- Go to Users > Users > Add New User. The Create New User dialog displays.
- Fill in the form. You do not need to define a password at this stage (new administrators can log in for the first time with an empty password and define a password afterwards)
Select the Administrator checkbox to assign administrator rights for the Definiens system. Select the Active checkbox if you additionally want to activate the user status for Definiens Data Management.
Administrator Rights
Assigning administrator rights to users means they are able to log into the Administration Console and create new or change existing user rights. Administrators are also allowed to modify the access rights for Definiens workspaces managed in Definiens Data Management. Administrator rights should be reserved to a limited number of users.
- Click the Create User button. The new user is listed on the Manage Users page.
Edit User Properties and Passwords
Modify user properties including password, activation status, and administrator rights.
- To edit user properties, choose Users > Users. The Manage Users page displays the list of users.
- Click the Edit button for a user. The User Properties Of dialog displays.
- Edit the properties.
- If you want to change the password, choose Change Password. Enter the new password in both text boxes. Click the Apply Changes button to return to the User Properties Of dialog.
- Click the Apply Changes button. The property changes are displayed on the Manage Users page.
Select User Groups for a User
To provide a user with appropriate user rights, you have to select one or multiple user groups for the user.
- To select user groups for a user choose Users > Users. The Manage Users page displays the list of users.
- Select a user by clicking on its name. The Select Groups for User dialog displays a list of available groups.
- Select check boxes of groups to include the user as a member. Clear check boxes of groups to exclude the user.
- Click the Apply Changes button. The changes are displayed in the Groups column of the Manage Users page.
Alternatively you can select users for each group.
Manage Users in Groups
A user group assembles different users depending on the user rights you want to assign to each group. Groups enable you to categorize users, for example, according to their roles within your processes.
After providing each group with adequate user rights each user of a group has similar user rights. This allows easy management of access rights for the complete group of users.
To create groups and assign users to groups choose Users > Groups to display a list of existing groups on the Manage Groups page.
Figure 43: Manage Groups page.
The groups All Users and Administrators are available by default. Every new user is automatically member of the All Users group.
This helps you when setting up a new Definiens system; you automatically assign basic user rights without creating groups. All detailed definitions of users, groups and user rights can be done later.
Add New Groups
Define new groups of users. Groups enable you to categorize users according to their roles within your processes. Access rights in Definiens Data Management are only granted to entire groups, not to individual users.
- To create groups and assign users to groups choose Users > Groups to display a list of existing groups on the Manage Groups page.
Figure 44: Manage Groups page.
The groups All Users and Administrators are available by default. Every new user is automatically a member of the All Users group.
- Choose Users > Groups > Add New Group. The Create New Group dialog displays.
Figure 45: Create New Group dialog.
- Enter a name for the group and a description.
- Click the Create Group button. The new group is listed on the Manage Groups page.
Edit Group Properties
To modify group properties:
- To edit group properties, choose Users > Groups. The Manage Groups page displays the list of groups.
- Click the Edit button of a group. The Group Properties dialog displays.
- Edit the name or description.
- Click the Apply Changes button. The changes are displayed on the Manage Groups page.
Assign Users to Groups
Because access rights are generally granted on the group level, we recommend that you assign each user to one or more groups. By default, each new user will be assigned to the All Users group.
- To select users for a group, choose Users > Groups. The Manage Groups page displays the list of available groups.
- Select a group by clicking on its name. The Select Users for Group dialog displays a list of available users.
Figure 46: Select Users for Groups dialog.
- Select the checkboxes of each user you want to include as a member of this group. Clear the checkboxes of users who will not be members of this group.
- Click the Apply Changes button. The changes are displayed in the Users column of the Manage Groups page. Alternatively, you can select groups for each user.
Delete Group
Delete a group that you do not need any more.
- To delete a group, choose Users > Groups. The Manage Groups page displays the list of groups.
- Click the Delete button of a group.
- Reconfirm and the list on the Manage Groups page is updated.
Manage Group Rights and Access Types
An access type defines the user rights for each group. If you use multiple databases, you may want define an access type for each database or for each type of database. This simplifies management of user rights for all databases that have the same access type.
To create access types and assign rights to users groups, choose Users > Access to display a list of existing access types on the Manage Access Control page.
Add Access Types
An access type defines a typical access rights pattern for each group.
- To create access types and assign rights to user groups, choose Users > Access to display a list of existing access types on the Manage Access Control page.
Figure 47: Manage Access Control page.
- To add an access type, choose Users > Access > Add New Access Type. The Create New Access Type dialog displays.
Figure 48: Create New Access Type dialog.
- Enter a name for the access type.
- Click the Create Access Type button. The access type is listed on the Manage Access Control page.
Edit Access Type Properties
Modify properties of an access type.
- To edit properties of an access type, choose Users > Access. The Manage Access Control page displays the list of available access types.
2. Click the Edit button of an access type. The Properties of Access Type displays.
- Edit the name.
- Click the Apply Changes button. The changes are displayed Manage Access Control page.
Assign Groups to Access Types
For each access type, you have to define access rights for each group. The rights control creating, reading, updating (modifying) and deleting.
- To edit access rights, choose Users > Access. The Manage Access Control page displays the list of available access types.
- Select an access type by clicking on its name. The Define Access Rights For dialog displays a list of available groups.
Figure 49: Define Access Rights dialog.
- For each group (one per row), select the appropriate permissions.
Simplifying Access Rights
The way access rights can be configured for Definiens Data Management allows many different configurations. However, we strongly recommend using only the following three combinations:
• Read Only Access: Select the Read check box only.
• Normal Access: Select the Create, Read and Update check boxes.
• Full Access: Select all check boxes: Create, Read, Update and Delete.
- Click the Apply Changes button. The changes are displayed in the Description column of the Manage Access Control page.
Manage Storage of Data Management
Use the Administration Console to manage the access to data storages of Definiens Data Management. This is only required if you use the Definiens Data Management extension.
- Log-in to the Definiens Administration Console.
- Choose Storage > Storages. The Manage Storages page displays a list of existing data stores.
Add New Storage
Each tablespace needs to be registered in the Definiens Administration Console as a data store. This is done by adding a new storage. The information kept in the storages is used to centrally manage all connection information to databases.
- To add new storages choose Storage > Storages. The Manage Storage page displays a list of existing data stores.
Figure 50: Manage Storages page.
- Click Add New Storage. The Create New Storage dialog displays.
Figure 51: Create New Storage dialog.
- Define the database properties:
Oracle
Name Enter a name for this storage. This storage name is displayed in the user interface of Definiens Clients when users select a Definiens Data Store to connect to.
Service Enter the service name of the database of the form:
//Name of processing node/servicename
Example:
//pe1955n010/orcl or //pe1955n010/xe
User Enter the user name of the Oracle user account.
Password Enter the related password.
Storage Type Oracle ODBC.
IBM DB2
Name Enter a name for this storage. This storage name is displayed in the user interface of Definiens Clients when users select a Definiens Data Store to connect to.
Service Enter a string explaining the log-in details for the database of the form:
Database=Database name;Hostname=Machine name;
Service Name?=50000;Protocol=TCPIP
Example:
Database=DEF_DM;Hostname=My DB 2?_Host;
Service Name?=50000;Protocol=TCPIP
User Enter the user name of the Windows account that you created for the IBM DB2 database.
Password Enter the related password.
Storage Type IBM DB2.
- Click the Create Storage button. The new storage is listed on the Manage Storages page.
Edit Storage Properties
Modify properties of a storage.
- To edit properties of a storage, choose Storage > Storages. The Manage Storages page displays a list of existing data stores.
- Click the Edit button of a storage. The Storage Properties dialog displays.
- Edit the properties.
- Click the Apply Changes button. The changes are displayed on the Manage Storages page.
Define Group Access for Storages
You can specify the groups that are allowed to access each storage. By default, all users have access rights to a new storage.
- To select user groups for a storage, choose Storage > Storages. The Manage Storage page displays a list of existing data stores.
Figure 52: Manage Storages page.
- Select a storage by clicking on its name. The Select Groups with Access to Storage dialog displays a list of available groups.
Figure 53: Select Groups with Access to Storage dialog.
- Select the checkboxes of groups that will access this storage. Clear the checkboxes of groups that will not access this storage.
- Click the Apply Changes button. The changes are displayed in the Accessible for Groups column of the Manage Storages page.
Delete Storage
Delete a storage that you do not need any more.
- To delete a storage, choose Storage > Storages. The Manage Storages page displays a list of existing data stores.
- Click the Delete button of a storage.
- Reconfirm and the list on the Manage Storages page is updated.
Monitoring Processing in a Web Browser
If you use Definiens eCognition® Life Server for processing, you can control the status of jobs submitted for processing via a web browser.
- To display the Definiens Job Scheduler status page in your web browser, go to the machine that host the Definiens eCognition® Grid and choose the Windows Start menu > Start > All Programs > Definiens Grid > Job Scheduler Status Page.
Alternatively, you can enter a web address that is identical to the entry in the Job Scheduler entry of the Start Analysis Job dialog.
If a local Job Scheduler is used, you can enter http://localhost:8184.
- The HTML page is split into four parts, where you can resize the panes by clicking on the dividers and dragging them:
- User Jobs lists all jobs on schedule.
- Job Number Overview lists all projects of a selected user job
- Engines lists the Analysis Engine software instances of participating processing nodes.
Engine Usage displays the capacity utilization of all Analysis Engine Software instances of participating processing nodes of the Definiens eCognition® Grid.
Review User Jobs
Look in the User Jobs pane to see all jobs on the scheduler. There are four options you can use to filter this list; any filter in use is surrounded by asterisks:
- All is the default.
- Active Jobs are those currently being processed.
- Inactive Jobs lists successfully completed jobs and those that failed or were cancelled.
- Failed lists only those that did not successfully finish.
Look at some of the available data in this pane:
- Gray text means that the job has been closed because the workspace has been updated and the job will soon be deleted from the database. See Reopen a Job on page 65 for more information.
- Click Active, to display only jobs currently running.
- Push the Refresh button to reload the site.
- Click Log to see additional information about how the job was processed. The log lists the dates of events, followed by machine and Analysis Engine Software number and the type of event, which are either connecting or shutting down of an instance of Analysis Engine Software.
- Click on the index number of a job in the User Jobs pane to view its details in the Job Number Overview pane.
Review Job Overview
In the User Jobs pane, click on the job number in front of a job to switch to the Job Number Overview pane and review processing details. Click “1” to view the processing status of each project sent for processing, which is one of the following:
- Failed
- Waiting
- Canceled
- Processing-done
- Unauthorized
- Timeout
- Crashed
If you wish to stop the current job displayed, click Cancel in the upper-right corner.
View Job Details
In the Job Number Overview pane, you can review processed jobs by monitoring the status of each project sent for processing. You can click on the item number of a project to switch to the Job Details pane.
Figure 54: Job Details section of the Job Scheduler page displayed in a web browser.
If processing failed, look in the Remarks section for further information. Other information displayed includes the start and end times, the local path of the utilized rule set, a list of the image layers submitted for processing and the path of all the output files you specified in the Configure Exported Results dialog box, and the used configuration of the Analysis Engine Software.
Show Log
Click the Show Log link at the bottom of this page to display configuration information for the current job.
Monitor Analysis Engine Software Status
In the Engines pane, the participating Analysis Engine Software instances of participating processing nodes are listed. Filter them by selecting either only the “active” or “inactive” instances. The status of an active instance is idle. The status of instances whose analysis could not be completed is set to timeout. Click on the item number to display details. If an error occurred during processing, check the Remarks pane.
Review Analysis Engine Software Usage
The Engine Usage pane displays two graphs representing capacity utilization of all Analysis Engine Software instances of participating processing nodes of the Definiens eCognition® Grid. The left-hand graph represents the workload of the last 60 seconds while the right one displays data for the last 24 hours.
Reopen a Job
If the text for a job in the User Jobs pane is gray, the processing states and result references have been updated in the workspace. Processing states and the result references will eventually be deleted. The default time before deletion is five days (this value can be changed in the Definiens Administration Console).
If you close a workspace before processing is complete, the relevant entry will not turn gray until the workspace is reopened and updated. Once a workspace has been updated, and the line is therefore gray, the job will be deleted from the database.
- If you need to reopen a job, double-click the job number to open the job in the Job Number Overview pane.
- Click Reopen to reopen the job.
- The line in the User Jobs pane will turn black again.
Back Up the Definiens Administration Console Database
We highly recommend that you regularly back up the database of Definiens Administration Console. It is stored as xdadmin.db file on the primary node of the Definiens eCognition® Grid. The default path is C:\Documents and Settings\All Users\Application Data\Admin Console Data?\db.
General
- Temp path is used for Definiens cache files. During image analysis, the temp folder is used to store working files that may consume large amounts of disk space. Examples are:
Ensure the user who runs the Analysis Engine Software has access rights to this temp folder.
- License Check Timeout: In case the license is not available at application startup, the license check is retried for twice. Set the time in seconds before the license will be requested again.
- Default Server Configuration: If you work with the DIA Command Line Client, you can set the used software configuration needed to process the job. This information is analyzed by the Definiens eCognition® Grid in order to start and configure the Analysis Engine Software according to the requirements of the job. For regular processing, you find these settings on the Configuration tab of the Start Analysis Job dialog box. Examples are:
- eCognition
- eCognitionEarthServer.7.last
- Enable File Mapping: In cases of low system memory conditions you can activate file mapping to use memory-mapped files for allocating huge processing memory blocks. The default value is false.
Logging
- Log Path: Path of log files, for example .\Logs
- Max. File Size: Integer value specifying the maximum size in bytes for the log file. The default value is 10485760. After a file size is reached, the file is deleted and recreated. A zero value means no size limit; bear in mind that this can result in extremely large files.
- Trace Level: Level of detail in log files. Select 1 to increases the level of detail. Available values are 0 and 1
File Management
- Samba shares prefix, for example /mnt.
Samba sharesare are assumed to have computer name denoted in lower case. For example, for Abcd1 the samba share should look like /mnt/abcd1 not /mnt/Abcd2.
Storage
- The URL of the authentication server. Should be the same the Definiens Administration Console listens to. For example:
http://localhost:4002/
http://T41pn015:4002/
ODBC
- Oracle DSN: ODBC data source name used for connecting to any storage of type Oracle ODBC, for example “My Oracle”
- Connection File Location: The value of a variable defining the path of the folder containing files with Arc SDE? Connections, for example .\Connections
CSV Settings
- Decimal separator: A separator of decimal numbers used for export as comma-separated value files, such as a period (.)
- Column delimiter: A delimiter used for export as comma-separated value files, such as a semicolon (;)
DIAGRID
- Numbers of Engines: The number of instances of Analysis Engine software available for processing on this processing node. To change the number of engines, we recommend using the Properties of Node, which avoids having to restart the Control Service afterwards. Use −1 to start as many threads as the number of CPUs installed on the machine. This is also true for hyper-threading CPUs. Example values are 1, 4 and −1.
A hyper-threading CPU is not a regular CPU. If one thread is started on the regular CPU and another is started on the hyper-threading CPU, the hyper-threading CPU is significantly slower than the regular CPU. However, you need a license for each thread.
- Job Scheduler: The port the Job Scheduler monitors. Examples are localhost:8148 and T41pn015:8148. Take care when changing the port. Do not change this value if there is no special need.
- Config Service: Port of the Configuration Services of all nodes of the Definiens eCognition® Grid. It is used for communication among Configuration Service and other components. Examples are localhost:8148 and T41pn015:8148. Again, do not change this value if there is no special need.
- Use Config Service: The Configuration Service enables you to work with different software configurations. You can disable (false) the Configuration Service to only use Analysis Engine software and Job Scheduler for processing data. Values are true and false
- Start Image Cache Manager: Selected image drivers require the activation of the Image Cache Manager.
Values: true or false (default)
- Start Data Spooler: For each storage that you want to use, you must start a separate Data Management Spooler Service. Enter all names of storages to be started separated by commas, for example development,qa,production
DIA Control Service
Configuration parameters for the Control Service:
- Install directory: Path to the Job Scheduler and the Analysis Engine Software executable files. Do not change this path if there is no special need.
- Restart time: Time in seconds at which the Control Service restarts a crashed instance of Analysis Engine Software or Job Scheduler.
DIA Config Service
Configuration parameters concerning the Configuration Service:
- Configuration folder: Path to the configuration files. Do not change this path unless there is a special need.
- Storage folder: Path to the storage files. Do not change this path unless there is a special need.
- Local service: The primary node provides a processing unit by default (true). To disable it, enter false.
DIA Job Scheduler
Configuration parameters for the Job Scheduler:
- Database Folder: The database of the Job Scheduler is stored by default below the Documents and Settings folders. The default path is C:\Documents and Settings\user name\Application Data\Definiens\Job Scheduler?.dat folders. In some cases the size of the database can exceed 2GB. If necessary, you can change the storage location by editing the path (for example: C:\Program Files\Definiens Grid\Admin Console?\Data).
Settings
- Engine status timeout: Time in seconds before the Analysis Engine Software status is set to timeout. If the Analysis Engine Software answers after the preset timeout the status is set back to the current status.
- Engine idle timeout: If an instance of the Analysis Engine Software did not receive any job during a specified time, the engine idle timeout, it will be canceled.
- Orphan job timeout: When a job is assigned to an instance of the Analysis Engine Software, the Job Scheduler takes it out of the job queue and waits until the Analysis Engine Software comes and takes the job. If that does not occur during a specified time, the orphan job timeout, the job will be again added to the job queue.
- Days to keep history: Time in days the processing states and result references are kept in the history. Afterwards they will be deleted.
Data Management Spooler
Configuration parameters concerning the Data Management Spooler:
- User Name: The user name of the Data Management Spooler user to authorize for writing results to the storage. The default user name is Administrator
- Password: The password of the Data Management Spooler user to authorize for writing results to the storage. The default password is admin
- Delete CSV files: By default, .csv files are deleted after spooling (true). If you want to keep csv result files, for example to use in a spreadsheet, enter false.