Inventory Visibility and Interoperability Tool. TECHNICAL REPORT WD.B (Part 3 of 4)

Transcription

1 Apolon IV/I Tool User Guide Inventory Visibility and Interoperability Tool Faculty of Organizational Sciences TECHNICAL REPORT WD.B (Part 3 of 4) B5.10 Inventory Visibility Sub-Project: Apolon An Open Source Experimental Inventory Visibility Tool Version Date Comment 0.1 8/15/2006. First functional version /13/2006. Detroit test version. Test case added together with new use cases /03/2007. New use cases added together with other document sections /01/2007 Shared with the AIAG consortium for internal quality control /22/2007 Complete

2 About FOS Our scientific and research mission is aimed at solving particular organizational and management problems as well as innovation in knowledge and capacity building in the Serbian economy. In conditions of intensive changes, FOS grew to be a leading scientific and academic institution, where undergraduate and graduate studies (Specialist, M.Sc., and Ph.D. programs) are offered. Within the FOS Institute for Information Systems, one center and six laboratories perform research and education activities in the fields of information systems and software development methodologies, business process modeling, advanced software architectures, semantic enterprise application integration and interoperability, information systems development, information retrieval and integration on the Web, document and workflow management systems, and databases. FOS faculty especially pride themselves for having developed advanced software systems such as ARTIST, a graphical CASE tool for process and data modeling, and ADMIS, a component-based workflow & document management system for automation of administrative processes. ADMIS includes Electronic Front Office (EFO) and Dictionary of Information Resources of Serbian Government (DIRS). EFO supports use of, government services by providing a fundamental Disclaimers The information contained in this document is the proprietary and exclusive property of FOS except as otherwise indicated. No part of this document, in whole or in part, may be reproduced, stored, transmitted, or used for design purposes without the prior written permission of FOS. The information contained in this document is subject to change without notice. The information in this document is provided for informational purposes only. FOS specifically disclaims all warranties, express or limited, including, but not limited, to the implied warranties of merchantability and fitness for a particular purpose, except as provided for in a separate software license agreement. Privacy Information This document may contain information of a sensitive nature. This information should not be given to persons other than those who are involved in the Athena project or who will become involved during the lifecycle. ii

3 Table of contents About FOS... ii Disclaimers... ii Privacy Information... ii 1 Introduction Document overview Main features Application process Using Apolon IV/I Tool Actor catalogue Use case catalogue Main use cases: Kanban Board Consume Kanban Container Authorize Kanban Container Ship Kanban Container Receive Kanban Container Other use cases Register for use Log In Maintain Kanban Loop Create Kanban loop Update Kanban Loop Delete Kanban Loop Maintain Consumption Document Create Consumption Document Update Consumption Document Delete Consumption Document Maintain Shipment Schedule Document Create Shipment Schedule Document Update Shipment Schedule Document Delete Shipment Schedule Document Maintain Shipment Document Create Shipment Document Update Shipment Document Delete Shipment Document Maintain Receive Delivery Document Create Receive Delivery Document Update Receive Delivery Document Delete Receive Delivery Document References iii

4 1 Introduction 1.1 Document overview This Client User Guide introduces the Apolon web-based client. It specifies the minimum system requirements and detailed installation requirements for the Apolon client on Windows 2000/NT/xp and UNIX based systems. Use this guide to prepare you for using Apolon. This guide is for: Persons with different roles in Kanban process Test executors System Administrators 1.2 Main features Apolon is a tool designed for monitoring and exchange of Electronic Kanban Containers. After the registration process is complete, a party can start using Apolon. Apolon is offered in form of Web Application and it can be used through a standard web browser. These are main features of Apolon IV/I tool: Registering new parties with two different roles: Customer and Supplier Two access levels: Admin and Regular, with different capabilities Other security solutions Maintaining Kanban Loop data and monitoring active Kanban Loops Communication through exchange of Kanbans Creating four types of business object documents Translating BODs into RDF format using domain ontologies Sending and receiving SOAP messages through Web service interface Communication type : many to many Persisting received and sent messages Validating sent and received RDF instances Sending positive and negative responses iv

