The Server area is accessible via the icon at the top of the left browser of the Archive Portal administration module. It contains data relating to the configuration of the CTGate.exe and CTServer.exe executables as well as all the indicators (Execution Status, Console, Log Files, etc.) allowing the administration of the Archiving server components. The area is divided into 6 tabs:
- Status : CTServer execution status.
- Settings : CTServer and CTGate settings.
- Sessions : List of current sessions.
- Console : Messages displayed in the CTServer Console.
- Server Log files : CTServer Log Files.
- Gate Log files : CTGate Log Files.
Status Tab
The Status tab allows you to monitor the proper execution of the CTServer executable. The three buttons located in the upper right corner (Start Server, Restart Server, and Stop Server) can be used to control the execution of CTServer from a web browser (even if the CTServer executable is running as a Windows Service). Since some parameter changes require a restart of CTServer, simply go to this tab and use the Restart Server button.
The information displayed in the Status tab is grouped into several functional blocks:
- Server Status : Execution status of CTServer.exe (Stopped, Starting, Running...)
- Running Since : Date/Time of CTServer.exe startup
- Restart Time : The time at which CTServer.exe should restart
- Activation Key : Information about the activation key for CTServer.exe (Validity date, number of sites, number of users authorized to connect)
- License Aggreement : Date on which the user license was accepted
- Server Startup Mode : Startup mode of CTServer.exe (Application or Service)
- Server Startup Duration : Execution time of CTServer.exe
- Server Process ID : Process ID of the executable CTServer.exe
- Server Integrity Level : Access level of the CTServer.exe process
- # Session : Number of sessions currently open
- # Request : Number of requests executed since CTServer.exe was started
- # Access Login : Number of connections since CTServer.exe started
- # Search : Number of searches launched since CTServer.exe was started
- # Conversion : Number of PDF/EML conversions started since CTServer.exe was launched
- Computer Name : Hostname of the server hosting Apache / CTServer.exe
- Processor Identifier : Type of processor installed on the machine
- # Processor : Number of processors in the machine
- Memory Total : Memory size (in GB) installed on the machine
- % Memory Used : % of memory currently used
- Memory Available : Amount of memory (in GB) available on the machine
- Root Folder Path : Installation directory path for the Archive Portal
- Configuration file : Path to the configuration file (CTServer.ini) for CTServer.exe and CTGate.exe
- # Online Site : Number of Sites (based on Notes) published on the Archive Portal
- # Access Login : Number of users authorized to log in to the Archive Portal (Access.xml file)
- # Directory Person : Number of Person entries in the Domino Address Book (Directory.xml)
- # Directory Group : Number of groups in the Domino Address Book (Directory.xml)
- Portal Folder Path : Path to the folder directory containing the configuration files (Site.exe, Access.xml, Directory.xml, Licence.xml, Statistics.xml...) for CTServer.exe
- Portal Administrator : List of users with administrative privileges for the Archive Portal
- Portal Security Officer : List of users with security officer privileges for the Archive Portal
- CTServer.exe File Path : Path to the CTServer.exe file
- File Version : Version number of CTServer.exe
- File Size : Size of the CTServer.exe file
- File Modification Date : Date of last modification of the CTServer.exe file
- CTGate.exe File Path : Path to the CTGate.exe file
- File Version : Version number of CTGate.exe
- File Size : Size of the CTGate.exe file
- File Modification Date : Date of last modification of the CTGate.exe file
Settings Tab
The Settings tab displays all the parameters for CTGate.exe and CTServer.exe, which are grouped together in the CTServer.ini file. These parameters can be modified directly from the interface. You must save the changes by clicking the Update Server Settings button located in the upper right corner of the screen. Parameters related to CTGate.exe are applied immediately after modification, while those related to CTServer.exe require a restart of CTServer.exe to take effect.
The settings displayed in the Settings tab are grouped into several functional blocks:
- Directory.xml File Path : Path to the Directory.xml file
- Access.xml File Path : Path to the Access.xml file
- Site.xml File Path : Path to the Site.xml file
- User Preference Folder Path : Path to the folder containing the user preference files
- Search Folder Path : Path to the folder where the user search results are stored
- Incomming data Folder Path : The file path where the data sent by users to the Portal Archive is stored
- Output Data Folder Path : The file path where the data sent by the Archive Portal to users is stored
- Use GZip Compression : Option for compressing the data sent to users
- Log Folder Path : Path to the folder where the log files for CTServer.exe are stored
- Log Files Detail Level : Level of detail of CTServer logs
- Purge Log Files after : Retention period for CTServer logs
- Gate Log Folder Path : Path to the folder where the log files for CTGate.exe are stored
- Enable Gate Log : Option to enable the generation of log files for CTGate.exe
- Server Window Name : Name of the instance: CTServer.exe
- Restart Server at (Hour) : The time at which CTServer.exe should restart
- Process Request # Threads : Number of threads handling user requests
- Enable Security : Option to enable the portal's data security model (ACL + Reader Fields)
- Server Timeout Duration : Maximum time allocated for CTServer.exe to respond to CTGate.exe
- Inactive Session Timeout : The duration after which an inactive user session is purged
- Number of Site entries per Page : Number of sites displayed on a page of the Archive Portal
- Default UI Language : Default language (EN or FR) used by the Archive Portal
- Database Manager update ACL : Option allowing site managers to modify the access control list (ACL) of that site
- Database Manager update Properties : Option allowing site managers to modify the properties of that site (Title, Owner, Type, Categories)
- Portal Name : Archive Portal Name
- Portal Folder Path : Archive Portal folder path
Sessions Tab
The Sessions tab displays the list of active user sessions:
A session is defined by a User's access to a Site (Notes database) via the Archive Portal. The information associated with a session is as follows:
- Login : The username (login)
- Site : The title of the accessed site
- Creation Date : The timestamp of the first interaction with this site
- Last Access : The timestamp of the last interaction with this site
- Idle : The number of minutes that have passed since the last interaction
- # Events : The number of events (requests between the user's browser and CTServer.exe) in this session
- FT Index : Indicates whether the Full Text Index has been loaded into memory for this site (it is loaded as soon as a user performs a search)
Since user sessions consume server memory, CTServer.exe has an automatic session cleanup mechanism that purges sessions after a period of inactivity (15 minutes by default). This duration can be configured in the Settings tab (Inactive Session Timeout).
Console Tab
The Console tab displays the same information as that shown in the CTServer.exe executable window:
Each line displayed corresponds to a request from CTGate.exe to CTServer.exe, to verify access rights to a resource present on the disk (Document, Image, HTML file, Attached file) or to obtain a dynamically calculated resource (View Index, Search, Export...).
A request is broken down into several blocks :
- REQ-P01 : Identifier of the internal thread within CTServer that was responsible for processing the request.
- 2023/11/28 15:56:08 [616] : Timestamp of the request (milliseconds are in square brackets).
- GET : Type of HTTP request.
- cooperteamdev.com/cgi-bin/CTArchivePortal/CTGate.exe? : URL for accessing the Archive Portal.
- NSIDoc : Site Name.
- /PICTURES/P000119_C125864100487FC5.gif&ID=00000916 : Identifier of the requested resource.
- for [ctadmin] : User login.
- at [85.12.168.45] : User's IP address.
- in 2 ms : Execution time of the request by CTServer.exe.
Server Log files Tab
The Server Log files tab contains all the log files for the CTServer executable:
You can view the contents of a log file by clicking on its name (in the left-hand side of the screen), and its content will be displayed on the right-hand side. Enabling the generation of log files for the CTServer.exe executable is configured in the Settings tab, on the Log Files Detail Level line.
The changes will not take effect until the CTServer.exe server is restarted.
Gate Log files Tab
The Gate Log files tab contains all the log files for the CTGate executable:
You can view the contents of a log file by clicking on its name (in the left part of the screen), and its content will be displayed in the right part. Enabling the generation of log files for the CTGate.exe executable is configured in the Settings tab, on the Enable Gate Log line.
The changes take effect immediately. Since the production of logs related to CTGate can quickly generate thousands of files, it is best to only enable this option during troubleshooting phases. You can manually delete the CTGate log files using the Delete all Files button located in the upper right corner of the screen.
Comments
0 comments
Please sign in to leave a comment.