Aras Innovator 11. XSLT Report Tool Users Guide

Transcription

1 Dcument #: Last Mdified: 1/4/2018

2 Cpyright Infrmatin Cpyright 2018 Aras Crpratin. All Rights Reserved. Aras Crpratin 300 Brickstne Square Suite 700 Andver, MA Phne: Fax: Website: Ntice f Rights Cpyright 2018 by Aras Crpratin. This material may be distributed nly subject t the terms and cnditins set frth in the Open Publicatin License, V1.0 r later (the latest versin is presently available at Distributin f substantively mdified versins f this dcument is prhibited withut the explicit permissin f the cpyright hlder. Distributin f the wrk r derivative f the wrk in any standard (paper) bk frm fr cmmercial purpses is prhibited unless prir permissin is btained frm the cpyright hlder. Aras Innvatr, Aras, and the Aras Crp "A" lg are registered trademarks f Aras Crpratin in the United States and ther cuntries. All ther trademarks referenced herein are the prperty f their respective wners. Ntice f Liability The infrmatin cntained in this dcument is distributed n an "As Is" basis, withut warranty f any kind, express r implied, including, but nt limited t, the implied warranties f merchantability and fitness fr a particular purpse r a warranty f nninfringement. Aras shall have n liability t any persn r entity with respect t any lss r damage caused r alleged t be caused directly r indirectly by the infrmatin cntained in this dcument r by the sftware r hardware prducts described herein Aras Crpratin All Cpyrights Reserved. 2

3 Table f Cntents Send Us Yur Cmments... 4 Dcument Cnventins Intrductin Running Reprts Reprt ItemType Reprt Tab Reprt Query Stylesheet Query Stylesheet Tab Reprt Tl Tips and Tricks Query Tips Stylesheet Tips AML Schema Ckbk User Input fr Reprting Services-based Reprts Reprt Chser User Input fr XSLT based Reprts Aras Crpratin All Cpyrights Reserved. 3

4 Send Us Yur Cmments Aras Crpratin welcmes yur cmments and suggestins n the quality and usefulness f this dcument. Yur input is an imprtant part f the infrmatin used fr future revisins. Did yu find any errrs? Is the infrmatin clearly presented? D yu need mre infrmatin? If s, where and what level f detail? Are the examples crrect? D yu need mre examples? What features did yu like mst? If yu find any errrs r have any ther suggestins fr imprvement, indicate the dcument title, and the chapter, sectin, and page number (if available). Yu can send cmments t us in the fllwing ways: Supprt@aras.cm Subject: Aras Innvatr Dcumentatin Or, Or, Pstal service: Aras Crpratin 300 Brickstne Square Suite 700 Andver, MA Attentin: Aras Innvatr Dcumentatin FAX: Attn: Aras Innvatr Dcumentatin If yu wuld like a reply, prvide yur name, address, address, and telephne number. If yu have usage issues with the sftware, visit Aras Crpratin All Cpyrights Reserved. 4

5 Dcument Cnventins The fllwing table highlights the dcument cnventins used in the dcument: Dcument Cnventins Cnventin Bld Cde Yellw highlight Yellw highlight with red text Nte: Italics Descriptin Indicates the names f menu items, dialg bxes, dialg bx elements, and cmmands. Example: Click OK. Cde examples appear in curier fnt. It may represent text yu type r data yu read. Cde highlighted in yellw draws attentin t the cde that is being indicated in the cntent. Red text highlighted in yellw indicates the cde parameter that needs t be changed r replaced. Reference t ther dcuments. Ntes cntain additinal useful infrmatin. Warning Successive menu chices Warnings cntain imprtant infrmatin. Pay special attentin t infrmatin highlighted this way. Successive menu chices may appear with a greater than sign (-->) between the items that yu will select cnsecutively. Example: Navigate t File --> Save --> OK Aras Crpratin All Cpyrights Reserved. 5

6 1 Intrductin The Reprt Tl is the user interface fr creating and maintaining Reprts abut items and their cnfiguratins. The intent f the Reprt Tl is t ffer a very simple user interface fr designing Reprts. In technical terms, the Reprts are the result f an XSLT transfrmatin f an AML item cnfiguratin, which is the result f a query. The Reprt Tl allws direct editing f the XSLT style sheet. Reprts are relatinships n ItemTypes. The Reprt item has prperties that define hw t query data fr the Reprt and frmat it fr display. Reprts tend t fall int the fllwing types: A reprt abut an item and its relatinships. Fr example, a BOM reprt. These are Item type Reprts. A static query reprt abut items by ItemType. Fr example, an Open ECO reprt. These are ItemType type Reprts. A dynamic query reprt abut items by ItemType. The user interactively enters query criteria fr the reprt. These are Generic type Reprts Aras Crpratin All Cpyrights Reserved. 6

7 2 Running Reprts The main menu bar has a Reprts menu chice, which is cntext sensitive as yu navigate the main tree. The drp dwn menu is ppulated with the Reprt items related t the ItemType yu selected frm the tree. Hw Reprts appear n the Reprts menu: The Generic type reprts are always shwn. (Generic Reprts tend t be interactive and the user interface will be implemented in future release.) The ItemType type reprts are shwn when yu select an ItemType frm the main tree. The Item type reprts are nly shwn when yu select an item. Additinally, Item Reprts appear n the right-muse cntext ppup menu Aras Crpratin All Cpyrights Reserved. 7

8 3 Reprt ItemType Use the Reprt Tl t edit Reprt items, which are instances f the Reprt ItemType. This sectin prvides a brief verview f the Reprt ItemType as well as a technical understanding f hw Reprts are implemented in Aras Innvatr. Reprts are the result f an AML query r a Methd. The Reprt ItemType implements the prperties fr yu t define the query and XSLT style sheet r Methd. The Reprt als describes where and hw the Reprt is viewed n the client. The fllwing table lists the Reprt ItemType prperties: ItemType Reprt Prperties Prperty Data Type Length/ Surce Cntent/Cmments name string 32 The name fr the Reprt. descriptin string 128 The descriptin fr the Reprt. type list Reprt Types target list Reprt Targets This specifies the type f Reprt: Item, ItemType, r Generic. The type f item defines hw the Reprt is handled by the server and when it appears n the Reprts main menu bar. This specifies where t shw the Reprt results: in the main windw, its wn windw, r all reprts in ne windw when many items are multi-selected. label Multilingu al String 32 This allws us t specify the text, in different languages, f Menu entry fr this Reprt under the Reprts Menu f the Client interface. reprt_query text The AML query t generate data fr the Reprt r an XSLT style sheet t generate the actual AML query if the Reprt type is Item. xsl_stylesheet text The XSLT style sheet used t transfrm the query results int the Reprt. methd item Methd The Methd is evaluated and the result is the Reprt. If a Reprt is based n the results f a Methd the reprt_query and xsl_stylesheet prperty are nt used Aras Crpratin All Cpyrights Reserved. 8

9 Prperty Data Type Length/ Surce Cntent/Cmments lcatin list Reprt Lcatins This defines where the lgic fr generating the Reprt is perfrmed: n the client r server. Typically this is server side but it is pssible t run a Methd client side t generate a Reprt. ItemTypes have relatinships t Reprts called the Item Reprt RelatinshipType. Yu can create new Reprts and edit existing Reprts frm the Reprts tab n the ItemType windw. Reprts are related items because Generic Reprts are nt specific t any particular ItemType thus are standalne Reprts. Reprts tend t be based n an item r items by ItemType and their cnfiguratins Aras Crpratin All Cpyrights Reserved. 9

10 4 Reprt Tab When yu pen a Reprt item frm the Reprts tab n the ItemType windw the Reprt Tl pens. This is the standard Tear ff Item Windw including the standard menu bar and tlbar. Belw that is the Reprt tab bar allwing yu t switch between the Reprt details and the XSLT style sheet text editr. This sectin describes the Reprt tab, which is the Reprt Frm. The Reprt tab is the page where yu set up the Reprt. Here yu prvide its name, its type, the target windw t shw the Reprt results plus set up the query criteria t generate the data fr the Reprt. The fllwing screensht shws a sample Reprt that is f type ItemType, meaning the Reprt Query is a static query that searches fr Vendr items. The AML query als limits the results by defining nly the prperties desired using the select attributes. The target is set t One Windw s the Reprt appears in a separate windw when run frm the client Aras Crpratin All Cpyrights Reserved. 10

11 The fllwing table prvides a descriptin fr each field n the Reprt Frm. Reprt Frm Fields Field Name Descriptin Cntent/Cmments The Reprt name The Reprt descriptin Type Type On Menu Bar Reprt Query Cntains Generic Always The Reprt Query is an AML query fr the Reprt, but if nt set then use the <Item> passed in the bdy f the client request as the AML query. These are dynamic Reprts where the query is knwn at run time. ItemType Item When selected ff the main tree. When selected ff the main search grid. The reprt_query is the AML query. The reprt_query is an XSLT style sheet applied against the <Item> passed in the bdy f the client request as the AML query, which is the selected item frm the main search page. Target Lcatin Reprt Query Label Where t shw the Reprt results: in the main windw, its wn windw, and all reprts in ne windw. Where the methd fr generating the Reprt is evaluated n the client r server. The AML query r XSLT style sheet t make the AML query frm the item depending n whether the type is set t Item r ItemType. This allws us t specify the text, in different languages, f Menu entry fr this Reprt under the Reprts Menu f the Client interface. 4.1 Reprt Query When the Reprt type is set t ItemType r Generic, the Reprt Query is the static AML query used t generate the data fr the Reprt. The fllwing attributes are very useful t help filter and cntrl the results fr yur Reprt. select the select attribute is used t define the set f prperties yu want returned frm the query. This is a cmma delimited list f prperty names (nt the prperty label). It is identical t the select clause in SQL if yu are familiar with relatinal database technlgy. Yu can gain significant perfrmance imprvements t yur Reprts by limiting the data returned frm the query. The fllwing example illustrates the select attribute by selecting the item_number, descriptin, and cst prperties frm the Part ItemType: <Item actin="get" type="part" select="item_number,descriptin,cst"/> 2018 Aras Crpratin All Cpyrights Reserved. 11

12 rder_by the rder_by attribute is used t rder the results. The Reprt Tl ffers the ability t srt the data in a variety f ways but smetimes yu may want the data in a pre-srted rder. This is a cmma delimited list f prperty names (nt the prperty label). This is identical t the rder by clause in SQL if yu are familiar with relatinal database technlgy. The fllwing example illustrates the select attribute by selecting the item_number, descriptin, and cst prperties frm the Part ItemType. <Item actin="get" type="part" select="item_number,descriptin,cst" rder_by="item_number"/> page & pagesize if yu are perfrming a query fr items and yu knw that there can be hundreds r thusands f items, yu can limit the number f items returned by using the page and pagesize attributes. Tgether they cntrl hw many items t return (the pagesize) and which page t return. The fllwing example illustrates the select attribute by selecting the item_number, descriptin, and cst prperties frm the Part ItemType. <Item actin="get" type="part" select="item_number,descriptin,cst" rder_by="item_number" page="1" pagesize="50"/> Relatinships ften yu want the relatinship items in additin t the surce item t generate a Reprt shwing the items cnfiguratin. The query may cntain the <Relatinships> tag t hld the <Item> tags fr the relatinship items yu want included in the query results. The <Item> tags can themselves include the same cntrl attributes. The fllwing example illustrates the Relatinships tag t include the BOM relatinships. Ntice the select attribute fr the BOM type Item defines the prperties t be returned fr bth the BOM relatinship item plus the prperties fr the Part item referenced by the related_id prperty, which is defined within the parenthesis fllwing the related_id prperty. <Item actin="get" type="part" select="item_number,descriptin,cst" rder_by="item_number"> <Relatinships> <Item actin="get" type="part BOM" select="qty,ref_des,related_id(item_number,descriptin,cst)"/> </Relatinships> </Item> 2018 Aras Crpratin All Cpyrights Reserved. 12

13 4.2 Stylesheet Query When the Reprt type is set t Item, the Reprt Query is an XSLT style sheet. Use the stylesheet t transfrm AML fr the selected item int a new AML query that yu can use t query the data fr the Reprt. The reasn fr creating the new query is that the item selected tends nt t already include the item relatinships, s yu need t generate the actual query dynamically using the data knwn frm the selected item. Fr example, the fllwing is an XSLT style sheet that transfrms a Part item int a new AML query fr a BOM Reprt. Ntice that fr the mst part this is actually an AML query but because it s an XSLT style sheet the Attribute value templates { can be used t substitute values inline frm the selected item. The text within the curly brackets is evaluated as an expressin, which in this case is simply returning the values fr the type and id attributes frm the selected item. <Item actin="get" type="{@type" id="{@id" select="item_number,descriptin,cst"> <Relatinships> <Item actin="get" type="part BOM" select="qty,ref_des,related_id(item_number,descriptin,cst)"/> </Relatinships> </Item> 2018 Aras Crpratin All Cpyrights Reserved. 13

14 5 Stylesheet Tab The Stylesheet Tab presents the XSLT style sheet fr the Reprt in its native frmat s yu can edit the stylesheet t make changes. This is a simple text area where yu can edit the XSLT style sheet directly. Clicking Apply applies the changes. Clicking Reset reverts back t the text befre the changes Aras Crpratin All Cpyrights Reserved. 14

15 6 Reprt Tl Tips and Tricks This dcument is a guide t help yu becme mre prductive with the Reprt Tl by shwing yu hw t address sme f the mre cmmn tasks that need t be dne when designing a Reprt. 6.1 Query Tips Using the select attribute The select attribute enables yu t filter dwn the set f prperties fr the Items returned frm a query. <Item type="part" actin="get" select="part_number,part_descriptin,part_cst"/> Using the rder_by attribute The rder_by attribute enables yu t rder the results f the query. The style sheet als supprts srting n the prperties. <Item type="part" actin="get" select="part_number,part_descriptin,part_cst" rder_by="part_number" /> Using the cnditin attribute The cnditin attribute enables yu t specify a cnditin fr the prperties used as search criteria. All the cnditins that are allwed in SQL are allwed as the values t the cnditin attribute. Nte: The greater then and less then symbls are replaced with the tw letter pneumnic wrd. The < symbl is lt and the > symbl is gt, >= is ge and s n. <Item type="part" actin="get" select="part_number,part_descriptin,part_cst" rder_by="part_number"> <part_number cnditin="like">%123%</part_number> </Item> OR'ing prperty values The <r> tag prvides a way t lgically OR prperty values fr the search criteria. <Item type="part" actin="get" select="part_number,part_descriptin,part_cst" rder_by="part_number"> <r> 2018 Aras Crpratin All Cpyrights Reserved. 15

16 <state>released</state> <state>in Review</state> </r> </Item> Return Relatinships in the results Yu can include the <Relatinships> tag and the relatinship items yu want t return. <Item type="{@type" id="{@id" actin="get" select="part_n,part_desc,part_cst"> <Relatinships> <Item type="part EBOM" actin="get" select="psitin,qty,related_id"> <related_id> <Item type="part" actin="get" select="id,part_n,part_desc,part_cst"> <Relatinships> <Item type="part AVL" actin="get" select="avl_status,related_id(descriptin,manufacturer,cmpnent_n)"/> </Relatinships> </Item> </related_id> </Item> </Relatinships> </Item> Using Relatinships as search criteria Yu can include the <Relatinships> tag t describe the search criteria fr the relatinship items. <Item type="{@type" id="{@id" actin="get" select="part_n,part_desc,part_cst"> <Relatinships> <Item type="part EBOM" actin="get" select="psitin,qty,related_id"> <qry cnditin="gt">1000</qty> </Item> </Relatinships> </Item> 2018 Aras Crpratin All Cpyrights Reserved. 16

17 6.2 Stylesheet Tips Displaying a nn-breaking white space T display a nn-breaking white space, use the <xsl:text> tag. <xsl:text disable-utput-escaping="yes">&nbsp;</xsl:text> Or this: Displaying the frmatted text prperty T display frmatted text (the marked up text) prperty value in XSLT, use the disable-utputescaping attribute with the <xsl:value-f> tag. The marked up text fr the frmatted text prperty is a cmplete HTML dcument and nly the cntent fr the BODY tag is required. <xsl:value-f disable-utput-escaping="yes" select=".//body/*"/> Displaying nested tables fr relatinships. T display the relatinship Items fr nested tables, reduce the XPath t the relative path based n the cntext nde fr the <xsl:fr-each> lp that the nested relatinships table is in. <xsl:fr-each select="relatinships/item"> <xsl:fr-each select="related_id/item/relatinships/item"> </xsl:fr-each> </xsl:fr-each> Resize the Reprt windw. T resize the reprt windw, add an nlad callback functin fr the HTML page. Add the fllwing cde befre the <bdy> tag: <script> nlad = functin() { tp.windw.resizet(800,600); </script> Shw a different value based n the value fr a prperty. T shw a different value in the Reprt based n the actual value f the prperty. Fr example, the actual value f the prperty is the hex number fr a clr but yu want t shw the name f the clr in text. <xsl:chse> <xsl:when test="mgr_pinin='#ff0000'">red</xsl:when> <xsl:when test="mgr_pinin='#ffff00'">yellw</xsl:when> <xsl:when test="mgr_pinin='#00ff00'">green</xsl:when> </xsl:chse> Using script functins in the style sheet. T call a JavaScript r VBscript functin in the style sheet, there is a predefined namespace named "user" that is used t implement yur <msxsl:script> blck. The first step is t add the JavaScript r VBscript t yur stylesheet and the secnd step is t call the functin defined Aras Crpratin All Cpyrights Reserved. 17

18 The fllwing example shws hw t call the VBscript DatDiff() functin: <msxsl:script language="vbscript" implements-prefix="user"> Functin mydatediff(day) mydatediff = DateDiff("d", day.item(0).text, Nw) End Functin </msxsl:script> Add the cde abve in the stylesheet after the <xsl:stylsheet> tag. Then call the functin using the <xsl:value-f> tag like this: <xsl:value-f select="user:mydatediff(created_n)"/> Supprting Eurpean languages. T shw the results in a Eurpean language: a. Set the encding attribute fr the rt xml tag: <?xml versin="1.0" encding="is "?> b. Set the encding attribute fr the utput tag: <xsl:utput encding="is " methd="html" mit-xml-declaratin="yes" standalne="yes" indent="yes" /> 2018 Aras Crpratin All Cpyrights Reserved. 18

19 7 AML Schema The fllwing is the AML Schema: <xsd:schema xmlns:xsd=" <xsd:cmplextype name="item"> <xsd:all> <!-- Any user elements defined by the ItemType fr the item --> <xsd:cmplextype name="relatinships" minoccurs="0" maxoccurs="1"> <xsd:all> <xsd:element name="item" minoccurs="0" maxoccurs="unbunded"> <xsd:cmplextype> <xsd:all> <!-- Any user elements defined by the ItemType fr the item --> <xsd:attribute name="id" type="xsd:id" /> <xsd:attribute name="type" type="xsd:string" /> <xsd:attribute name="typeid" type="xsd:idref" /> <xsd:attribute name="actin" type="xsd:string" /> <xsd:attribute name="srt_rder" type="xsd:integer" /> </xsd:all> </xsd:cmplextype> </xsd:element> </xsd:all> </xsd:cmplextype> </xsd:all> <xsd:attribute name="id" type="xsd:id" /> <xsd:attribute name="type" type="xsd:string" /> <xsd:attribute name="typeid" type="xsd:idref" /> <xsd:attribute name="actin" type="xsd:string" /> <xsd:attribute name="select" type="xsd:string" /> <xsd:attribute name="rder_by" type="xsd:integer" /> <xsd:unin> <xsd:attributegrup> <xsd:attribute name="pagesize" type="xsd:integer" /> <xsd:attribute name="page" type="xsd:integer" /> </xsd:attributegrup> <xsd:attributegrup> <xsd:attribute name="levels" type="xsd:integer" /> <xsd:attribute name="cnfig_path" type="xsd:string" /> </xsd:attributegrup> </xsd:unin> </xsd:cmplextype> </xsd:schema> 2018 Aras Crpratin All Cpyrights Reserved. 19

20 8 Ckbk This sectin prvides a set f recipes fr perfrming cmmn reprting tasks. 8.1 User Input fr Reprting Services-based Reprts Yu need a Frm t cllect user input fr Named Parameters fr the SQL query fr Reprting Services based Reprts. Technique A Client Methd-based Reprt is used t present a Frm t cllect the user input. The user input is mapped t a query_string fr the Reprt Server request via the RSGatwway.aspx page. Prcedure fr building a user input Frm fr Reprting Services-based Reprts with Named Parameters: 1. Lgin t Aras Innvatr as admin. 2. Navigate t the Administratin->Frms ff the Main Tree. 3. Open a new Frm Item. 4. Set the Frm Item prperties as fllws: a. Name = My Reprt (this can be any name yu want) b. Add a frm event that fires nlad Name the Methd My Reprt_setDefaults (this can be anything yu want). c. Add fields t the frm that will match the input yu are requesting. Name the fields apprpriately ( PartNumber, Descriptin, Cst ) d. Add a Buttn field with a label Submit 1. Create a Field Event that fires nclick. 2. Name the Methd My Reprt_OnClick (this can be anything yu want) e. Save, unlck, and clse. 5. Navigate t the Administratin->Methds ff the Main Tree. 6. Edit the My Reprt_OnClick Methd Item. 7. Set the methd cde as shwn. Set dcument.frms[0].<fieldnameonfrm>.value t the names f the fields n the My Reprt Frm. var retval=[]; // retval will be used in MyReprt_OpenDialg // dcument.frms[0].<fieldnameonfrm>.value retval["partnum"] = dcument.frms[0].partnumber.value; retval["desc"] = dcument.frms[0].descriptin.value; 2018 Aras Crpratin All Cpyrights Reserved. 20

21 retval["cst"] = dcument.frms[0].cst.value; parent.args.dialg.result = retval; parent.args.dialg.clse(); 8. Save, unlck, and clse. 9. Create anther Methd Item ( MyReprt_OpenDialg, this can be called whatever yu want). 10. Set the methd cde as shwn: a. Update var reprtname with the name f yur Reprt as deplyed t the Reprt Server. b. The URL query strings ( &np: ) shuld reference the parameter as defined in the reprt. var inn = this.getinnvatr(); var ReprtInputFrm = inn.newitem("frm", "get"); ReprtInputFrm.setAttribute("select", "id, width, height"); ReprtInputFrm.setPrperty("keyed_name", "My Reprt"); ReprtInputFrm = ReprtInputFrm.apply(); var param = { title: "My Reprt", frmid: ReprtInputFrm.getID(), iseditmde: "1", aras: aras, pener: windw, innvatr: inn // use param.item nly if the Reprt is f Type=Item //and yu need t pass the cntext item t the dialg //item : this dialgheight: ReprtInputFrm.getPrperty('height','800'), dialgwidth: ReprtInputFrm.getPrperty('width','600'), cntent: 'ShwFrmAsADialg.html' ; functin callback (dialgwrapper) { var result = dialgwrapper.result; if (!result){ return var reprtname = "My Reprt"; // Yur Reprt Name Here var url = tp.aras.getserverbaseurl() + "RSGateway.aspx?irs:Reprt=" + reprtname Aras Crpratin All Cpyrights Reserved. 21

22 "&np:item_number="+result.partnum + "&np:descriptin="+result.desc + "&np:cst="+result.cst; var w = windw.pen(); w.lcatin = url; return "<html></html>"; var wnd = tp.aras.getmainwindw(); wnd = wnd === tp? wnd.main : tp; wnd.arasmdules.dialg.shw("iframe", param).prmise.then(callback); 11. Save, Unlck, and Clse 12. Edit the My Reprt_SetDefaults Methd Item. 13. Set the methd cde as shwn: var fields = ["PartNumber", "Descriptin", "Cst"]; var values = ["%", "%", "%"]; fr (var i = 0; i < fields.length; i++){ // currentfield = <FieldID> + "span" var currentfieldid = getfieldbyname(fields[i]).id; // currentfield = <Actual field ID> currentfieldid = currentfieldid.substring(0,currentfieldid.indexof('s')); var currentfield = dcument.getelementbyid(currentfieldid); currentfield.value = values[i]; 14. Save, unlck, and clse. 15. Navigate t the Administratin->Reprts ff the Main Tree. 16. Open a new Reprt Item. 17. Set the Reprt Item prperties as fllws: Name = My Reprt (this can be anything yu want). Type = Generic, ItemType, depending n when yu want the Reprt t appear n the Reprt menu; Generic always, ItemType nly when that ItemType is selected ff the Main Tree. Lcatin = Client; this is required because the My Reprt_OpenDialg Methd returns an HTML page with JavaScript that needs t be parsed and Client side Reprt nly writes the transfrmed page t the brwser windw and thus the JavaScript is nt parsed. Target = Nne; the windws will be created by My Reprt_OpenDialg. Methd = My Reprt_OpenDialg Reprt Query = Leave blank; it is currently nt used fr this purpse 2018 Aras Crpratin All Cpyrights Reserved. 22

23 The Reprt Item shuld nw appear n the Reprt menu and when selected the User Input Dialg shuld pen. When the user clicks Submit the user input is mapped as a query_string and the actual Reprt is requested frm the Reprt Server via the RSGateway. If yu want t add validatin, add this either in My Reprt_nClick r in MyReprt_OpenDialg, after the mdal dialg is returned. 8.2 Reprt Chser Yu need a dialg t present a set f Reprting Services-based Reprts t chse frm fr the selected Item. Technique A Client Methd based Reprt is used t present a Frm t get the Reprt chice. The user selectin is mapped t a query_string fr the Reprt Server request via the RSGatwway.aspx page. This is similar t recipe 8.1 User Input Frm but in this case we d want the ID fr the selected Item t be passed as a Named Parameter n the query_string. Prcedure fr building a Reprt Chser dialg fr Reprting Services based Reprts: 1. Lgin t Aras Innvatr as admin. 2. Navigate t the Administratin->Lists ff the Main Tree. 3. Open a new List Item 4. Set the List Item prperties as fllws: a. Name = ReprtChserOptins b. Add values with Labels and Values that match the names f yur Reprts as deplyed t the Reprt Server. 5. Save, unlck, and clse 6. Navigate t the Administratin->Frms ff the Main Tree. 7. Open a new Frm Item. 8. Set the Frm Item prperties as fllws: a. Name = Reprt Chser (this can be any name yu want) b. Add a frm event that fires nlad Name the Methd ReprtChser_nLad (this can be anything yu want) c. Add a new Radi Buttn List: Name this field rdi1 d. Add a Buttn field with a label Submit: 1. Create a Field Event that fires nclick. 2. Name the Methd ReprtChser_OnClick (this can be anything yu want). e. Save, unlck, and clse. 9. Navigate t the Administratin->Methds ff the Main Tree. 10. Edit the ReprtChser_OnClick Methd Item. 11. Set the methd cde as shwn: 2018 Aras Crpratin All Cpyrights Reserved. 23

24 var inputoptins = dcument.getelementsbytagname("input"); var retval = []; fr (var i = 0; i < inputoptins.length; i++){ if (inputoptins[i].classname!= "arascheckbxorradi"){ cntinue; if (inputoptins[i].checked === true){ retval['reprtselected'] = inputoptins[i].value; parent.args.dialg.result = retval; parent.args.dialg.clse(); 12. Save, unlck, and clse. 13. Create anther Methd Item ( ReprtChser_OpenDialg ), this can be called whatever yu want). 14. Set the methd cde as shwn: a. The URL query strings ( &np: ) shuld reference the parameter as defined in the reprt. var inn = this.getinnvatr(); var itemids = typef(thisitem)!=="undefined"? thisitem.getid() : aras.getmainwindw().main.wrk.grid.getselecteditemids(',').split(',')[ 0]; var ReprtInputFrm = inn.newitem("frm", "get"); ReprtInputFrm.setAttribute("select", "id, width, height"); ReprtInputFrm.setPrperty("keyed_name", "ReprtChser"); ReprtInputFrm = ReprtInputFrm.apply(); var param = { title: "ReprtChser", frmid: ReprtInputFrm.getID(), iseditmde : "1", aras : aras, pener : windw, innvatr : inn, item : this, dialgheight: ReprtInputFrm.getPrperty('height','800'), dialgwidth: ReprtInputFrm.getPrperty('width','600'), 2018 Aras Crpratin All Cpyrights Reserved. 24

25 cntent: 'ShwFrmAsADialg.html' functin callback(dialgwrapper) { var result = dialgwrapper.result; if (!result!result['reprtselected']){ return; var test=0; var url = aras.getserverbaseurl() + "RSGateway.aspx?irs:Reprt=" + result['reprtselected'] + "&np:id=" + itemids; // and the Item ID. var w = tp.windw.pen(); w.lcatin = url; return "<html></html>"; var wnd = aras.getmainwindw(); wnd = wnd === tp? wnd.main : tp; wnd.arasmdules.dialg.shw("iframe", param).prmise.then(callback); 15. Save, Unlck, and Clse 16. Edit the ReprtChser_nLad Methd Item. 17. Set the methd cde as shwn. a. var radibuttnspan = getfieldbyname('rdi1') uses the name f the radi buttn field as defined n the ReprtChser Frm Item. var radibuttnspan = getfieldbyname('rdi1'); var sysvaluespan = radibuttnspan.getelementsbyclassname("sys_f_value"); if (sysvaluespan.length!= 1){ return; sysvaluespan = sysvaluespan[0]; var inn = this.params.thisitem.getinnvatr(); var reprts = inn.newitem("list", "get"); reprts.setattribute("levels", "2"); reprts.setprperty("keyed_name", "ReprtChserOptins"); 2018 Aras Crpratin All Cpyrights Reserved. 25

26 reprts = reprts.apply(); var reprtrel; if (reprts.iserrr() reprts.getitemcunt > 1){ return false; else{ reprtrel = reprts.getrelatinships("value"); fr (var i = 0; i < reprtrel.getitemcunt(); i++){ var value = reprtrel.getitembyindex(i); var valuelabel = value.getprperty("label", ""); var reprtbuttnspan = dcument.createelement("span"); reprtbuttnspan.setattribute("id", "MyRadi"); reprtbuttnspan.setattribute("name", valuelabel); reprtbuttnspan.setattribute("style", "psitin:relative;display:blck;"); var radiinput = dcument.createelement("input"); radiinput.setattribute("type", "radi"); radiinput.setattribute("value", valuelabel); radiinput.setattribute("name", "ReprtOptins"); radiinput.setattribute("class", "arascheckbxorradi"); var reprtlabel = dcument.createelement("label"); reprtlabel.setattribute("fr", "MyRadi_id"); reprtbuttnspan.appendchild(radiinput); reprtbuttnspan.appendchild(radiinput); reprtbuttnspan.appendchild(reprtlabel); reprtbuttnspan.appendchild(dcument.createtextnde(valuelabel)); sysvaluespan.appendchild(reprtbuttnspan); 18. Save, unlck, and clse. 19. Navigate t the Administratin->Reprts ff the Main Tree. 20. Open a new Reprt Item Aras Crpratin All Cpyrights Reserved. 26

27 21. Set the Reprt Item prperties as fllws: a. Name = Reprt Chser (this can be anything yu want). b. Type = Item (Yu d nt need the reprt_query template when prmpted). c. Lcatin = Client; this is required because the ReprtChser_OpenDialg Methd returns an HTML page with JavaScript that needs t be parsed. The Client side Reprt nly writes the transfrmed page t the brwser windw and thus the JavaScript is nt parsed. d. Target = Nne; the windws will be created by ReprtChser_OpenDialg. e. Methd = ReprtChser_OpenDialg f. Reprt Query = Leave blank; it is currently nt used fr this purpse 22. Save, unlck, and clse the Reprt. 23. Navigate t the Administratin->ItemTypes ff the Main Tree. 24. Search fr the ItemType fr this Reprt. 25. Edit the ItemType and select the Reprts Tab. 26. Add an Existing related Item and select this Reprt. 27. Save, unlck, and clse the ItemType. The Reprt shuld nw appear n the Reprt menu when the Item is selected. When the user clicks Submit the selected Reprt the actual Reprt is requested frm the Reprt Server via the RSGateway. The ID fr the selected Item is autmatically passed as a Named Parameter np:id s yu must name yur Named Parameter in the SQL query with lwercase id als. 8.3 User Input fr XSLT based Reprts Yu need user input fr XSLT based Reprts. Technique Use a Generic Reprt called frm a client Methd s that user input can be cllected fr the query. This sectin describes the steps fr building the User Input Reprt. This is an example and there are alternative ways t implement the user interface but this des illustrate a way t dynamically run a Reprt. In this example, we use a very simple Reprt t get ne input frm the user, which is the Part Number fr the item_number prperty fr the Part ItemType t dynamically build the AML query fr ur Reprt. The fllwing are the steps fr building an Interactive Reprt: 1. Create a Generic Reprt as a template. a. Set the Reprt prperties as fllws: Name = My Reprt (this can be any name yu want) Type = Generic Lcatin = Server Target = Windw b. Cnstruct an AML query and write the Reprt as usual Aras Crpratin All Cpyrights Reserved. 27

28 c. Once the Reprt is written the AML query is n lnger required because the Reprt acts as a template and the AML query is prvided frm the user input interactively s remve the Reprt Query AML frm the Reprt item. But yu may want t use the AML query string as the starting pint fr building the query in the Methd cming up next. 2. Create a client side Methd (named "My Reprt" fr this example) that will: a. Get the user input fr the query, which is a mdal dialg fr this example. b. Cnstruct the actual AML query based n the user input. Use the AML query frm the Reprt yu created as the starting pint. We replace hard-cded search criteria in the AML with variables in ur Methd. c. Create an XML dcument t hld the AML query. d. Get the Reprt item. e. Run the Reprt passing the query XML dcument as the query criteria. 3. Create an Actin t call the Methd. Set the Actin prperties as fllws: Type = Generic Lcatin = Client Target = Nne Methd = My Reprt Name = My Reprt This prvides the lgic t get user input and t invke the Reprt frm an Actin menu chice. The fllwing is client side Methd cde t run the Interactive Reprt: // The Reprt is run as a Generic Reprt s we can pass ur wn AML query fr the Reprt. // Get the query criteria frm the user via a mdal dialg. var params = { aras:aras, innvatr: this.getinnvatr(), dialgheight:227, dialgwidth:350, cntent: 'ReprtTl/UserDialgs/MyReprt.html' ; functin callback(dialgwrapper) { var result = dialgwrapper.result; if (!result){ return; // Create a query Item t hld the AML query fr the Reprt. // The ItemType Part is an example and yu can set this as required. var qry = aras.iminnvatr.newitem('part','get'); // The user input frm the mdal dialg is serialized the int a string. // The frmat fr the serialized string is delimited fr the list f prperties // fr cnstructing the query and each prperty is a name/value pair : delimited. var params = result.split(' '); 2018 Aras Crpratin All Cpyrights Reserved. 28

29 fr (var i=0; i<params.length; ++i) { var param = params[i].split(':'); qry.setprperty(param[0], param[1]); // Get the Reprt item by name. var reprtqry = aras.iminnvatr.newitem('reprt','get'); reprtqry.setprperty('name', 'My Reprt') reprtqry.setattribute('select', 'name,descriptin,reprt_query,target,type,xsl_stylesheet,lcatin,' + 'methd(name,methd_type,methd_cde,runas_user,runas_pwd)'); var reprt = reprtqry.apply(); // Run the reprt passing the query Item as the query criteria fr the Reprt. // The runreprt functin is part f the client Tlkit API, // which expects nde bject nt IOM Item bjects. aras.runreprt(reprt.nde, '', qry.nde); var wnd = aras.getmainwindw(); wnd = wnd === tp? wnd.main : tp; wnd.arasmdules.dialg.shw("iframe", param).prmise.then(callback); 4. Create the HTML page that captures the user s input fr the Reprt. In the sample Methd cde abve, yu ntice the call t pen the mdal dialg and lad it with the ReprtDialgs/MyReprt.html page. This is the relative URL t the file frm the Client/scripts flder fr which the Methds n the server side are invked. Nte: If the flder Client/scripts/ReprtTl/UserDialgs des nt exist create it. The flder name can be anything yu want; basically we are simply creating a lcatin t put the HTML files fr the Reprt dialgs. The fllwing is the sample HTML fr the MyReprt.html page: <html> <style type="text/css"> bdy { backgrund-clr:#d4d0c8;.header { backgrund-clr:#ccccff; fnt-family:helvetica; fnt-weight:bld; fnt-size:16pt; fnt-style: italic; clr:#000000; brder-width:1px; brder-style:inset; padding:8px;.buttns { backgrund-clr:#d4d0c8; brder-width:2px; brder-style:grve; 2018 Aras Crpratin All Cpyrights Reserved. 29

30 padding:10px; td { fnt-family:helvetica; fnt-weight:bld; fnt-size:8pt; </style> <script> var args = windw.frameelement? windw.frameelement.dialgarguments : windw.dialgarguments, aras = (args && args.aras)? args.aras : parent.aras; windw.dialgarguments = args; functin cancel() { args.dialg.result = ''; args.dialg.clse(); functin apply(frm) { args.dialg.result = ''; // Serialize the field values int a string. // Delimit the fields with the character // and delimit the prperty name/value with the : character. // i.e. prp-name:value prp-name:value fr (var i=0; i<frm.elements.length; ++i) { var field = frm.elements[i]; if (field.type == 'text') { if (field.value) { if (args.dialg.result) args.dialg.result+= ' '; args.dialg.result+= field.name + ':' + field.value args.dialg.clse(); nlad = functin() { dcument.bdy.scrll = 'n'; </script> <bdy> <frm> <table brder="0" cellspacing="0" cellpadding="0" width="100%"> <tr height="60"> <td class="header" clspan="2"> My Reprt </td> </tr> 2018 Aras Crpratin All Cpyrights Reserved. 30

31 <tr> <td align="right" style="padding:20px 10px 0px 0px;" nwrap> Descriptin: </td> <td style="padding:20px 00px 0px 0px;"><input type="text" name="part_desc"></td> </tr> <tr> <td align="right" style="padding:4px 10px 20px 0px;" nwrap> Cst: </td> <td style="padding:4px 0px 0px 0px;"><input type="text" name="part_cst"></td> </tr> <tr> <td align="center" class="buttns" clspan="2"> <input type="buttn" value="ok" nclick="apply(this.frm)"> <input type="buttn" value="cancel" nclick="cancel()"> </td> </tr> </frm> </bdy> </html> 5. Yu shuld nw be able t click n My Reprt in the Actin menu and interactively run the Reprt Aras Crpratin All Cpyrights Reserved. 31