The Application Level Events (ALE) Specification, Version 1.0 - GS1

More documents

Recommendations

Info

555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 8.1 ALE – Main API Class --- define(specName:string, spec:ECSpec) : void undefine(specName:string) : void getECSpec(specName:string) : ECSpec getECSpecNames() : List // returns a list of specNames as strings subscribe(specName:string, notificationURI:string) : void unsubscribe(specName:string, notificationURI:string) : void poll(specName:string) : ECReports immediate(spec:ECSpec) : ECReports getSubscribers(specName:String) : List // of notification URIs getStandardVersion() : string getVendorVersion() : string An ECSpec is a complex type that defines how an event cycle is to be calculated. There are two ways to cause event cycles to occur. A standing ECSpec may be posted using the define method. Subsequently, one or more clients may subscribe to that ECSpec using the subscribe method. The ECSpec will generate event cycles as long as there is at least one subscriber. A poll call is like subscribing then unsubscribing immediately after one event cycle is generated (except that the results are returned from poll instead of being sent to a notificationURI). The second way is that an ECSpec can be posted for immediate execution using the immediate method. This is equivalent to defining an ECSpec, performing a single poll operation, and then undefining it. The execution of ECSpecs is defined formally as follows. An ECSpec is said to be requested if any of the following is true: • It has previously been defined using define, it has not yet been undefined, and there has been at least one subscribe call for which there has not yet been a corresponding unsubscribe call. • It has previously been defined using define, it has not yet been undefined, a poll call has been made, and the first event cycle since the poll was received has not yet been completed. • It was defined using the immediate method, and the first event cycle has not yet been completed. Copyright © 2005, 2004 EPCglobal Inc, All Rights Reserved. Page 18 of 71
591 592 593 594 595 596 597 Once requested, an ECSpec is said to be active if reads are currently being accumulated into an event cycle based on the ECSpec. Standing ECSpecs that are requested using subscribe may transition between active and inactive multiple times. ECSpecs that are requested using poll or created using immediate will transition between active and inactive just once (though in the case of poll, the ECSpec remains defined afterward so that it could be subsequently polled again or subscribed to). This description is summarized in the state diagram below. immediate, when no startTrigger specified subscribe or poll, when no startTrigger specified immediate define subscribe or poll Start trigger received or repeatPeriod elapsed Unrequested Requested Active undefine unsubscribe of last subscriber Stop trigger received, duration elapsed, or field stable for stableFieldInterval Stop condition reached, and only requester was poll 598 599 600 601 602 603 604 605 606 607 608 609 610 Stop condition reached, and only requester was immediate The primary data types associated with the ALE API are the ECSpec, which specifies how an event cycle is to be calculated, and the ECReports, which contains one or more reports generated from one activation of an ECSpec. ECReports instances are both returned from the poll and immediate methods, and also sent to notificationURIs when ECSpecs are subscribed to using the subscribe method. The next two sections, Section 8.2 and Section 8.3, specify the ECSpec and ECReports data types in full detail. The two methods getStandardVersion and getVendorVersion may be used by ALE clients to ascertain with what version of the ALE specification an implementation complies. The method getStandardVersion returns a string that identifies what version of the specification this implementation complies with. The possible values for this string are defined by EPCglobal. An implementation SHALL Copyright © 2005, 2004 EPCglobal Inc, All Rights Reserved. Page 19 of 71
Page 1 and 2: 1 2 3 The Application Level Events
Page 3 and 4: 52 53 54 55 56 57 58 59 60 61 62 63
Page 5 and 6: 115 116 117 118 119 120 121 122 123
Page 7 and 8: 171 172 173 174 175 176 177 178 179
Page 9 and 10: 256 257 258 259 260 261 262 263 264
Page 11 and 12: EPC1 EPC2 EPC3 EPC1 EPC2 EPC4 EPC3
Page 13 and 14: 388 389 390 391 392 393 394 395 396
Page 15 and 16: 465 466 467 468 469 470 471 472 473
Page 17: 535 536 537 538 539 540 541 542 543
Page 21 and 22: 629 630 Exception Name DuplicateSub
Page 23 and 24: 657 658 659 660 661 662 663 664 665
Page 25 and 26: 731 732 733 734 735 736 737 738 739
Page 27 and 28: 800 801 802 803 804 805 806 807 808
Page 29 and 30: 865 866 867 868 869 870 871 872 873
Page 31 and 32: 903 904 905 906 907 908 909 910 911
Page 33 and 34: 964 965 966 967 968 969 970 971 972
Page 35 and 36: 1007 1008 1009 1010 1011 1012 1013
Page 37 and 38: 1078 1079 1080 1081 1082 1083 1084
Page 39 and 40: 1151 1152 1153 1154 1155 1156 1157
Page 41 and 42: 1232 1233 1234 1235 1236 1237 1238
Page 43 and 44: 1331 1332 1333 1334 1335 1336 1337
Page 45 and 46: 1471 1472 1473 1474 1475 1476 1477
Page 47 and 48: 1611 1612 1613 1614 1615 1616 1617
Page 49 and 50: 1751 1752 1753 1754 1755 1756 1757
Page 51 and 52: 1875 1876 1877 1878 1879 1880 1881
Page 53 and 54: 2015 2016 2017 2018 2019 2020 2021
Page 55 and 56: 2155 2156 2157 2158 2159 2160 2161
Page 57 and 58: 2295 2296 2297 2298 2299 2300 2301
Page 59 and 60: 2435 2436 2437 2438 2439 2440 2441
Page 61 and 62: 2575 2576 2577 2578 2579 2580 2581
Page 63 and 64: 2660 2661 2662 2663 2664 2665 2666
Page 65 and 66: 2691 2692 2693 2694 2695 2696 2697
Page 67 and 68: 2741 2742 2743 2744 2745 2746 2747
Page 69 and 70:
2780 2781 2782 2783 2784 2785 2786
Page 71:
2818 2819 2820 2821 2822 2823 2824
show all

The Application Level Events (ALE) Specification, Version 1.0 - GS1

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?