Diagnostics
To access this option, type 6 Diagnostics from the main menu. The Diagnostics menu is displayed:
|
Diagnostics 1 Check for email capabilities 2 Check for secure FTP capabilities 3 Check IP address 4 Check external export 5 Check Z3950 capabilities 6 Report incomplete activations 7 Report centralized management maintenance tasks (only by sfxglb41) 8 Move to CDI - Single Activation of electronic collections (only by sfxglb41) |
Check for e-Mail Capabilities
This option tests the e-mail module to verify that it is operating properly.
The SFX software includes an e-mail module used by the following tools:
- SFXAdmin help form
- KB Manager E-mail Ex Libris button
- Local document delivery and feedback targets
- Statistics module
- MARC enhancement tool
The files involved with the check are:
- /exlibris/sfx_ver/sfx4_1/lr_4/lib/NetWrap/Email.pm
- /exlibris/sfx_ver/sfx4_1<instance>/config/mail.config_>
To run the check, select 1 Check for email capabilities from the Diagnostics menu.
Make sure that the SMTP server (such as sendmail) is running properly to allow the tools listed above to send e-mail.
The following is displayed:
|
Test Email module From: <fill in email address> To: <fill in email address> Subject: <fill in subject> Message: <fill in message> Sending email...Sent! This is the log: Mail::Sendmail v. 0.78 - Fri Sep 19 12:58:39 2003 Date: Fri, 19 Sep 2003 12:58 -0500 Server: localhost Port: 25 From: <email address will be here> Subject: <subject will be here> To: <email address will be here> |
If the test program reports that SMTP is not running properly, contact your server administrator.
As a workaround for this problem, it is also possible to send e-mails using the command-line mail application. However, this option is limited (no attachments can be sent) and should only be used if the SMTP server cannot be set up properly.
- Log on as an instance user and type the following:
|
cn vi mail.config_ |
- Change smtp to command.
- Change the path in which the mail command is located, if the location is different than /bin/mail.
We found a problem with emails from the Report broken links feature not being received for some SFX installations, where the email server has been configured to not allow emails to be sent by servers that do not have a DNS entry.
Customers encountering this problem should specify the SFX server hostname in a field called mail_from in the mail.config_ file, while making sure that the hostname specified should be accessible from outside the local network. Additionally, a new parameter called override_from_value should be set to 1 in the mail.config_ file. This ensures that the mail_from configuration value is used, instead of the server hostname (used by default).
When using the parameters, make sure the number sign (#) is at the beginning of the line (which means the line is commented out) is removed:
|
Section "general" mode "smtp" override_from_value "1" mail_from "noReply@exlibrisgroup.com" EndSection |
Check for Secure FTP Capabilities
Secure FTP is required for the following programs that are part of the SFX server:
- MARCit
- Export of electronic journals using the External Export program. Note that External Export is not available in MetaLib version 4 and later.
For more information on the Export, refer to Appendix C External Export of the SFX Advanced User's Guide.
To test the secure FTP, select 2 Check for Secure FTP Capabilities from the Diagnostics menu. The following screen is displayed. (Bold text is typed by the user):
|
Server: ftp.exlibris-usa.com User: sfxuser WARNING: Terminal issues in the Net::SFTP code prevent this module from hiding the password. DO NOT type your password if nobody else is to read it from this screen! Password: XXXX Loading modules... Instantiating... Connecting to sfxuser@ftp.exlibris-usa.com ... Everything seems to be OK for outgoing SFTP connections. |
Specify a server address, user name, and password to test the SFTP connection to a particular server.
Check IP Address
This option checks that the IP address of the server is not an IP address reserved for internal networks. This check needs to be performed when installing SFX (before requesting a license from Ex Libris).
To check the IP of the SFX server, select 3 Check IP Address from the Diagnostics menu.
The following are examples of possible messages:
|
The hostname 'xx.xx.xx.xx.xx', resolves to the IP address 'xx.xx.xx.xx'. A license should not be generated. Reason: This is an IP address reserved for internal networks. Please check your /etc/hosts file and/or your DNS server. |
|
The hostname 'xxx', resolves to the IP address 'xxx.xx.xx.xx'. This is seems to be a valid IP address. A license should be generated. |
Check External Export
Use this option to troubleshoot problems with the External Export tool. For more information on External Export, refer to the External Export section of the SFX Advanced User's Guide.
- Set up the external_export.config file on the SFX server to test an external export from the SFX server to the SFX server itself.
The file is located at: /exlibris/sfx_ver/sfx4_1/<instance_name>/config/external_export.config
- Remove the comment marks from each line.
- Fill in information about the SFX server and instance where you want to perform the test.
For example:
|
#Section "metalib.uni.edu" # username "metalib_ftp" # password "xxxxxx" # type "secure" # export "Y" #EndSection Section "sfx.uni.edu" username "sfxlcl41" password "xxxxxxx" type "secure" export "Y" EndSection |
- Run the Check External Export tool:
- Log on to the SFX server as an instance user.
- Type da.
- Type ./server_admin_util and select 6 Diagnostics and 4 Check External Export.
- Specify the base URL of the instance that you are testing.
The following is displayed:
|
Diagnostics 1 Check for e-mail capabilities 2 Check for secure FTP capabilities 3 Check IP address 4 Check external export 5 Check Z3950 capabilities Please select [1-5,q,m]: 4 Please enter the SFX Instance Base URL: http://sfx.uni.edu:9003/sfxlcl41 Making request. This may take a few moments... External Export succeeded! The file that was created: e-collection.03312004135818.xml-marc.gz Target location of output file: HOME directory of 'sfxlcl41' at 'sfx.uni.edu' |
The following table describes possible error messages and the problems to which they correspond:
| Error Message | Problem |
|---|---|
| Failed to contact the SFX Instance: Not Found (404) |
|
| External Export failed! The error that was returned: 10.1.2.231 not authorized to use external_export (Check external_export.config for a section named '10.1.2.231') | This message occurs if no information is specified in external_export.config. |
| External Export failed! The error that was returned: Could not instantiate Net::SFTP or could not establish secure connection to '10.1.2.231' with <user> . You should check the user's credentials or that the server's signature has not changed. |
|
| The file permissions in the scratch or scratch/e_collection_update directory are too restricted External Export failed! The error that was returned: Cannot open ../dbs/scratch/e-collection for writing | This message occurs in case the file permissions in the scratch or scratch/e_collection_update directory are too restricted. |
| External Export failed! The error that was returned: Could not upload../dbs/scratch/e-collection.03252004141754.xml-marc.gz into e-collection.03252004141754.xml-marc.gz. | This message occurs if the file permissions for the destination directory are too restricted. |
Check Z39.50 Capabilities
This service checks whether the Z39.50 has access to a particular OPAC.
- Log on to the SFX server as the instance user.
- Type da.
- Type ./server_admin_util.
- Select 6 Diagnostics from the main menu of the Server Admin Utility and select 5 Check Z3950 Capabilities.
You are prompted for the following information related to the z39.50 server for which you want to test access:
- Z39.50 server address
- Z39.50 server port
- Z39.50 base code
- Z39.50 syntax - possible values: USMARC, UNIMARC, or SUTR
- Z3950 user name and password (optional)
- Search string in prefix query notation
The following table lists several examples of searches that can be used for testing:
| Search Criteria | Description |
|---|---|
| @attr 1=7 1-57231-890-2 | Searches on ISBN 1-57231-890-2 |
| @attr 1=8 0003-0007 | Searches on ISSN 0003-0007 |
| @attr 1=4 test | Does a keyword search for the word test |
If the Z39.50 search is successful, information on the number of records found is displayed. You are prompted to specify the number of records to be presented. For testing purposes, type 1 or 2 records.
For example (bold text is typed by the user):
|
Please enter Z3950 server address [required]: opac.university.edu Please enter Z3950 server port [required]: 210 Please enter Z3950 base code [required]: opac_net Please enter Z3950 syntax [required]: USMARC Please enter Z3950 user [optional]: Please enter Z3950 password [optional]: connected to opac.university.edu:210[opac_net] Please enter search string in prefix query notation [required]: @attr 1=8 0003-0007 Number of records that match @attr 1=8 0003-0007 are 1. Please enter the number of records to be presented [required]: 1 record number 1: |
|
000 02990cas 2200697 4500 001 805408 005 20020415161700.0 007 cr cnu-------- 008 750726c19209999maumr1p 0 a0eng d 022 0 $a0003-0007 030 $aBAMIAT 032 $a075660$bUSPS 042 $ansdp$alc 043 $an-us--- 050 00 $aQC851$b.A6 082 $a551.506273 049 $aIADA 110 2 $aAmerican Meteorological Society. 245 00 $aBulletin of the American Meteorological Society. 260 $aBoston, MA, etc.,$bAmerican Meteorological Society. 300 $av.$bill.$c23-27 cm. 310 $aMonthly 362 0 $av. 1- 1920- 650 0 $aMeteorology$vPeriodicals. 776 1 $tBulletin of the American Meteorological Society (Online)$x1520-0477$w(OCoLC)38983929$w(DLC)sn 98007717 776 1 $tJournals of the American Meteorological Society$x1093-9563$w(DLC)sn 97004040$w(OCoLC)3691189 |
Report Incomplete Activations
This option produces a report that lists the following partially activated targets:
- Portfolios have been activated, but the target is not activated
- Targets that have been activated, but not any of their portfolios
- Portfolios have been activated, but no target services
- Target services have been activated, but no portfolios
- Targets have been activated, but no target services
- Target services have been activated, but no targets
The report is saved in the dbs/scratch directory of the instance. It contains information on incomplete activations for both default and institutes (if defined in the instance). In the Active object portfolios report, the number of active portfolios is included in the report output.
The following is an example of an incomplete activation report:
|
Creating report... please wait. Get incomplete activations for default institute Finished creating report
Contents of report file: a) Active object portfolios For the following target(s), at least one portfolio was found to be active, but the target itself is not active: 3 BIOMED_CENTRAL_SUBSCRIPTION default 1 CRKN_WILEY_ONLINE_LIBRARY default For the following target service(s), at least one portfolio was found to be active, but the target service itself is not active: 3 BIOMED_CENTRAL_SUBSCRIPTION-getFullTxt default
b) Active targets For the following active target(s), no active target services were found: ACTA_PRESS default
c) Active target services For the following active target service(s), no active target was found: CRKN_WILEY_ONLINE_LIBRARY-getFullTxt default For the following active target service(s), no active portfolios were found: AKADEMIAI_KIADO-getFullTxt default
Report file saved in: /exlibris/sfx_ver/sfx4_3/SST05/dbs/scratch/report_incomplete_activations.20121108160317 Report process finished successfully |
Report Centralized Management Maintenance Tasks
This option displays statistic information on tasks run via the centralized management of maintenance tasks function.
When selecting this option the following is displayed:
|
Report time range 1 Last day 2 Last week 3 Last month 4 Since specific date 5 For specific date range Please select [1-5,q,m,u]: 2 Please enter email to send the report: |
Select the time range for which you want to create the report, and enter an email address to which you want the report sent. The following is displayed:
|
You can find the report here: /exlibris/sfx_ver/sfx4_1/sfxglb41/dbs/scratch/central_crons-report.20131128171659.csv Report is sent to email: <email address> The report is a tab delimited file that contains, for each task run: Name of the task<tab>instance<tab>date<tab>start time<tab> |
Move to CDI – Single Activation of Electronic Collections (only by sfxglb41)
This option will allow you to run the Move to CDI from August 2020 and onwards. The option should not be run until the full CDI documentation for SFX is available in August 2020 at: Documentation and Training.
