Dialog IT Dynamics Practice

Transcription

1 Dialog IT Dynamics Practice FOUNDATION SUITE Dialog Dynamics WinServ for Dynamics SL Installation and Configuration Guide INTRODUCTION The Dialog Dynamics WinServ application is a Windows Service that will run automated functions in the Windows Operating System using a poling function. WinServ can be configured to perform a number of automated processes including: 1. Replaces Dynamics SL Communicator and routing all messages using the SMTP protocol Removes the need to have a Dynamics SL client running on a dedicated Windows machine 1.2. Removes the need to install Outlook Client and consume an Outlook license for SL Communicator PREREQUISITES 2 INSTALLATION 3 LICENSING AND REGISTRION 6 Registering Dialog WinServ for a specific Machine (Server) Validating your Customer ID and Order ID 6 Generating new Customer ID and Order ID 8 Validating a existing Customer ID and Order ID 7 Generate License Keys 11 WINSERV MAIN SCREEN REFERENCE GUIDE 13 SERVICE FILTER 14 SERVICE LIST FRAME 16 ITEM DETAILS FRAME 16 CONFIGURING WINSERV SERVICES 17 DELEGATION SERVICES

2 PREREQUISITES Dialog WinServ requires that the.net Framework Version 2 be installed. The installation program will automatically test for the existence of the.net framework and, if not found, prompt you with the following message: Click Yes to be directed to the Microsoft.NET Framework installation web site. Click No to locate the.net framework installation files manually.

3 INSTALLATION This document will guide you through the steps required to install the Dialog WinServ for Dynamics SL. The process involves Installing the Windows Service application. Registering the Machine and obtaining a License Key Configuring the application to interact with you Dynamics SL database 1. Run DialogWinServ.Setup.msi Running this setup utility will install the WinServ on your machine. When launched the following screen will appear. Click [Next] to continue.

4 2. Define the installation location 2.1. Setup will automatically recommend an installation location. Accept this location or click the [Browse] button to install to a different location Choose if you wish the application to be accessible to Everyone or Just Me 2.3. Click [Next] to continue. 3. Confirm Installation If you are happy to proceed with the install click [Next] to continue

5 4. Processing Dialog: A process dialog will appear showing the progress of the files being copied to your system. 5. Installation Complete Dialog: Upon completion the following dialog appears. Click [Close] to complete the installation.

6 LICENSING AND REGISTRATION The Windows Service can be installed and run free of charge, but still requires registration. The registration can be generated over the internet and requires only the machine code for the Server on which the service will be run. Registering WinServ for a specific Machine (Server) 1. Launch the Register screen from the Windows Start menu 2. The License Activation Wizard will launch displaying the activation screen. The machine code displayed is the code for the current workstation or server. If you already have a License Key, for this machine, enter the key in the fields provided and click [Next]. If you do not have a license key, for this machine, you will need to generate one. Click the [Generate Key] button to obtain a new license key. Before you can generate a license key you require a Customer ID and Order ID. When you click the [Generate Key] button it will take you to the Customer and Order Validation screen to either validate existing keys or generate new keys where required. Ensure you have a connection to the Internet before trying to retrieve a License Key from Dialog.

7 Validating your Customer ID and Order ID 1. Clicking the [Generate] key on the previous screen will display the Order Information screen below. Before you can generate license keys you are required to validate your Customer ID and Order ID. You can obtain a Customer ID and Order ID by either: Purchasing the Windows Service full version from. When you purchase the software from your Customer ID and Order ID will be ed to you. Requesting a Free Registration. You options in this screen will be: 1.1. Validate your existing Customer ID and Order ID or Enter your Customer ID and Order ID in the provided fields and press the [Validate Order] button Generate a new Customer ID and/or Order ID. If you have never registered the WinServ application with (Free to Purchased) you will first need to Generate a Valid Customer ID and Order ID. Once you have validated your Customer ID and Order ID you can proceed to generate the require license keys for the new Machine.

8 Generating new Customer ID and Order ID If you have not you obtained a valid Customer ID or Order ID you can do so by following the instructions below: 1. Enter your Name, Company and and press the [Request Now]. 2. A screen will display advising the application is connecting to s registration server.