5 1.3 Application process Several users can be registered to represent each party (customer or supplier). A single user can have REGULAR or ADMIN status that determines which of the tool functionalities he can use. Users with admin status can register other users, define agencies and locations, new items and change Kanban Loop details. Regular users can use main functionalities of IV & I Tool witch means that they can change status of Kanban Containers, create new Business Object Document and send appropriate message over Web-service Interface. There are four main types of BOD that can be created and sent from one side, received and processed by the other side. These types are: 1) Kanban Consumption This document informs other side (supplier) that Kanban Container (or Containers) is EMPTY and that the replacement is needed. When Kanban (or Kanbans) changes its status from FULL to EMPTY, user (client) can create new Kanban Consumption document and adds list of EMPTY Kanbans. 2) Shipment Schedule After we have created proper Kanban Consumption Document, we can authorize shipment of EMPTY Kanbans and define other shipment details. By creating this type of document, party (client) publishes a signal to a supplier that authorizes new shipment. Kanban (or Kanbans) changes its status from EMPTY to AUTHORIZED. 3) Shipment When party (supplier) receives Shipment Schedule Document, it can reply by creating and sending new Shipment Document. This document informs the client that the new shipment was sent toward him. Kanban (or Kanbans) changes its status from AUTHORIZED to SHIPPED. 4) Receive Delivery When user (client) receives new Shipment Document, he knows that the shipment was sent. When the client physically receives shipment, he informs supplier by replying to him with the new Receive Delivery Document. Kanban (or Kanbans) changes its status from SHIPPED to RECEIVED. 2 Using Apolon IV/I Tool 2.1 Actor catalogue Actor catalogue Actor Admin Administrator Customer Supplier Description Admin can execute all available actions This user is responsible for registering parties, users, locations and their possible roles. This user is registered with a customer role. This user is registered with a supplier role. 1

6 2.2 Use case catalogue Use case catalogue Use case Description Actors Kanban board Register for use Maintain party Register users Maintain items Maintain Kanban loop Consume Kanban Container Authorize Kanban Containers Receive Kanban Containers Ship Kanban Containers Provides the insight into Kanban loop and Kanban statuses and provides capability to change Kanban statuses by generating Consume Kanban Container document, Authorize Kanban Container document, Receive Kanban Containers and Ship Kanban Containers for selected kanbans. Provides the ability to register for using Apolon tool. Provides the ability to maintain party data (agency that party has been registered by, locations, contact persons, etc.) Provides the ability to maintain users and their roles for the specific party. Provides the ability to enter and update customer items data. Provides the ability to maintain Kanban loop and Kanban data. Define Kanban loop for Customer, Supplier and item that will be exchanged between them. Provides the ability to create Consume Kanban Container document, or to change it, if it has already been created automatically. Provides the ability to create Authorize Kanban Containers document, or to change it, if it has already been created automatically. Provides the ability to create Receive Kanban Containers document, or to change it, if it has already been created automatically. Provides the ability to create Ship Kanban Containers document. Customer /Supplier Unregistered administrator Administrator Administrator Customer Customer/ Supplier Customer Customer Customer Supplier 2

7 2.3 Main use cases: Kanban Board Use case name Actors Purpose Kanban board Customer/ Supplier The use case executes when Customer/Supplier wants to get the insight into Kanban loop and Kanban statuses or to change Kanban statuses. Pre-Condition There is at least one Kanban loop registered in which that Customer/Supplier is stated as one of the parties involved. Kanban status transition rules were defined. Post- Condition Begins When Kanban status is changed. Customer/Supplier loges on as Customer/Supplier and manually triggers this action by pressing appropriate button. Appropriate user form is presented to user. Steps Customer/Supplier navigates to the specific Kanban loop whose status he wants to see. The system shows kanbans for that specific Kanban loop and their statuses. Customer/Supplier selects kanbans whose statuses he wants to change and then selects on of the following actions: Consume, Authorize, Receive / Ship. Every system action needs to be confirmed. Ends When Exceptions Customer/Supplier selects the action and thus leaves the form. If system could not perform the selected action (due to inappropriate Kanban status transition, etc), appropriate error message with description of an error is shown. Field description KanbanLoop data Attribute name Description RDF mapping KanbanLoopID Customer, Supplier, Ship from, Ship to Kanban loop system ID - Unique, mandatory, system generated. Agency no 3

