User Journey: Export a portfolio to ORE
Table of Contents
This page documents a user journey: An operations user writes a set of trades out as the ORE portfolio the engine reads.
A user journey describes what one person is trying to do, before anything is built. It is a design document that outlives any sprint. These trade journeys are use cases, so they name the operations and messages each step needs and leave the screens to the UX standards.
1. Goal
"I want the ORE portfolio the engine reads, made from the firm's trades, so that a run uses what the firm holds." The journey is done when the person has the file, or the file is in storage for a run, and the person knows which trades it holds.
2. Actor and trigger
The actor is an operations user, or the compute grid acting for one. The trigger is a run that needs a portfolio. The journey starts with a choice of trades and ends with a file or a storage reference.
3. Steps
- Choose the trades. The person chooses a book, a portfolio or a list of trades.
- Check them. The system says which trades it cannot export and why.
- Export. The system writes the portfolio file, or writes it to storage.
- Read the result. The system reports the number of trades and the location of the file.
4. Screens
This journey is a use case. It is the Export action in the Workflows menu of the trade list. It also serves the compute journeys, which need a portfolio in storage.
The Trades prototypes draw it in ore-portfolio with ?mode=export. No wireframe is drawn here. The prototype story draws the screens, from the
UX standards and from this use case.
5. Entities composed
This journey adds no entity of its own. It reads and writes the trade and the records on its page.
6. Operations and messages
| Step | Operation | Subject | Status |
|---|---|---|---|
| Export | Export the portfolio to the caller | trading.v1.ops.export_portfolio |
exists |
| Export | Export the trades to storage | trading.v1.ops.export_trades_to_storage |
exists |
Status is one of exists, partial, or missing. A subject that contains
<instrument> stands for the one instrument table the trade type routes to. The plural
is written with a plain s. A table whose plural is irregular, such as
trade_activities, has its own subject: check the protocol header, not the pattern.
7. What is missing
- The choice of trades by portfolio, by book and by list is not verified against the two requests.
- A trade the export cannot write is reported how? Check the response.
- The task "Export the trades as the ORE portfolio the engine reads" is in flight in another environment. Read it before this journey is built.
8. Related journeys
- Import a portfolio from ORE — to bring trades in.
- Review a trade and its history — to read the trades before they leave.