Difference between revisions of "AMS Setup"

From Adjutant Wiki

(Created page with "__NOTOC__ ==Overview== This is a guide for consultants to use to set up an AMS connection from start to finish. Setup typically takes a few hours and involves making connect...")
 
(Overview)
Line 4: Line 4:
 
This is a guide for consultants to use to set up an AMS connection from start to finish. Setup typically takes a few hours and involves making connections from the Eclipse software to the Adjutant database.  
 
This is a guide for consultants to use to set up an AMS connection from start to finish. Setup typically takes a few hours and involves making connections from the Eclipse software to the Adjutant database.  
  
The ultimate goal is to establish an ODBC connection from Eclipse to Adjutant reading a specific set of data tables. The function of the integration is for Adjutant to pass order and bundle information into Eclipse/AMS and to receive back production and material usage information.  
+
The goal is to establish an ODBC connection from Eclipse to Adjutant reading a specific set of data tables. The function of the integration is for Adjutant to pass order and bundle information into Eclipse/AMS and to receive back production and material usage information.
 +
 
 +
In the past, AMS Integration involved sending flat files across the servers back and forth with the necessary data. As of today, the most efficient way to pass data back and forth is by a direct SQL data transfer.  
  
 
This set up assumes a hosted connection, though non-hosted connections have a similar and at times identical setup.
 
This set up assumes a hosted connection, though non-hosted connections have a similar and at times identical setup.

Revision as of 12:50, 1 September 2020

Overview

This is a guide for consultants to use to set up an AMS connection from start to finish. Setup typically takes a few hours and involves making connections from the Eclipse software to the Adjutant database.

The goal is to establish an ODBC connection from Eclipse to Adjutant reading a specific set of data tables. The function of the integration is for Adjutant to pass order and bundle information into Eclipse/AMS and to receive back production and material usage information.

In the past, AMS Integration involved sending flat files across the servers back and forth with the necessary data. As of today, the most efficient way to pass data back and forth is by a direct SQL data transfer.

This set up assumes a hosted connection, though non-hosted connections have a similar and at times identical setup.

Rule Setup

When appropriate, you may need to enter a sentence or two to relay additional information immediately below the header and before you begin the steps.

Example Image.png

  1. When referencing how a customer should access the desired Screen Name, format the menu path like Transaction > System > Change Running User.
    • Notice that the menu path and screen name should be bold.
  2. All Action list buttons like Cancel Changes for example, should also be bold.
  3. Whenever possible, consolidate steps using the #* bullet points.
    • This can help keep the numbered list from growing to a high number.
    • For example, a how-to with 23 steps can be more intimidating and make a simple procedure look like too many steps.
    • But the bullet points break it up.
  4. As long as you don't skip spaces between the # characters, it will auto number. Even a single space can mess it up.
  1. Review carefully, because a skipped space will mess up the sequencing.
  2. Continue the steps using the same pattern.


Setup Options

Consider whether or not an additional note is required to give an overview or additional information about this step. For example, if this is an optional step, or a step that maybe some customers will not need to complete - that information could be entered here.

Delete this section if the process only requires a single section.

  1. If the process involves multiple screens or multiple, distinct steps, break it up into sections using the headers.
  2. Continue using the same format for additional steps.


Eclipse Setup

This section is an optional place to document any follow-up steps, further considerations, or links to other pages that may be helpful. Delete this section if it is not needed.

Just for reference, below is an example of an indented bullet list, along with guidance for when to use bold formatting.

  • Menu Paths should be bold for easy reference
    • Screen Names should be bold
      • Tab Names inside of screen should also be bold
        • Field Names should generally be bold. There may be cases where using single quotes for a 'field name' is appropriate.
          • 'Sections' in a screen such as the 'Customer' section label in the Order Entry screen should use single quotes
          • 'Column labels' in a grid should generally use single quotes
          • 'OK' or 'Cancel' buttons (or any other buttons on a pop-up message) should have single quotes
  • I have used italics for things like Report Names when I am referring to the report and not the screen name for the report, and for filenames.xlsx

Updating the Category tags is critical to helping customers find content. Review the Categories list and tag all categories below