8 AgencyID. Agency ID is primary key generated by system. no <fos:identifier SchemeAgencyID. Agency ID given by third party (EDIFACT 3055 code list). Unique and mandatory. <fos:agencyid SchemeName. Agency name given by third party (EDIFACT 3055 code list).mandatory. No <fos:identifier <fos:identifiervalue ID Identifier key assigned by agency. <fos:party Name Party name. <fos:partyname> QuantityPerKanban LoopSize Quantity of each Kanban within Kanban loop. Mandatory. Number of kanbans in each Kanban loop. Mandatory. Item Kanban loop defined Item. Mandatory. <fos:item.. <fos:itemid> Item status Effective date time Item status. Kanbanloop effective date time. Kanban data KanbanID EffectiveDateTime Kanban system ID. Unique, mandatory system generated. The date/time at which the status was effective. no <fos:kanban <fos:effectivedatetime KanbanNumber Kanban identifier. Unique within the loop. <fos:kanban <fos:kanbannumber Kanban status Kanban status. Possible values: 1, 2, 3, 4 (Empty, Authorized, Shipped, Full) <fos:kanban <fos:kanbanstatus 4

9 Main usage scenarios are realized through Kanban Board page. Kanban Board is the first page being displayed after the user has logged on. Kanban Board shows the list of active Kanban Loops. Only Kanban Loops which party field matches the party of the logged-in user will be displayed in the table. By default, the loops will be filtered by the user role. If user role is ADMIN, system will show all Kanbanloops. Press to filter table data Navigation Block Press to see loops details By choosing one of the listed Kanban Loops, the user can view the list of Kanbans contained by given loop, along with the loop attributes. The data in the Status column represents the percentage of the Kanbans that are full. Input filtering value Select filter criteria Navigate trough Kanban loops 5

10 Center of the page shows Kanban Loop attributes inside of the panel. List of Kanbans is shown inside of separate Kanban table at the bottom of the page. Single Kanban can be selected by marking adequate checkbox inside of last table column. Kanbans table header has a next list of action blocks: Navigation Block ( - NB -) First page Previous 10 records Previous page Next page Next 10 records Last page Select number of maximum table rows Document block Consume selected Kanbans Authorize selected Kanbans Ship selected Kanbans Receive selected Kanbans Used for selecting target Kanbans. Multiple selections allowed. Navigation block appears at several pages with less or more similar purpose. It should be mentioned that the user has a small control over field values. There are only a small number of fields that can be modified by the user. Application will populate most of a fields based on previously persisted data. Create new document Delete document Save document Confirm document Send message Some of these buttons may appear in other table headers, performing same functionalities on different objects. 6

11 2.3.1 Consume Kanban Container Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Consume Kanban Container Customer Communicating consumption signal to supplier party There is at least one Consumption document persisted in the system. Consumption signal has been sent. Actor manually triggers action by pressing appropriate button. 1. User navigates to the Consumption document based on which he wishes to send Consumption signal. 2. User clicks on the Send button 3. System converts the chosen document to Rdf instance, creates the message and displays the sending details page to the user. 4. User navigates to the address he wishes to send the message to. 5. User clicks on Send message button. 6. Message is sent. Ends When User is redirected to Kanban loop page Exceptions Field description Document data Attribute name Description RDF mapping DocumentID Document type Document status Document system ID. Unique, mandatory, system generated. Type of created document. Mandatory. Possible value:, ShipmentSchedule', Status of created document. Possible values: Created and Confirmed. Mandatory. <fos:documentid> <fos:shipmentschedule No Document date Document creational date and time. ID. <fos:documentdatetime> 7

12 and time Mandatory. Document item data Doc Item ID KanbanID, Kanban number, Kanban status, Effective date time Document item system ID. Unique, mandatory system generated. These fields belong to Kanban object no The User can create new Kanban Consumption Document from the Kanban Board by selecting FULL Kanbans and pressing button. Program creates new Kanban Consumption Document and saves it into database. Selected Kanbans are copied into new Document in form of Document Item. If transaction does not follow Kanban-Status-Transition-Rules, application will ignore it. List of Document Items appears at the bottom of the page as illustrated bellow: 8

13 STEP 1: User navigates to the Authorization document he wishes to send. Navigate STEP 2: User clicks on the Send button Send 9

14 STEP 3: System converts the chosen document to Rdf instance, creates the message and displays the sending details page to the user. STEP 4: User navigates to the address he wishes to send the message to. Navigate STEP 5: User clicks on Send message button. Send 10

