Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

eLandings WIKI Documentation includes the following:

eLandings Overview & Presentations about the system https://elandings.alaska.gov/confluence/pages/editpage.action?pageId=983
The training system and training scenarios http://elandingst.alaska.gov/
eLandings System Interface Docuementation including web service and XML documentation https://elandings.alaska.gov/confluence/display/doc/eLandings+System+Interface+Guide
Glossary of FisheriesTerms https://elandings.alaska.gov/confluence/display/doc/Glossary
ELandings Users Guide https://elandings.alaska.gov/confluence/display/doc/eLandings+Users+Guide
tLandings overview https://elandings.alaska.gov/confluence/display/doc/tLandings+Overview
Overview of ELandings PDF https://elandings.alaska.gov/confluence/download/attachments/11502381/Overview+of+eLandings.pdf?version=1&modificationDate=1245091076000
Communication between two different systems  https://elandings.alaska.gov/confluence/download/attachments/16976018/eLandings+support.ppt
Extracting data from eLandings https://elandings.alaska.gov/confluence/display/doc/Extracting+Report+Data+from+eLandings
Submitting Reports to eLandingshttps://elandings.alaska.gov/confluence/display/doc/Submitting+Reports+to+eLandings
Processing eLandings XML tutorials - https://elandings.alaska.gov/confluence/display/tr/130pm+-+430+--+Processing+XML+using+Software+Libraries
Work through one of the actual XSD XML tutorials in .Net or Java https://elandings.alaska.gov/confluence/display/tr/.NET+Tutorial+-+Processing+XML+Using+Software+Librarieshttps://elandings.alaska.gov/confluence/display/tr/Java+Tutorial+-+Processing+XML+Using+Software+Libraries

