How to Upload a Desire to Learn Export Into Folio

UXPROD-531 - Getting issue details... STATUS

Problem(s)

1. Libraries often create orders in their own LSP organization to keep track of order commitments and manage receiving. If the library has no means of transmitting this information to the relevant vendors they would need to manually re-create these orders in a vendor system.
2. Creating orders in a vendor system requires the library to commencement confirm in their ain system whether they currently own the material or non. If the order can exist created in the library system and electronically sent it helps prevent the duplication acquisitions piece of work.

Use Cases & Requirements

Requirement	Status	Utilize cases
Generate EDIFACT format files based on FOLIO Orders.	VERIFIED	Library currently communicates all orders with big vendors via EDI. This reduces the corporeality of duplicate endeavor needed to manage acquisitions through this vendor. Oft this is because the vendor could non or would not support a direct API integration with their ILS arrangement Users need to confirm that they don't already own or have an outstanding or for the material they want to acquire. This is near easily washed in the LSP system. Libraries volition then check multiple vendors to compare pricing before conquering.
Ship orders in different formats equally specified in the Organization record. Eg EDIFACT format, email etc	VERIFIED	Library needs to configure unlike EDI details for unlike organizations. Often files need to be uploaded to different directories or use unlike naming conventions or different codes Horrasawitz does not accept standing orders via EDI so the library volition send PDFs via mail or electronic mail.
Send orders based on different export method configurations for the same vendor. Configure multiple consign methods per Organisation record	VERIFIED	The establishment has multiple libraries there will be unlike pickup and dropoff directories for the EDI files. Meaning ii separate EDI files would be uploaded to two separate directories OR two separate FTP locations. Eg. ane for Chief library and one for Law Some accounts with different envelope addresses (Library EDI codes) may exist included on the same EDI file OR the library may demand to take them exported on separate files.
Allow user to bespeak they desire the order to be sent Later the guild has been opened. "Automate consign" tin can be edited after society is opened. Nevertheless, once exported this field must be locked down an user must explicitly land they want the order exported again for it to be included in a second export file.	VERIFIED	When nosotros know files are existence uploaded subsequently in the twenty-four hour period to the FTP location, someone may discover that an order was included on the wrong file. To correct this they volition edit the order and point information technology should exist exported and save. This should let this order to be included in the file before it is uploaded to the Vendors FTP location at the set time. The library has not noticed that the box was checked and would like to uncheck the consign box after information technology was opened merely earlier it was included in the export. Library occasionally will want to re-send an society in a "new" export file. Say at that place has been a change of Vendor.
Transport orders in dissimilar formats for the same Organization based on account number	VERIFIED	For a given vendor the library may send virtually orders through EDI simply treat some club types differently. Data that drives the identification of a dissimilar communication method Business relationship number (Team/location/Acquisition unit of measurement. These would likely exist represented by business relationship number) Acquisition method (for diff methods the social club may of may not exist exported for a given Vendor) Social club type (Old, Ongoing, Ongoing-subs) Material type (this could be a concern but generally if it is information technology volition be backed into the account number or order type)
Limit what orders are sent based on Acquisition method for a given vendor	VERIFIED	For some material types the library will send order info through EDI but for others, they may create orders in the vendor systems and recreate in Page. The library volition differentiate between rush and non-rush. Non-rush orders going through EDI and Rush orders going through e-mail Orders that are identified as certain acquisition methods should NOT be exported because the Vendor would already have these orders.
Allow library to trigger a "Resend" for the generated file	VERIFIED	If something goes incorrect with the upload to ftp (Which does happen) nosotros need to be able to resend the EDI file, without regenerating it and sending boosted orders along with it. Eg. If order was changed from difficult cover to paperback we would want to ship in a new file.
Brandish consign summary on POL. Allow user to click a link and find the consign file in the export log area.	VERIFIED	Generally not many users are involved in trouble shooting EDI issues. Being able to discover the file that a specific vendor did non receive is important but would be washed by administrators.
In that location is a separate permission for download or resend consign	VERIFIED	It is helpful for users to be able to identify the sent date and condition of export etc. but just admins should be able to manage exports.
Allow user to immediately send ane specific lodge to a vendor in EDI format. Sent on it'southward own file? Aye Transmit via FTP or other? Other, sent via email.	VERIFIED	For blitz orders we have the power to choose to send an order immediately in EDI format. This file is sent equally a single record via email to the vendor. These are sent to a specific address noted in the Vendor tape. They are sent with specific subject and via an email address specified in the Vendor file.

