Aras Innovator 12 Programmer’s Guide Document #: 12.0.02019054101 Last Modified: 05/24/2019 Aras Innovator 12 Programmer’s Guide Copyright Information Copyright © 2019 Aras Corporation. All Rights Reserved. Aras Corporation 100 Brickstone Square Suite 100 Andover, MA 01810 Phone: 978-806-9400 Fax: 978-794-9826 E-mail: [email protected] Website: https://www.aras.com Notice of Rights Copyright © 2019 by Aras Corporation. This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, V1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). Distribution of substantively modified versions of this document is prohibited without the explicit permission of the copyright holder. Distribution of the work or derivative of the work in any standard (paper) book form for commercial purposes is prohibited unless prior permission is obtained from the copyright holder. Aras Innovator, Aras, and the Aras Corp "A" logo are registered trademarks of Aras Corporation in the United States and other countries. All other trademarks referenced herein are the property of their respective owners. Notice of Liability The information contained in this document is distributed on an "As Is" basis, without warranty of any kind, express or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose or a warranty of non- infringement. Aras shall have no liability to any person or entity with respect to any loss or damage caused or alleged to be caused directly or indirectly by the information contained in this document or by the software or hardware products described herein. 2019 Aras Corporation All Copyrights Reserved. 2 Aras Innovator 12 Programmer’s Guide Table of Contents Send Us Your Comments ............................................................................................. 6 Document Conventions ................................................................................................ 7 1 Introduction .............................................................................................................. 8 1.1 The Item ....................................................................................................................................... 8 1.2 The Aras Markup Language (AML) .............................................................................................. 9 1.3 Methods and the IOM ................................................................................................................. 10 2 AML ......................................................................................................................... 11 2.1 <Item> Tag ................................................................................................................................. 11 2.2 <Relationships> Tag .................................................................................................................. 11 2.3 <property> Tags ......................................................................................................................... 11 2.4 Attributes .................................................................................................................................... 12 2.4.1 Item Attributes ............................................................................................................. 12 2.4.2 Property Attributes ....................................................................................................... 14 3 IOM Reference ........................................................................................................ 16 3.1 IOMCredentials Class ................................................................................................................ 17 3.2 Innovator Class .......................................................................................................................... 17 3.3 Item Class .................................................................................................................................. 17 3.3.1 Base Methods .............................................................................................................. 17 3.3.2 Boolean Methods ......................................................................................................... 18 3.3.3 Attribute Methods ........................................................................................................ 18 3.3.4 Property Methods ........................................................................................................ 18 3.3.5 Relationship Methods .................................................................................................. 19 3.3.6 Item Collection Methods .............................................................................................. 19 3.3.7 Logical Methods .......................................................................................................... 20 3.3.8 Creating New Item Method .......................................................................................... 20 3.3.9 Error Methods .............................................................................................................. 21 3.3.10 Extended Item Class methods..................................................................................... 21 4 Methods .................................................................................................................. 23 4.1 Item Actions Extend the Item Class ........................................................................................... 23 4.1.1 Context Item ................................................................................................................ 24 4.1.2 Methods are Item Factories ......................................................................................... 24 4.1.3 Handling the Wrong ItemType ..................................................................................... 24 4.1.4 Methodology ................................................................................................................ 25 4.2 Built in Action Methods ............................................................................................................... 25 4.3 Generic Methods ........................................................................................................................ 27 4.3.1 Context Item ................................................................................................................ 27 4.3.2 Methods are Item Factories ......................................................................................... 27 4.3.3 Methodology ................................................................................................................ 28 2019 Aras Corporation All Copyrights Reserved. 3 Aras Innovator 12 Programmer’s Guide 4.4 Server Events ............................................................................................................................. 28 4.4.1 Context Item ................................................................................................................ 28 4.4.2 Methodology ................................................................................................................ 28 4.4.3 Available Server Events .............................................................................................. 29 4.4.4 Polymorphic ItemTypes Server Event Inheritance ...................................................... 32 4.4.5 Required Server Events .............................................................................................. 32 4.4.6 Server Event Version ................................................................................................... 32 4.5 Client Events .............................................................................................................................. 33 4.5.1 Context Item ................................................................................................................ 33 4.5.2 Form Events ................................................................................................................ 33 4.5.3 Field Events ................................................................................................................. 34 4.5.4 Grid Events .................................................................................................................. 35 4.5.5 Item Type Events ......................................................................................................... 38 4.5.6 Item Actions and Server Event .................................................................................... 39 5 Action Items ........................................................................................................... 40 5.1 Client Side Method Rules ........................................................................................................... 40 5.2 Server Side Method Rules ......................................................................................................... 40 5.3 Use Cases .................................................................................................................................. 42 5.3.1 Client side - has cache Item is dirty ............................................................................. 42 5.3.2 Client side - no cache Item - no item_query value .....................................................