WorkPlace Agent Service Installation and User Guide WorkPlace 16.00.00.00 + Paramount Technologies Inc. 1374 East West Maple Road Walled Lake, MI 48390-3765 Phone 248.960.0909 Fax 248.960.1919 www.paramountworkplace.com
Copyright Trademarks Copyright 2016 Paramount Technologies. All rights reserved. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Paramount Technologies. Notwithstanding the foregoing, the licensee of the software with which this document was provided may make a reasonable number of copies of this document solely for internal use. WorkPlace is a registered trademark of Paramount Technologies and is registered in the United States and other countries. Microsoft, Windows, Windows Server and Windows Vista are either registered trademarks or trademarks of Microsoft Corporation or its affiliates in the United States and/or other countries. The names of actual companies and products mentioned herein may be trademarks or registered marks - in the United States and/or other countries - of their respective owners. Unless otherwise noted, the example companies, organizations, products, domain names, e-mail addresses, logos, people, places, and events depicted herein are fictitious. No association with any real company, organization, product, domain name, e-mail address, logo, person, place, or event is intended or should be inferred. Intellectual property Paramount may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in any written license agreement from Paramount, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property. Warranty disclaimer Paramount Technologies disclaims any warranty regarding the sample code contained in this documentation, including the warranties of merchantability and fitness for a particular purpose. Limitation of liability The content of this document is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Paramount Technologies. Paramount Technologies assumes no responsibility or liability for any errors or inaccuracies that may appear in this manual. Neither Paramount Technologies nor anyone else who has been involved in the creation, production or delivery of this documentation shall be liable for any indirect, incidental, special, exemplary or consequential damages, including but not limited to any loss of anticipated profit or benefits, resulting from the use of this documentation or sample code. License agreement Use of this product is covered by a license agreement provided with the software product. If you have any questions, please call the Paramount Technologies Support at 800.725.4408 (in the U.S. or Canada) or +1.800.725.4408. Publication date July 2016 Page 2 of 16
Table of Contents Overview... 4 Installation Overview... 4 Step by Step Installation... 4 1. Run the WorkPlace Agent Service Installer (Setup.exe)... 4 2. Click through Installer Screens... 5 3. Configure the WorkPlace Agent Service... 7 4. Configure WorkPlace... 13 5. Start the Service... 13 Uninstalling the WorkPlace Agent Service... 13 Event Log... 13 Configure WorkPlace for Background email... 14 Email Troubleshooting... 15 Email Error Message Displayed in WorkPlace... 15 Email Error Message w/details Displayed in WorkPlace... 16 Table of Exhibits Figure 1: Installation File Location... 5 Figure 2: WorkPlace Agent Service Configuration... 8 Figure 3: WorkPlace Job Scheduling Options... 9 Figure 4: Windows Service... 9 Figure 5: WorkPlace Agent Configuration Settings... 13 Figure 6: Event Viewer... 14 Figure 7: WorkPlace Outgoing email Configuration Options... 15 Figure 8: WorkPlace email Error Messages... 16 Page 3 of 16
Overview The WorkPlace Agent Service is a Windows based service that handles the following WorkPlace background processing events; Background Processing of email Notifications and Reminders Enable and Disable Alternate Approvers based on Calendar email based Approval Processing Enterprise Application Integration Connector (EAIC) Synchronizations Enterprise Application Integration Connector (EAIC) Queue Processing Data Integration API (DIAPI) Processing Vendor Portal Synchronizations Third Party Document Management Synchronizations Multicurrency Exchange Rate synchronizations with external exchange rate provider Direct Connect / OFX Credit Card Expense Import The WorkPlace Agent Configuration application provides an interface for users to setup and configure the agent as scheduled services for automatic processing of the jobs required for their WorkPlace environment. Multiple instances can be configured using the application to provide maximum flexibility for selectively scheduling the frequency by job for multiple environments. Installation Overview The WorkPlace Agent Service installation program is launched by double clicking on the setup.exe that is located in the root of the installation package and on the IIS Server where WorkPlace was installed. Once launched, review the displayed screens and then install the application. Once completed the install program will offer to launch the configuration application, if left checked the WorkPlace Agent Service Configuration program will be launched for setup. The configuration tool is also located from your start menu under Programs -> Paramount Technologies -> WorkPlace Agent Service -> WorkPlace Agent Configuration. Step by Step Installation 1. Run the WorkPlace Agent Service Installer (Setup.exe) Launch the Setup.exe installation program from the computer that will be running the WorkPlace Agent service. Most likely this will be the web server that hosts the WorkPlace application. This is not a requirement though, any computer can host this service as long as it has access to the WorkPlace application. Page 4 of 16
Figure 1: Installation File Location 2. Click through Installer Screens The following screens will appear in the installer. Accept each screen until finished. Leave the checkbox checked to Launch the Application which will launch the configuration tool for setting up and starting the WorkPlace Agent Service. Click Next on the Welcome Screen Page 5 of 16
Accept the License Agreement and Click Next Review Install Settings and Click Install Page 6 of 16
Upon Successful Install Click Finish to Launch the Configuration Application 3. Configure the WorkPlace Agent Service The WorkPlace Agent Configuration Application will be opened upon successful installation and can also be opened via the shortcut that is located under Programs -> Paramount Technologies -> WorkPlace Agent Service -> WorkPlace Agent Configuration. Multiple WorkPlace Instances can be configured which allows for the ability to configure multiple environments with different parameters. NOTE: Any changes that are made will not take effect until the service is Re-started. Note that the service is NOT started by default. Page 7 of 16
Figure 2: WorkPlace Agent Service Configuration Page 8 of 16
Figure 3: WorkPlace Job Scheduling Options Configuration Settings - General Setting Description Service This shows the current status of the WorkPlace Agent Service and allows the user to Start, Stop and Restart it. The Service is also listed in the Windows Services applet. Figure 4: Windows Service Page 9 of 16
Setting Description Record Extended When checked, the WP Agent will record extended information Information to the to the Windows Event Log (see figure 4 above) as it both loads Event Log the configured jobs and as it processes each one through various stages. Configuration Settings - Connection Setting Description Instance Indicates the current instance that is being editing. URL URL to the WorkPlace Agent page. Authentication There are 3 modes of authentication that are supported for connection to WorkPlace. 1. Windows Authentication using Service Account This option will use the Windows Account that is specified on the service itself. If using this option, ensure that the account setup for the service via the services applet has the proper permissions to access the WorkPlace URL* and underlying database**. 2. Windows Authentication This is the traditional Windows Authentication which will require a value for Domain, User Name and Password that has access to the WorkPlace URL* and underlying database**. 3. SQL Server Authentication This requires a valid SQL Server User Name and Password that has proper access to the underlying database. * User must part of the WorkPlace Active Directory group that has the WMI Control permissions on the WorkPlace web server. Domain User Name Password Company DB(s) **Database permissions are not needed if using NTSHARED authentication as the WPShared user database permission will be used. Required when Windows Authentication is selected. Required when Windows Authentication or SQL Server Authentication is selected. Required when Windows Authentication or SQL Server Authentication is selected. Comma delimited list of company database names, when specified only the companies listed will be executed. If this and the controldb are not specified then all companies registered for WorkPlace will be used. Page 10 of 16
Setting Description Control DB(s) Comma delimited list of control database names, when specified only companies associated with the control db will be executed. This can be combined with company db to execute against a specific set of company db's associated with the control db. If this and the company db are not specified then all companies registered for WorkPlace will be executed. Configuration Settings Job Scheduling Setting Description Job Job that is being scheduled. 3rd Party Document Process scheduled routines related to 3 rd party document Management management products. Refer to the respective solutions install/setup guide for more information. Alternate Approver Enable/Disable Alternate Approvers based on the Approvers calendar. DIAPI Process inbound documents and send any custom outbound documents. Direct Connect/OFX Communicates with OFX provider(s) to import Credit Card transactions to the WorkPlace Expense Solution. EAIC Queue Process the EAIC Queue. Priority entries are run first EAIC Queue Priority Only before un-prioritized entries. Process only the Prioritized entries in the EAIC Queue. This job will NOT process un-prioritized entries. This job will typically have a very frequent scheduled timeframe within seconds. This is necessary as certain WorkPlace screens will submit a priority entry and will be held up waiting for the response. So, if this is set to say a minute and WorkPlace is processing a priority item it will not get feedback for potentially a minute out. EAIC Synchronization email Approval email Check/Send Exchange Rate Portal Note: Suggested time for this is 5 seconds. Perform EAIC synchronization. Check for and process any inbound email approvals. Check for any email reminders and send all queued up emails. This job must be scheduled if the System Setting Send email in the Background with the WorkPlace Agent is enabled in WorkPlace. Synchronizes with exchange rate provider to provide updated exchange rates when this multicurrency system setting is enabled within WorkPlace. Communicate with the vendor portal and process any Page 11 of 16
Setting Last Run Clear Last Run Next Run Frequency Never One time Description updates entered by the vendors. Indicates the last time the job was run. Clears the last run time. This is useful for re-running One time jobs. This is a dynamically calculated preview to show when the next run time will be based on the current settings. Default option and these jobs will never run. Runs one time only on or after the supplied start date and time. Once run it will never again unless the Last Run time is cleared. Seconds Runs on or after the supplied start date and time and then thereafter by the specified seconds. Daily Runs on or after the supplied start date and time and then thereafter by the specified days. Weekly Runs on or after the supplied start date, time and selected days of week, then thereafter by the specified Page 12 of 16
Setting Description weeks. Figure 5: WorkPlace Agent Configuration Settings 4. Configure WorkPlace Based on the job scheduling selections made, ensure that WorkPlace has been licensed, setup and configured for the associated service(s). An overview of the Background email processing has been included below for reference and troubleshooting this feature which is available for all WorkPlace environments. 5. Start the Service Once all settings has been configured make sure to start the WorkPlace Agent Service. To monitor the Services progress simply go the Event Viewer and view the WorkPlace Agent Service log under the Application and Services Logs group. Uninstalling the WorkPlace Agent Service To uninstall simply go to Control Panel -> Programs and Features, select the WorkPlace Agent Service and click Uninstall. Or, select Uninstall WorkPlace Agent Service which is located in Programs -> Paramount Technologies -> WorkPlace Agent Service. Event Log The WorkPlace Agent maintains its own event log called WorkPlace Agent Service on the server it was installed to. The information stored in the log is very helpful for troubleshooting and should be referred to if any agent related issues are experienced. Page 13 of 16
Figure 6: Event Viewer Configure WorkPlace for Background email If the WorkPlace Agent Service is going to be used to send the emails then WorkPlace must be configured to allow the service to send the emails rather than WorkPlace sending them in real time. To configure, log into WorkPlace and go to System Settings -> General -> email Outgoing SMTP on the General tab and check the Send email in the Background with the WorkPlace Agent option. Page 14 of 16
Figure 7: WorkPlace Outgoing email Configuration Options Note: All outgoing emails except for the Purchase Order emailed to Vendor work with this service. These emails will still be sent as they did previous to this functionality with no change. Email Troubleshooting When an error with email is encountered, WorkPlace will display a message at the header of each page indicating that an outgoing email error has occurred and also provide a hyperlink with more details. When the email subsystem encounters an error it will queue up the emails in error to be resent in the next 5 minutes. This means that if you fix the error in the message it will not go away until at least 5 minutes has elapsed and the agent has triggered the email job. To manually reset the email queue from within SQL, simply run the following against the WorkPlace company database and then restart the WorkPlace Agent Service: Email Error Message Displayed in WorkPlace UPDATE WCEmailQueue SET idfbatchkey=null Page 15 of 16
Email Error Message w/details Displayed in WorkPlace Figure 8: WorkPlace email Error Messages Page 16 of 16