Proposed workflow

• Conquering method is a converted to a controlled vocabulary

Option ane:

• Default "Automate consign" Yes/no, is prepare by acq method and applied to orders created for that organization accordingly. If it equals yep that orders will be a part of the export job

Selection 2:

All acquisition methods can trigger the "Export by default" for specific Organizations. User assigns organizations to conquering methods in settings

Choice 3:

All acquisition methods can trigger the "Consign by default" for specific Integrations. User identifies acquisition methods the default export to true in integration settings

• Each organization can have multiple "Integration methods" and each method is configured separately. Ie. It is possible to have multiple EDI configurations, Email, csv etc.

• Each organisation account number can be associated with one Integration method. (Ie. EDI 1 OR EDI 2)
• Each export configuration can have multiple accounts associated with information technology. (Ie. EDI 1 tin be assigned 3 accounts) NOTE nosotros would need to consider No business relationship specified as a split up consignment for organizations that have no accounts configured.
• Each Integration method may have more than 1 manual method. In the screenshot you see FTP and Email every bit possibilities. ane method is prepare every bit the primary and used by default for all transmissions

• The Politician every bit a whole will have "Automate consign" checkbox fix and will have the "Consign method" determined by account number. All the same, it can be adapted on an lodge by order basis if the user desires.

Note: "Export method" is only editable if Automate export = true

• Each order line could have a different account number (Or no account number) associated with it. This will attach it to the right export details for the format selected at the PO level. Ie. if EDI is selected the account may indicate EDI 1 or 2 etc. If e-mail it could be different per account likewise
• In this workflow the consign path for acq method + business relationship number = export details for Politico.

Consign details summary is exist presented on the POL then user tin can hands confirm what happened with an export

• Accordion contains fundamental details of the export

Orders tin be filtered based on the post-obit export details

• Export date (Appointment range)
• Export method (Select list) Hard because of organization dependency.

Guild unopened and reopened

• When an order is beingness opened that was previously export. Ie. if user unopened an guild to edit it and reopens over again.
• User is intercepted by confirmation modal and must determine to reset the order for export. If yes it will be included in the next export for the assigned vendor.

Ship Immediately

• For urgent orders user can choose to send immediately
• The orders trigger an firsthand export and are sent on their own file via the transmission method

View export history

View export history for a specific export type past clicking the associated link or push button

Arrive at the full screen view of the export history for that arrangement

Using export manager

Using Organizations

Hybrid approach

Workflow diagram:

User Questions

Question	Status	Conclusion	Comments
Should the determination to consign exist determined past the acq method on the Political leader and be based on organization?	CLOSED	Yeah, this provides the flexibility we need.	This allows consign decisions to exist based on the Organization AND Conquering method.
Should dissever POLs potentially have different consign settings?	Airtight	This is not needed at the Pol. Nor is it necessary to accommodate the export method per POL beyond the default. Information technology would either exist Automate export or Not.	No utilize cases were identified for creating orders with multiple POLs for different accounts that should have dissimilar export details.
Do export details need to be shown at the PO level?	Closed	Yeah display consign details for PO equally a whole	Most institutions will create separate orders for split accounts which ways the export data will ofttimes exist relevant for the lodge as a whole
How volition this relate to renewals?	Open up		Waiting for use cases via Slack aqueduct to confirm. No specific use cases brought forward in meeting.

Vendor Questions

Question	Status	Determination	Comments
Do you have multiple configurations for individual libraries?	Closed	Fifty-fifty if the the library or entities within the library have different base accounts they MAY accept separate Library EDI Codes or not. Folio will need to let different configuration to have the same library editing code and vendor editing lawmaking.	If there were going to be multiple configuration in that location would likely be multiple vendor records. This is generally the example when there are separate base accounts.
Do you divide orders past account in carve up EDI files in in a single file?	Airtight	Split up accounts sometimes appear on the aforementioned file in the same location. They tin can also be separated, this is not a concern for the vendor processing and is common exercise.	From the GOBI perspective the aforementioned customer may send multiple files in a single twenty-four hour period. It is unusual to accept split locations for an individual establishment. It typically happens when you lot take 1 base account merely separate subs for law, bus, etc. which volition be uploaded to diff directory locations.
Does the file need a specific identifier?	CLOSED	Doesn't have to be specific format just needs to be unique over time	What the ID is is not really a concern and then long as the file names are non duplicated. If you are going to "re-send" a file within 90 days. The danger is if the file proper name is the same it will not be "Reprocessed" considering GOBI keeps track of what'due south been processed.
Does the library need to contact GOBI when a file needs to exist "Re-loaded"?	Airtight	As long as they have a resend part they can contact the vendor and the vendor volition sort out the file.	The concern is more that the file never attain gobi. Ie. it wasn't successfully uploaded. In this instance it would need to be resent.