In addition, third-party developers, who opt to make use of the eLandings Public Web Services, should read and pay particular attention to:
1. Public Web Service Documentation
a. https://elandings.alaska.gov/confluence/display/doc/Public+Web+Service+Documentation
In addition, third-party developers, who opt to design their application around the eLandings web pages, should read and pay particular attention to:
2. Limit Modification Requests to General System Improvements and Bug Fixes
The eLandings team has attempted to create general systems that meet the needs of a large user group. The eLandings team is often asked to customize these general systems to meet the specific needs of small subsets of the user group. Typically, upon review, these customizations are found to create confusion or difficulty for other subsets of the larger user group. Such requests are often denied. However, each request takes eLandings team time and resources to review. The eLandings team would ask that third-party developers limit their requests to general system improvements and bug fixes. Customizations designed to meet a small subset of the user group should be implemented within third-party applications.
3. Direct Questions to the eLandings Team
The eLandings team recognizes that third-party developers will run into questions that they cannot yet be answer using the online documentation or through experimentation within the eLandings Training system. The documentation and system are constantly under active development. When these resources are exhausted, it is appropriate to direct questions to the eLandings email group, which includes everyone on the eLandings team. Using this email group will help your questions reach someone who can answer your question. We would discourage initially contacting a specific eLandings team member as they may be out of the office or allocated to other tasks. We would also request that third-party developers not contact eLandings contractors as these contractors may not be under contract to field your voracious questions.
4. Acquiring Report Numbers
Interfacing systems are required to download a report identifying number from the eLandings system for each report that the interfacing system will submit. Sets of report numbers can be downloaded in anticipation of future reports. Each number downloaded shall be used for one, and only one, report.
Failure modes: if an interfacing system generates its own numbers and uses them to submit reports then report collisions can occur. If a report number is not already on the system then the collision may not occur immediately. If an interfacing system reuses a report number then a prior report may be unintentionally overwritten.
Exceptions: if an interfacing system generates a report, but has a user submit it through the Report Import web page then the report number in the report will be replaced with a new number generated on the eLandings system. The interfacing system can get this number by having the user input it, or by having the user download the resulting report on eLandings and feed it back to the interfacing system.
For additional information see:
getLandingReportNumbers() https://elandings.alaska.gov/confluence/display/doc/getLandingReportNumbers%28%29
<ARE THERE OTHER WAYS TO DO THIS? ¿ Add link or documentation>
5. Acquiring Fish Ticket Numbers
Interfacing systems are required to download fish ticket numbers from the eLandings system for each report that the interfacing system will submit. Sets of fish ticket numbers can be downloaded in anticipation of future reports. Each number downloaded shall be used for one, and only one, report.
Failure modes: if an interfacing system generates its own fish ticket numbers and uses them to submit reports then confusion can result. The reports will be saved successfully, but referencing reports by fish ticket number may result in the wrong report being referenced.
Exceptions: if an interfacing system generates a report, but has a user submit it through the Report Import web page then the fish ticket numbers in the report may be replaced with new number generated on the eLandings system. This depends on whether or not the fish ticket numbers in the report are importable numbers, retrieved from the Importable Numbers web page. If the fish ticket numbers are replaced the interfacing system can get them by having the user input them, or by having the user download the resulting report on eLandings and feed it back to the interfacing system.
For additional information see:
getFishTicketNumbers() https://elandings.alaska.gov/confluence/display/doc/getFishTicketNumbers%28%29
<ARE THERE OTHER WAYS TO DO THIS? ¿ Add link or documentation>
6. Uploading Reports
Interfacing systems are required to upload reports one at a time. That is, one call to eLandings for each report. No capability for mass upload of a single file containing multiple reports will be provided. Multiple report uploading would increase the complexity of error feedback to interfacing systems if reports have errors.
For example, let us say that uploading 100 records typically takes your application two minutes to run. If the upload fails after 1 minute and 17 seconds, how do you recover? How do you know which records were uploaded and which failed? Compare this to a single report upload situation. If you are uploading a single report and it fails, it is very easy to pinpoint what report failed to upload. It is easier to write error handling to handle errors in uploading a single report at a time.
Requests for a multiple report upload capability should not be made to the eLandings development or support team.
For additional information see:
File Import <THIS PAGE OF DOCUMENTATION COULD BE EXPANDED> https://elandings.alaska.gov/confluence/display/doc/File+Imports
Manually importing & extracting reports via XML <THIS PAGE OF DOCUMENTATION COULD BE EXPANDED> https://elandings.alaska.gov/confluence/pages/viewpage.action?pageId=21692855
saveLandingReport() https://elandings.alaska.gov/confluence/display/doc/saveLandingReport%28%29
submitInitialLandingReport() https://elandings.alaska.gov/confluence/display/doc/submitInitialLandingReport%28%29
submitFinalLandingReport() https://elandings.alaska.gov/confluence/display/doc/submitFinalLandingReport%28%29
saveProductionReport() https://elandings.alaska.gov/confluence/display/doc/saveProductionReport%28%29
submitProductionReport() https://elandings.alaska.gov/confluence/display/doc/submitProductionReport%28%29
<ARE THERE OTHER WAYS TO DO THIS? ¿ Add link or documentation>
7. Wasting Report and Fish Ticket Numbers
Interfacing systems should not download excessive numbers of report and fish ticket numbers, and then not use them in reports. Interfacing systems may have some unused numbers left over at the end of the season, but this number should not be excessive.
Failure modes: if too many fish ticket numbers are downloaded then the number could roll over. This would happen if 1 million fish ticket numbers were requested in one year. The reports that used the duplicate numbers could be stored, but this would cause confusion. If too many report numbers are downloaded this will cause the report number magnitude to grow, but we have at least a billion numbers before this is a problem. However, if we reach that threshold reports will not be accepted.
If the eLandings team discovers excessive number requests, these numbers may be severely rationed.
For additional information see:
getLandingReportNumbers() https://elandings.alaska.gov/confluence/display/doc/getLandingReportNumbers%28%29
getFishTicketNumbers() https://elandings.alaska.gov/confluence/display/doc/getFishTicketNumbers%28%29
<ARE THERE OTHER WAYS TO DO THIS? ¿ Add link or documentation>
8. Extracting Reports
Interfacing systems are required to download reports one at a time. That is, one call to eLandings for each report. No capability for a mass download will be provided. The capability for multiple reports in a download exposes eLandings to problems with system limits on performance and numbers of elements in a single XML document. Requests for a multiple report download capability should not be made to the eLandings development or support team.
Exceptions: the Report Extract web page allows users to get a set of reports in a single download. This is subject to a 1000 report limit, and may be subject to errors if other limits are exceeded.
For additional information see:
File Exports <THIS PAGE OF DOCUMENTATION COULD BE EXPANDED> https://elandings.alaska.gov/confluence/display/doc/File+Exports
Data Extract Web Page <This page of documentation does not exist yet ¿ please create it>
Manually importing & extracting reports via XML <THIS PAGE OF DOCUMENTATION COULD BE EXPANDED> https://elandings.alaska.gov/confluence/pages/viewpage.action?pageId=21692855
findUserLandingReports() https://elandings.alaska.gov/confluence/display/doc/findUserLandingReports%28%29
getLandingReport() https://elandings.alaska.gov/confluence/display/doc/getLandingReport%28%29
findUserProductionReports() https://elandings.alaska.gov/confluence/display/doc/findUserProductionReports%28%29
getProductionReport() https://elandings.alaska.gov/confluence/display/doc/getProductionReport%28%29
<ARE THERE OTHER WAYS TO DO THIS? ¿ Add link or documentation>

9. Searching for Reports
Interfacing systems can search for reports by a limited set of criteria. The available criteria are: 1. Processor identifying numbers ¿ Processor Code and Federal Permit Number. 2. Date ranges ¿ report date and last update date. 3. Tender operation identifiers ¿ Tender ADF&G number and tender batch. Interfacing systems are expected to set the processor identifying numbers to limit searches to their own reports.
For additional information see:
eLandings Web Page Search Functionality <This page of documentation does not exist yet ¿ please create it>
Data Extract Web Page <This page of documentation does not exist yet ¿ please create it>
findUserLandingReports() https://elandings.alaska.gov/confluence/display/doc/findUserLandingReports%28%29
findUserProductionReports() https://elandings.alaska.gov/confluence/display/doc/findUserProductionReports%28%29
<ARE THERE OTHER WAYS TO DO THIS? ¿ Add link or documentation>

  • No labels