15 2.3.2 Authorize Kanban Container Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Authorize Kanban Container Customer Communicating authorization signal to supplier party There is at least one Authorization document persisted in the system. Authorization signal has been sent. Actor manually triggers action by pressing appropriate button. 1. User navigates to the Authorization document based on which he wishes to send Authorization signal. 2. User clicks on the Send button 3. System converts the chosen document to Rdf instance, creates the message and displays the sending details page to the user. 4. User navigates to the address he wishes to send the message to. 5. User clicks on Send message button. 6. Message is sent. Ends When User is redirected to Kanban loop page Exceptions Field description Document data Attribute name Description RDF mapping DocumentID Document system ID. Unique, mandatory, system generated. <fos:documentid> Document type Type of created document. Mandatory. Possible value:, ShipmentSchedule', <fos:shipmentschedule 11

16 Document status Status of created document. Possible values : Created and Confirmed. Mandatory. No Document date and time Document creational date and time. ID. Mandatory. <fos:documentdatetime> Schedule type no Schedule start date time <fos: scheduledstartdatetime> Schedule duration <fos: scheduledduration > Schedule end date time <fos: scheduledenddatetime> Cumulative quantity start date time <fos: cumulativequantitystartdatetime> Last receiving date time <fos: lastreceivingdatetime > Last shipment receive quantity <fos: lastshipmentreceivedquantity > Total received quantity <fos: totalreceivedquantity > Document item data Doc Item ID Document item system ID. Unique, mandatory system generated. no KanbanID, Kanban number, Kanban status, Effective date time These fields belong to Kanban object 12

17 The User can create new Shipment Schedule Document from the Kanban Board by selecting EMPTY Kanbans and pressing button. Program creates new Shipment schedule Document and saves it into database. Selected Kanbans are copied into the new Document in form of Document Item. If transaction does not follow Kanban-Status-Transition-Rules, application will ignore it. List of Document Items appears at the bottom of the page as illustrated bellow: You can add or remove Document items, save or remove document and send it using web service client. Before sending the document, it is necessary to confirm it. You can also create document by clicking at the button, however in that case you need to fill in all the information for Kanban loop by yourself, so we do not recommend this. 13

18 STEP 1: User navigates to the Consumption document he wishes to send. Navigate STEP 2: User clicks on the Send button Send 14

19 STEP 3: System converts the chosen document to Rdf instance, creates the message and displays the sending details page to the user. STEP 4: User navigates to the address he wishes to send the message to. Navigate STEP 5: User clicks on Send message button. Send 15

20 2.3.3 Ship Kanban Container Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Ship Kanban container Supplier Communicating shipment signal to supplier party There is at least one Shipment document persisted in the system. Shipment signal has been sent. Actor manually triggers action by pressing appropriate button. 1. User navigates to the Shipment document based on which he wishes to send Shipment signal. 2. User clicks on the Send button 3. System converts the chosen document to Rdf instance, creates the message and displays the sending details page to the user. 4. User navigates to the address he wishes to send the message to. 5. User clicks on Send message button. 6. Message is sent. Ends When User is redirected to Kanban loop page Exceptions Field description Document data Attribute name Description RDF mapping DocumentID Document system ID. Unique, mandatory, system generated. <fos:documentid> Document type Type of created document. Mandatory. Possible value:, ShipmentSchedule', <fos:shipmentschedule Document status Status of created document. Possible values : Created and Confirmed. No 16

21 Mandatory. Date and time Document creational date and time. ID. Mandatory. <fos:documentdatetime > Actual ship date time Net weight measure Gross weight meas. Document item data Doc Item ID Document item system ID. Unique, mandatory system generated. no The User can create new Shipment Delivery Document from the Kanban Board by selecting AUTHORIZED Kanbans and pressing button. Program creates new Shipment Delivery Document and saves it into database. Selected Kanbans are copied into the new Document in form of Document Item. If transaction does not follow Kanban-Status-Transition-Rules, application will ignore it. List of Document Items appears at the bottom of the page as illustrated bellow: 17

22 STEP 1: User navigates to the Shipment document he wishes to send. Navigate STEP 2: User clicks on the Send button Send 18

23 STEP 3: System converts the chosen document to Rdf instance, creates the message and displays the sending details page to the user. STEP 4: User navigates to the address he wishes to send the message to. Navigate STEP 5: User clicks on Send message button. Send 19

24 2.3.4 Receive Kanban Container Use case name Communicate Kanban Receivement Actors Customer Purpose Communicating Receivement signal to supplier party Pre-Condition There is at least one Receive document persisted in the system. Post-Condition Receivement signal has been sent. Begins When Actor manually triggers action by pressing appropriate button. Steps 1. User navigates to the Receivement document based on which he wishes to send Receivement signal. 2. User clicks on the Send button 3. System converts the chosen document to Rdf instance, creates the message and displays the sending details page to the user. 4. User navigates to the address he wishes to send the message to. 5. User clicks on Send message button. 6. Message is sent. Ends When User is redirected to Kanban loop page Exceptions Field description Document data Attribute name Description RDF mapping DocumentID Document system ID. Unique, mandatory, system generated. <fos:documentid> Document type Type of created document. Mandatory. Possible value:, ShipmentSchedule', <fos:shipmentschedule 20

