Docs: EDI admin section updated with new screenshots and SANs info
authorJennifer Pringle <>
Sat, 13 Sep 2014 03:41:57 +0000 (23:41 -0400)
committerYamil Suarez <>
Sat, 13 Sep 2014 03:41:57 +0000 (23:41 -0400)
EDI admin section updated to include screenshots and information
regarding entering the SANs required for EDI to work.

Signed-off-by: Jennifer Pringle <>
Signed-off-by: Yamil Suarez <>
docs/media/create-edi-accounts-2.png [new file with mode: 0644]
docs/media/create-edi-accounts-3.png [new file with mode: 0644]
docs/media/create-edi-accounts-4.png [new file with mode: 0644]
docs/media/create-edi-accounts-5.png [new file with mode: 0644]
docs/media/enter-library-san-2.png [new file with mode: 0644]
docs/media/enter-provider-san-1.png [new file with mode: 0644]
docs/media/enter-provider-san-2.png [new file with mode: 0644]

index c29a9e1..f0eb89d 100644 (file)
@@ -279,57 +279,104 @@ Edit a distribution formula
 To edit a distribution formula, click the hyperlinked title of the formula.
-Many libraries use Electronic Data Interchange (EDI) accounts to order new
-acquisitions. Users can set up EDI accounts and manage EDI messages in the admin
- module. EDI messages and notes can be viewed in the acquisitions module.  See
+Electronic Data Interchange
+Many libraries use Electronic Data Interchange (EDI) accounts to send purchase orders and receive invoices
+ from providers electronically.  In Evergreen users can setup EDI accounts and manage EDI messages in 
+ the admin module.  EDI messages and notes can be viewed in the acquisitions module. See
 also the link:../installation/edi_setup.txt[EDI Installation Instructions]