9 3. On completion a successful dialog box will display. Press [OK] to accept and continue. Once you have successfully created a Customer ID and Order ID you can proceed to validate the IDs and Generate License

10 Validating a existing Customer ID and Order ID 1. Enter your Customer ID and Order ID in the fields provided and press [Validate Order]. If you just finished Generate new Customer and Order IDs the ID fields will remain populated. You will still need to press {Validate Now] to continue to the License Keys screen. 2. When the Customer and Order IDs are validated a screen is displayed showing your current License Keys. 3. To generate License Keys for a new Machine click the [Generate Key] hyperlink.

11 Generate License Keys 1. Once you have validated your Customer and Order ID you will have click the [Generate Key] button. A confirmation dialog will be displayed. Assuming your details are correct press [Yes] to continue. 2. A new License Key will be generated for this Machine and displayed to the License History pane.

12 3. Process [Next] to continue. This will display the starting screen with your Machine Registration Key Press [Next] to continue. 4. If you press [Next] to continue the Finish dialog is displayed Press [Finish] to end the Wizard.

13 WINSERV MAIN SCREEN REFERENCE GUIDE Launch the WinServ from the Windows Start menu. The Dialog WinServ main screen is displayed. This screen shows all the Services that are currently running. The screen contains a number of parts; Service Filter, Service List, Service Details and Service Log.

14 SERVICE FILTER The Service Filter allows you to select a specific Service Type to filter the Service List to only those Services that match that type. Delegating and Polling allow only a single Service for each type. For Executing and Reporting it is possible to define and unlimited list of Events to be processed. To filter the Service List click the Service Type in the Service Filter frame. The Service List will be repopulated with only the Services that match the selected type. To see all configured Services select All. SERVICE LIST FRAME The Service List displays summary details for all configured Services based on the selected Service Filter. The columns displayed in the list are: ID: Defines the Service s unique identification number. This value is assigned by the system when you add a new Service. Item: Displays the Service Name, which was entered in the Name field when the Service was created. Description: Displays the Service Description, which was entered in the Description field when the Service was created. The full text entered in the Description is displayed in the Description frame below the Service List. As you select each Service record its full description is displayed to the Description frame. Type: Defines the Type of Service for the row See: Delegating: Only a single Service can be configured for Delegating. This Service is used for Dialog s Management Assignment and Delegation module. Manager Assignments and/or Delegations can be scheduled to occur and/or reverse at some point in the future. Future dated Assignments / Delegations insert a record in a schedule table. The Delegating Service polls this table based on the frequency defined and when an Assignment or Delegation is due to be processed it performs the applicable changes to the Employee, Project or Document Approver fields. Executing: Executing Services execute stored procedures based on the frequency defined in the Service schedule. Dialog has provided some standard stored procedures that can be scheduled. This mostly relates to Order Management and auditing OM Process Manager. All of the events are provided with the free version of the software. Polling: Only a single service can be configured for polling. The polling service replaces Dynamics SL Communicator. It polls the communicator table (PJCOMMUN) based on the frequency defined in the service and whin it finds any records due for processing it sends out the alerts via SMTP. The recipients, subject and body are all controlled by the Dynamics SL Communicator table and the message will be structured the same as if it were sent by Dynamics SL Communicator itself.

15 Reporting : This feature was built for one of Dialog s clients and may not be a truly generic feature. The Service polls the Communicator table (PJCOMMUN) for a customer record type (SSRS Report). It obtains the SSRS report ID, optional Parameter and recipient list from the PJCOMMUN record. It then s an electronic copy of the SSRS report to the recipient list. This function was created to address some limitations in displaying SSRS reports in Business Portal at some sites. We have customised the Business Portal pages to populate the PJCOMMUN table with a cus tom record type. The PJCOMMUN record has a report id for an Invoice format, a Document number for the invoice to be ed and a recipient to send the Invoice to. The Service can be used for sending any SSRS reports using the above model. It will require an Executing Service or some other Dynamics SL or Business Portal customisation to populate the PJCOMMUN table with the report details to be ed. Status: Defines if the Service is currently active or not. When select a Service you can change the Status by: Clicking the Set Active or Set Inactive buttons in the top toolbar or [Right][Click] the selected Service to display a menu and select Set Active or Set Inactive Net Execution Time to Execution Frequency Defines the date and time the service is next scheduled to be inserted into the service process queue Defines the length of time remaining before the service is next scheduled to be inserted into the service process queue. Defines the frequency the service is inserted into the service process queue.

