ApplicationXtender TestLaunch Usage and
Documentation Guide
This guide is to provide usage of the TestLaunch website in order to generate URL's for use with third party applications to retrieve or import documents into ApplicationXtender.
This guide contains sections, providing definitions The TestLaunch website can be used to generate URLs for use with third party applications in order to retrieve documents from ApplicationXtender.
This guide provides definitions and steps for the different available options when utilizing the
ApplicationXtender TestLaunch page.
To test these options directly, enable the Test Launch page in your AX web.config.
1. Open the web.config file typically located on Web Server at c:\inetpub\wwwroot\appxtender
2. Perform a search for Testlaunch within the document
3. Modify the value from 'False' to 'True'
4. Save the web.config file
The test Launch page can then be accessed using the URL information as below. Use HTTPS when using secure paths.
AX 7 and lower use format – http://servername/appxtender/testlaunch.aspx
AX 8 and higher user format – http://servername/appxtender/testlaunch
The initial display page
Offers multiple target interface options to create a working URL for use outside of ApplicationXtender to reach into ApplicationXtender and perform tasks.
The primary Target Interface options are
• ISubmitQuery – Use to perform queries and display documents
• IDocument – Use to perform retrieval of specific document and page number
• IDocImport – Use to import documents into specific application
• Main Page – Only available in AX 7 and lower
ISubmitQuery - Use to perform queries and display documents
Under Common Parameters:
1. Target Platform (AX 7 and lower) – Only .NET is available.
2. Target Site – Should auto-populate with the current web server base information. If not populate this with http://servername/appxtender
3. Auto Logout on close
1. Default (XsAdmin) (AX 7 and lower) uses the current settings from ApplicationXtender
Admin
2. Check box – overrides the Admin settings to force Automatic logout or not for Isubmit queries when a user closes out their web browser. AX 7 and lower shows option of Yes or No.
4. Block Navigation Check box (AX 8 and higher) – Yes or No (AX 7 and lower) – Yes prevents users from navigating within AX while No allows searching or navigation to other AX applications.
5. Display Mode – Different display modes (DispMode) available to provide end users different views or access to documents. A list of these and some examples are provided in Appendix 1.
6. View Mode (AX 7 and lower only) – Result
| view |
|---|
1. Datasource Application List
1. Displays application list – not available for all display modes
2. Query Criteria
1. Shows the Query search criteria instead of the resulting documents so end user can make adjustments or create a new search
3. Result Set
1. Shows the result set for the query executed. If only one document is returned this will typically be shown instead of the result set. Setting this value will always show the result set.
7. Custom Error Page – used to transfer user to a custom error page – needs to be created and then enter into the box to redirect users in the event an error occurs.
8. Error Pass Thru – used in conjunction with the Custom Error Page
9. Credentials – temporary credentials can be created to test user encryption and pass through to AX website. These encrypted credentials last 20 minutes before they will need to be re- encrypted to test again. AX automatically encrypts and passes through current user credentials so this is primarily used for testing or in the event using a specific user to pass through instead
of the current end user. NOTE – If a user has an account with AX that will always be used. If the
user does not have an AX account the specified user will be passed through encryption process and used to access documents.
1. Enter domain, user and Password and click Generate.
10. Data Source – specify the name of the AX datasource
11. Application Name – Specify the name of the AX Application
12. Client Type (AX 7 and lower only) – Options to view documents
1. Default – uses what is set for the default user accounts within AX Administrator
2. Thin client – Uses a view only viewer – limited options to view document
3. Interactive viewer – Uses the Interactive plugins installed with AX on each user workstation to display documents. This provides access to annotations and other toolbars to interact with the document directly.
4. Thumbnail Viewer
5. Interactive w/options
Under Interface Parameters:
1. Query Type – Normal or Saved query – specify a standard query or use a saved query
2. Saved Query – if using a saved query specify the saved query here
3. Save and Run – save query and run query yes/no
4. Search all Revisions – search all document revisions yes/no or not set
5. Public Query – yes/no – specifies using a public query or a private query
6. Update Fields – show available fields only or all fields
7. Fulltext Query – full text value to query (search a document for specific word if Fulltext engine is licensed and used)
8. Fulltext Query Type – And, Or, Exact or expression – used with Fulltext query to specify additional Fulltext criteria
9. Fulltext Operation – And/Or – Used with FullText – And/Or used in conjunction with Index query
10. FullText Thesaurus – Use Thesaurus with Fulltext search – similar words to those specified in
Fulltext Query
11. ECI (XML) Mode (AX 7 and lower only) – Yes/No – Not typically used.
12. Field Value Criteria
1. Field Name – Enter Field name
2. Field Value – Enter field value
1. Click Add to add to final search criteria
2. Click Delete all to remove any already entered values
13. Hidden Field List
1. Choose index fields to hide or show in result set
1. These settings stay in place unless hidden field set is changed from Hide to Show
2. Choose Hide, Show or clear
1. Hide will prevent index field from showing in result set
2. Show will restore index field in result set
3. Clear clears out current settings in index field result set
Under Target URL:
1. Encrypted – Yes or No option – encrypts URL data when executing to prevent navigation use by anyone that may intercept the URL
2. Path – Full URL path generated when using Compile button
3. Length – shows length of the URL
4. Compile button – generates the URL and populates the path field
5. Launch compiles the URL and launches a browser window using the generated URL in order to test the previously set configurations.
IDocument – Use to retrieve specific document and page if desired
Under Common Parameters:
1. Target Platform (AX 7 and lower) – Only .NET is available.
2. Target Site – Should auto-populate with the current web server base information. If not populate this with http://servername/appxtender
3. Auto Logout on close
1. Default (XsAdmin) (AX 7 and lower) uses the current settings from ApplicationXtender
Admin
2. Check box – overrides the Admin settings to force Automatic logout or not for Isubmit queries when a user closes out their web browser. AX 7 and lower shows option of Yes or No.
4. Block Navigation Check box (AX 8 and higher) – Yes or No (AX 7 and lower) – Yes prevents users from navigating within AX while No allows searching or navigation to other AX applications.
5. Display Mode – Different display modes (DispMode) available to provide end users different views or access to documents. A list of these and some examples are provided in Appendix 1.
6. Custom Error Page – used to transfer user to a custom error page – needs to be created and then enter into the box to redirect users in the event an error occurs.
7. Error Pass Thru – used in conjunction with the Custom Error Page
8. Credentials – temporary credentials can be created to test user encryption and pass through to
AX website. These encrypted credentials last 20 minutes before they will need to be re-
encrypted to test again. AX automatically encrypts and passes through current user credentials so this is primarily used for testing or in the event using a specific user to pass through instead
of the current end user. NOTE – If a user has an account with AX that will always be used. If the user does not have an AX account the specified user will be passed through encryption process and used to access documents.
1. Enter domain, user and Password and click Generate.
9. Data Source – specify the name of the AX datasource
10. Application Name – Specify the name of the AX Application
11. Client Type (AX 7 and lower only) – Options to view documents
1. Default – uses what is set for the default user accounts within AX Administrator
2. Thin client – Uses a view only viewer – limited options to view document
3. Interactive viewer – Uses the Interactive plugins installed with AX on each user workstation to display documents. This provides access to annotations and other toolbars to interact with the document directly.
4. Thumbnail Viewer
5. Interactive w/options
Under Interface Parameters:
Document Id – enter document id to open
Page Number – enter page number of document id to open
Under Target URL:
1. Encrypted – Yes or No option – encrypts URL data when executing to prevent navigation use by anyone that may intercept the URL
2. Path – Full URL path generated when using Compile button
3. Length – shows length of the URL
4. Compile button – generates the URL and populates the path field
5. Launch compiles the URL and launches a browser window using the generated URL in order to test the previously set configurations.
IDocImport – Use to import into Application – can specify specific index field and value to pre-populate. After page loads can then import documents and complete index fields.
Under Common Parameters:
1. Target Platform (AX 7 and lower) – Only .NET is available.
2. Target Site – Should auto-populate with the current web server base information. If not populate this with http://servername/appxtender
3. Auto Logout on close
1. Default (XsAdmin) (AX 7 and lower) uses the current settings from ApplicationXtender
Admin
2. Check box – overrides the Admin settings to force Automatic logout or not for Isubmit queries when a user closes out their web browser. AX 7 and lower shows option of Yes or No.
4. Block Navigation Check box (AX 8 and higher) – Yes or No (AX 7 and lower) – Yes prevents users from navigating within AX while No allows searching or navigation to other AX applications.
5. Display Mode – Different display modes (DispMode) available to provide end users different views or access to documents. A list of these and some examples are provided in Appendix 1.
6. Custom Error Page – used to transfer user to a custom error page – needs to be created and then enter into the box to redirect users in the event an error occurs.
7. Error Pass Thru – used in conjunction with the Custom Error Page
8. Credentials – temporary credentials can be created to test user encryption and pass through to AX website. These encrypted credentials last 20 minutes before they will need to be re- encrypted to test again. AX automatically encrypts and passes through current user credentials so this is primarily used for testing or in the event using a specific user to pass through instead
of the current end user. NOTE – If a user has an account with AX that will always be used. If the user does not have an AX account the specified user will be passed through encryption process and used to access documents.
1. Enter domain, user and Password and click Generate.
9. Data Source – specify the name of the AX datasource
10. Application Name – Specify the name of the AX Application
11. Client Type (AX 7 and lower only) – Options to view documents
1. Default – uses what is set for the default user accounts within AX Administrator
2. Thin client – Uses a view only viewer – limited options to view document
3. Interactive viewer – Uses the Interactive plugins installed with AX on each user workstation to display documents. This provides access to annotations and other toolbars to interact with the document directly.
4. Thumbnail Viewer
5. Interactive w/options
Under Initial Document Index Values:
Field Name – enter field name to index Field Value – enter field value to index Under Target URL:
1. Encrypted – Yes or No option – encrypts URL data when executing to prevent navigation use by
anyone that may intercept the URL
2. Path – Full URL path generated when using Compile button
3. Length – shows length of the URL
4. Compile button – generates the URL and populates the path field
5. Launch compiles the URL and launches a browser window using the generated URL in order to test the previously set configurations.
Main Page – Used to access AX – defaults to main Application list or Query window if using Result set or query result views.
Under Common Parameters:
1. Target Platform (AX 7 and lower) – Only .NET is available.
2. Target Site – Should auto-populate with the current web server base information. If not populate this with http://servername/appxtender
3. Auto Logout on close
1. Default (XsAdmin) (AX 7 and lower) uses the current settings from ApplicationXtender
Admin
2. Check box – overrides the Admin settings to force Automatic logout or not for Isubmit queries when a user closes out their web browser. AX 7 and lower shows option of Yes or No.
4. Block Navigation Check box (AX 8 and higher) – Yes or No (AX 7 and lower) – Yes prevents users from navigating within AX while No allows searching or navigation to other AX applications.
5. Display Mode – Different display modes (DispMode) available to provide end users different views or access to documents. A list of these and some examples are provided in Appendix 1.
6. View Mode (AX 7 and lower only) – Result view options
1. Datasource Application List
1. Displays application list – not available for all display modes
2. Query Criteria
1. Shows the Query search criteria instead of the resulting documents so end user can make adjustments or create a new search
3. Result Set
1. Shows the result set for the query executed. If only one document is returned this will typically be shown instead of the result set. Setting this value will always show the result set.
7. Custom Error Page – used to transfer user to a custom error page – needs to be created and then enter into the box to redirect users in the event an error occurs.
8. Error Pass Thru – used in conjunction with the Custom Error Page
9. Credentials – temporary credentials can be created to test user encryption and pass through to AX website. These encrypted credentials last 20 minutes before they will need to be re- encrypted to test again. AX automatically encrypts and passes through current user credentials so this is primarily used for testing or in the event using a specific user to pass through instead
of the current end user. NOTE – If a user has an account with AX that will always be used. If the user does not have an AX account the specified user will be passed through encryption process and used to access documents.
1. Enter domain, user and Password and click Generate.
10. Data Source – specify the name of the AX datasource
11. Application Name – Specify the name of the AX Application
12. Client Type (AX 7 and lower only) – Options to view documents
1. Default – uses what is set for the default user accounts within AX Administrator
2. Thin client – Uses a view only viewer – limited options to view document
3. Interactive viewer – Uses the Interactive plugins installed with AX on each user workstation to display documents. This provides access to annotations and other toolbars to interact with the document directly.
4. Thumbnail Viewer
5. Interactive w/options
Under Interface Parameters:
1. Query Type – Normal or Saved query – specify a standard query or use a saved query
2. Saved Query – if using a saved query specify the saved query here
3. Save and Run – save query and run query yes/no
4. Search all Revisions – search all document revisions yes/no or not set
5. Public Query – yes/no – specifies using a public query or a private query
6. Update Fields – show available fields only or all fields
7. Fulltext Query – full text value to query (search a document for specific word if Fulltext engine is licensed and used)
8. Fulltext Query Type – And, Or, Exact or expression – used with Fulltext query to specify additional Fulltext criteria
9. Fulltext Operation – And/Or – Used with FullText – And/Or used in conjunction with Index query
10. FullText Thesaurus – Use Thesaurus with Fulltext search – similar words to those specified in
Fulltext Query
11. ECI (XML) Mode (AX 7 and lower only) – Yes/No – Not typically used.
12. Field Value Criteria
1. Field Name – Enter Field name
2. Field Value – Enter field value
1. Click Add to add to final search criteria
2. Click Delete all to remove any already entered values
13. Hidden Field List
1. Choose index fields to hide or show in result set
1. These settings stay in place unless hidden field set is changed from Hide to Show
2. Choose Hide, Show or clear
1. Hide will prevent index field from showing in result set
2. Show will restore index field in result set
1. Clear clears out current settings in index field result set
Under Target URL:
1. Encrypted – Yes or No option – encrypts URL data when executing to prevent navigation use by anyone that may intercept the URL
2. Path – Full URL path generated when using Compile button
3. Length – shows length of the URL
4. Compile button – generates the URL and populates the path field
5. Launch compiles the URL and launches a browser window using the generated URL in order to test the previously set configurations.
Appendix 1
Web AX DispMode and ViewMode Reference Guide
DispMode
Available Options:
'DispMode=1', 'DispMode=2', 'DispMode=4', DispMode=8' and 'DispMode=11'
1. If the DispMode option is left out of the URL, the display mode uses the default settings and all options are available. In the query results screen, the available applications as well as all options are viewable:
Figure 1: Query Result View
2. Image view below with no DispMode set (DocNavBlocked flag is not set below, allowing Application navigation and new searches):
Figure 2: Image view
3. DispMode=1 – "Hide Application List"
a. The same view as using the "DocNavBlocked=true" option – blocks the application list from showing on the left hand side in the query results and prevents navigation to other documents or applications:
Figure 3: Query results view DispMode=1
b. In the Image view with DispMode=1, the option to perform a "new search" is removed, as is the application name to prevent accessing a new search or the application list:
Figure 4: Image view DispMode=1
4. DispMode=2 – Hide Logout Button
a. This option removes the Logout button (see the options above showing the door with the arrow missing from the screen below):
Figure 5: Query result and Image view DispMode 2
5. DispMode=4 – Document View Page: Hide Document/Page Menus
a. This option removes both the Document and Page buttons (as seen in DispMode=1 view above):
Figure 6: Image view - DispMode=4
6. DispMode=8 – Document View Page: Hide Document Operations
a. Removes the Document Operations button leaving only the Page Operations button:
Figure 7: Image View - DispMode=8
7. DispMode=11 – Hide Logout, Application List, and Document Operations
a. This option removes the Application list, blocks Document Operations, and removes the
Logout button from view. This is the most restrictive view/access. Query Result View: Figure 8: Query result view- DispMode=11
Image View:
Figure 9: Image View - DispMode=11
ViewMode – Only available in AX 7 and lower
Available Options:
'Query Criteria' and 'ResultSet'
1. Query Criteria
a. The Query Criteria will bring the link to the Query window and populate the information from the index values populated. This allows the end user to modify the query if needed before executing:
Figure 10: Query criteria view
2. ResultSet
a. The ResultSet option automatically executes the query and displays the result set. If a single document is retrieved, this will be displayed otherwise a list of documents matching the search criteria is displayed:
Figure 11: ResultSet View option
| -file | ||||
|---|---|---|---|---|
|