Wiki

Scale Your Enterprise

User Tools

Site Tools

Trace: • Versago Upgrade • Introduction (Email and Password Configuration) • Links • Filters • Introduction (Global Connections) • contact • Workflow Schedules Version 2.5 and after • Working with the Service Layer • downloads
versago:payment_configuration_and_reports

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
versago:payment_configuration_and_reports [2019/09/19 14:28]
runger [Related Pages] 		versago:payment_configuration_and_reports [2020/11/04 11:19] (current)
dlee
Line 2: Line 2:
  
 This document describes the steps to configure Versago to accept credit card and eCheck payments. It also describes the reports available to provide traceability for Versago Payments processing. This document describes the steps to configure Versago to accept credit card and eCheck payments. It also describes the reports available to provide traceability for Versago Payments processing.
- 
-====== Audience ====== 
- 
-This document is intended for Versago administrators and end-users that are responsible for supporting the payments process. End-users do not have access to the configuration functions. 
  
 ====== Related Pages====== ====== Related Pages======
Line 18: Line 14:
  
 ====== To Begin ====== ====== To Begin ======
- 
-This document is intended for Versago administrators. End-users do not have access to this function. 
  
   * Click on the Admin link in the profile section of the Versago home page to access the Administration console.   * Click on the Admin link in the profile section of the Versago home page to access the Administration console.
Line 32: Line 26:
   * Click on the “Payment Setup” link in the Admin console to begin.   * Click on the “Payment Setup” link in the Admin console to begin.
  
-{{:versago/payments1.png?576x208}}+{{  :versago/payments1.png?576x208  }}
  
   - Select the appropriate **Payment Gateway** from the drop-down list.   - Select the appropriate **Payment Gateway** from the drop-down list.
Line 39: Line 33:
   - Enter the **Merchant Login** provided by your gateway.   - Enter the **Merchant Login** provided by your gateway.
   - Enter the **Merchant Password** provided by your gateway.   - Enter the **Merchant Password** provided by your gateway.
-  - Select the payment method(s) you wish to accept.  \\ \\ <WRAP center round important 50%>+  - Select the payment method(s) you wish to accept.  \\ \\ <WRAP center round important 100%>
 Be sure the checkbox is cleared if you do not want to accept a payment method. In the illustration above, American Express is not accepted and will not be presented as an option for the user. Be sure the checkbox is cleared if you do not want to accept a payment method. In the illustration above, American Express is not accepted and will not be presented as an option for the user.
 </WRAP> </WRAP>
   - Click the Demo option during testing only. This option must be cleared for production operations.   - Click the Demo option during testing only. This option must be cleared for production operations.
  
-====== Mapping SAP Business One Values ====== 
- 
-For the payment information in Versago to be processed into SAP Business One, some specific values must be defined. This is done using the “Versago Payment Info Mapping” form. 
- 
-{{:versago/payments2.png?576x298}} 
- 
-  - Click the look-up (funnel) icon in each credit card field to see a list of credit cards defined in your SAP Business One system. 
-    - Select the card that matches the label on the field. 
-    - The internal SAP code is displayed in the right-hand column. 
-    - If you do not accept a particular type of card (Discover in this example), leave the field blank. 
-  - Click the look-up icon in the “eCheck GL Account” field to select the appropriate GL account where bank transfers will be posted. 
-    - The internal SAP code is displayed in the right-hand column. 
-  - Enter the URL to your Bizweaver instance that will process the payments into SAP Business One. 
-    - Be sure to include HTTP:%%//%% or HTTPS:%%//%% as appropriate. 
-  - Enter the port used by your Bizweaver instance. 
-  - Enter the Bizweaver workflow ID that will process the payments into SAP Business One. 
- 
-**Notes** 
- 
-  * Credit cards must be defined in your SAP Business One system before item 1 can be defined. 
-  * The internal SAP codes are displayed for support purposes only. The user does not need to be concerned with them during the configuration process. 
-  * Your system administrator should be able to provide you with the information needed for items 3 and 4. 
-  * The workflow to process payments from Versago will need to be imported (or created) in Bizweaver before item 5 can be set. This value will be different for each installation. 
- 
-Once any of the codes have been defined and saved, the associated report, “Versago Payment Info Mapping” must be used to review and update values. The maintenance form will not allow more than one record to be created. 
  
 ====== Payment Selection Report Setup ====== ====== Payment Selection Report Setup ======
