IDEA Server Administration User Guide
IDEA Server Administration User Guide
IDEA Server 10
CaseWare IDEA Inc. is a privately held software development and marketing company, with
offices in Toronto and Ottawa, Canada, related companies in The Netherlands and China, and
CaseWare Analytics Partners serving over 90 countries. CaseWare IDEA Inc. is a subsidiary
of CaseWare International Inc., the world leader in business-intelligence software for
auditors, accountants, and systems and financial professionals.
Section 1
Introduction 7
Overview 8
Feedback 8
IDEA Server Administration 9
Printing Administration Pages 10
Searching 10
Sorting Displayed Information 10
Refreshing Displayed Information 10
Accessing IDEA Server Administration 11
Keyboard Shortcut Keys 13
Section 2
Dashboard Administration 15
Dashboard 16
Viewing the State of Services Running on the Server 17
Viewing Software Compatibility 18
Viewing ODBC Compatibility 19
Section 3
Users and Groups Administration 21
Users and Groups 22
User Account Types 23
New Users 23
Assigning User Account Types 24
CA407 IDEA Server Administration User Guide
Section 4
Projects Administration 27
Projects 28
Viewing Users Associated with a Project 30
Displaying or Hiding Sub-Projects 31
Assigning Team Leaders to IDEA Server Projects 32
Moving Projects 33
Uploading Library Files 34
Archiving IDEA Server Projects 35
Restoring Archived Projects 36
Deleting Archived Projects 37
Canceling Tasks from the Progress Pane 38
Section 5
Server Configuration Administration 39
Server Configuration 40
Editing Server Settings 41
Setting the Number of Concurrent Tasks 41
Decommissioning IDEA Task Servers 42
Activating IDEA Task Servers 43
Viewing Server and Project Location Information 44
Editing Outgoing Mail Server Settings 45
Configuring Outgoing Mail Server Settings 45
Testing Outgoing Mail Server Settings 46
Setting the Managed Projects Location for IDEA Server Only Mode Users 47
Section 6
Task List Administration 49
Task List 50
Organizing Displayed Tasks 51
Stopping Tasks 52
6
Section 1
Introduction
CA407 IDEA Server Administration User Guide
Overview
IDEA Server is a powerful data analysis application that operates using network servers.
While you view the data and perform your analysis using the IDEA client installed on your
computer, all your data storage and processing is done on a server.
IDEA Server Administration is a tool used by IDEA Server Administrators to manage users
and groups, IDEA Server projects, server configuration, and tasks within the IDEA Server
environment.
IDEA Server Administration can be installed on the machine hosting IDEA Task Management
Server or any other machine in the IDEA Server environment. For more information on
installation options, see the IDEA Server Installation Guide.
This document details how to use IDEA Server Administration to manage the IDEA Server
environment.
Feedback
Your feedback is important to us. Send your documentation-related comments to
IDEAdocumentation@caseware.com.
8
Section 1: Introduction
Page Description
Dashboard Displays all the servers within the IDEA Server environment and
indicates whether they are functioning successfully. From this
page, you can manage server information, such as software or
ODBC incompatibilities.
Users and Groups Lists all IDEA Server users specified in Corporate License
Manager. From this page, you can edit user accounts and change
password information for the IDEA Server Administrator account.
Projects Lists all IDEA Server projects and their associated sub-projects.
From this page you can modify, archive, and unarchive existing
IDEA Server projects.
Server Configuration Define active and inactive servers and view server locations.
Task List Displays the 5,000 most recent IDEA Server tasks. From this page,
you can view information on tasks, as well as stop or terminate
tasks.
The IDEA Server Administration window may also display a Progress pane at the bottom of
the window. From the Progress pane, you can view the progress of a move project or upload
files task being performed, view a list of queued move project tasks, as well as cancel any of
those listed tasks.
From the toolbar, you can perform the following common tasks:
l Print
l Find
l Sort
l Refresh
9
CA407 IDEA Server Administration User Guide
1. In the IDEA Server Administration window, click the administration page you want to
print.
2. From the main toolbar, click the Print button and select Print from the drop-down list.
4. Click OK.
Searching
Search for a particular item on the Users and Groups, Projects, and Task List administration
pages.
To perform a search:
1. In the IDEA Server Administration window, click Users and Groups, Projects, or
Task List.
2. From the toolbar on the selected administration page, in the Find drop-down field,
enter your search criteria or select an existing criteria from the drop-down list.
The first item that matches your criteria is highlighted in the list.
To refresh a page:
10
Section 1: Introduction
IDEA Server Administration is packaged with a default IDEA Server Administrator user
account (ISAdmin). All other users are populated by Corporate License Manager and are
assigned Basic User accounts by default.
Upon initial setup, you must log in to IDEA Server Administration with the default IDEA
Server Administrator account (ISAdmin). You can then assign IDEA Server Administrator
privileges to other licensed IDEA Corporate users. Any user with IDEA Server Administrator
permissions can log in to IDEA Server Administration using their credentials.
You can only perform IDEA Server Administration tasks with the ISAdmin account.
1. From the Windows Start menu (e.g., Windows 10), navigate to the IDEA Server
folder.
You must connect to the server that hosts IDEA Task Management Server.
4. From the Server drop-down list, select the server that you want to connect to.
a. Click Servers....
b. Click Add.
c. In the Name field, enter the name of the server you want to add.
d. In the Authentication Port field, accept the default or enter the appropriate
port information.
11
CA407 IDEA Server Administration User Guide
e. Click OK.
The server name is added to the IDEA Server list in the Add/Remove Servers
dialog box.
f. Click Close.
g. From the Server drop-down list, select the server name you just added.
5. Click OK.
If a server was not selected, IDEA Server Administration tries to connect to the
last known server.
Security
To prevent unauthorized users from accessing the default IDEA Server
Administrator account (ISAdmin), it is recommended to change the default
password for this account.
12
Section 1: Introduction
Shortcut Key When Pressed in the Left Pane When Pressed in the Right
Pane
Enter Moves focus to the grid in the right Only applicable in the Server
pane. Configuration and Users and
Groups administration pages.
If Server Configuration is selected
Opens the Edit dialog box for the
and Enter is pressed, the focus
selected item.
moves to the Servers tab in the
right pane.
13
Section 2
Dashboard Administration
CA407 IDEA Server Administration User Guide
Dashboard
The Dashboard is the starting page of the IDEA Server Administration window. It displays all
the servers within the IDEA Server environment and indicates whether they are functioning
successfully. The following information can be viewed for each server:
Name Description
Server Type The server type, such as Task Management Server or Task Server.
Disk Space The amount of free disk space on the drive where the IDEA database files
are stored. When the disk space falls below 1 GB the text is displayed in
red.
You can perform the following tasks from the Dashboard page:
16
Section 2: Dashboard Administration
2. In the Services column for a particular server, click the indicator icon (green check
mark or red X).
The Services dialog box appears indicating whether all services are running or
displaying any inconsistencies in the State column.
17
CA407 IDEA Server Administration User Guide
The Software column on the Dashboard page indicates whether servers have the correct core
software (green check mark) or if software inconsistencies have been found (red X). When
inconsistencies have been found you can click the red X to see where the inconsistencies are
occurring. The Software Compatibility dialog box appears displaying all core software and
operating system information for each server. The IDEA Server Administrator needs to
ensure that all servers within the IDEA Server environment are configured similarly to
resolve all conflicts.
2. In the Software column for a particular server, click the indicator icon (green check
mark or red X).
l When you click the green check mark, a message appears indicating that
incompatibilities have not been found. Click OK.
l When you click the red X, the Software Compatibility dialog box appears
displaying where inconsistencies were found. Verify that all servers are running
supported operating systems and the same .NET version. If inconsistencies were
found, a red X appears in the IDEA Server column.
3. In the Software Compatibility dialog box, from the IDEA Server column, click the red
X.
The Software Compatibility dialog box now displays inconsistencies found with the IDEA
Server software, such as missing files.
18
Section 2: Dashboard Administration
The IDEA Server Administrator needs to ensure that all servers within the IDEA Server
environment are configured similarly to resolve all conflicts.
2. In the ODBC column for a particular server, click the indicator icon (green check mark
or red X).
l When you click the green check mark icon, a message appears indicating that no
incompatibilities have been found. Click OK.
l When you click the red X, the ODBC Compatibility dialog box appears displaying
where inconsistencies were found.
3. Click the red X for a particular listed DSN to display more information on the issue.
19
Section 3
From this page, you can maintain user accounts, which includes changing the password for
the default ISAdmin account or assigning user account types to all other IDEA Server users.
Users can only access information in the IDEA Server environment from IDEA, if they have
been assigned an IDEA Server user account type. User account types define the type of
access users have within the IDEA Server environment.
From the Users and Groups page, you can view the following information:
Column Description
Username The user's system credentials to log into the IDEA Server
network.
You can perform the following tasks from the Users and Groups page:
22
Section 3: Users and Groups Administration
Basic User Can access IDEA Server projects that are assigned to them. By default, all
new users specified from the Corporate License Manager are assigned the
Basic User account type.
Team Leader A Basic User with additional project management permissions. Team
Leaders can access the Project Administration task in IDEA to create,
manage and assign users to IDEA Server projects, that they created.
Users defined as Team Leaders can also be given Administrator
permissions.
New Users
When new users are granted access to IDEA in Corporate License Manager, IDEA Server
Administration automatically adds the new users the next time the Users and Groups page is
accessed or when you refresh the page. By default, new users are assigned Basic User
accounts.
23
CA407 IDEA Server Administration User Guide
A user account can be assigned both a Team Leader and an Administrator account at the
same time. A Basic User account cannot be combined with any other account type.
3. From the Users and Groups toolbar, click the Edit button.
4. From the Account Type section, select the appropriate role for the user.
5. Click OK.
24
Section 3: Users and Groups Administration
3. From the Users and Groups toolbar, click the Edit button.
5. In the New password field, enter a new password for the account.
The new password can have a maximum of 50 characters and is case sensitive.
7. In the Password hint field, enter a phrase that will help you remember the password.
8. Click OK.
25
Section 4
Projects Administration
CA407 IDEA Server Administration User Guide
Projects
A project is a sort of IDEA Server container used to hold or group a set of original files that
make up the data imported from a client, as well as any files subsequently formed through
analysis. The Projects page lists all IDEA Server projects and their associated sub-projects.
You can view project information, edit, move, upload files to, and archive and unarchive
existing projects. IDEA Server projects are created, modified, and deleted, in IDEA, by users
who are defined as Team Leaders.
From the Projects page, you can view the following information for each project on the
server:
Column Description
Server The name of the IDEA Task Server on which the project is
stored.
Disk Space The total disk space used (in GB) for the project.
Last Accessed The date and time the project was last accessed. An empty field
indicates the project has not been accessed yet.
Folder Name The relative path used to locate the project folder on the IDEA
Task Server.
You can perform the following tasks from the Projects page:
l Move project
28
Section 4: Projects Administration
l Archive projects
29
CA407 IDEA Server Administration User Guide
2. From the Users column for the required project, click the numbered link.
The Users in project dialog box appears. It displays all the users associated with the
project.
3. Click OK to close the dialog box and return to the Projects page.
30
Section 4: Projects Administration
l In the Name column, right-click and select Expand All to expand all collapsed nodes.
l In the Name column, right-click and select Collapse All to collapse all expanded
nodes.
31
CA407 IDEA Server Administration User Guide
4. From the Select a new team leader list, select a new team leader for the project.
32
Section 4: Projects Administration
Moving Projects
If you have more than one IDEA Task Server in your IDEA Server environment, you can
move projects between servers for load balancing. Only one project can be moved at a time,
but you can create move project tasks for other projects while a project is being moved. The
tasks will be queued in the order they were initiated.
The Progress pane, at the bottom of the IDEA Server Administration window, displays the
project that is currently being moved and any other queued move project tasks. When a
project is being moved, it cannot be accessed by other users. Projects that are queued to be
moved are still accessible to users.
To move a project:
The Move Projects dialog box appears. It displays all available IDEA Task Servers along
with the amount of free disk space available on each server.
5. Click OK.
6. If the size of the project exceeds the available disk space listed, you are prompted to
confirm the move. The available disk space listed may not reflect the actual disk space
available at the time the move is performed; therefore, you may have adequate disk
space. Do one of the following:
If there is enough disk space on the server, the task proceeds successfully;
otherwise, the project is not moved.
7. From the main toolbar, click the Refresh button to update the information in the list.
33
CA407 IDEA Server Administration User Guide
The Progress pane, at the bottom of the IDEA Server Administration window, displays the
progress of the upload files task.
To upload files:
3. From the Projects toolbar, click the Upload Library Files button.
4. In the Select Destination Library Group dialog box, select the relevant Library group
and then click OK.
5. Navigate to and select the files to upload and then click Open.
Only the files relevant to the selected Library group are shown.
In IDEA, the files will appear in the Current Project Library in the relevant Library
group.
34
Section 4: Projects Administration
Once a project is archived, it cannot be accessed from IDEA. Archiving a project helps free up
space against the total number of allowable active IDEA Server projects. There is no limit to
the number of IDEA Server projects that can be archived.
35
CA407 IDEA Server Administration User Guide
To restore a project:
4. Click Unarchive.
The project is restored to its original folder and is listed in the Projects page.
36
Section 4: Projects Administration
4. Click Delete.
37
CA407 IDEA Server Administration User Guide
The Progress pane only displays a progress bar for any move project or upload files tasks you
perform during your current instance of IDEA Server Administration. If you exit out of IDEA
Server Administration and then re-open it, this information will no longer be displayed at the
bottom of the window. You can access this information on the Task List page.
To cancel tasks:
1. From the Progress pane, click the associated Cancel button for the task you want to
cancel.
38
Section 5
Server Configuration
Administration
CA407 IDEA Server Administration User Guide
Server Configuration
The Server Configuration page lets you configure which servers are active, the number of
concurrent running tasks allowed, and file locations for each server. The Server Configuration
page contains the following tabs:
Tab Description
Server Displays information for all servers in the IDEA Server environment.
From this tab, you can also set the number of concurrent tasks,
decommission an active server, and activate a decommissioned server.
E-mail Lets you edit and test outgoing mail server settings.
IDEA Server Lets you set the Managed Projects location for IDEA Server Only Mode users.
Only Mode
You can also print, sort, and refresh the displayed information on each tab.
40
Section 5: Server Configuration Administration
Column Description
Concurrent Tasks The total number of tasks that can be run concurrently on the
server.
Running Tasks The total number of tasks that are currently running on the
server.
# Files The total number of files on the server. These files can be part
of different projects.
The maximum number of concurrent tasks must be greater than 0 and less than
2,147,483,647. It is recommended that the maximum number be no greater than the number
of cores on the selected IDEA Task Server. Increasing the number beyond the recommended
maximum may severely degrade server performance.
41
CA407 IDEA Server Administration User Guide
The Server Configuration page appears. The Servers tab is displayed by default.
4. In the Concurrent tasks field, enter the total number of tasks that can be run at the
same time.
5. Click OK.
l Projects located on the server are inaccessible until the server is activated again.
l All tasks that are currently running on the server will finish and queued tasks will
remain queued and will be executed the next time the server is activated.
If you are decommissioning an IDEA Task Server for maintenance, you should deactivate the
server and then perform the maintenance tasks. Once the maintenance tasks are completed,
you can then activate the server again to gain access to the projects located on the server.
If you are uninstalling an IDEA Task Server, it is recommended to move the projects to
another active IDEA Task Server, deactivate the server, and then uninstall it. Note that you
cannot uninstall an IDEA Task Server that exists on the same machine as the IDEA Task
Management Server.
42
Section 5: Server Configuration Administration
1. If required, move projects from the IDEA Task Server to be decommissioned to another
active IDEA Task Server.
The Server Configuration page appears. The Servers tab is displayed by default.
6. Click OK.
You can now perform maintenance on the server or uninstall the server. An error
message is displayed if errors occur while deactivating the server.
IDEA Task Servers can be deactivated, and while in this state, projects located on the server
cannot be accessed. You can use the Edit Server dialog box to return a deactivated server to
an Active state.
The Server Configuration page appears. The Servers tab is displayed by default.
5. Click OK.
43
CA407 IDEA Server Administration User Guide
Column Description
44
Section 5: Server Configuration Administration
Column Description
From e-mail The e-mail account from which e-mails will be sent.
E-mail account The e-mail account to which an e-mail will be sent in order to
verify that the SMTP settings are valid.
The Server Configuration page appears. The Servers tab is displayed by default.
4. In the SMTP server field, enter the name of the outgoing mail server.
5. In the Port field, enter the port used for the outgoing mail server.
The default port number is 25. You can enter a value up to 65,000.
45
CA407 IDEA Server Administration User Guide
6. In the From e-mail field, enter an e-mail account on the SMTP server from which mail
will be sent.
7. Click OK.
The Server Configuration page appears. The Servers tab is displayed by default.
3. In the E-mail account field, enter an e-mail address to where you want to send the
test e-mail.
4. Click Send.
5. Click OK.
46
Section 5: Server Configuration Administration
For IDEA Server Only Mode users, IDEA Server Administrators set the location of the
Managed projects. This location must be a shared network location that all IDEA Server Only
Mode users have full access (read and write) to. By default, the location is set to:
Using the default setting, the following folder structure is created on the shared network
location ("desktop") and on IDEA Server:
<IDEASERVERNAME>
<Data storage folder name defined during installation>
SOMProject
<Numbered string representing user account>
IDEA Projects
Default
Library Groups
Local Library
Library Groups
On IDEA Server, the SOMProject folder will take the place of the Projects folder. By default,
all IDEA Server Only Mode users have full access to these folders. IDEA Server
Administrators are responsible for setting Windows permission restrictions at the
<Numbered string representing user account> level, if required.
When in IDEA Server Only Mode, the following locations are in place:
File Location
Source Files IDEA Server (Source Files.ILB)
47
CA407 IDEA Server Administration User Guide
File Location
Export from Field Statistics Network shared location (Results.ILB)
Monetary Unit Sampling - Hit Point Report - Export Network shared location (Results.ILB)
1. In the IDEA Server Administration window, click IDEA Server Only Mode.
2. Click the Browse button adjacent to the IDEA Server Only Mode path field to
navigate to and select a shared network location.
3. Click Apply.
48
Section 6
Task List
The Task List displays the 5,000 most recent IDEA Server tasks that are being or have been
run, that are pending or have been canceled. From the Task List page, you can view
information on tasks, stop, and terminate tasks.
You can view the following information for each task on the server:
Column Description
Name The name of the task being run or that has been run.
State The status of the task being run or that has been run.
l Queued
l Scheduled
l Starting
l Running
l Error
l Completed
l Retry
l User Cancelled
Server The name of the server where the IDEA Task Service in use is
located.
Completed The date and time the task was completed or stopped. An empty
field indicates the task has not completed yet.
You can perform the following task from the Task page:
l Stop a task
l Terminate a task
50
Section 6: Task List Administration
2. Click and drag a column header to Task List toolbar by the Grouped by field.
3. Click the grouping button to sort the Task List by that particular group in ascending or
descending order.
4. To remove a grouping, click and drag the grouping button from the Task List toolbar
back to the column headings.
51
CA407 IDEA Server Administration User Guide
Stopping Tasks
Stopping a task in IDEA Server Administration lets you safely cancel a task that is running,
queued or scheduled. When a task is stopped, the user who created the task receives a
message indicating the task was stopped and no results are sent to the user.
To stop a task:
5. Click OK.
52
Section 6: Task List Administration
53
CaseWare IDEA Inc.
1400 St. Laurent Blvd., Suite 500
Ottawa, ON K1K 4H4
Canada
1-800-265-4332
www.casewareanalytics.com