You are on page 1of 8

Solution ID: Summary: Details: Specific To:

699429 E-WF/PRCS ; How to configure SMTP PeopleTools 7.5x, 8.1x, 8.4x SOLUTION 699429 - E-WF/PRCS ; How to configure SMTP PeopleTools 7.5x, 8.1x, 8.4x Enterprise PeopleTools Any Version

If you intend to implement PeopleSoft Workflow and use the Process Scheduler to generate electronic mail messages then SMTP settings must be configured for both the Application Server as well as the Process schedulers. These settings are configured through PSADMIN or through the PSAPPSRV.CFG and PSPRCS.CFG file respectively. ;=============================================================== ; Settings for SMTP mail ;=============================================================== SMTPServer=PSP-SMTP-01<---- name of your SMTP server (this can also be the IP address of the SMTP server) ----------------------------------------------------------------------------------------------------------------------------------------------SMTPPort=25 <---- port number for your server (usually will be 25) SMTPServer1=PSP-SMTPG-01 <----- name of backup server (not necessary) SMTPPort1=25 <---- backup server port number SMTPSender=PeopleSoft@peoplesoft.com <----- Valid email ID format SMTPSourceMachine=ts-hp03.peoplesoft.com <------<machine name that App Server or Process Scheduler is on>.<companyname>.com (this can also be the IP address of the machine without the <companyname>.com) Note: This needs to be the machine name of the server being configured, Application or Process Scheduler, NOT THE NAME OF THE DATABASE YOU ARE CONNECTING TO. The backup server is optional. If your company plans on sending high volumes of email, you may set up a backup server to handle overflow of the primary server. If the primary server is overloaded or has simply gone down, the backup will takeover. SMTP will not try to re-send any failed mail. You can test SMTP settings on the application server by using the following procedure: Tools 7.5x: First go to PeopleTools >Workflow Administrator > Use > WF System Defaults, and make sure the Email Active checkbox is checked. Next, add your email ID to an existing Roleuser in Roleuser Maintenance, or add yourself in as a new Roleuser.

Next, go to Use > Worklist/Email Message > Add, accept the datetime stamp, in the Subject and the Message body, type the word "test". Check 'email' as the routing preference, and select the Roleuser that has your email address attached to it in the "Deliver To" field, and save the panel. This will send an email to you. Check your Inbox, and if the email's return address is the same as what you entered for SMTPSender, then SMTP is configured correctly. Tools 8.1 First go to Home > PeopleTools > Workflow Administrator > Use > Workflow System Defaults , and make sure the Email Active checkbox is checked. Next, add your email ID to an existing User Profile, Home > PeopleTools > Maintain Security > Use > User Profiles. Then Verify the Worklist user routing preference is checked under the Workflow tab. Next, navigate to Home > PeopleTools > Workflow Administrator > Use > Worklist / Email Message , and send an email message. Select the OPRID to which your email address is assigned to in the Deliver To field of the Worklist/Email Message page. In the Subject and the Message body, type the word "test". Check 'email' as the routing preference, and save the page. Tools 8.4x First go to Home > PeopleTools > Workflow > Use > Defaults & Messages > Set Workflow Defaults, and make sure the Email Active checkbox is checked. Next, add your email ID to an existing User Profile, PeopleTools > Security > User Profiles. Then Verify the Worklist user routing preference is checked under the Workflow tab. Next, navigate to Home > PeopleTools > Workflow > Use > Defaults & Messages > Worklist / Email Message , and send an email message. Select the OPRID to which your email address is assigned to in the Deliver To field of the Worklist/Email Message page. In the Subject and the Message body, type the word "test". Check 'email' as the routing preference, and save the page. In Tools 7.5x and 8.1x, if you receive an email, but it says that it is from your email address (i.e. john_doe@peoplesoft.com), then the email was sent 2-tier via your MAPI/VIM32.DLL, and not via SMTP. When you trigger an email from PeopleSoft in 3-tier, the email request will first look at the App Server SMTP configuration, and if that is not configured correctly, it will then look to your local client registries for your maill DLL file and send it that way. This is important to know because we have a lot of customers that think SMTP is configured correctly, when in fact the email is being sent 2-tier. The above test is the quickest way to determine which method is sending your email. To test SMTP configuration for the process scheduler, run a process through the scheduler distributing an email to the configured user. Additional parameters are found in Tools 8.1x, they are as follows: SMTPSourceMachine= <------ In 8.1+ this is the IP address of the app server OR Scheduler depending on where you are configuring this parameter. SMTPCharacterSet=UTF-8 <------ Here, specify the character set used on the sender's machine.