16 ITEM DETAILS FRAME The item details frame (Tab) displays all the details for the configure service. This is divided into three key parts: service parameters, recipients and description. Parameters Name Type Server Name Database name SMTP Address Recipients Failure Alerts Event recipients Description Defines the parameters that have been set for the service Defines the name of the service as per the field in the list Defines the type of service Defines the SQL server that the Dynamics SL database is stored on. Defines the SQL server database (Dynamics SL Database) that the service will be processed against. This is the Dynamics SL database that the execution stored procedures will run in. It is the SL database whose PJCOMMUN table is polled. Defines the SMTP address that messages will be sent out via. Recipients are used for two key purposes depending on the service that has been created When a service is created at least one static address must be defined. This is the address to which an alert will be sent when an error or failure occurs with processing a service event. Some events require a static recipient list. Most event types will obtain their recipient list from a dynamics source such as the communicator table (PJCOMMUN). However, for some executing events you may wish to send an alert specifically to a static address. Provides a detailed description of the service that has been configured. This can be defined or edited in the service maintenance screen for the applicable service.

17 CONFIGURING WINSERV SERVICES DELEGATION SERVICES 1. In the WinServ Main screen click the [Add New] button. This launches a sub-screen to define the service options. 2. Configure the details of the general tab 2.1. In the Service Type dropdown select Delegating 2.2. Set the Service to Enabled (if you want it to be set to Active when you finish and save Enter a Name for the Service. This is optional but we suggest Manager Delegation or similar Enter a Description to explain the Service to other users if you require. This is optional Tick the Enable Test Mode? if required. Test mode inserts extra details and records into the event log when you are trouble shooting issues with a service. It is not generally required.

18 3. Configure the details of the connection tab 3.1. Select the Server that your Dynamics SL database resides on. Choose local if the Service is running on the same Server as the applicable Dynamics SL SQL Server. If the SQL Server is on another machine select <Browse for more > from dropdown list Select your SQL Authentication method, Windows or SQL Server Authentication If you select SQL Server Authentication define the User Name and Password to be used. Note: Do not press the Test Connection until a database has been selected Select the Dynamics SL Application database that delegations will occur in..

19 Choose <Browse for more> to obtain a list of available databases for the selected Server Select the applicable Application Database from the list and press the [OK] button Press the Test Connection hyperlink to test the connection details and authentication are all valid and correct. 4. Configure the details of the Notification Tab 4.1. Enter a Sender s address. This can be any valid address in the SMTP address list Enter a valid SMTP Server address 4.3. Click the Test Connection hyperlink to check the Sender and SMTP details are correct Enter a valid static address in the field and click the add hyperlink. This is the account to which all service processing errors or failures will be sent. At least one address is required. Add extra recipient if you desire.

20 5. Configure the details of the options tab 5.1. Define the execution frequency Define the date and time of the first (next) execution time Select the frequency dimension (minute, hour, day, month) Enter the frequency interval. 6. Click the [Save] button at the base of the screen to complete configuration of the delegations service. To find out more about Dialog s Financial Suite for Dynamics SL, contact us today. Dialog Offices Brisbane Sydney Hobart Darwin Level 7, 35 Boundary St Level 5, 107 Mount St 75 Federal St Level 8, 9-11 Cavenagh St South Brisbane QLD 4101 North Sydney NSW 2060 North Hobart TAS 7000 Darwin NT 0800 T: T: T: T: E: brisbane@dialog.com.au E: sydney@dialog.com.au E: hobart@dialog.com.au E: darwin@dialog.com.au Canberra Melbourne Perth Fecca House, Unit 6 Level 10, 60 Collins St Level 3, 55 St Georges Tce Level One, 4 Phipps Close Melbourne VIC 3000 Perth WA 6000 Deakin ACT 2600 T: T: T: E: E: perth@dialog.com.au E: Canberra@dialog.com.au