Evolution Questions

Question	Status	Decision	Comments
If user unopens lodge and reopens should this order be exported again?	Closed	No, exporting order in a 2d file should crave explicit instruction from a user. Ie. a specific action that they trigger	Frequently times new orders will exist created when pregnant details change. There are some situations where meaning details modify but we don't want the order to be sent.
How are the export dates managed? What volition exist the start and end date of each export?	CLOSED	Export based on what has not been sent still. If user triggers the re consign for an order the flag should be reset so the order can be included on a new export.	Build the consign file based on what orders have not yet been sent for a given vendor. When we try to ship a previously exported guild the system shows error bulletin Build base of operations on orders that have been opened and not exported nevertheless.
Should nosotros allow different POLs on a single order to be exported via different methods	Open up		This is not something libraries currently do, no utilise cases were brought forward.
If order is updated before re-ship of EDI file. Should the EDI file include updates or but the original information.	CLOSED	Exports can send the latest version of an order. If libraries desire or need to maintain copies they could look to the FTP server or other transmission method for a record of exactly what data was sent	If the Vendor is confirming receipt of EDI files it is not important for u.s.a. to maintain proof of transmission. Generally we rely on an verbal copy actualization in the method of transmission. Ie. in the email account or on the FTP server.
Do nosotros need to be able to consign EDI files with methods other than FTP? Ie. Email?	Closed	We will ultimately need to support multiple manual methods for EDI.	Some vendors require SFTP some FTP. In some cases e-mail is used
User makes changes of the config for which scheduled export orders In Progress  : What is expected behavior? a) existing chore should be stopped and overwritten by new one b) new task should wait completion of active scheduler execution in the queue?	OPEN	When a user makes changes to the export configuration the changes should only bear upon exports with a starting time date/time greater than the date/time the changes were saved.	If an export is in the queue it should non be overwritten. The start date of the export is the well-nigh of import date as the export should include data from that bespeak in time. This would include configuration. If an export was set to run at 5pm there should exist no possibility that it volition include information that we entered into folio afterward that time. Fifty-fifty if the export is waiting in a queue.

Piece of work Breakdown Construction

	Work	Comments	Story	~ Approximate