-Review the [[versago:report_configuration|Reports Configuration]] page. The basic process through the “Display” step is the same for record selection reports. Details of the basic setup are not included in this document.+Review the **//[[versago:report_configuration|Reports Configuration]]//** page. The basic process through the “Display” step is the same for record selection reports. Details of the basic setup are not included in this document.
 ===== To Begin ===== ===== To Begin =====
   * Click on the Admin link in the profile section of the Versago home page to access the Administration console.   * Click on the Admin link in the profile section of the Versago home page to access the Administration console.
Line 94: Line 63:
 The “Record Submission” page is used to configure the report for record selection. When the “Enable Record Submission” checkbox is selected, additional configuration items are displayed. The “Record Submission” page is used to configure the report for record selection. When the “Enable Record Submission” checkbox is selected, additional configuration items are displayed.
  
-{{:versago/recordsub2.png?384x109}} +{{  :versago/recordsub2.png?384x109  }} 
  
 Also select the “Process Payments” option checkbox if this report will be used for accepting and processing credit card and eCheck payments. Also select the “Process Payments” option checkbox if this report will be used for accepting and processing credit card and eCheck payments.
Line 100: Line 69:
 Configuration of Record Submission reports for payments is described in the documents //Versago – Payments Setup//. Configuration of Record Submission reports for payments is described in the documents //Versago – Payments Setup//.
  
