FrameworkDirect Installation & User Guide

Transcription

1 FrameworkDirect Installation & User Guide Version FrameworkDirect Installation & User Guide 1

2 SoftWriters, Inc. has made every effort to ensure that this manual is correct and accurate, but reserves the right to make changes without notice at its sole discretion at any time. The software described in this document is supplied under a license and may be used or copied only in accordance with the terms of such license, and in particular any warranty of fitness of SoftWriters, Inc. products for any particular purpose is expressly excluded and in no event will SoftWriters, Inc. be liable for any consequential loss. The SWI logo and the SoftWriters, Inc. name are registered trademarks of SoftWriters, Inc. All other product names in this publication may be trademarks or registered trademarks of their owners. Copyright 2018 SoftWriters, Inc. All Rights Reserved FrameworkDirect Installation & User Guide 2

3 Table of Contents FrameworkDirect Installation & User Guide Table of Contents Overview 4 Installation Prerequisites 5 Installation 6 Licensing 11 Configuration 12 FrameworkLTC Settings 14 Troubleshooting 16 FrameworkDirect Installation & User Guide 3

4 Overview This document details the procedures for installing and using FrameworkDirect. FrameworkDirect is a web service that allows users to directly access the FrameworkLTC databases. XML messages are exchanged to query, update, or insert data into the FrameworkLTC databases. FrameworkDirect operates directly with the data in the databases. FrameworkDirect Installation & User Guide 4

5 Installation Prerequisites This application is complex and should be installed by a qualified network administrator. A working knowledge of Microsoft SQL Server and Microsoft IIS is essential for a correct installation. FrameworkDirect must be installed on a server where Microsoft Internet Information Services (IIS) is also installed. See the Microsoft product documentation for installation and configuration steps. Microsoft SQL Server 2008R2 or higher must be installed and the FrameworkLTC must be accessible during the installation of FrameworkDirect. For assistance will installing and configuring FrameworkDirect, contact SoftWriters, Inc. Support at , option 2. FrameworkDirect Installation & User Guide 5

6 Installation Verify that Microsoft IIS is installed on your server prior to installing FrameworkDirect. FrameworkDirect and IIS must be installed on the same server. 1. Navigate to the Application Download Center on the Customer Engagement Zone. This page is located under the Download > Applications menu Click the FrameworkDirect link in the Core Products section. 3. A Setup message will display at the bottom of the window. Click Run. 4. The FrameworkDirect InstallShield Wizard will begin. 5. Click Next on the Installer Welcome screen. FrameworkDirect Installation & User Guide 6

7 6. Read and accept the License Agreement. Click Next. 7. Enter the User Name and Organization into the Customer Information screen. Click Next. 8. Enter the name of the SQL Server where the FrameworkLTC databases are located. FrameworkDirect Installation & User Guide 7