25 Document status Status of created document. Possible values: Created and Confirmed. Mandatory. No Document date and time Document creational date and time. ID. Mandatory. <fos:documentdatetim e> Received quantity Actual delivery date time Document item data Doc Item ID Document item system ID. Unique, mandatory, system generated. no The User can create new Receive Delivery Document from the Kanban Board by selecting SHIPPED Kanbans and pressing button. Program creates new Receive Delivery Document and saves it into database. Selected Kanbans are copied into the new Document in form of Document Item. If transaction does not follow Kanban-Status-Transition-Rules, application will ignore it. List of Document Items appears at the bottom of the page as illustrated bellow: 21

26 STEP 1: User navigates to the Receive document he wishes to send. Navigate STEP 2: User clicks on the Send button Send 22

27 STEP 3: System converts the chosen document to Rdf instance, creates the message and displays the sending details page to the user. STEP 4: User navigates to the address he wishes to send the message to. Navigate STEP 5: User clicks on Send message button. Send 23

28 2.4 Other use cases Register for use Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Register for use Unregistered administrator Register for using the system. Login form is presented to user. Request for use has been sent. Actor manually triggers action by pressing appropriate button. 1. User clicks at Click here to register link. 2. Registration request form is presented to the user. 3. User enters his address and request information. 4. User clicks at Send request link. 5. Request for registration has been sent. Ends When Request for registration has been sent. Exceptions If the user enters non-valid address, system will show : Mail address is not correct. If the user leave message text field empty, system will show : Must enter request text. STEP 1: User clicks at Click here to register link. 24

29 STEP 2: Registration request form is presented to the user. STEP 3: User enters his address and request information. STEP 4: User clicks at Send request link. 25

30 2.4.2 Log In Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Log in Customer/Supplier Logging on to the system. Login form is presented to user. User has completed registration process. User is logged in. Actor manually triggers action by pressing appropriate button. 1. User enters his/her user name and password. 2. User presses the Login button. 3. System logs the user. Ends When User chooses Login action. Exceptions User name and/or password are incorrect. In this case action is rejected and appropriate error message is shown STEP 1: User enters his/her user name and password. STEP 2: User presses the Login button. 26

31 2.4.3 Maintain Kanban Loop Create Kanban loop Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Create Kanban loop Customer/Supplier Creating new Kanban Loop. There is at least one Register party with defined Agency and Party that can be used to set Customer, Supplier, Ship From or Ship To loop attribute. There is at least one defined Location and Item. Appropriate user form is presented to user. Kanban loop is created. Actor manually triggers action by pressing appropriate button. 1. User clicks on Edit link to proceed to maintain page 2. User clicks on New Kanban loop button. 3. New Kanban loop is created. 4. User enters information describing created Kanban loop. 5. User clicks on a Save button to save the information entered. 6. Information is saved. Ends When Customer/Supplier selects the action and thus leaves the form. Exceptions If the information entered is incorrect, action is rejected and user is presented with appropriate message If data entered is in incorrect format, action is rejected and user is presented with appropriate message. 27

32 STEP 1: User clicks on Edit link to proceed to maintain page STEP 2: User clicks on New Kanban loop button. 28

33 STEP 3: New Kanban loop is created. STEP 4: User enters information describing created Kanban loop. 29

34 STEP 5: User clicks on a Save button to save the information entered STEP 6: Information is saved. 30

35 Update Kanban Loop Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Maintain Kanban loop Customer/Supplier Maintaining existing Kanban loops. There is at least one Kanban loop persisted in the system. User is presented with appropriate web form. Kanban loop is updated. Actor manually triggers action by pressing appropriate button. 1. User navigates to the Kanban loop he/she wishes to maintain. 2. User clicks on Edit button to enter maintain page. 3. User enters new information to the selected Kanban loop. 4. User selects existing Kanbans of a chosen Kanban loop. 5. User clicks on a Remove Kanban button. 6. Selected Kanbans are deleted. 7. User clicks on Add Kanban button. 8. New Kanban is added. 9. User enters information describing new Kanban. 10. User clicks on Save button 11. Actions are saved Ends When Customer/Supplier selects the action and thus leaves the form. Exceptions If the information entered is incorrect, action is rejected and user is presented with appropriate message If data entered is in incorrect format, action is rejected and user is presented with appropriate message. 31