i	Export must exist based on "Acquisition method" and "Acquisition method" is a converted to a controlled vocabulary.	Dennis Bridges Now "Acquisition method" on the Pol level and non on Society level. Should information technology be moved to Society level? I recall acquisition method should remain at the POL. It may not be important for the exporting of POL merely users may use unlike conquering methods for reporting purposes that all trigger consign.	MODORDSTOR-256 - Getting result details... STATUS MODORDSTOR-258 - Getting issue details... Status MODORDERS-615 - Getting upshot details... STATUS
2	Investigate a difference between FTPS (Secure FTP) and SFTP - https://stackoverflow.com/questions/12803942/secure-ftp-with-org-apache-commons-net-ftp-ftpclient What format is required - FTPS or SFTP? The fact is that there are sure differences between them, and unlike clients are to be used in program lawmaking.Dennis Bridges Some vendorsrequire SFTP and some FTP. Information technology should be reasonable to begin with FTP but we must keep in mind that additional formats volition be needed. Users besides wait to be able to transmit EDI files via e-mail for some vendors Would it be possible to have test admission to similar server for integration verification?Dennis Bridges the FSE squad should be able toassist us in setting something like this upwardly. That squad helped create the FTP server we currently use to test voucher consign.		MODEXPW-33 - Getting issue details... STATUS MODEXPW-39 - Getting issue details... Condition MODEXPW-33 - Getting effect details... Status	5
3	Based on the current architecture and design, the consign configuration should be stored in mod-configuration. CRUD operation should exist done through  mod-data-consign-jump Annotation : !!! Only one configuration is supported in current implementation and refactoring is mandatory!!!		MODEXPS-40 - Getting issue details... STATUS
iv	Check and confirm that initially set upward job is not executed immediately (mod-data-consign) !Checked with Slava Kandramai : Scheduled task run immediately Lawmaking ref : org.page.des.scheduling.ExportTrigger#scheduleTaskWithDayPeriod		MODEXPS-39 - Getting outcome details... STATUS
5	(mod-information-export-bound) Refactor existing approach to shop configuration for Schedulers : The design should be hands extensible for new types of exports and customer requirements for export settings (for now BurSar configuration is hardcoded).		MODEXPS-41 - Getting outcome details... STATUS	3
6	Rework scheduling approach for supporting multiple Cron jobs with different configurations Implement scheduling of the EDIFACT orders export		MODEXPS-42 - Getting upshot details... Status MODEXPS-54 - Getting issue details... Status	8
vii	Implement EDIFACT consign worker (mod-data-export) A new worker should be able to query data from modern-orders, catechumen it from FOLIO format into EDIFACT and upload the effect onto FTP Is there any existing open up-source re-usable implementation, or own implementation is required? UPD: Folijet is using for EDIFACT writes/generates EDIFACT every bit well every bit reads/parses: https://github.com/xlate/staedi. Here's the fasten regarding pick https://issues.folio.org/browse/MODDATAIMP-317		MODEXPW-40 - Getting issue details... STATUS MODEXPW-41 - Getting consequence details... STATUS
8	Move uploading logic on FTP from mod-invoice ( src/main/java/org/page/services/ftp ) to mod-information-export-worker (modernistic-invoice → Kafka → mod-data-export)		MODEXPW-32 - Getting issue details... Condition	3
	Clarify requirements for performance - How many orders have to be processed per 2nd / infinitesimal? Dennis Bridges This task is happening in the background and at a set interval, so performance thresholds are higher. This export should have less than eight hours and ideally it would be less than thirty minutes, so any errors are reasonably possible to troubleshoot and correct before the next business twenty-four hour period. expected information book - Approximate maximum number of orders to exist exported at once?Dennis Bridges encounter comments column but to be safe we should consider the possibility that one export could includethousands of POLs. Library ordering tin be concentrated to specific times of twelvemonth which makes averages unreliable measures. reliability - What is the expected behavior if export process fails during execution? Dennis Bridges ideally If an consign fails an administrator should be alerted via email (Raman Auramau brand sense; demand to add together to configuration). Otherwise a tape of this failure should exist visible in the log with a description of the error that occurred. how long to keep consign job history and store generated files?Dennis Bridgesco-ordinate to the user group information technology does not seem necessary to store generated files every bit historical copies should be available at FTP location or in email when files are transmitted successfully. If not transmittedsuccessfully, so it would be ideal to transmit the most recent information when the manual is triggered again.	Institutions reported that they will send EDIFACT lodge data to an boilerplate of 6-x different Vendors Between 100 and 300 orders per week An average of 50 orders per Vendor per week Conservative estimate would be that a larger file would include 500 orders. Which could be 5000 lodge lines in i single consign file.
	Make performance testing of EDIFACT consign implementation
	EDI consign result download mod-information-consign-jump Add GET API for retriving FILE from SFTP or MINIO Add download functionality in scope of	retry job instead, download our of lotus	To be created MODEXPW-33 - Getting issue details... STATUS	3 SP
	Resend Relieve file in MinIO mod-information-export-jump Add Resend API to move EDI file from MINIO to SFTP (Export type strategy)	out of lotus	MODEXPW-43 - Getting issue details... STATUS To be created	8 SP
	Order/Order line consign history mod-gild-storage  Create table with indexes Create mod-orders export-history API mod-orders Create Event consumer from mod-data-worker-spring	out of lotus except filter by export date iii SP + 1 SP	MODORDSTOR-274 - Getting upshot details... STATUS MODORDSTOR-275 - Getting event details... STATUS To be created	10 SP

Notes (Dennis' comments)

Features:

UXPROD-531 - Getting event details... Condition

UI Stories

Central	Summary	T	Created	Updated	Due	Assignee	Reporter	P	Status	Resolution

MOD Stories

Key	Summary	T	Created	Updated	Due	Assignee	Reporter	P	Status	Resolution

vestalanatuother.blogspot.com

Source: https://wiki.folio.org/display/ACQ/Export+FOLIO+orders+in+EDIFACT+format

Share this post