Skip to main content

Fundamentals of Item Operation with Aras Innovator API

Aras Innovator API (Innovator Object Model; IOM) provides simple way to build and submit query request with AML. This article will introduce some common methods.

Get Innovator Instance

No matter develop server side or client side code, IOM provides same members to call. The only difference is the way to get Innovator instance. Syntax of VB .NET and JavaScript show as below:

VB. NET


Dim objInno As Innovator = Me.getInnovator()

JavaScript


var inno = aras.IomInnovator;
※Due to the syntax of IOM in VB .NET and JavaScript are similar, the following examples will only enumerate with JavaScript.

Create Item

Mainly use the method "newItem".

Syntax


var itm = inno.newItem('Part', 'get');

Built AML


<Item isNew="1" isTemp="1" type="Part" action="get"/>

Handle Attribute

Related methods are "setAttribute" and "getAttribute".

Set Syntax


itm.setAttribute('select', 'id');

Built AML Node


<Item isNew="1" isTemp="1" type="Part" action="get" select="id"/>

Get Syntax


var select = itm.getAttribute('select', '');
//id

Handle Property

Related methods are "setProperty" and "getProperty".

Set Syntax


itm.setProperty('item_number','A*');

Built AML Node


<Item isNew="1" isTemp="1" type="Part" action="get" select="id">
    <item_number>A*</item_number>
</Item>

Get Syntax


var itemNumber = itm.getProperty('item_number', '');
//A*

Handle Property Attribute

Related methods are "setPropertyAttribute" and "getPropertyAttribute".

Set Syntax


itm.setPropertyAttribute('item_number','condition','like');

Built AML Node


<Item isNew="1" isTemp="1" type="Part" action="get" select="id">
    <item_number condition="like">A*</item_number>
</Item>

Get Syntax


var condition = itm.getPropertyAttribute('item_number', 'condition', '');
//like
標籤：

Comments

Post a Comment

Popular posts from this blog

aras.uiShowItemEx Method (aras Object)

aras.uiShowItemEx Method Shows Item with Item node. Syntax aras.uiShowItem( itemNd , viewMode , isOpenInTearOff ) Parameters Name Type Description itemNd Object Required. Item node. viewMode String Optional. Unknown purpose but only supports the following values: tab view (Default) openFile new ※Each supported value will get same result. Therefore, call method and pass undefined for this parameter is OK. isOpenInTearOff Boolean Optional. Specifies whether show Item with tear-off window. true - open in a tear-off window. false - open in a tab. (Default) Return Value An AsyncResult object or a Boolean. Returns AsyncResult object if the Item winodw is opened successfully, otherwise returns false. See Also aras Object Aras Innovator Client Framework
Post a Comment
Read more

aras.uiShowItem Method (aras Object)

aras.uiShowItem Method Gets Item by Item ID and then shows the Item. Syntax aras.uiShowItem( itemTypeName , itemID , viewMode ) Parameters Name Type Description itemTypeName String Required. Name of the ItemType. itemID String Required. ID of the Item. viewMode String Optional. Unknown purpose but only supports the following values: tab view - This is default. openFile new ※Each supported value will get same result. Therefore, call method without this parameter is OK. Return Value An AsyncResult object or a Boolean. Returns AsyncResult object if the Item winodw is opened successfully, otherwise returns false. See Also aras Object Aras Innovator Client Framework
Post a Comment
Read more

window.handleItemChange Method (Instance Window Object)

window.handleItemChange Method Changes current Item's property value. If Item is not locked, the function will do nothing. Syntax window.handleItemChange( propNm , propVal , dataType , datePattern ) Parameters Name Type Description propNm String Required. Property name. propVal String Required. Property value. dataType String Optional. Property data type. If the data type is "date", this parameter is required, otherwise it is not necessary to pass. datePattern String Optional. Date pattern, supports the following values: short_date (Default) short_date_time long_date long_date_time See Also Instance Window Object Aras Innovator Client Framework
Post a Comment
Read more