Support Tools
### Overview
These are the operating instructions for the tool "Implem.SupportTools" to help you solve problems that occur when using Pleasanter.
### Notes
Due to the integration of the Framework and Core versions, the support tools are not included in the archive currently being distributed.
Some functions can be replaced by [Pleasanter SDK](/sdk).
### How To Use
#### １． Set the configuration file reference path
Implem.SupportTools operates by referencing various configuration files (.json) under the App_Data folder in the Pleasanter operating environment.
The path to the App_Data folder is set in the SupportTools configuration file ".\SupportTools\Implem.SupportTools.exe.config".
Set the path to App_Data in the "value" field below.
<applicationSettings>
<Implem.SupportTools.Properties.Settings>
<setting name="PleasanterSettingsPath" serializeAs="String">
<value>%SystemDrive%\inetpub\wwwroot\pleasanter\App_Data</value>
</setting>
</Implem.SupportTools.Properties.Settings>
</applicationSettings>
#### ２． Start SupportTools
Run Implem.SupprtTools.exe in the SupportTools folder.
The following dialog box will be displayed.
The text box in the center displays the log when SupportTools is executed. The contents displayed here are also output to the ".\Logs\Implem.SupportTools.log" file.
#### ３． Email Sending Test
The email-sending test attempts to send an email using the parameters set in "App_Data\Parameters\Mail.json".
##### Operation Procedure
1. Click the [Email Sending Test] button.
2. The "Email Sending Test" dialog box appears. The values set in Mail.json are loaded and displayed in each control.
3. Set the details of the email to be sent (To, CC, BCC, subject, body) and click the [Send] button.
4. If an error occurs during sending, the details of the error will be displayed in the log display area of the "Pleasanter Test Tool" dialog box. Refer to the error message and review the settings of Mail.json.
#### ４．SysLog Viewer
The SysLog Viewer is a function that allows you to view the contents of the SysLogs table of Pleasanter. You can also output the displayed contents to a CSV file.
##### Operation Procedure
1. Click the [SysLog Viewer] button.
2. The "SysLog Viewer" dialog will be displayed.
*The database connection is made by referencing the "SaConnectionString" set in ".\App_Data\Parameters\Rds.json".
##### View in real-time mode
1. Select the [Real-time] tab.
2. The most recent records in the SysLogs table will be displayed in a list for the number of records specified in "Number of records to retrieve".
3. After that, the list will be updated every number of seconds specified in "Update interval".
4. The initial values for "Number of records" and "Update interval" can be set in "./Settings/SysLogViewer.json".
##### View in period specification mode
1. Select the [Period specification] tab.
2. Specify the "Start date" and "End date".
3. Records for the specified period will be displayed in the list.
##### Common functions
1. You can hide records of that SysLogType by turning off the "SysLogType" checkbox.
2. Double-click any record in the list to check the details of that record.
3. You can output the records displayed in the list to CSV using the "CSV output..." button.
#### ５．LDAP synchronization test
The LDAP synchronization test is a function that displays a list of AD accounts that can be obtained using the parameters set in "App_Data\Parameters\Authentication.json".
For information on setting up integration with Active Directory, please refer to the following manual.
- [Linking Pleasanter with Active Directory](/manual/active-directory)
##### Operation Procedure
1. Click the [LDAP Sync Test] button.
2. The "LDAP Sync Test" dialog box will be displayed.
3. Click the [Get AD Information] button.
4. The Active Directory accounts acquired according to the settings in the "Authentication.json" file will be displayed in a list.
6. Click the [Open Settings File] button to open the "Authentication.json" file you are referencing.
7. If an error occurs when acquiring AD information, the contents of the error will be displayed in the log display area of the "Pleasanter Test Tool" dialog box. Refer to the contents of the error message and review the parameters of Authentication.json.
8. Click the [CSV Output] button to output the contents displayed in the list to a CSV file.
