RAM Connector - User Guide

RAM Connector - User Guide

Prerequisites

Supported Visual version are 7.0.0 – 10
Database Platform: SQL Server & Oracle
.Net Framework 4.6.2


Installation

Use the following Link to download the setup file. Once downloaded follow these steps to install

Install


Run RAMConnectorInstaller.exe

Click Next


 

Select your version of Visual; Single Site = VM 7.0 or below, Multi Site = VM 7.1x or above



Use the default path or change as needed



Click Install



Lastly, click the Finish button to complete the install






Licensing

Request for a license key can be made via email. Send your request to incident@synergyresources.net and included the product name, company name and local Windows domain name with your request.
On the desktop will be a shortcut to an application titled RAM Product Info.  Use this to register the application, update your license code if needed, and receive updates if available

Enter you license key in the textbox



T
Info
o register the key, click on the save icon to the right
You will receive a message box if the key was successful or failed



Updating


Run the RAM Product Info shortcut from the desktop
Click on the link – Check for Updates


The application will check to see if there are any new published updates



Info
The next screen will confirm if you are on the latest version or if there is an update show a list of features & defects that are a part of the update.
Click close or follow the prompts to update your software.
If updating the application will auto download the update and install.




Validation

Verify Web Connection

By default, the RAM Connector is installed to the Default Web Site in IIS.  To verify connection, navigate to (preferably in Google Chrome or Firefox):

Though an error will occur, this can be considered a success as it is expecting parameters that will be passed in from the Real Asset Management software.

Please see Error Handling section if Chrome or Firefox cannot be used.



Configuration

Follow the Next Steps to configure the RAM connector

Database

In the install folder will be a folder titled DatabaseSQL.  Open the file with the name that corresponds to your database type (IE: SqlServerInstall.sql for SQL Server installs).  Run the script to get the correct database objects into your database.

Asset-4000 Config

Open  Asset 4000



Notes
Base URL: The URL for the RAM Connector API installed.  By default, it would be: http://[NameOfServer]/RAMConnector/api/
NameOfServer: would be the name of the server the API is installed on
Connectivity API: The name of the REST method to be called to test connectivity.  Should be connectivity
AssetImport API:  The name of the REST method to be called to import into Visual’s General Journal.  Should be generaljournal.
Server Name: If using SQL Server, the name of the server the Visual database is located on.
Database Name: The name of the Visual database
User Name: The User Name used to connect to database
Password: The password used to connect to database


Info
Clicking on Test Login will test the stored credentials against the API.  You’ll either get a success message or a failure with the reason why it failed.



Visual

In Purchase Order Entry, there will be a Customizable User Defined Field (CUDF) named “RAM” within the Purchase Order Lines section.  Line(s) that have been vouchered (through Accounts Payable – Invoice Entry) must have this field set to “New” to be retrieved by the API and processed by Asset Management 4000





User Guide


Error Handling

In the installed directory, a folder named “Errors” will be created to hold any error(s) that occur anytime the API is called.  The text file will be named the date in which the error(s) occurred.  All error(s) will be appended to that file until the next day in which a new file will be created with the next day’s date.







Outbound Data From Visual

WEB SERVICE
Verb: GET
Header: DBAUTH

Body: Empty

Purpose: Retrieve Vouchers ready to be processed by Real Asset Management software

Returned XML Example:





Inbound Data From Asset Management

WEB SERVICE
Verb: POST
Header: DBAUTH: 

ACTION: “CLEAR”
Body: Purchase Order + Line Number formatted as PURCHASEORDER-LINE (IE: PO30021-5)
Purpose: Clear status on that Purchase Order & Line Number so they are not retrieved again
Message Response: Boolean (True if successful, error if anything else)



Verb: POST
Header: DBAUTH: 

ACTION: “PROCESSED”

Body:
 

Purpose: Set status of received vouchers to “Processing”
Message Response: Boolean (True if successful, error if anything else)

Verb: POST
Header: DBAUTH: 
 
ACTION: “DELETE”
Body: Purchase Order + Line Number formatted as PURCHASEORDER-LINE (IE: PO30021-5)
Purpose: Set the Purchase Order & Line back to “New” to be processed again (Such as when it is deleted from Real Asset Management software)
Message Response: Boolean (True if successful, error if anything else)


Verb: POST
Header: DBAUTH: 
 
ACTION: “RESET”
Content: Empty
Purpose: Beta only – Reset voucher(s) that have gone through the full cycle of “New” -> “Processing” -> “Clear” so they can be retrieved again – TESTING only
Message Response: Boolean (True if successful, error if anything else)



Verb: POST
Header: DBAUTH: 
 

Content: 
 
Purpose: Import General Journal(s) into Infor Visual
Message Response: Ok (Http Status 200)


Console Test application:  RestfulTest.exe

assembly v4.8.0.0 version 1.0.1.0

This application will require the .config file to be setup per the client connection;
  <appSettings>
    <add key="ServerName" value ="LT-KMAUZOUL-02"/>
    <add key="Database" value="VM9MS"/>
    <add key="UserId" value ="SYSADM"/>
    <add key="PassWord" value="pass"/>
  </appSettings> 

Once these values are set, the code can be run from the Windows Command Prompt  RestfulTest.exe
It will prompt the user to run the following tests, (each of these tests will create a log file (.xml) in the current runtime directory)
  1. Test Connection
  2. Get vouchers
  3. Type PO-Line to get status.  Leave empty to skip
  4. Set Processing on vouchers?
  5. Type PO-LINENUMBER to Reset.  Leave empty to skip
  6. Write General Journal?
  7. Reset assets?




    • Related Articles

    • Troubleshooting RAM / Asset 4000 Connector Error(s)

      Error Handling In the installed directory, a folder named “Errors” will be created to hold any error(s) that occur anytime the API is called. The text file will be named the date in which the error(s) occurred. All error(s) will be appended to that ...

    • Synergy uniPoint Connector - User Guide

      Installation You can find the installation document for Synergy uniPoint Connector here. How to Use Overview Synergy uniPoint Connector can be used in the following Visual windows: Customer Maintenance Customer Order Entry Part Maintenance Vendor ...

    • SmartViews Scheduler User Guide

      PREREQUISITES Supported Visual version are 7.0 – 10.x Database Platform: SQL Server & Oracle Microsoft .Net Framework 4.8 ADMINISTRATION INSTALLING Use the following link to download the setup file. Once downloaded follow these steps to install. Run ...

    • Smartviews Data Connection

      How to Add a data connection? Step 1 : Login to SmartViews and select Designer tab and Click on "Add" a data connection Currently, Smartviews support the following data connection: Microsoft SQL server MS Access MS Excel Oracle ODBC Lillyworks ...

    • SmartViews - User Guide

      Prerequisites: Windows Server 2012R2-2022 Windows 8-11 SQL Server 2012R2-SQL 2019 SQL Server 2017 minimum Cumulative Update (CU) is 31 (14.0.3456.2) Visual 7x- .NET 4.6.2 if outgoing ports are blocked at the organization’s firewall, the following ...