| Excerpt |
|---|
The retrieval system..AX 7 and lower out of the box document retrieval and 3rd party program integration. AX 8 and higher utilizes similar out of the box functionality with a change to the URL format. |
| Table of Contents |
|---|
The below URL is a general format that has been implemented in other environments and is an out of the box solution for AX retrieval.
These settings can be accessed using http://localhost/appxtender/testlaunch from an installed AX web server. The testlaunch needs to be enabled in webconfig before it is accessible (testlaunch enable = "true").
The below uses IsubmitQuery to perform a query on the AX datasource and retrieve documents. This also depends on the use of Active Directory. This is due to the fact that the isubmit query is passing along the currently logged in windows user credentials and verifying with AX and Active directory the permissions associated with the user/group.
There is also an Idocument option that does similar task but and requires docid and or with optional page number for the document to retrieve successfully.
V7- format
V8+ format
ISUBMIT
http://SERVERNAME/AppxtenderAppXtender/DataSources/DATASOURCENAME/ISubmitQuery?AutoLogoutOnClose=True&DocNavBlocked=True&DispMode=11&SearchAllRevisions=True&PublicQuery=False&UpdateAvlFieldsOnly=True&AppName=APPLICATIONNAME&INDEXFIELDINDEXNAME=INDEXVALUE&INDEXFIELDINDEXNAME=INDEXVALUE
Link breakdown:
- Servername = The name of the server where AX web is setup
- Datasourcename = The name of the AX Datasource
- ApplicationName = Name of the AX application retrieving from
- DispMode = What is shown or hidden to the end user retrieving.
- DispMode 1 = Hide Main Page DS App List
- DispMode 2 = Hide All Pages Logout
- DispMode 4 = DocView Page - Hide Menu and Toolbar
- DispMode 8 = Hide DocView Page Doc and Page Menu Items and Index View
- DispMode 11 = Hide Logout, DS App List, DocView Page Doc and Page Menu Items and Index view
| Note |
|---|
Note: Document View Hide Menu and Toolbar option only works for IDocument entry point. |
- Indexfield Indexname = field number index name of the index retrieving such as if "invoice number" is in field1 and want to retrieve by "invoice number" then enter field1.
- IndexValue = the value of the Index field you wish to retrieve. For instance invoice number = 12345 would be field1=12345 in the URL above.
- Add additional Indexfield Indexname using the & symbol and enter necessary values for retrieval.
- ClientType = You can specify thin client or interactive client (AX 7 and olderprior only)
- Thin Client - Basic view only mode (ClientType=Thin)
- Interactive Viewer - provides users with access to Annotation and other tools to modify documents (ClientType=Interactive)
- Thumbnail viewer - provides access to thumbnail views (ClientType=Thumbnail)
- Interactive w/options - Interactive Client and can disable other tools/menu items (ClientType=MPEDTHLS)
- M - Disable Page Menu
- P - Disable Print Menu
- E - Disable Annotation Edit
- D - Disable Annotation Redaction
- T - Disable Annotation Text
- H - Disable Annotation Highlight
- L - Disable Annotation Shape
- S - Disable Annotation Rubber Stamp
I've Below are some mocked up the url below further examples to emphasize the changes needed to make the URL(s) work.
V7 and below
http://AXSERVER01/appxtender/iDocument.aspx?DataSource=AX&AppName=Invoices&DocNavBlocked=true&DispMode=1&AutoLogoutOnClose=true&DocId=2
http://AXServer01/AppxtenderAXSERVER01/Appxtender/iSubmitQuery.aspx?DataSource=AX&DocNavBlocked=true&DispMode=1&AutoLogoutOnClose=true&AppName=INVOICES&Invoice_number=123456
V8 and above
http://AXSERVER01/AppXtender/DataSources/AX/IDocument/ISubmitQuery?AutoLogoutOnClose=True&DocNavBlocked=True&DispMode=11&SearchAllRevisions=True&PublicQuery=False&UpdateAvlFieldsOnly=True&AppName=INVOICESInvoices&field1DocId=1234562&field5PageNum=INVOICEAbove I specified an additional index field number. In my example field5 is a doctype and Invoice is the specific doctype to match with the previous Invoice number (field1) of 123456.1
Additional Testlaunch information can be found at ApplicationXtender - TestLaunch - Web Integration