CLICK Documentation
Videos Available
Note that all of these topics are available in videos on YouTube.
Table of Contents
CLICK in a Nutshell
CLICK is a tool available to AgGateway members that helps business analysts and developers comprehend and implement AgGateway Open Standards.
Getting Started with CLICK
Download
Log in at http://www.aggateway.org.
In the menu, select eConnectivity | eConnectivity Tools |CLICK. (This may change in the future as AgGateway improves the structure of its website.)
Click on the download link.
Install
Go to your download folder.
Right click on the zip file.
Choose properties.
Check the Unblock checkbox if you see one.
Click OK.
Right click on the download file.
Choose Extract All.
Choose a folder to which you would like the files extracted (e.g., Documents folder).
Once the files are extracted, go to that folder.
Run
Double click on the CLICK folder.
Double-click on CLICK.exe to launch the application.
Create a Desktop Shortcut (optional)
Right click on CLICK.exe.
Choose Send To from the pop-up menu.
Choose Desktop (create shortcut).
Go to desktop.
Double-click the shortcut to launch CLICK.
User Interface Overview
In the top-right is CLICK version 3.1.0.0. Your version is likely to be a later version.
Next is the standard and version dropdown list.
CLICK supports AgGateway Open Standards going back to version 4, OAGi Chem eStandards going back to version 4, and AgXML version 4.
Next is the Context dropdown list.
Over the years, AgGateway has collected notes on implementing standards in various contexts, e.g., crop protection for Canada, seed and feed for the United States.
Next is the Open New Window button, which will be addressed later in this documentation.
In the Search section, you can search by All Elements in the standard, or by Messages Only.REPLACE
Choose Messages Only.
In the search box, type order.
Note that the search results include any message with order in its name, which includesOrderChange where Order begins the message name and RetailerOrderSummaryReport where Order occurs in the middle of the name.
Click on one of the search results and note that the structure is shown in the treeview in the center.
Next, search All Elements.
Search for product.
As you may expect, there is a large number of search results. There are so many, that it exceeds the current supported number of search results displayed.
You may need to narrow your search to find the results you seek.
Search ordercreate.
As it appears in the search results, click on it so that its structure appears in the main tree view.
As you click on the disclosure triangles, the structure unfolds.
As you click on various items, in this case ProductIdentifier, content on the right is filled in for that selected item.
For ProductIdentifier, we see the definition: The unique code or number for a specific product.
We see Notes, which includes synonyms.
We see a list of Parent Elements.
We see a list of Messages in which ProductIdentifier appears.
When you click on Agency, there is no information to the right. However, there is a code list which includes AGIIS-ProductID, ANSI, AssignedByBuyer, and others.
There are a number of visual cues in CLICK.
Items that are in bold indicate required, which is supported by the occurrence listed after the item.
For example, Header indicates 1..1, which means a header is required. One is required and only one is permitted.
Moving down to OrderCreateProductLineItem, it indicates 1..*, which indicates that one is required but many may occur.
There are also icons to the left of the text, that give some indication of whether or not an element has structure, or whether it is just a value and whether or not an item may occur many times.
The icon next to OrderCreateProductLineItem is a structure icon with a plus sign on it, which indicates that there can be more than one. That visual cue is complemented supported by the text that follows, 1..*.
Consider ShipNotice.
Choose the USA | Feed context.
Choose ShipNoticeStatus.
Hide Parent Elements and Messages to provide more room and resize the Notes section.
You then will see that there is a Context Note.
The notes indicate that when you implement ShipNotice in the context of a feed related process in the United States, that this note applies.
It says, "In this context [USA | Feed] the elements use is conditional [i.e., depends on the situation]. If a ShipNotice is updated, then send Update as the status otherwise would not use this on an original ShipNotice."
Notice that when you click on ShipNoticeStatus in the Search Results, which brings ShipNoticeStatus to the top, the context notes go away. This is a very important point because context notes require a drill-down starting at the root of a message.
Click on ShipNotice in the Messages section to go back to the top.
Switch back to OrderCreate.
Drill down to ScheduleDateTimeInformation under the OrderCreateProductLineItem.
Examine DateTimeInformation. Notice that it is composed of a choice. An implementer would choose DateTime, or DateTimeRange as required.
CLICK indicates this by having a Choose... item in the treeview with enclosed options.
Notice that when you hover the mouse over DateTimeRange, a tool tip appears.
In this case it says "Structure for ranges of date/time information. All DateTime elements need to conform to ISO 8601."
Next, examine ContractProductLineItem.
Note that a child of ContractProductLineItem is itself, ContractProductLineItem. If you drill down on that you see another ContractProductLineItem.
This is recursive. CLICK allows you to keep drilling down as far as you want.
As we'll see later, when we produce Excel documentation, that situation is addressed by just including the first occurrence and just adding the word recursive in parenthesis afterwards.
Another CLICK feature, is to right-click on an element and choose Hoist from the context menu.
Doing so hoists the selected element to the top and that makes it the root of the displayed tree.
Another handy feature is Open New Window. Click on Open New Window.
Doing so creates a new window.
Set the windows side by side and hide various panels.
In the left panel, choose AgGateway Open Standards Version 4.0.0.
Search for Partner Information again.
You'll notice that in Version 4, UnloadingPoint and LoadingPoint are just text.
In Version 5.3, they are structures.
A final feature to note is that you can navigate by using the arrow keys. Click on an item in the tree view, and the up and down arrow keys go up and down. The right-left arrow keys will expand or collapse structures.