8 Enter valid SQL login credentials. (The SQL login credentials are typically for the sa account. However, you can use any SQL login credentials that have permissions to the FrameworkLTC databases. Click Next. FrameworkDirect Installation & User Guide 8

9 9. Set the Log Folder. The file path will default to the user's temp folder. Click Next. 10. Choose the Setup Type. The Complete installation will default the installation to the Program Files directory. To move the installation to another drive or directory, select Custom. Click Next. FrameworkDirect Installation & User Guide 9

10 11. Click the Install button on the Ready to Install the Program screen. 12. When the installation has completed, click Finish. FrameworkDirect Installation & User Guide 10

11 Licensing The FrameworkDirect Interface must be licensed before the service will run. The FrameworkLTC Interface License Utility is used to license the FrameworkDirect Interface. The utility will connect with the SoftWriters, Inc. server and send the pharmacy NPI. The SoftWriters, Inc. server will send the License Key back to the utility when it matches the NPI with a license. To open the FrameworkLTC Interface License Utility: 1. To open the FrameworkLTC Interface License Utility, click the Start button. 2. Select Program Files. 3. Select FrameworkDirect. 4. Select Request FwDirect License Key. The FrameworkLTC Interface License Utility will open. 5. On the FrameworkLTC Interface License Utility: Select the Pharmacy from the Pharmacy drop down menu. Select FrameworkDirect from the Product drop down menu. 6. Click Request License. The License Key field will populate when the interface is licensed. Note: If the licensing utility returns a server connection error, check the server IP address in the configuration file. The file is located at the following path: C:\Program Files\SoftWriters\FrameworkLTC Interface License Utility\FwInterfaceLicenseUtil.exe.config. The IP address is listed towards the bottom of the file as shown on the example below. The correct address is FrameworkDirect Installation & User Guide 11

12 Configuration After the installer has finished, FrameworkDirect will need to be manually configured. The FrameworkDirect settings are located in a configuration file name, Web.config. The configuration file is an XML file stored at the following path on the C:\ drive: C:\inetpub\wwwroot\fwdirect\Web.config. The configuration file can be opened using Notepad or Microsoft Visual Studio. Connection String Key The ConnectionString key will need to be updated. The value for the Server will need to be replaced with the SQL server name. The User ID value can be left at the default of sa or it can be changed to another SQL User ID that has read/write access to the FrameworkLTC databases. The Password value will need to be replaced with the password associated with the entered User ID. The portions of the string to be changed are highlighted in yellow below. This key is located on line 21 of the configuration file. <addkey="connectionstring" value="server=xxx;user ID=xxx;Password=xxx"/> New Batch ID The NewBatchID key will set the Batch ID on new orders. The value will default to FWDIRA. To change the Batch ID replace the value highlighted below with the desired value for the Batch ID. This key is located on line 38 of the configuration file. <addkey="newbatchids" value="fwdira"/> Reorder Batch ID The ReorderBatchID key will set the Batch ID on reorders/refills. The value will default to FWDIRB. To change the Batch ID replace the value highlighted below with the desired value for the Batch ID. This key is located on line 42 of the configuration file. <addkey="reorderbatchids" value="fwdirb"/> Reorder Batch ID for Inactive Items The ReorderBatchIDForInactiveItems key will set a Batch ID for all reordered items where the items status is no longer set to active. By default, no value is set for this key and all reorders will be assigned the Batch ID from the ReorderBatchID key. To assign a different Batch ID for these items, replace the value highlighted below with the desired Batch ID. The Batch ID should be entered between the quotation marks. For example, the user can enter INACT between the quotation marks for correct syntax. This key is located on line 45 of the configuration file <addkey="reorderbatchidforinactiveitems" value=""/> NOTE: The values for NewBatchID, ReorderBatchID and ReorderBatchIDForInativeItems should be limited to a 6-character lengths. Anything greater than 6 characters will be truncated when the batch is created in FrameworkLTC. Reset Date Written for Reorders The ResetDateWrittenForReorders key will change the written date of reorders coming through FrameworkDirect to the date of dispense. By default, the value for this key is set to False and all reorders will keep their original written date. To assign the dispense date to all reorders, replace the value highlighted below with True. This key is located on line 48 of the configuration file. <addkey="resetdatewrittenforreorders" value="false"/> Log Path FrameworkDirect Installation & User Guide 12

13 The LogPath key will change the selected folder path of the log file. This was selected in step 9 during installation. By default, the value for this key is set to the user's temp folder. <add key="logpath" value="c:\logs\"/> FrameworkDirect Installation & User Guide 13

14 FrameworkLTC Settings A pharmacist, Interface FWDirect, is created in FrameworkLTC during the FrameworkDirect installation. Users can also set the reviewing pharmacist in FrameworkLTC for all refills/reorders coming from FrameworkDirect. Users can select the default Entered By Pharmacist and Reviewed by Pharmacist on the Interface Options tab of the Pharmacy Setup window in FrameworkLTC. The default selection for the FwDirect drop-down menus will be the Interface FWDirect pharmacist. FrameworkDirect Installation & User Guide 14

15 When orders come into FrameworkLTC through FrameworkDirect, batches will be created based on the Batch ID set in the FrameworkDirect configuration file. By default, the new orders will go into FWDIRA and refills/reorders will go into FWDIRB. In the example below, there is an additional batch for reorders where the NDC is inactive. By default, these orders will go into the FWDIRB batch. To change the Batch IDs, see Configuration. FrameworkDirect Installation & User Guide 15

16 Troubleshooting There are three common ways to begin troubleshooting issues with FrameworkDirect : Check the Event Viewer for FrameworkDirect errors. Verify the Server Name, User ID, and Password in the configuration file. Verify the FrameworkDirect is functioning by invoking the pharmacy list. This function will generate a list of pharmacies currently tied with FrameworkDirect, which users can manually verify for accuracy. To invoke the Pharmacy List: 1. Open IIS Manager and browse the web service. Click on FwDirect from the Default Web Site folder and then click Browse *.80 (http). 2. The FwDirect directory will open in the default web browser. Click FwDirect.asmx. FrameworkDirect Installation & User Guide 16

17 3. The FwDirect web service will open. Click on the Pharmacy List function. 4. Click the Invoke button. 5. If the web service is running correctly, then a list of the pharmacies in the FrameworkLTC databases will be returned. FrameworkDirect Installation & User Guide 17