36 STEP 1: User navigates to the Kanban loop he/she wishes to maintain. STEP 2: User clicks on Edit button to enter maintain page. 32

37 STEP 3: User enters new information to the selected Kanban loop. STEP 4: User selects existin g Kanbans of a chosen Kanban loop. 33

38 STEP 5: User clicks on a Remove Kanban button. STEP 6: Selected Kanbans are deleted. 34

39 STEP 7: User clicks on Add Kanban button. STEP 8: New Kanban is added. 35

40 STEP 9: User enters information describing new Kanban. STEP 10: User clicks on Save Kanban button 36

41 Delete Kanban Loop Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Delete Kanban loop Customer/Supplier Delete existing Kanban loops. There is at least one Kanban loop persisted in the system. User is presented with appropriate web form. Kanban loop is deleted. Actor manually triggers action by pressing appropriate button. 1. User navigates to Kanban loop he/she wishes to delete. 2. User clicks on Edit link to enter maintain page. 3. User clicks on Delete button. 4. Kanban loop is deleted Ends When Customer/Supplier selects the action and thus leaves the form. Exceptions If the user tries to delete Kanban loop that is related to some of the persisted entities, system will show appropriate message that points to cause of the error. STEP 1: User navigates to Kanban loop he/she wishes to delete. 37

42 STEP 2: User clicks on Edit link to enter maintain page. STEP 3: User clicks on Delete button. 38

43 2.4.4 Maintain Consumption Document Create Consumption Document Use case name Create consumption document from Kanban loop page. Actors Customer Purpose Creating new consumption document. Pre-Condition There is at least one Kanban loop, based on which it is possible to create consumption document. Mentioned Kanban loop has at least one Kanban in status FULL which is being emptied. The user is presented with appropriate form. Post-Condition Consumption document has been created. Begins When Steps Actor manually triggers action by pressing appropriate button. 1. User chooses search criteria by which he wishes to narrow down the list of Kanban loops. 2. User enters the search value. 3. User clicks on Search button. 4. System retrieves those Kanban loops that match chosen criteria. 5. User navigates to Kanban loop, he/she wishes to create consumption document for. 6. User picks Kanbans of selected Kanban loop. 7. User clicks Consume button on the Kanban loop form. 8. Document is created with selected Kanban loops attached to it as document items. Consumption document page is presented to user. 9. User clicks on Confirm button. 10. Created document is confirmed. Ends When Customer selects the action and thus leaves the form. Exceptions If a search value is in incorrect format, the search action will be rejected. User will be warned with appropriate message. If user selects Kanbans that are in wrong status, no document items will be added to created document. 39

44 Update Consumption Document Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Update consumption document Customer Performing update action on existing consumption document. There is at least one consumption document persisted in the system. User is presented with appropriate form. Consumption document has been updated. Actor manually triggers action by pressing appropriate button. 1. User navigates trough consumption documents and chooses the document he/she wishes to modify. 2. User enters new information about chosen document in appropriate fields. 3. User clicks on Save button. 4. System saves the changes user has made. 5. User selects one or more document items of selected consumption document. 6. User clicks on a Delete document item button. 7. Selected document items are deleted. 8. User clicks on Add new item button. 9. User enters information about newly added item. 10. User clicks on a Save item button 11. System saves the document items. Ends When Customer selects the action and thus leaves the form. Exceptions If the information about consumption document is incorrect, save action is rejected. User is warned with appropriate message If the information about document item is incorrect, save action is rejected. User is presented with appropriate message. 40

45 Delete Consumption Document Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Delete Consumption document. Customer Deleting existed consumption document. There is at least one consumption document persisted in the system. User is presented with appropriate form. Consumption document has been deleted. Actor manually triggers action by pressing appropriate button. 1. User selects consumption document he/she wishes to delete. 2. User clicks on Delete button. 3. Document is deleted Ends When Customer selects the action and thus leaves the form. Exceptions 41

