View
10
Download
0
Category
Preview:
Citation preview
Copyright © 2016, 2017, Oracle and/or its affiliates. All rights reserved.
TPM – Viewpoint Vista Technical Manual
Version 1.0 May 2, 2017
Page 2
Table of Contents Overview ........................................................................................................................................ 3
Description .................................................................................................................................. 3 Viewpoint Vista Subcontracts and Subcontract Change Orders exported to TPM .................... 3
Viewpoint Vista Compliance exported to TPM .......................................................................... 3 Viewpoint Vista AP Invoices imported from TPM .................................................................... 3 Viewpoint Vista AP Invoice Reversals imported from TPM ..................................................... 3 Viewpoint Vista AP Payments imported from TPM .................................................................. 3
Design Methodology...................................................................................................................... 4 Automated Solution for Interfaces .............................................................................................. 4
Viewpoint Objects ......................................................................................................................... 4
Database Objects ........................................................................................................................... 4 Field Mappings .............................................................................................................................. 5
Subcontracts ................................................................................................................................ 5 Change Orders ............................................................................................................................ 6
Compliance ................................................................................................................................. 7 Invoices / Invoice Rejections ...................................................................................................... 7
Payments ..................................................................................................................................... 9
Job Streams ................................................................................................................................. 10 Subcontracts .............................................................................................................................. 10
Change Orders .......................................................................................................................... 10 Compliance ............................................................................................................................... 11 Invoice....................................................................................................................................... 12
Invoice Rejections (Reversal) ................................................................................................... 13
Payments ................................................................................................................................... 13
Payment Integration Preconditions........................................................................................... 14
TexturaLink................................................................................................................................. 14 System Requirements: .............................................................................................................. 14 Installation: ............................................................................................................................... 14
Configuring TexturaLink .......................................................................................................... 16 TexturaLink Configuration Parameters .................................................................................... 16 TexturaLink Home Screen ........................................................................................................ 17
Page 3
Overview
Description This document contains a comprehensive explanation of the Viewpoint Vista/Oracle Textura Payment Management Interface. There are five components of this interface:
1. Viewpoint Vista Subcontracts and Subcontract Change Orders exported to TPM
2. Viewpoint Vista Compliance exported to TPM
3. Viewpoint Vista Accounts Payable Invoices imported from TPM
4. Viewpoint Vista Accounts Payable Invoice Reversals imported from TPM
5. Viewpoint Vista Accounts Payable Payments imported from TPM.
Viewpoint Vista Subcontracts and Subcontract Change Orders exported to TPM
Subcontracts and Commitment change orders against those subcontracts for jobs using TPM will be extracted and imported into TPM. Requests initiated from TexturaLink will use a JDBC driver to connect to Textura views in the Viewpoint database.
Viewpoint Vista Compliance exported to TPM
Compliance requirements tracked on a subcontract tracked in TPM will be imported into TPM. These records will initiate holds or releases in TPM based on the status as it is tracked in Viewpoint. Requests initiated from TexturaLink will use a JDBC driver to connect to Textura views in the Viewpoint database.
Viewpoint Vista AP Invoices imported from TPM
Subcontract Invoices are created in TPM and exported to the Viewpoint Vista Accounts Payable system. The import of Invoice voucher data is initiated by TexturaLink either on a scheduled basis or on-demand using web services. Invoices are imported using Viewpoint’s standard import tables and routines and a Textura specific import template.
Viewpoint Vista AP Invoice Reversals imported from TPM
Subcontract Invoices are created in TPM and exported to the Viewpoint Vista Accounts Payable system once they are approved in TPM. If a subcontractor invoice that was previously approved and exported from TPM is later rejected by the GC, TPM will send an invoice rejection record to reverse the existing payable. The import of an Invoice reversal is initiated by TexturaLink either on a scheduled basis or on-demand using web services. Reversal invoices are imported using Viewpoint’s standard import tables and routines and a Textura specific import template.
Viewpoint Vista AP Payments imported from TPM
Payments made to subcontractor invoices are created in TPM and exported to the Viewpoint Vista Accounts Payable system once funds are disbursed and verified. Payments are imported using Viewpoint’s standard import tables and routines and a Textura specific import template.
Page 4
Design Methodology
Automated Solution for Interfaces Due to the need for an automated solution, the following design methodology was adopted:
1. All data to be imported into Viewpoint Vista will use the standard import tables (IM), routines,
and Textura specific templates and procedures
2. All data extracted from Viewpoint Vista will use Textura specific views that are called from
TexturaLink using a direct database connection and JDBC
3. All integration points can be scheduled or invoked by a user using TexturaLink.
Viewpoint Objects
Object Name Object Type Notes
AP Inv Txt Import Template Used to import AP Invoices into Viewpoint
AP VInv Tx Import Template Used to import AP Invoice Reversals into Viewpoint
AP Pay Txt Import Template Used to import AP Payments into Viewpoint
Textura Short Pay Hold Hold code Used for partial payment integration into Viewpoint
Textura User User Name Viewpoint user with proper access (only applicable when using data security)
ExcludeFromTextura Custom Field Custom field for excluding certain Subcontracts from exporting to TPM
Database Objects
Object Name Object Type Notes
Textura Database User Used by TexturaLink to connect to the database
TexturaSubcontract View Subcontract Header View
TexturaSubcontractItems View Subcontract Details View
TexturaChangeOrder View Subcontract Change Order Header View
TexturaChangeOrderItems View Subcontract Change Order Details View
Textura Compliance View Subcontract compliance view
txtbspAPHBInsertExistingTrans Stored Procedure Used for Processing Payment Imports
txtbspIMUploadRejection Stored Procedure Used for Processing Invoice Reversal Imports
txtspIMUploadHeaderDetailPay Stored Procedure Used for Processing Payment Imports
txtspIMUploadShortPay Stored Procedure Used for Processing Payment Imports
Vendor Name Procedure Stored Procedure Used for Processing Payment Imports
txtvspIMUploadAPDB Stored Procedure Used for Processing Retention Imports
Page 5
Field Mappings
Subcontracts Header
Table Field TPM Field Notes
bSLHD SLCO & Job Main Job Number Company number and Job number combined, example 01-1234
bSLHD Vendor Vendor Id
bSLHD SL Subcontract Number
bSLHD Description Description
bSLIT WCRetPCT Default Retention Percentage
If multiple retention rates are on lines, use the MAX percentage
bSLIT OrigCost Subcontract Amount Sum of base contract amount of Items
bSLHD ExcludeFromTextura Must be False
Details
Table Field TPM Field Notes
bSLHD SLCO & Job Main Job Number Company number and Job number combined, example 01-1234
bSLHD Vendor Vendor Id
bSLHD SL Subcontract Number
bSLIT SLItem Subcontract Item Number
bSLIT Description Component Description
bSLIT Phase Account Code
bSLIT JCCType Category Code
bSLIT WCRetPCT Component Retention Percentage
bSLIT OrigCost Component Amount
bSLIT TaxCode Tax Code
bSLIT OrigUnits Quantity
bSLIT OrigUnitCost Unit Price
bSLIT UM Unit of Measure
Page 6
Change Orders Header Table Field TPM Field Notes
bSLHD SLCO & Job Main Job Number
Company number and Job number combined, example 01-1234
bSLHD Vendor Vendor Id
bSLHD SL Subcontract Number
bSLCD SLChangeOrder Change Order Number
bSLCD ActDate Change Order Date
PMSubcontractCO Description
Change Order Title
PMSubcontractCO Notes
Change Order Description
bSLHD ExcludeFromTextura Must be False
Details Table Field TPM Field Notes
bSLHD SLCO & Job Main Job Number
Company number and Job number combined, example 01-1234
bSLHD Vendor Vendor ID
bSLHD SL Subcontract Number
bSLCD SLChangeOrder Change Order Number
bSLCD SLItem Subcontract Item Number
bSLIT Phase Account Code If multiple account codes on lines, use the first
bSLIT JCCType Category Code
If multiple category codes on lines, use the first
bSLCD ChangeCurCost Component Amount Sum of change order amount per item
bSLCD ChangeCurUnits Quantity
bSLCD ChangeCurUnitCost Unit Price
bSLCD UM Unit of Measure
bSLCD Description Component Description
bSLIT TaxCode Tax Code
Page 7
Compliance
Table Field TPM Field Notes
bSLHD SL Contract Number
bSLHD Vendor Vendor ID
bSLCT
Description & CompCode & Seq Description
Combination of Description, Compliance Code, and Sequence number, example "Liability Insurance, LI-1"
APVC Memo
bSLCT ReceiveDate Issue Date
bSLCT ExpDate Expiration Date
bSLHD SLCO & Job Main Job Number
Company number and Job number combined, example 01-1234
bSLCT Verify
HQCP Comp Type
bSLCT Complied bSLCT CompCode
bSLCT Seq
Status
Received Logic: If it is a Date type item, expiration date must be greater than the current date and Verify must equal TRUE. If it is a Flag type item, complied must equal TRUE
Invoices / Invoice Rejections Header Field Description TPM Field
Co Company Company code from Project Number
Mth Month First of the Draw Month. If month is closed, choose next open month.
Vendor Vendor VendorId
APRef AP Reference InvoiceNumber & RevisionID
Description Description Project # : Draw #
InvDate Invoice Date InvoiceDate
InvTotal Invoice Total InvoiceGrossAmount
PayMethod Pay Method (C/E) "C"
PrePaidYN PrePaid (Y/N) "N"
CMCo CM Company Company code from Project Number
CMAcct CM Account BankCode
PayOverrideYN Payment Override (Y/N) "N"
ReleaseRetgFlag Release Retainage Indicator
RetentinIndicator
Page 8
Details Field Description TPM Field
Co Company Company code from Project Number
Mth Month First of the Draw Month. If month is closed, choose next open month.
APLine AP Line SubcontractItemNumber
LineType Line Type "7"
SL SubContract SubcontractNumber
SLItem SubContract Item SubcontractItemNumber
JCCo Job Cost Company Company code from Project Number
Job Job Lookup based on Subcontract Item
PhaseGroup Phase Group Lookup based on Subcontract Item
Phase Phase Lookup based on Subcontract Item
JCCType Job Cost Type Lookup based on Subcontract Item
CostCode Cost Code Lookup based on Subcontract Item
GLAcct General Ledger Account Lookup based on Subcontract Item
UM Unit of Measure UnitOfMeasure
Units Units Quantity
UnitCost Unit Cost UnitPrice
ECM (E=1/C=100/M=1000) "E"
GrossAmt Gross Amount ItemGrossAmount
MiscAmt Miscellaneous Amount 0
MiscYN Miscellaneous (Y/N) "N"
Retainage Retainage ItemRetentionHeld
BurUnitCost Burden Unit Cost 0
BECM Burden (E=1/C=100/M=1000) "E"
SMChange Stored Material Chg 0
Page 9
Payments Header Field Description TPM Field
Company Company Company code from Project Number
Month Month First of the Payment Month. If month is closed, choose next open month.
CMCo CM Company Company code from Project Number
CMAcct CM Account ERPBankCode
CMRef
CM Reference Number CheckNumber
PaidDate Paid Date PaymentDate
Vendor Vendor VendorID
Name Vendor Name Lookup from Vendor Record
Amount to be paid
Amount to be Paid CheckAmount
Detail Field Description TPM Field
Company Company Company code from Project Number
Month Month First of the Payment Month. If month is closed, choose next open month.
APRef
AP Reference Number InvoiceNumber & RevisionID
Retainage Flag Retainage Flag If RetentionAmount <> 0 then "R" ELSE NULL
Amount to be paid
Amount to be Paid
If Retainage Flag = "R" then RetentionAmount ELSE ItemGrossAmount
Subcontract number SubContract SubcontractNumber
Page 10
Job Streams
Subcontracts
Change Orders
Page 11
Compliance
Page 12
Invoice
Page 13
Invoice Rejections (Reversal)
Payments
Page 14
Payment Integration Preconditions 1. A Textura Short Pay Hold must be created as a hold code in Viewpoint.
2. The CM Account used for Textura invoices and payments must be set up as the ERP Bank Code in TPM (Edit Organization/ERP Bank Code).
TexturaLink The TexturaLink application is installed on a dedicated server or virtual machine in the client’s environment. TexturaLink connects to the Viewpoint Vista application using web service requests the Textura user created during the setup of the integration package.
System Requirements: Java 8 or above
Windows 7 (64 bit), Windows Server 2008 (64 bit) and later
At least 5gb of RAM
10gb of free hard drive space
Microsoft .NET Framework version 4.5
Installation: 1. Navigate to http://services.texturacorp.com/ebis/texturalink/installer/ to download the
installer.
2. Enter a valid TPM username and password, and click Next.
3. Choose the Viewpoint lib adapter in the left dropdown list. The current version will be auto-
selected, and click Next.
Page 15
4. Choose the installation location, and click Next.
5. Change the Log Level to Debug.
6. Check the box to Setup Windows Service, and click Next.
7. This will proceed with the installation. Click Finish to close the installer.
8. Open the Windows Task Manager, and click on the Services tab. Right click on textura-
Viewpoint-lib and select Start. This will start the service.
Page 16
9. Open a browser and enter http://localhost:9292 to open TexturaLink. It may take a few minutes
to start. Localhost can be replaced with the actual server name for users to connect to
TexturaLink from outside the TexturaLink server.
Configuring TexturaLink Click on the Textura Org User tab to enter the Textura TPM username and password
TexturaLink will use to connect to TPM. Click on Create New to enter the credentials,
and then click on Save.
Click on the Configurations tab.
The following configuration properties will need to be added:
TexturaLink Configuration Parameters
Object Name Description Point of Use
Enable.split.exports.by.mainjob If enabled, separate import IDs will be created per job number in Viewpoint IM Upload
Invoices/Rejections/Payments
Textura.Service.url Textura environment URL for TexturaLink.
All
Link.local.filepath Folder location for storing audit log files from TexturaLink
All
Schedule.cron.export.getprojects Enter cron expression to enable the schedule for the Get Projects service
Get Projects
Schedule.cron.import.new.contracts Enter cron expression to enable the schedule for importing subcontracts
Import Subcontracts
Schedule.cron.import.changeorders Enter cron expression to enable the schedule for importing change orders
Import subcontract change orders
Schedule.cron.import.compliances Enter cron expression to enable the schedule for importing compliance records
Import Compliance
Schedule.cron.export.invoices Enter cron expression to enable the schedule for receiving invoices
Invoices
Schedule.cron.export.rejections Enter cron expression to enable the schedule for receiving invoice cancelations
Invoice Rejections
Schedule.cron.export.payments Enter cron expression to enable the schedule for receiving payments
Payments
Click on the Login User tab to create usernames and passwords for TexturaLink users.
Any user that will need to run jobs manually should be set as a ROLE_ADMIN.
Page 17
TexturaLink Home Screen
Legal Notices
Page 18
TPM – Viewpoint Vista Technical Manual
Copyright © 2016, 2017, Oracle and/or its affiliates. All rights reserved.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are “commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate failsafe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.
This software or hardware and documentation may provide access to or information on content, products and services from third-parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.
Recommended