SMTPEncodingDLL= <------ Specifies the name of a DLL used to translate the mail message to nonUnicode character set. By default, all outgoing SMTP mail is sent using UTF-8 encoding, which is the only encoding type PeopleSoft supports. SMTPGuaranteed=0 <------ Set this option to 1 if you want TriggerBusinessEvent email PeopleCode to be delivered through the messaging system. With this option on, the system periodically retries email sent with TriggerBusinessEvent until successful. By enabling this feature you implement a mechanism to ensure that emails get routed to the appropriate place just in case SMTP mail fails for some reason, such as network timeouts, down mail servers, invalid parameters, and so on. NOTE: with SMTPGuaranteed=1, no logging information will be produced in the Application Server Log, and emails are now sent through Application Messaging/Integration Broker. Therefore, Application Messaging/Integration Broker must be setup as well as appropriate message channels. This functionality is not available via Process Scheduler SMTPTrace=0 <------Turns SMTP trace on/off. Trace shows up in the APPSRV.LOG file. SMTPSendTime=0 <------ This parameter, if enabled, controls whether the message contains a "send time" populated by the application server. If disabled, the "send time" is blank and will be populated by the receiving gateway (depending on the gateway). To enable this option enter 1; to disable enter 0. This puts the time that the email was Sent on the email itself. This setting is not available in the PSPRCS.CFG file. Additional parameters are found in Tools 8.4x, they are as follows: SMTPBlackberryReplyTo= <------the internet address that you want to be the "Reply To" address for Blackberry Email Responses. This must be a valid address such as user1@xyzcorp.com ****You can also do 3-tier tracing by setting the Log Fence to 5 (it defaults to 3) on the App Server. SMTP tracing will show up in the APPSRV.LOG file. Interpret the tracing as follows: SMTP (in) : TCP/IP Initialization call (rx) : Output received from the SMTP server (tx) : Output sent to the SMTP server (ex) : Status of the TCP/IP termination call Also see resolution 708169 for example of interpreting SMTP tracing, this is included below: ***Resolution 708169 - How to interpret SMTP tracing ISSUE: Experiencing issue with Mail server. Customer has trace file but does not know what the errors mean. SOLUTION: This resolution is also available in the attached Word doc, and can be found in the GSC Tips & Techniques database as well.

The tracing is interpreted in the following guidelines: SMTP (in) : TCP/IP Initialization call (rx) : Output received from the SMTP server (tx) : Input received from the SMTP server (ex) : Status of the TCP/IP termination call and the following trace is an example of a successful email and it's tracing in Tools 8.13 in a Demo database: PSAPPSRV.250 [07/12/01 15:23:39 PTDMO@RHUTCHIS051500](4) Service ICPanel completed: elapsed time=0.0500 PSAPPSRV.250 [07/12/01 15:23:39 PTDMO@RHUTCHIS051500](5) ManagerGetService for ICPanel, Object PGM:PGM(GEN_MSG_SEND/GBL/ENG) left in use. UseCount=1, bUpdate=0 PSAPPSRV.250 [07/12/01 15:23:39 PTDMO@RHUTCHIS051500](5) (NET.100): Network API tracing TUXEDO: tpreturn {rval='TPSUCCESS', rcode=0, data=0x0162b738, len=21209, flags=0x00000000} PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 ICPanel](4) Starting Service PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](4) Executing component GEN_MSG_SEND/GBL in menu WORKFLOW_ADMINISTRATOR PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [in]: initialize WinSock => Ok PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [in]: create socket => Ok PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [in]: make addr (psh-mms-01) => Failed PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [in]: name to addr (psh-mms-01) => Ok 216.131.194.26 PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [in]: connect 216.131.194.26:25 => Ok PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [in]: setsockopt SO_SNDTIMEO:10000 => Ok PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [in]: setsockopt SO_RCVTIMEO:10000 => Ok PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [rx]: 220 psh-mms-01.peoplesoft.com Service ready PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: helo RHUTCHIS051500.peoplesoft.com PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [rx]: 250 Ok PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: mail from: PeopleSoft@peoplesoft.com PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [rx]: 250 Ok

PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: rcpt to: rob_hutchison@peoplesoft.com PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [rx]: 250 Ok PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: data PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [rx]: 354 Start mail input; end with <CRLF>.<CRLF> PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: Mime-Version: 1.0 PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: From: PeopleSoft@peoplesoft.com PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: To: rob_hutchison@peoplesoft.com PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: Subject: =?utf-8?B?VEVTVAAAAAAAAAAAAA==?= PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: Content-type: multipart/mixed; PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: boundary=ps-boundary-1 PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: --ps-boundary-1 PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: Content-type: text/plain; charset=UTF-8 PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: --ps-boundary-1--

PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [rx]: 250 Ok - Data received PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [tx]: quit PSAPPSRV.250 [07/12/01 15:23:43 PTDMO@RHUTCHIS051500 (IE 5.01; WINNT) ICPanel](5) SMTP [rx]: 221 psh-mms-01.peoplesoft.com Service closing connection Here is a list of return codes that SMTP can generate. The return code is located immediately after the service name, i.e. PSAPPSRV.250: REPLY CODES BY FUNCTION GROUPS 500 Syntax error, command unrecognized [This may include errors such as command line too long] 501 Syntax error in parameters or arguments 502 Command not implemented 503 Bad sequence of commands 504 Command parameter not implemented 211 System status, or system help reply 214 Help message [Information on how to use the receiver or the meaning of a particular non-standard command; this reply is useful only to the human user] 220 <domain> Service ready 221 <domain> Service closing transmission channel 421 <domain> Service not available, closing transmission channel [This may be a reply to any command if the service knows it must shut down] 250 Requested mail action okay, completed 251 User not local; will forward to <forward-path> 450 Requested mail action not taken: mailbox unavailable [E.g., mailbox busy] 550 Requested action not taken: mailbox unavailable [E.g., mailbox not found, no access] 451 Requested action aborted: error in processing 551 User not local; please try <forward-path> 452 Requested action not taken: insufficient system storage 552 Requested mail action aborted: exceeded storage allocation 553 Requested action not taken: mailbox name not allowed [E.g., mailbox syntax incorrect] 354 Start mail input; end with <CRLF>.<CRLF> 554 Transaction failed

<Update> Common errors in the trace file: PSAPPSRV.211 [05/16/02 13:40:53 T4884DC@CDLG00003218077 MsgAPI](5) SMTP [in]: setsockopt SO_SNDTIMEO:50000 => Failed and PSAPPSRV.211 [05/16/02 13:40:53 T4884DC@CDLG00003218077 MsgAPI](5) SMTP [in]: setsockopt SO_RCVTIMEO:50000 => Failed. What this means is that you were not able to make a connection to your mail server within 50 seconds, so this failure is occurring. The 50 connect time is not a configurable number, we set that in our source code, so you cannot manipulate it. It used to be 10 seconds, we recently increased it to 50. The average connection to the mail server takes less than a second. This may be an issue with either your mail server, or performance with the app server. Could be that after so many emails, the app server gets bogged down and does not make a connection in time to the mail server. If it's a mail server issue, of course that is not something we support. On your mail server, your banner size may be too large. If your banner exceeds the alotted 528 characters, you will get a service timeout regardless of how quickly you make the connection. You should be able to see your banner message by doing: telnet <IP address of mail server> 25 to the mail server box. The message you see will begin with a 220 code (service ready), then your banner. If it is anything on our side, it would be a performance problem due to lack of resources on the app server. Do you have another app server you can test with? Did you create it as a 'Small', 'Large', or 'Developer size app server? Check the task manager resource meter of the app server while it is processing the email, is it always tapped out at 99%-100%? Try increasing your Service Timeout and Recycle Count for PSAPPSRV in your PSAPPSRV.CFG file. Try something like 20,000 and 100,000 respectively. Try increasing the min and max instances of PSAPPSRV. Another common error is the "make addr (MAIL.PILOT.NET) => Failed" error. This is natural. This occurs because SMTP does not accept DNS names, so it fails on the DNS name, then automatically converts it to an IP address, "name to addr (MAIL.PILOT.NET) => Ok 129.9.202.19". This does not harm anything. If you are having trouble connecting to the SMTP Server, please use Telnet to verify the connection is available: telnet <IP address of mail server> <port> Once this is done, you should recieve a reply looking something like this:

220 psh-esds-1208.peoplesoft.com ESMTP Server (Microsoft Exchange Internet Mail Service 5.5.2653.13) ready -----------------------------------------------------------------------------------------------------------------------------------------------Enterprise PeopleTools 8.48 PeopleBook: System and Server Administration > Setting Application Server Domain Parameters -> SMTP Settings

You might also like