46 2.4.5 Maintain Shipment Schedule Document Create Shipment Schedule Document Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Create authorize document from Kanban loop page. Customer Creating new Authorize document. There is at least one Kanban loop, based on which it is possible to create authorize document. Mentioned Kanban loop has at least one Kanban in status EMPTY which is being emptied. The user is presented with appropriate form. Authorize document has been created. Actor manually triggers action by pressing appropriate button. 1. User chooses search criteria by which he wishes to narrow down the list of Kanban loops. 2. User enters the search value. 3. User clicks on Find button. 4. System retrieves those Kanban loops that match chosen criteria. 5. User navigates to Kanban loop, he/she wishes to create authorize document for. 6. User picks Kanbans of selected Kanban loop. 7. User clicks Authorize button on the Kanban loop form. 8. Document is created with selected Kanban loops attached to it as document items. Auth orize document page is presented to user. 9. User clicks on Confirm button. 10. Created document is confirmed. Ends When Customer selects the action and thus leaves the form. Exceptions If a search value is in incorrect format, the search action will be rejected. User will be warned with appropriate message. If user selects Kanbans that are in wrong status, no document items will be added to created document. 42

47 STEP 1: User chooses search criteria by which he wishes to narrow down the list of Kanban loops. STEP 2: User enters the search value. 43

48 STEP 3: User clicks on Find button. ST EP 4: System retrieves those Kanban loops that match chosen criteria. 44

49 STEP 5: User navigates to Kanban loop, he/she wishes to create authorize document for. STEP 6: User picks Kanbans of selected Kanban loop. 45

50 STEP 7: User clicks Authorize button on the Kanban loop form. STEP 8: Document is created with selected Kanban loops attached to it as document items. Authorize document page is presented to user. 46

51 STEP 9: User clicks on Confirm button. 47

52 Update Shipment Schedule Document Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Update authorize document Customer Performing update action on existing authorize document. There is at least one authorize document persisted in the system. User is presented with appropriate form. Authorize document has been updated. Actor manually triggers action by pressing appropriate button. 1. User navigates trough authorize documents and chooses the document he/she wishes to modify. 2. User enters new information about chosen document in appropriate fields. 3. User clicks on Save button. 4. System saves the changes user has made. 5. User selects one or more document items of selected authorize document. 6. User clicks on a Delete document item button. 7. Selected document items are deleted. 8. User clicks on Add new item button. 9. User enters information about newly added item. 10. User clicks on a Save document button. 11. System saves the document items. Ends When Customer selects the action and thus leaves the form. Exceptions If the information about authorize document are incorrect, save action is rejected. User is warned with appropriate message If the information about document item is incorrect, save action is rejected. User is presented with appropriate message. 48

53 STEP 1: User navigates trough authorize documents and chooses the document he/she wishes to modify. STEP 2: User enters new information about chosen document in appropriate fields. 49

54 STEP 3: User clicks on Save button. STEP 4: System saves the changes user has made. STEP 5: User selects one or more document items of selected authorize document. 50

55 STEP 6: User clicks on a Delete document item button. STEP 8: User clicks on Add new item button. 51

56 STEP 9: User enters information about newly added item. STEP 10: User clicks on a Save Document button. 52

57 Delete Shipment Schedule Document Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Delete authorize document. Customer Deleting existed authorize document. There is at least one authorize document persisted in the system. User is presented with appropriate form. Authorize document has been deleted. Actor manually triggers action by pressing appropriate button. 1. User selects authorize document he/she wishes to delete. 2. User clicks on Delete button. 3. Document is deleted Ends When Customer selects the action and thus leaves the form. Exceptions STEP 1: User selects authorize document he/she wishes to delete. 53

58 STEP 2: User clicks on Delete button Maintain Shipment Document Create Shipment Document Use case name Actors Purpose Pre-Condition Post-Condition Begins When Create shipment document from Kanban loop page. Supplier Creating new shipment document. There is at least one Kanban loop, based on which it is possible to create shipment document. Mentioned Kanban loop has at least one Kanban in status AUTHORIZED which is being emptied. The user is presented with appropriate form. Shipment document has been created. Actor manually triggers action by pressing appropriate button. 54

59 Steps 1. User chooses search criteria by which he wishes to narrow down the list of Kanban loops. 2. User enters the search value. 3. User clicks on Search button. 4. System retrieves those Kanban loops that match chosen criteria. 5. User navigates to Kanban loop, he/she wishes to create shipment document for. 6. User picks Kanbans of selected Kanban loop. 7. User clicks Ship button on the Kanban loop form. 8. Document is created with selected Kanban loops attached to it as document items. Shipment document page is presented to user. 9. User clicks on Save button. 10. Created document is saved. Ends When Supplier selects the action and thus leaves the form. Exceptions If a search value is in incorrect format, the search action will be rejected. User will be warned with appropriate message. If user selects Kanbans that are in wrong status, no document items will be added to created document Update Shipment Document Use case name Actors Purpose Pre-Condition Post-Condition Begins When Update shipment document Supplier Performing update action on existing shipment document. There is at least one shipment document persisted in the system. User is presented with appropriate form. Shipment document has been updated. Actor manually triggers action by pressing appropriate button. 55

