Aras Innovator 11 开发指南：PLM PDM程序员必备

Aras

开发指南

4星 · 超过85%的资源需积分: 50 94 浏览量更新于2023-05-19 3 收藏 1.78MB PDF 举报

身份认证购VIP最低享 7 折!

领优惠券(最高得80元）

"Aras Innovator 11.0 - Programmer's Guide 是一本针对PLM（产品生命周期管理）和PDM（产品数据管理）程序员的开发指南，由Aras Corporation编写。该指南的文档编号为11.0.02015121801，最后更新日期为2018年1月4日。本指南包含了对Aras Innovator 11开发平台的详细说明，旨在帮助开发者理解和利用这个平台进行软件开发。" Aras Innovator 11是Aras Corporation推出的一款强大的企业级PLM解决方案，它集成了PDM、项目管理、工程变更控制、文档管理等多种功能。作为开发人员，通过这份指南可以深入学习如何利用Aras Innovator 11的API、工作流引擎、数据模型以及用户界面定制等核心特性。在Aras Innovator 11开发指南中，你将学到以下关键知识点： 1. **Aras Innovator平台架构**：理解Aras Innovator的层次结构，包括服务器端组件、数据库结构以及客户端接口，这对于高效地开发和部署应用程序至关重要。 2. **编程接口(API)**：Aras Innovator提供了丰富的API供开发者使用，包括.NET、SOAP和RESTful接口。学习如何使用这些API来创建、读取、更新和删除数据，以及实现自定义业务逻辑。 3. **数据模型**：Aras Innovator基于灵活的数据模型，允许开发者定义复杂的实体关系。你需要掌握如何创建和操作自定义数据类型，以及如何使用元数据驱动的架构。 4. **工作流引擎**：了解如何设计和实施工作流，这涉及到任务分配、审批流程和事件触发。Aras Innovator的工作流引擎支持动态配置，可以满足不同业务场景的需求。 5. **用户界面定制**：Aras Innovator提供了一个可扩展的用户界面框架，你可以学习如何使用XSLT和JavaScript来定制和增强用户界面，以提供更佳的用户体验。 6. **安全性与权限管理**：学习如何配置用户角色、权限和访问控制，确保系统安全性和数据保护。 7. **集成与互操作性**：Aras Innovator支持与其他系统集成，如ERP、CAD等。你需要知道如何利用其API和其他集成工具进行系统间的通信。 8. **性能优化与调试**：掌握性能监控和优化技巧，以及如何调试Aras Innovator中的问题，以保证系统的稳定运行。 9. **版本管理和变更控制**：了解如何在Aras Innovator中处理版本控制，确保产品的迭代过程能够有效跟踪和管理变更。 10. **文档与知识管理**：学习如何利用Aras Innovator的文档管理功能，存储、检索和分享项目相关的技术文档和知识。请注意，由于Aras Innovator的开放出版许可协议，你可以自由分发此指南，但需遵守版权规定，未经许可不得实质性修改或以商业目的发布纸质版本。若要获取最新信息和更多支持，可访问Aras Corporation的官方网站或联系其技术支持。 Aras Innovator 11开发指南是开发者深入了解和熟练使用这一平台的宝贵资源，它不仅涵盖了基本概念，还提供了实践案例和指导，帮助你成为一名高效的Aras Innovator开发者。

资源详情

资源推荐

2018 Aras Corporation All Copyrights Reserved. 15

Aras Innovator 11

Programmer’s Guide

Attribute

Usage

Xml:lang

Language code for multilingual properties. You must use this in conjunction with

the internationalization namespace on the property tag. For example:

<i18n:name xml:lang="de"

xmlns:i18n="http://www.aras.com/I18N">Rad</i18n:name>

2018 Aras Corporation All Copyrights Reserved. 16

Aras Innovator 11

Programmer’s Guide

3 IOM Reference

IOM Reference provides a general description of the IOM (Innovator Object Model or Item Object Model)

API. A more detailed API reference may be obtained from one of the following:

 On-line: Go to http://www.aras.com/support/documentation/documentation.aspx?Version=11.0

Under the section Other Documents, click On-Line API Guide.html.

 From Innovator Client UI: Login as Innovator Administrator. Under the Help menu, select API

Reference.

 In Innovator CD Image: Go to the documentation folder and open Aras Innovator - API

Guide.html.

The IOM is an Object Model for the AML, but it is not purely Object Oriented. Using Object Oriented

terms, an ItemType is like a ‘Class’ and the Item is like an ‘Object’. Although the Item is an Object with

methods, there is only one Item Class for all ItemTypes. In a pure Object Oriented representation, there

would be a Class for each ItemType because each ItemType has its own set of Properties to describe the

different Items.

An Item Object is intended to be abstract and pliable. Depending on its internal structure, the Item Object

usually represents one of five following supported types of IOM Items:

 Single Innovator Item of an arbitrary ItemType.

 Set of Innovator Items, as in the case for results of the action ‘get’ when more than one Item returns.

 Error, as in the case when an action request results in an error from the Innovator Server.

 Result to represent an arbitrary text wrapped by <Result> XML tags.

 Logical to represent a set of properties wrapped in a logical statement by one of logical XML tags:

<or>, <and>, or <not>; usually used to specify the search criteria for the action ‘get’.

The IOM is intended to be a generic and compact API for modeling the Item structure of the AML as

abstract Objects. The majority of the methods for the IOM deal with memory management of the AML

document for the Item Object. The AML is a script sent as a message to the Aras Innovator Server. The

IOM is an Object API to build the AML messages, submit them to the Innovator Server and parse an AML

document that is returned by the Server.

There are two major types of methods in the Item Class:

 methods that only work with item's AML in memory

 methods that communicate with the Server, i.e. send request(s) to and get response(s) from the

server.

All get\set type of methods as well as isXXX(...) (e.g. isError(), isCollection(), etc.) and add\remove

methods (e.g. addRelationship(...), removeProperty(...), etc.) belong to the former group. Methods like

fetchXXX(...) (e.g. fetchLockStatus()), apply(...), email(...), promote(...), lock\unlockItem(...), etc. belong to

the latter group. In case a method sends a request to the server it must be explicitly mentioned in the API

reference method comments.

2018 Aras Corporation All Copyrights Reserved. 17

Aras Innovator 11

Programmer’s Guide

Note: The term ‘method’ has two meanings in this guide; the typographical convention used throughout

this Guide is as follows:

Lowercase ‘method’ refers to methods on an IOM Item Object.

Capitalized ‘Method’ refers to Method Items stored in the Aras Innovator database.

Sample code is shown in Courier 10pt font.

Optional arguments are surrounded by [] characters.

3.1 IOMCredentials Class

The IOMCredentials Class defines the login credentials for connecting to the Aras Innovator Server. The

Item Class has a credentials public property, which is an IOMCredentials Object.

Typically, you do not need to know about or deal with the credentials Object because the Methods run in

a logged in session. You can, however, set the credentials for the Item Object using these methods, if

you want to submit the apply requests to a different Aras Innovator server. The IOMCredentials Class

methods are mostly getters and setters for URLs (Innovator and Vault servers), DB name, and login name

and password.

3.2 Innovator Class

In Innovator Class, methods like applyAML(…), applyMethod(…), and applySQL(…), being type

Item, send the apply request to the Aras Innovator Server. In response, the Server creates XML that

apply_ methods used to construct an Item Object to return; methods like getItemById(…) and

getItemByKeyedName(…) search the database the logged in session is connected to, and methods like

newItem(…), newError(…) and newResult(…) construct a new instance of the Item Object.

Other members of this class perform miscellaneous non-Item related operations. Use them if you need to

get a new GUID (methods getNewID() ), generate a next sequence value (method

getNextSequence(…) ), or calculate the MD5 hash value for a given string (method ScalcMD5(…) .)

3.3 Item Class

An Item Object can represent an Item, a set of Items, or an Error.

Item public constructor has one required argument itemtype-name and one optional argument action.

The new Item is only populated with the Properties and default values from the ItemType when the

optional action argument is ‘add’.

The Item Class public field dom represents a DOM Object that holds the data for the Item in the AML

format.

3.3.1 Base Methods

The Item Class base method apply(…)submits the AML apply request to the Innovator Server using the

context Item DOM as the AML source and returns a new Item built on the XML returned by the Server. In

contrast, the base method loadAML(…) does not return a new Item but rather rebuilds this.dom using

AML taken as an argument.

2018 Aras Corporation All Copyrights Reserved. 18

Aras Innovator 11

Programmer’s Guide

You can call clone(…)method to get a new identical instance of the context Item and you can call

setNewID() method to replace the context Item id by newly generated GUID.

3.3.2 Boolean Methods

Use Call method isCollection()to find out whether or not the Item represents a set of Items, e. g.

whether or not its dom property holds more than one Item node. Use Call isError()method to find out

whether or not the Item represents an Error. See the IOM API on-line reference for more boolean

members of the Item Class.

3.3.3 Attribute Methods

Methods such as getAction(), getID(), and getType() return a value of Item node action, id, and

type attribute respectively, while method getAttribute(…) takes an attribute-name as an argument

and, therefore, can be used to get any attribute by name. Thus, getAction()is a short cut to

getAttribute(“action”), getID() is a short cut to getAttribute(“id”), and so on.

Each get method in this group has a corresponding set method: setAction(…),

setID(…),setType(…), and setAttribute(…). Notice that method setAttribute(…) not only

sets new value for an existing attribute but can also add a new attribute to the Item node and then sets its

value.

3.3.4 Property Methods

Property methods comprise a set of accessors to Item properties and Item property’s attributes: get_, set_

(which acts also as add_), and remove_. In addition, if a property has/needs a nested Item there are

methods to get/insert these nested Items.

Accessors to Properties are getProperty(…), setProperty(…), and removeProperty(…).These

methods take then property name as an argument.

Accessors to Property’s attribute are getPropertyAttribute(…), setPropertyAttribute(…), and

removePropertyAttribute(…). These methods take property and attribute names as arguments.

Method setProperty(…)/setPropertyAttribute(…)not only sets new value for an existing Item

property/ property’s attributes but creates new property/ property’s attributes and then sets its value if the

property/ property’s attributes with a given name does not yet exist.

The setProperty method requires property values to be in a locale-neutral format. Decimal and float

values should use the period symbol (.) as the decimal separator and no digit separator (i.e. commas

separating thousands). The dash symbol (-) should be used to denote a negative value. Date/Time

values should be in ‘YYYY-MM-DD[Thh:mm:ss]’ format and in the local (or corporate) time zone.

Language-specific values should be set using the language code as the third argument.

Accessors to Property’s nested Item are: getPropertyItem(…), setPropertyItem(…), and

createPropertyItem(…). All these methods take property name as an argument, and method

setPropertyItem(…) needs, in addition, an Item Object as the second argument to create a DOM for

the nested Item.

2018 Aras Corporation All Copyrights Reserved. 19

Aras Innovator 11

Programmer’s Guide

3.3.5 Relationship Methods

Relationship methods are made up of a set of Item’s relationship accessors: getRelationships(…),

addRelationship(…), createRelationship(…), and removeRelationship(…). The difference

between createRelationship(…) and addRelationship(…), two methods that both are adding an

Item node to the Relationship parent node, is subtle. Let’s consider the following server-side VB method

to illustrate how createRelationship(…) works:

Dim myInnovator As Innovator = Me.getInnovator()

Dim myItem As Item = myInnovator.NewItem("myType","myAction")

myItem.createRelationship("User","add")

This code results in the following myItem.dom XML:

</Relationships>

</Item>

Similar code that exercises addRelationship(…) methods is:

Dim myInnovator As Innovator = Me.getInnovator()

Dim myItem As Item = myInnovator.NewItem("myType","myAction")

Dim relItem As Item = myInnovator.NewItem("User","add")

myItem.addRelationship(relItem)

and this code results in following myItem.dom XML:

<Item isNew="1" isTemp="1" type="User" action="add"

id="7EA3F18935CC493A900DAB63E839FDA2">

<default_vault>67BBB9204FE84A8981ED8313049BA06C</default_vault>

</Item>

</Relationships>

</Item>

As you can see addRelationship(…) produces a more detailed Item node under the Relationship

parent node.

There are three methods getRelatedItem(…), setRelatedItem(…), and createRelatedItem(…)

that are valid for relationship Items only and are used as a short cut to the

Item.get/setPropertyItem() methods.

3.3.6 Item Collection Methods

This group is comprised of methods to work with collections. Collection in this context is a set of Items as

in the case for results from a query. Method appendItem(…) appends its Item Object argument to an

existing collection or converts a single Item instance to a set of Items. This mechanism is illustrated in the

following C# sample:

Innovator myInnovator = this.getInnovator();

Item myItem = myInnovator.newItem("myType","myAction");

剩余92页未读，继续阅读

cfy_cl7502

粉丝: 1
资源: 7

会员权益专享

Aras Innovator 11 开发指南：PLM PDM程序员必备

Aras Innovator开发指南

Aras Innovator 120 配置手册

aras12开发手册说明书

aras innovator 11 programmer鈥檚 guide

aras innovator plm 下载

aras innovator 12sp

aras innovator 使用说明书

aras innovator 贴吧

aras innovator 启动工作流并传入变量

aras 500 错误

Aras Javascript

aras入门教程5_项目管理

arasopenplm系统管理手册

Aras管理操作手册

aras-b.github.io

Aras_Framework系统管理操作手册

ARAS JavaScript的API开发帮组

Aras 学习文档

Aras Open PLM 安装指南

会员权益专享

最新资源