-See the [[#record-submission-setup|Record Submission Setup]] section for detailed information on configuring the record submission information.+See the //**[[record_submission_configuration|Record Submission Configuration]]**// page for detailed information on configuring the record submission information.
  
 ===== Calendar tab ===== ===== Calendar tab =====
Line 118: Line 87:
 Charts should not be used with Record Selection reports. Charts should not be used with Record Selection reports.
  
-====== Record Submission Setup ====== +====== Back-End Processing ======
- +
-Record submission setup consists of three parts: Selection Screen setup, Confirmation Screen setup, and database information. +
- +
-===== Selection Screen ===== +
- +
-The Selection Screen setup defines what the users sees on the Report page where they select the items for submission. Click the [**View Example**] button to see a generic version of a record selection screen. +
- +
-{{:versago/recordsub3.png?700}} +
- +
-  - The two checkboxes are required for payment processing +
-    - The “Editable field” selection causes a field with the current value (the open balance of an invoice, for example) to be displayed on the selection page and allows the user to change the value (to pay less than the balance, for example). +
-    - The “Show and submit …” selection causes the values the user enters in the editable field for the selected records to be summed, the sum displayed at the bottom of that column and submitted to the next step in the process which is the confirmation screen. +
-    - These two options can be used for non-payment processes if it makes sense. +
-  - “Submit Button Label” and “Reset Button Label” values are displayed on the corresponding buttons in the report. +
- +
-Here is an example of how the selection page might look, followed by the confirmation page. +
- +
-{{:versago/recordsub4.png?600}} +
- +
-{{:versago/recordsub5.png?384x177}} +
- +
-===== Confirmation Screen ===== +
- +
-The Confirmation Screen setup defines what the users sees on the page where they review the items selected for submission. This setup is required for payment processing. Click the [**View Example**] button to see a generic version of a confirmation screen. +
- +
-{{:versago/recordsub6.png?600}} +
- +
-  - Check the “Include a Confirmation Screen …” checkbox to provide a screen with a summary of their selections. +
-    - This option is required for payments processing and is optional for non-payment record submissions. +
-    - The remaining values in this section are only available if the “Include …” option is selected. +
-  - Enter a title for the confirmation screen. +
-  - Enter any user instructions you would like to include on the confirmation screen. +
-  - Select up to three (3) report fields to be displayed on the confirmation screen. +
-    - These fields are in addition to the “Editable” field defined in the previous section. +
-  - Enter a label for the Submit and Cancel buttons on the confirmation screen. +
- +
-===== Select Database ===== +
- +
-The final piece of the setup process is to define where the information selected by the user will be stored in the database. +
- +
-{{:versago/recordsub7.png?384x91}} +
- +
-  - Select a database from the “Database” drop-down list. +
-    - The process for defining databases is found ** here **. +
-  - Enter a database table name where the information will be stored. +
-    - The general rules for the name are no spaces or special characters other than an underscore as shown in the image above. The name should be something that will help other people understand its purpose. +
-    - The table is created the first time the submission information is defined. +
-    - If additional columns are added to the report, they are automatically added to the table the next time this step in the configuration is passed. +
-    - If columns that are part of the table structure are removed in the report, they remain in the table. +
- +
-====== Submission Database Table Structure Details ====== +
- +
-As noted earlier, a table to hold the information related to the selected records is stored in a table in the specified database. All record submission tables have the same basic structure as described below. +
- +
-^Column Name                                       ^Type and Size^Notes                 ^ +
-|User columns from initial setup appear first      |             |                      | +
-|vgo_PaymentDate                                   |DateTime     |For payment processing| +
-|vgo_PaymentDetails                                |nvarchar(100)|For payment processing| +
-|vgo_CC_RespCode                                   |nvarchar(50) |For payment processing| +
-|vgo_TransID                                       |nvarchar(50) |For payment processing| +
-|vgo_PaymentType                                   |Int          |For payment processing| +
-|vgo_CreatedBy                                     |nvarchar(50) |Creation information  | +
-|vgo_CreateDate                                    |DateTime     |Creation information  | +
-|vgo_CreatedById                                   |Int          |Creation information  | +
-|vgo_PostingStatus                                 |Int          |Processing control    | +
-|vgo_PostingDate                                   |DateTime     |Processing control    | +
-|vgo_PostingId                                     |Int          |Processing control    | +
-|vgo_BatchId                                       |Int          |Processing control    | +
-|User columns added after initial setup appear last|             |                      | +
-|                                                  |             |                      | +
- +
-  - **Payment Processing** items are used by the internal payment process. These values are only populated for payment transaction. +
-  - **Creation Information** items are populated for all transactions. +
-  - **vgo_CreatedBy**: Versago user ID (email) that created the transaction. +
-  - **vgo_CreateDate**: Date and time the transaction was created. +
-  - **vgo_CreatedById**: Versago internal user ID number. +
-  - **Processing Control** items can be used to manage back-end processing using tools such as Bizweaver. +
-  - **vgo_PostingStatus**: Typically used to indicate if a record has been processed by the back-end. +
-  - **vgo_PostingDate**: Typically used to capture when a record has been processed by the back-end. +
-  - **vgo_PostingId**: Typically used to capture the ID number of the record created during back-end processing. +
-  - **vgo_BatchId**: A sequential number added by the application when a set of records is added to the database. This value can be used to process a group of records together during back-end processing. +
- +
-====== Database Trigger for Processing ======+
  
 In a Versago environment, back-end processing is typically done using Bizweaver. The information here refers to Bizweaver but other process flow tools might be used as well. In a Versago environment, back-end processing is typically done using Bizweaver. The information here refers to Bizweaver but other process flow tools might be used as well.
Line 207: Line 93:
 Most record submission reports will have an associated Bizweaver workflow to handle additional processing. For payments this might be creating SAP Business One Incoming Payment transactions. Or it might be updating the status on a group of orders. Most record submission reports will have an associated Bizweaver workflow to handle additional processing. For payments this might be creating SAP Business One Incoming Payment transactions. Or it might be updating the status on a group of orders.
  
-There are two ways to initiate this processing. One is to have the Bizweaver workflow set on a schedule so that it executes periodically during the day. Second is to initiate the workflow when the submission is saved to the database. For the second option a database trigger is used.+There are two ways to initiate this processing. The most basic approach is to have the Bizweaver workflow set on a schedule so that it executes periodically during the day.
  
-The SQL database needs to be initialized to allow triggered (immediate) processing to occur.  The initialization process is described **//[[bw:call_bizweaver_web_service_from_sql_server|here]]//**. +The more sophisticated approach is to initiate the workflow when the submission is saved to the database. For the second option a database trigger is used.
- +
-The following discussion assumes that you have some knowledge about database triggers and have access to the SQL Server tools needed to install them. +
- +
-===== Payments Processing ===== +
-A basic database trigger to initiate Bizweaver processing for payments will look like this. +
- +
-<code sql payments_trigger_sql.txt> +
-CREATE TRIGGER [dbo].[twbs_tr_VersagoPayments] +
-ON [dbo].[Versago_Payments] +
-AFTER INSERT +
-AS +
-BEGIN +
--- SET NOCOUNT ON added to prevent extra result sets from +
--- interfering with SELECT statements. +
-SET NOCOUNT ON; +
--- +
-DECLARE +
-@vgo_BatchID INT, +
-@object INT, +
-@url VARCHAR(5000), +
-@bw_url nvarchar(100), +
-@bw_WorkflowID int, +
-@bw_port int, +
-@pArgVariableName nvarchar(50) +
--- +
-/* It may be necessary to change all instances of "vgoCommon" to a different name if you have used a different name */ +
-select +
-t0.BW_URL, t0.BW_Port, t0.BW_WorkflowID +
-from vgoCommon..twbs_vgo_payment_InfoMapping t0 +
--- +
-set @pArgVariableName = 'vgo_BatchID' +
-select @vgo_batchid = (select vgo_batchid from inserted) +
-select @bw_url = (select t0.bw_url from vgoCommon..twbs_vgo_payment_InfoMapping t0) +
-select @bw_port = (select t0.bw_port from vgoCommon..twbs_vgo_payment_InfoMapping t0) +
-select @bw_Workflowid = (select t0.BW_WorkflowID from vgoCommon..twbs_vgo_payment_InfoMapping t0)  +
--- +
-SELECT @url = @bw_url + '/BWService/api/workflow/InvokeWorkFlow?pTaskID=' + cast(@bw_WorkflowID as varchar) + '&pStartAfter=0&pArguments={' + @pArgVariableName + ':' + CAST(@vgo_BatchID AS VARCHAR) + '}' +
-EXEC sp_OACreate 'MSXML2.XMLHTTP', @object OUT; +
-EXEC sp_oamethod @object, 'open', NULL, 'get', @url +
-EXEC sp_oamethod @object, 'send'SELECT @url +
---select @responsetext as [Response] +
--- select @url +
-EXEC sp_oadestroy @object +
-END +
-</code> +
- +
-The following video illustrates this process. +
- +
-{{ :versago:versago_db_trigger_demo.mp4?800 |DB Trigger Demo}}. +
- +
-====== Reports Overview ====== +
- +
-Two main reports are provided for users to review payment transactions and resolve issues. These reports are Versago Payments Recap and Payments Transaction Log. The standard location for these reports is in the ‘Payments Admin” menu category. +
- +
-====== Versago Payments Recap Report ====== +
- +
-Detailed information about successful payment transactions can be viewed using the “Versago Payments Recap” report. This report displays details about each transaction, including invoices paid, information sent to the processing gateway, and the response from the gateway.+
  
 <WRAP center round important 60%> <WRAP center round important 60%>
-This report utilizes a SQL View as the data source.  The View must be created manually in the database.  Code to create the View is provided below.  +The following discussions assumes that you have some knowledge about database triggers and have access to the SQL Server tools needed to install them.
 </WRAP> </WRAP>
  
-Create the view in the **VersagoData** database (or whatever database name you may be using to capture Versago form data). +The SQL database needs to be initialized to allow triggered (immediate) processing to occur.  The initialization process is described **//[[bw:call_bizweaver_web_service_from_sql_server|here]]//**.  Examples of the trigger used to initiate Bizweaver processing are then found in the lower section of the page.
-<code sql> +
-CREATE view [dbo].[vgo_vw_PaymentTransactions] as +
-select distinct +
-t0.vgo_transid, +
-(select sum(x0.BalDue) from Versago_Payments x0 where x0.vgo_transid = t0.vgo_transid group by x0.vgo_transid) as [TtlAmtPaid], +
-CASE t0.vgo_paymenttype +
-when 1 then 'Credit Card' +
-when 2 then 'eCheck' +
-END as [TransType], +
-cast(t0.vgo_paymentdate as date) as [vgo_PaymentDate], +
-(select count(*) from Versago_Payments x0 where x0.vgo_transid = t0.vgo_transid) as [DocCount], +
-t0.vgo_PostingStatus, t0.vgo_PostingDate, t0.vgo_PostingId +
-from Versago_Payments t0 +
-</code> +
- +
- +
-Use the [[#payments-transaction-log-report|Payments Transaction Log]] report for information about unsuccessful transactions. +
- +
-===== Versago Payments Recap – Main Report ===== +
- +
-{{:versago/payments3.png?700}} +
- +
-  - Expand the row to see a list of invoices paid. +
-  - The “SAP Posting Status” indicates if the transaction has been posted into SAP Business One. +
-    - “0” indicates that the transaction has not been processed. +
-    - “1” indicates that the transaction has been posted successfully. +
-    - “9’ indicates that the transaction posting failed. +
-      - Click on a “9” to see the reason the SAP posting failed. +
- +
-{{:versago/payments4.png?700}} +
- +
-  * Click the __Transaction ID__ link to view details of the transaction. +
- +
-===== Payments Log Sub-report ===== +
- +
-{{:versago/payments5.png?700}} +
- +
-  - Click on the __CC Request__ or __eCheck Request__ link as appropriate to view the information that was sent to the gateway for processing. +
- +
-===== Payments Log Request (CC and eCheck) Sub-report ===== +
- +
-{{:versago/payments6.png?700}} +
- +
-{{:versago/payments7.png?700}} +
- +
-===== Payments Response (CC and eCheck) Sub-report ===== +
- +
-{{:versago/payments8.png?700}} +
- +
-{{:versago/payments9.png?700}} +
- +
-  * Click on the __Response__ link to view the information that was sent to back from the gateway. +
- +
-====== Payments Transaction Log Report ====== +
- +
-The Payments Transaction Log report is like the Payments Processing Recap report, except that it shows both successful and unsuccessful transactions. +
- +
-Note that the “Transaction ID” for unsuccessful transactions begins with “E” followed by the log record ID, and the date & time of the transaction. +
- +
-{{:versago/payments10.png?700}}+
  
-  - Click on the “CC Request” or “eCheck Request” link as appropriate to view the information that was sent to the gateway for processing. 
-  - Click on the “Response” link to view the information that was sent to back from the gateway. 
  
-In general, the “Response” information will be the most helpful for troubleshooting unsuccessful transactions since it shows the reason a transaction was rejected. 
  
versago/payment_configuration_and_reports.1568917700.txt.gz · Last modified: 2019/09/19 14:28 by runger

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial 4.0 International
CC Attribution-Noncommercial 4.0 International Valid HTML5 Valid CSS Driven by DokuWiki