60 Steps 1. User navigates trough shipment documents and chooses the document he/she wishes to modify. 2. User enters new information about chosen document in appropriate fields. 3. User clicks on Save button. 4. System saves the changes user has made. 5. User selects one or more document items of selected shipment document. 6. User clicks on a Delete document item button. 7. Selected document items are deleted. 8. User clicks on Add new item button. 9. User enters information about newly added item. 10. User clicks on a Save item button 11. System saves the document items. Ends When Supplier selects the action and thus leaves the form. Exceptions If the information about shipment document is incorrect, save action is rejected. User is warned with appropriate message If the information about document item is incorrect, save action is rejected. User is presented with appropriate message Delete Shipment Document Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Delete shipment document. Supplier Deleting existed shipment document. There is at least one shipment document persisted in the system. User is presented with appropriate form. Shipment document has been deleted. Actor manually triggers action by pressing appropriate button. 1. User selects shipment document he/she wishes to delete. 56

61 2. User clicks on Delete button. 3. Document is deleted Ends When Supplier selects the action and thus leaves the form. Exceptions Maintain Receive Delivery Document Create Receive Delivery Document Use case name Actors Purpose Pre-Condition Post-Condition Begins When Create receive document Customer Creating new receive document. There is at least one Kanban loop, based on which it is possible to create receive document. Mentioned Kanban loop has at least one Kanban in status SHIPPED which is being emptied. The user is presented with appropriate form. Receive document has been created. Actor manually triggers action by pressing appropriate button. Steps 1. User chooses search criteria by which he wishes to narrow down Kanban loops. 2. User enters the search value. 3. User clicks on Search button. 4. System retrieves those Kanban loops that match chosen criteria. the list of 5. User navigates to Kanban loop, he/she wishes to create receive document for. 6. User picks Kanbans of selected Kanban loop. 7. User clicks Receive button on the Kanban loop form. 8. Document is created with selected Kanban loops attached to it as document items. Receive document page is presented to user. 9. User clicks on Save button. 57

62 10. Created document is saved. Ends When Customer selects the action and thus leaves the form. Exceptions If a search value is in incorrect format, the search action will be rejected. User will be warned with appropriate message. If user selects Kanbans that are in wrong status, no document items will be added to created document Update Receive Delivery Document Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Update receive document Customer Performing update action on existing receive document. There is at least one receive document persisted in the system. User is presented with appropriate form. Receive document has been updated. Actor manually triggers action by pressing appropriate button. 1. User navigates trough receive documents and chooses the document he/she wishes to modify. 2. User enters new information about chosen document in appropriate fields. 3. User clicks on Save button. 4. System saves the changes user has made. 5. User selects one or more document items of selected receive document. 6. User clicks on a Delete document item button. 7. Selected document items are deleted. 8. User clicks on Add new item button. 9. User enters information about newly added item. 10. User clicks on a Save item button 11. System saves the document items. 58

63 Ends When Customer selects the action and thus leaves the form. Exceptions If the information about receive document are incorrect, save action is rejected. User is warned with appropriate message If the information about document item is incorrect, save action is rejected. User is presented with appropriate message Delete Receive Delivery Document Use case name Actors Purpose Pre-Condition Post-Condition Begins When Steps Delete receive document. Customer Deleting existed receive document. There is at least one receive document persisted in the system. User is presented with appropriate form. Receive document has been deleted. Actor manually triggers action by pressing appropriate button. 4. User selects receive document he/she wishes to delete. 5. User clicks on Delete button. 6. Document is deleted Ends When Customer selects the action and thus leaves the form. Exceptions 59

64 References Document No. Document Title Date Author IBP-2 Invent ory Visibility & Interoperability Electro nic Kanban Business Process Mart 2006 AIAG FP IP additional partner proposal November 2005 IST-ATH-B5 Advanced Technologies for Interoperability of Heterogeneous Enterprise Networks and their Applications FOSIVDD- Design documentation for December 2006 FOS 007 Apolon IV&I Tool 60