Web_ADI使用手册.doc

WEB ADI 学习实践小结一 What is WEB ADI WEB ADI全称是 WEB Application Development Integrator,原来是Oracle HRMS 模块提供的一个利用浏览器来进行存取的，在服务器段运行的self-service应用程序,后来经过不断地发展，现在基本可以用于一般模块的数据导入了。 二 What WEB ADI can do 概括的来说，利用WEB ADI可以实现以下功能： 1.下载数据(download data),类似于报表开发; 2.上载数据(upload data),适用于数据来源为Excel的少量数据导入开发，支持从csv文件导入数据到Excel再上载; 3.更新数据(update or insert data),可以实现先下载数据，修改后更新，或者新增记录后再上载。 三 How to use WEB ADI 按照WEB ADI可以实现的功能分类，假定现在所用职责为Oracle Web ADI，所用语言为中文，Office安装了VBA，设置了Excle的宏安全性和浏览器的安全性，下面分别说明如何使用WED ADI来实现： 1.下载数据，这个是最简单的，步骤如下： 1.1 根据需求创建获取数据的视图，这个就不多说了，根据具体需要而定； 1.2 点选Create Document功能，进入定义集成器页面，选择查看程序，一般选Excle2003，不勾选报告以能够编辑Excle，下一步选择集成器HR 集成器设置，在下一步选择布局集成器设置，再下一步选择内容为NONE，最后点击创建文档，在弹出来的Excle界面上选择元数据类型为下载，应用名按需要来选择，视图名就用刚才创建的，其他的就不用填了，然后上载数据； 1.5 在应用开发员职责下定义一个类型为“子函数”的功能，并将其隐式地挂到所用职责的菜单下，这一步不要忽略，不然会报你没权限使用集成器的错误； 1.6 与步骤1.2相同，进入后选择集成器HR 维护集成器表单功能关联，将集成器和上一步定义的功能关联起来； 1.3 定义布局：点选Define Layout功能，选择1.2步骤创建的集成器，查找，若没有布局，则会出现提示，你可以新增，更新或删除一个布局，一个集成器可以拥有多个布局，当然布局里的字段的提示其实也可以设置的，后面将会专门讲到； 1.4 定义查询参数：点选Create Document功能，选择集成器HR 创建独立查询，一路next到内容，填入1.2步骤创建的集成器（如果在这里填错了当弹出Excle后将不会有数据，但你可以直接点击LOV字段来重新选择应用和集成器），在下一步点击创建文档，弹出Excle来，在SQL WHERE 子句字段中填入where子句，示例如下：WHERE FULL_NAME LIKE NVL($PARAM$.P_FULL_NAME,FULL_NAME) AND NATIONAL_IDENTIFIER LIKE NVL($PARAM$.P_NATIONAL_IDENTIFIER,NATIONAL_IDENTIFIER) AND EMPLOYEE_NUMBER = NVL($PARAM$.PL_EMPLOYEE_NUMBER,EMPLOYEE_NUMBER)，其中FULL_NAME 和EMPLOYEE_NUMBER 是第一步定义的视图里的字段，Excle界面上在后面的“第N个参数”字段名称就是where子句里的$PARAM$.后面的名字，而且在where子句里=号的使用要谨慎，因为我发现=号后的参数一定要有值条件判断才起作用，否则对应的条件永远为假，用nvl也不起作用，不确定这是否是一个bug。参数类型和提示根据实际情况来填写。另外如果创建独立查询后想修改它，则在集成器里选择HR 维护独立查询，不过这样出来的Excle里面会自动的增加了一个hr:extra的参数作为第一个参数，而原来的参数都向后移了一位，你可以将它删除掉，把后面原来的参数再往前移动。 1.5 使用集成器，到这一步，就可以使用集成器了，点选Create Document功能，在进入的页面上选择查看程序(一般默认为Excle2003或Excle)，勾选报告以使你不能修改它，只能查看，在下一步选择你在1.2步骤创建的集成器，在下一步选择布局，假如你定义了多个布局，你可以从下拉列表中选择一个，在下一步进入内容，内容一般有两种，文本文件和NONE，文本文件是用于CSV文件数据源的，在这里我们选择NONE，review后点击创建文档，如果不出异常，就可以把数据下载到Excle里了！2.上载数据，这个需要调用API来实现,一般的步骤如下： 2.1 根据需求写好API程序； 2.2 定义集成器，在创建的Excle界面上选择元数据类型为创建，将API的包名和过程名(或函数名)填上，视图就不要填了，API类型根据实际选择，如果是函数名还要填写返回类型，当然别忘了集成器用户名和应用，而且，调用的过程一定要有参数，当然这好像是废话，但我试验过调用一个没有参数的过程，结果出错了，错误为违反了bne_attributes表的唯一性约束，到后台表一看，原来它将所调用的API作为集成器第一个attribute了（从0开始），如果API的过程没有参数，则将会重复定义一个同样的参数（也是从0开始），所以报错了! 2.3 在应用开发职责下定义一个类型为“子函数”的功能，并将其隐式地挂到所用职责的菜单下，这一步不要忽略，不然会报你没权限使用集成器的错误； 2.4 选择集成器HR 维护集成器表单功能关联，将集成器和上一步定义的功能关联起来； 2.5 定义布局，你可以新增，更新或删除一个布局，也可以为一个集成器定义多个布局； 2.6 到这里你就可以直接使用集成器了，具体使用方法参考1.5，如果你想把CSV的数据直接导进Excle，则还要在专门定义映射，点选Define Mapping功能，左边的来源列选择1，2，3.。，表示的是CSV文件的对应的列，右边的目标列是Excle中的列，也就是视图和API中显示在Excle界面上的列，按照实际情况将他们对应起来，然后在内容的页面上，选择TEXT FILE，然后下一步选择Mapping和指定文件路径，文件以“逗号”分割。 由于第一行为题头，所以开始导入行为“2”，在下一步就弹出Excl了； 3. 更新数据，包含了下载后更新记录和新增记录上载，这个一般要使用视图下载原系统的数据，然后通过视图的字段和API参数的映射，调用API来实现更新，具体步骤如下： 3.1 根据需求创建获取数据的视图，这个就不多说了，根据具体需要而定； 3.2 结合视图和实际需求创建API，在这里需要注意的问题是API中过程的参数名，一般命名为P_XXXX,而如果去掉P_后，即XXX与所用视图里对应的字段命名相同，则集成器将会自动为两者创建映射，这样后面就不用你手工来创建映射了； 3.3 创建集成器，在创建的Excle界面上选择元数据类型为创建，将API的包名和过程名(或函数名)填上，视图也填上，API类型根据实际选择，如果是函数名还要填写返回类型，当然别忘了集成器用户名和应用； 3.4 在应用开发员职责下定义一个类型为“子函数”的功能，并将其隐式地挂到所用职责的菜单下； 3.5 与步骤3.2相同，进入后选择集成器HR 维护集成器表单功能关联，将集成器和上一步定义的功能关联起来，这一步不要忽略，不然会报你没权限使用集成器的错误； 3.6 定义布局，你可以新增，更新或删除一个布局，也可以为一个集成器定义多个布局； 3.7 定义查询参数，具体参考1.4； 3.8 到此步你就可以使用集成器了，具体方法参考2.6。四. 最后将我在开发中遇到的问题和从前辈文档中学到的经验总结如下： 4.1 在WED ADI中，涉及到权限设置的有以下两个方面： 4.1.1 Profile中名为“BNE Allow No Security Rule”的项，默认值为N，即表示Integrator必须创建Security Rule，否则报You do not have permission to access this functionality，而值为Y时，表示没有创建Security Rule时可以访问；有Security Rule的则需要通过安全规则验证才行，一般建议按默认值设为N，而采用下下面介绍的办法； 4.1.2 把要用的Integrator对应的Function挂在当前职责的菜单下，但不填显示名，这是最简单的解决权限控制的方法，当然也可以把要用的菜单挂到职责对应的菜单下，可以根据需要来定。 4.2 这个其实不是问题，我只是在这里提一下，如果集成器用到API，对应API的过程一定要有参数（当然一般情况下应该会有参数的），不然会报违反了bne_attributes表的唯一性约束,具体的原因解释为，当创建用到API的集成器时，系统会也会在bne_attributes创建记录，第一条记录就是关于集成器所使用的存储过程，在attributes_code字段是XXX_P0_ATT的形式，XXX其实对应的就是所定义的集成器的integrator_code去掉_INT的后缀后的字符，假如API过程是有参数的，则系统会在bne_attributes表里创建对应的参数记录，其attributes_code从XXX_P1_ATT开始，但如果没有参数，则会在次创建attributes_code为XXX_P0_ATT的记录，所以就会报错了，系统如何插入bne_attributes表的具体过程详见hr_ade_adi_data_setup这个Package； 4.3 把集成器创建完后，使用集成器时还要经过几个步骤，有没有方法能一步到位，直接让Excle弹出来呢？(或者直接到输入查询参数界面呢？)，下面介绍具体实现方法： 4.3.1 在定义和集成器关联的function时，在名为Form（表单） 的tab 页的 ”Parameters” 属性中填入如下内容(这是个例子！)：bneage=BneCreateDoc&bne:language=ZHS&bne:viewer=BNE:EXCEL2003&bne:reporting=Y&bne:integrator=HX:GENERAL_3_INTG&bne:layout=HX:HX_MATERIAL_CONSUMPTION&bne:content=HX:GENERAL_3_CNT在此解释如下：bne:viewer是指所选用的查看程序，bne:reporting=Y表示可以编辑，bne:integrator的是指集成器的integrator_code，可以用“select integrator_code from bne_integrators_tl where user_name like XXX and tt.application_id =XXX”来找到integrator_code，bne:layout指的是集成器的layout_code，可以用“select layout_code from bne_layouts_b where integrator_code =XXX and gg.application_id =XXX”来得到layout_code，bne:content是指集成器的content_code,可以用“select content_code from bne_contents_b where application_id =XXX and integrator_code =XXX”来得到content_code，到bne:content就是到了查询参数输入的界面了，后面还有可以加上bne:noreview，值为true或false，true表示显示review的内容，false表示不显示review的内容直接弹出Excle； 4.3.2 此function的类型选择SSWA servlet function； 4.3.3 在”Web HTML” tab页的 “HTML Call”中填写：oracle.apps.bne.webui.BneApplicationService； 4.3.4 到此你就可以方便的使用集成器了。WebADI使用手册Author:Creation Date:JUN 3, 2008Last Updated:JUN 3, 2008Document Ref: Version:Note: Title, Subject, Last Updated Date, Reference Number, and Version are marked by a Word Bookmark so that they can be easily reproduced in the header and footer of documents. When you change any of these values, be careful not to accidentally delete the bookmark. You can make bookmarks visible by selecting Tools-OptionsView and checking the Bookmarks option in the Show region.Approvals:Note: To add additional approval lines, press Tab from the last cell in the table above. Copy Number_Note: You can delete any elements of this cover page that you do not need for your document. For example, Copy Number is only required if this is a controlled document and you need to track each copy that you distribute.Document ControlChange Record6DateAuthorVersionChange Reference3-jun-08Draft 1aNo Previous DocumentReviewersNamePositionDistributionCopy No.NameLocation1Library MasterProject Library2Project Manager34Note: The copy numbers referenced above should be written into the Copy Number space on the cover of each distributed copy. If the document is not controlled, you can delete this table, the Note To Holders, and the Copy Number label from the cover page.Note To Holders:If you receive an electronic copy of this document and print it out, please write your name on the equivalent of the cover page, for document control purposes.If you receive a hard copy of this document, please write your name on the front cover, for document control purposes.ContentsDocument Controlii1.Web ADI基础11.1.总体说明11.2.必要设置11.3.输入总账日记账22.Web ADI高级应用112.1.Skipped Pages的配置112.2.Layout及缺省值的配置133.Open and Closed Issues for this Deliverable16Open Issues16Closed Issues16Note: To update the table of contents, put the cursor anywhere in the table and press F9. To change the number of levels displayed, select the menu option InsertIndex and Tables, make sure the Table of Contents tab is active, and change the Number of Levels to a new value. 16File Ref: 3b4024953ac3e4cea2dbfb5e7c2db07d.pdf Company Confidential - For internal use only1. Web ADI基础Note:Note:Note:Note: 以Applmgr登录操作系统cd $APPL_TOP（Windows的变量格式为%APPL_TOP%）md scfmd 1.0.0md forms以Applmgr登录操作系统cd $APPL_TOP（Windows的变量格式为%APPL_TOP%）md scfmd 1.0.0md forms以Applmgr登录操作系统cd $APPL_TOP（Windows的变量格式为%APPL_TOP%）md scfmd 1.0.0md forms以Applmgr登录操作系统Create mockups of the forms using a graphic or design tool. You can use embedded objects as well as screen hardcopies.应用：Web Applications Desktop Integrator职责：Desktop Integration1.1. 总体说明Note: For each field, use the center and right tabs to enter additional information about the field.Include in the parenthesized list one or more of the following:OptionalRequiredDefaultDisplay OnlyList of Values (LOV) source说明针对11.5.10，其它低版本需要打补丁，请上Metalink查。1.2. 必要设置设置IE安全性N: IE/Tools/Option/Security/Internet/自定义级别把“对没有标记为安全的ActivveX控件进行初始化和脚本运行”设置为提示。“Initialize and script ActiveX controls not marked as safe” set to Prompt设置Excel安全性如果没有装Office没有装VBA，请安系统提示插入安装盘安装。N: EXCEL/Tools/宏/安全性勾选“信任对于Visual Basic项目的访问”。1.3. 输入总账日记账开始N: BNE /Create Document选择客户端程序N: Next不要选择Reporting选项，这样就可以编辑、上传。Viewer选Excel选择IntegratorN: Next选择功能；我们选择General Ledger - Journals。选择LayoutN: Next选择布局，相当于子功能；我们选择Functional Actuals - Single。选择ContentN: Next选择内容，选None就创建新的。Review N: Next此界面显示前述步骤所选的选项。ActinveX初始化N: Next然后出现：选择“是”。*如果没有设置IE安全性则会报错，提示要去设置。系统自动创建文档N: Next如果没有设置Excel安全性，会报如下错误。系统自动打开ExcelN: Next我们输入一张凭证，随便，和在Forms或者客户端方式的ADI上输入几乎一样。上传到EBSN: Excel/Oracle/Upload如上图。接下来，系统弹出参数画面：点击Upload完成上传。监控导入请求状态N: Excel/Oracle/Monitor点击Refresh刷新请求的运行情况。验证导入结果N: GL找到请求打开请求输出，找到导入生成的凭证批 到系统的总账模块查询刚刚上传的凭证：通过文件导入定位至，选择Content界面选Text File就可以从事先准备的文本文件将数据导入WEB ADI。选择Mapping方式 N: Next在local Filename处点击“浏览”从本地选择预先准备好的数据文件。Delimiter：选择数据文件使用的分隔符，如果选者Other，那么请在Delimiter Character处指明此字符。Ignore Consecutive Delimiters：是否将连续的分隔符视为一个处理。Start Importing at Line Number：数据文件中数据开始的行号。系统默认为2，因为要导入的数据文件一般都是包含title的。Mapping：选择要使用的Mapping规则。Mapping规则定义了数据文件各字段（来源）和Layout行上各字段（目标）的对应规则。注意: 如果操作的是一个多字节环境（例如，文本文件含有中文字符），必须在导入前将文本文件保存为UTF-8编码。否则， Web ADI在将数据下载至工作表时会报如下错误信息：2. Web ADI高级应用2.1. Skipped Pages的配置定位至Review 界面N: BNE /Create Document按照步骤(Page Flow)选择各个步骤的参数选项，一直定位到Review界面此界面显示前述步骤所选的选项。保存参数选项至ShortcutN: Save在Shortcut Name处填入快捷方式的名称，如ZTE_WEB_ADI选择Save to Shortcut List则添加至Shortcut List选择 Save to Form Function则创建为一个Form FunctionForm Function的名称=BNE_+Shortcut Name在Settings列表里选择需要保存的选项这里没有选择Viewer，因为无法预知客户端会使用什么版本的Excel。检查Form FunctionN: Apply如果选择了Save to Form Function，则系统自动创建一个功能。N: System Administrator前面保存的参数选项被记录到Parameters字段中，如下bne:page=BneCreateDoc&bne:reporting=N&bne:integrator=BNE:JOURNALS_115&bne:layout=BNE:FUNCT_ACT_MULTIPLE_11I&bne:content=BNE:NONE2为了跳过review步骤还需要增加一个参数：&bne:noreview=Yes将Form Function添加至MenuN: System Administrator另外，为了允许Upload，必须在Menu中包括以下任何一个功能：Enter Budget Journals, Enter Journals, Enter Encumbrances, and Import Journals2.2. Layout及缺省值的配置开始N: BNE / Define Layout选择IntegratorN: Next选择功能；我们选择General Ledger - Journals。选择LayoutN: Go如果要对已有的Layout进行操作，定位至该Layout并选择要进行的操作；这里我们选择Functional Actuals Multiple及Update操作。如果要创建新的Layout，N: Define Layout。更新LayoutN: Update首先选择是否要修改Layout Name。注意：Layout Key是无法维护的。N: Continue在打开的界面可以进行如下维护： 增加、减少工作表上列出的字段。 定义这些字段显示的位置 定义字段默认值的取数规则。以下是一个案例Field NameDefault ValueDefault TypeCategoryCategoryParameterSourceSourceParameterCurrencysob.currencycodeEnvironmentAccounting Dateselect to_char(sysdate,yyyy-mm-dd) from gl_period_statuses gps where gps.set_of_books_id=fnd_profile.value(GL_SET_OF_BKS_ID) and gps.closing