-because this is required for use of EDI.
+because this is required for use of EDI. 
-The following fields are required to create an EDI account: 
+Entering SANs (Standard Address Numbers)
-host, username, password, path, and incoming directory.
+For EDI to work your library must have a SAN and each of your providers must each supply you with their SAN.
-EDI accounts
+A SAN (Standard Address Number) is a unique 7 digit number that identifies your library.  
+Entering a Library's SAN
-Create EDI Accounts to communicate electronically with providers.
+These steps only need to be done once per library.
-. Create a label. The label allows you to differentiate between accounts for the
-same provider. No limits exist on the number of characters that can be entered
-in this field.
-. Enter a host. Your provider will provide you with the requisite FTP or SCP
-. Enter the username that has been supplied by your provider.
-. Enter the password that has been supplied by your provider.
-. Enter account information. This field enables you to add a supplemental
-password for entry to a remote system after log in has been completed. This 
-field is optional for the ILS but may be required by your provider.
-. Select an owner from the drop-down menu. The owner indicates the 
-organizational units whose staff can use this EDI account. This menu is 
-populated with the shortnames that you created for your libraries in the
-organizational units tree (See Admin -> Server Administration -> Organizational 
+. In Evergreen select _Admin_ -> _Server Administration_ -> _Organizational Units_ 
+. Find your library in the tree on the left side of the page and click on it to open the settings.
-The rule of parental inheritance applies to this list.
+Multi-branch library systems will see an entry for each branch but should select their system's
+top organization unit.
-. The Last Activity updates automatically with any inbound or outbound
-. Select a provider from the drop-down menu to whom this account belongs.
-. Enter a path. The path indicates a directory on the vendor’s server where 
-  Evergreen will deposit its outgoing order files.
-. Enter the incoming directory. This indicates the directory
-  on the vendor’s server where Evergreen will retrieve incoming order 
-  responses and invoices.
-. Enter the vendor account number supplied by your provider.
-. Enter the vendor account code supplied by your provider.
-. Click Save.
+. Click on the _Address_ tab.
+. Click on the _Mailing Address_ tab.
+. Enter your library's SAN in the field labeled _SAN_.
+. Click _Save_.
+image::media/enter-library-san-2.png[Enter Library SAN]
+Entering a Provider's SAN
+These steps need to be repeated for every provider with which EDI is used.
+. In Evergreen select _Admin_ -> _Server Administration_ -> _Acquisitions_ -> _Providers_.
+. Click the hyperlinked name of the provider you would like to edit.
+image::media/enter-provider-san-1.png[Enter Provider SAN]
+. Enter your provider's SAN in the field labeled _SAN_.
+. Click _Save_.
+image::media/enter-provider-san-2.png[Enter Provider SAN]
+Create an EDI Account
+CAUTION: You *must* create your provider before you create an EDI account for the provider.
+. Contact your provider requesting the following information:
+* Host
+* Username
+* Password
+* Path
+* Incoming Directory
+* Provider's SAN
+. In Evergreen select _Admin_ -> _Server Administration_ -> _Acquisitions_ -> _EDI Accounts_.
+. Click _New Account_. A pop-up will appear.
+image::media/create-edi-accounts-2.png[Create EDI Account]
+. Fill in the following fields:
+* In the _Label_ field, enter a name for the EDI account.
+* In the _Host_ field, enter the requisite FTP or SCP information supplied by your provider.
+* In the _Username_ field, enter the username supplied by your provider.
+* In the _Password_ field, enter the password supplied by your provider.
+* Select your library as the _Owner_ from the drop down menu. Multi-branch libraries should select their top level organizational
+ unit.
+* The _Last Activity_ updates automatically with any inbound or outbound communication.
+* In the _Provider_ field, enter the code used in Evergreen for your provider.
+* In the _Path_ field, enter the path supplied by your provider. The path indicates a directory on 
+the provider's server where Evergreen will deposit its outgoing order files.
+* In the _Incoming Directory_ field, enter the incoming directory supplied by your provider. This indicates 
+the directory on the vendor’s server where Evergreen will retrieve incoming order responses and invoices.
+image::media/create-edi-accounts-3.png[Create EDI Account]
+. Click _Save_.
+. Click on the link in the _Provider_ field.
+image::media/create-edi-accounts-4.png[Create EDI Account]
+. Select the EDI account that has just been created from the _EDI Default_ drop down menu.
+image::media/create-edi-accounts-5.png[Create EDI Account]
+. Click _Save_.
 EDI messages
diff --git a/docs/media/create-edi-accounts-2.png b/docs/media/create-edi-accounts-2.png
new file mode 100644 (file)
index 0000000..59f8ad7
Binary files /dev/null and b/docs/media/create-edi-accounts-2.png differ
diff --git a/docs/media/create-edi-accounts-3.png b/docs/media/create-edi-accounts-3.png
new file mode 100644 (file)
index 0000000..6a883b4
Binary files /dev/null and b/docs/media/create-edi-accounts-3.png differ
diff --git a/docs/media/create-edi-accounts-4.png b/docs/media/create-edi-accounts-4.png
new file mode 100644 (file)
index 0000000..8405fee
Binary files /dev/null and b/docs/media/create-edi-accounts-4.png differ
diff --git a/docs/media/create-edi-accounts-5.png b/docs/media/create-edi-accounts-5.png
new file mode 100644 (file)
index 0000000..277d799
Binary files /dev/null and b/docs/media/create-edi-accounts-5.png differ
diff --git a/docs/media/enter-library-san-2.png b/docs/media/enter-library-san-2.png
new file mode 100644 (file)
index 0000000..876cca0
Binary files /dev/null and b/docs/media/enter-library-san-2.png differ
diff --git a/docs/media/enter-provider-san-1.png b/docs/media/enter-provider-san-1.png
new file mode 100644 (file)
index 0000000..3f6037d
Binary files /dev/null and b/docs/media/enter-provider-san-1.png differ
diff --git a/docs/media/enter-provider-san-2.png b/docs/media/enter-provider-san-2.png
new file mode 100644 (file)
index 0000000..acd6f05
Binary files /dev/null and b/docs/media/enter-provider-san-2.png differ