Paradigm Deep Links

Overview

Paradigm now has a special link system known as Deep Links. This feature allow links that begin with paradigmerp:// to allow users open specific records directly in Paradigm from links in emails, websites, intranet pages, or desktop shortcuts.

How to Create Links

To use this link system, the format is:

paradigmerp://open?DocType=<DocumentType>&ParadigmID=<RecordID>

To create links, put values into the link following the “?” question mark that indicate the document type and document ID, separated by the “&” ampersand. Note that the document type and document ID parameters must match exactly, including that they are case sensitive.

Parameters

Document Type

Replace the value “<DocumentType>” with one of the possible options of documents from Paradigm. The acceptable values are listed below. Paradigm uses the value of DocType to know which database table to search in. For example, DocType=Invoice tells Paradigm to search the invoices table, which could return results for Invoices, Credit Memos, or Finance Charges. Setting the parameter to DocType=Customer indicates to the program to search the Customers table.

Record ID

Replace the value “<RecordID>” with the ID that the program should search for in the specified database table. This needs to match exactly the value from the document’s ID in Paradigm, including the case of the letters. The value of ParadigmID=OE-0001234 causes the program to look for a document with the ID “OE-0001234.” The two additional examples ParadigmID=SI-0010025 and ParadigmID=ABCCON001 show how to set the parameter for an invoice ID and customer ID.

Examples

Click on this link to open Paradigm and search for an Order with the ID OE-0001234:

paradigmerp://open?DocType=Order&ParadigmID=OE-0001234

Click on this link to open Paradigm and search for a customer with the ID TEST001:

paradigmerp://open?DocType=Customer&ParadigmID=TEST001

Click on this link to open Paradigm and search for an Inventory Adjustment with an ID of IADJ-0000006:

paradigmerp://open?DocType=InventoryAdjustment&ParadigmID=IADJ-0000006

Valid DocType Values

A large number of document types from Paradigm are supported within the link feature.

Category	Documents Supported	Example
Sales	Order, Quote, Invoice, Trip	paradigmerp://open?DocType=Invoice&ParadigmID=SI-0001234
Accounts Receivable	Receivable, Customer, Customer Prepayment, Finance Charge	paradigmerp://open?DocType=Customer&ParadigmID=ABCCON001
Accounts Payable	Request for Quote, Purchase Order, Purchase Invoice, Payable, Vendor, Vendor Prepayment	paradigmerp://open?DocType=VendorInvoice&ParadigmID=VI-0003344
Inventory	Product, Inventory Adjustment, Inventory Transfer, Inventory Build, Manufacture Order	paradigmerp://open?DocType=Product&ParadigmID=CO4226BLK
General Ledger	General Journal, GL Account, GL Detail	paradigmerp://open?DocType=GeneralJournal&ParadigmID=GJ-0002045
Banking	Write Check, Withdrawal, Make Deposit, Reconciliation	paradigmerp://open?DocType=WriteCheck&ParadigmID=WC-0003456

Suggestions for Using Deep Links

Open a Record from an Email: Click on a paradigmerp:// link in an email to open Paradigm and see the document.

Add a Link to an Intranet Page: Clicking on paradigmerp:// links on internal web pages to open records directly in Paradigm.

Create a Desktop Shortcut: A shortcut on the Windows desktop using a paradigmerp:// link will also take advantage of this feature. Double-clicking this shortcut will open the specific record.

Application Behavior

Paradigm does not need to be open for links to work. If the program is not open, the computer will try to open it and give it the link to guide it to the correct document type. If Paradigm is open already, it will bring the window to the front, and the document will open in that window, rather than opening a second instance of Paradigm. If the system setup includes multiple company files, the deep link will trigger the search to run in the company file that is currently logged in.