Ellucian Banner 9 and Colleague UI 5 LearnMode Integration

Transcription

1 Ellucian Banner 9 and Colleague UI 5 LearnMode Integration Administrator s Getting Started Guide Versions: and higher and and higher Written by: Product Knowledge, R&D Date: May 2018

2 2018 Hyland Software, Inc. and its affiliates.

3 Table of Contents Introduction... 4 Script template overview... 4 Class helper functions... 4 GetValue... 4 GetName... 5 wildcardsearch... 5 debout... 6 Accessibility tree acquisition functions... 6 FindWindow... 6 AppGetTree... 7 Accessibility tree search functions... 8 Accessibility tree search execution... 9 Assignment of search results to data dictionary fields... 9 Apply script in Banner Banner 9 SPAIDEN Script template Apply script in Colleague Colleague VOUI Script template

4 Introduction Ellucian s recent releases of Banner 9 and Colleague UI 5 have transformed the end user client for these two applications to responsive HTML5. Given the HTML5 capabilities of Banner 9 and Colleague UI 5, Ellucian recommends using browsers Google Chrome and Mozilla Firefox versus Microsoft Internet Explorer 11 for optimal performance. To support continued integration with these latest versions, the Perceptive Content LearnMode functionality now supports integration with the two applications running within either Chrome or Firefox via the Microsoft Windows Accessibility API. The LearnMode enhancement is available in the following versions: Perceptive Content and higher Perceptive Content and higher The LearnMode enhancement consists of the following two key components: A new LearnMode Visual Basic Script Library method AppGetTree() which calls into the Windows Accessibility API via COM to return the entire application tree in a single request. Dynamic activation of the Chrome accessibility interface when the AppGetTree() method queries the Chrome browser process window handle. Note This is only specific to the Chrome browser and is not required for Mozilla Firefox browser. This guide provides information on the AppGetTree() method as well as provided Visual Basic Script templates include class helper functions for implementing the AppGetTree() function within a LearnMode Application Plan for Banner 9 or Colleague UI 5 application screens. Script template overview Hyland provides Visual Basic Script templates for integrating with Banner and Colleague to help guide you through the structure and logic used in obtaining the application accessibility nodes and assigning them to data dictionary fields in the Application Plan Designer. The script templates include the following five sections: Class helper functions Accessibility tree acquisition functions Accessibility tree search variables Accessibility tree search execution Assignment of search results to data dictionary fields Class helper functions Class helper functions are defined at the beginning of the script and can be called anywhere within the script. This example script defines the following four class helper functions. GetValue Returns the text after ->, which represents the field value. 4

5 GetValue SYNTAX ARGUMENTS RETURN EXAMPLE GetValue text Returns the text in the appropriate field. No text after -> means that the field value is empty. function GetValue(text) splittext = Split(text, "->") if UBound(splitText) > 0 then GetValue = trim(splittext(1)) GetName Returns the text between [], which represents the name field. GetName SYNTAX ARGUMENTS RETURN EXAMPLE GetName text Returns the text in the appropriate field. No text between [] means that the field value is empty. function GetName(text) if InStr(text, "[") > 0 and InStr(text, "]") > 0 then GetName = Mid(text, InStr(text, "[")+1, InStr(text,"]")- InStr(text, "[")-1) wildcardsearch Determines if the text in the first string contains all the sub-strings of the second string separated by the wildcard pattern (*). wildcardsearch SYNTAX ARGUMENTS wildcardsearch text patternstring 5

6 wildcardsearch RETURN EXAMPLE TRUE = Text in first string contains all the sub-strings of the second string separated by the wildcard pattern (*). FALSE = One or more of the sub-strings are not found. function wildcardsearch(text, patternstring) strings = Split(patternString, "*") found = false For Each SubPattern In strings If Instr(1, text, SubPattern, vbtextcompare) < 1 Then found = false exit for else found = true Next wildcardsearch = found debout Writes out the string to a text file and then opens that text file in the default text editor/viewer. debout SYNTAX ARGUMENTS RETURN EXAMPLE debout tree Writes out the string to a text file. Use the ` character to comment out the code if you do not want the string written out to a text file. function debout(tree) fn = "C:\temp\debout.txt" Set objfso = CreateObject("Scripting.FileSystemObject") Set objfile = objfso.createtextfile(fn, True, true) objfile.write(tree) objfile.close CreateObject("WScript.Shell").Run(fn) Accessibility tree acquisition functions FindWindow Use FindWindow to get the identifier of the window (hwnd). FindWindow SYNTAX int FindWindow(STR WindowTitle) 6

7 FindWindow ARGUMENTS RETURN EXAMPLE ADDITIONAL INFORMATION String WindowTitle is the title of the window for which to search. You can include wildcards (* or?). The result is an integer that identifies the window in the system. h = FindWindow("*App*Nav*") The returned value is most useful when used as the first parameter to AppGetTree. AppGetTree This function returns all the accessibility nodes for a window in a tree like format. AppGetTree SYNTAX ARGUMENTS FILTERS long AppGetTree(int hwnd, String Filters, VARIANT* parrnodes) Use FindWindow to get the identifier of the window (hwnd). Use string filters to return nodes that match the specified filters. You can use multiple filters by separating each filter with the character. For example, the filter "text combobox" returns only nodes which contain "text" or "combobox". This filter is optional. Use the special filter string "parent:" to only return nodes that reside under the matching parent node. Typically, the AppGetTree call returns all accessibility nodes for all open tabs. Use the parent string to limit the nodes returned to a specific tab. The system processes this string first when combined with other filter strings. For example, "parent:document[application Navigator]" returns only nodes for the "Application Navigator" tab in Firefox. 7

8 AppGetTree parrnodes The accessibility nodes are broken into an array of string chunks of bytes or less. The return value of AppGetTree contains the number of elements in the array. The value is zero if the system does not return any accessibility nodes. If the total accessibility tree is smaller than 65K, the system returns the entire tree in the string in first entry in the parrnodes array. Each entry in the array contains a string of the accessibility nodes with each node separated by a carriage return and linefeed. Each accessibility node consists of a space indentation based on the depth of the node, '+' if the node is a parent, followed by the accessibility role, the accessibility name in brackets and the accessibility value, if the node has one preceded by '->' For example: +DIV[] +text[] label[start Date] text[start Date]->04/24/06 +DIV[] label[washington DC 20036,UNITED STA] RETURN EXAMPLE Message Box displays "text[start Date]->04/24/06". h = FindWindow("*App*Nav*") treechunks = AppGetTree(h, "", treenodes) for c = 0 to treechunks - 1 tree = tree + treenodes(c) nodes = Split(tree, vbcrlf) for ln = LBound(nodes) to UBound(nodes) if Instr(nodes(ln), "Start Date]->") > 0 then MsgBox nodes(ln) Accessibility tree search functions In this section, you define the number of nodes the script searches and the text string representing the node name that the system searches to obtain the desired value. The format of the text search string may differ between applications depending on the browser, Chrome or Firefox, you are using. You can use wildcards (*) when defining the search string as shown in the examples below. dim search(6) search(0) = " text[street Line 1*] ->" search(1) = " text[street Line 2*] ->" search(2) = " text[phone Number*] ->" search(3) = " text[city*] ->" search(4) = " text[state or*] ->" search(5) = " text[zip*] ->" search(6) = " combobox[part or Full Time Status*] ->" 8

9 Accessibility tree search execution In this section, the script traverses the accessibility tree nodes to locate the search strings defined in the previous section. The logic leverages the class helper functions GetValue() and GetName() to extract the values from nodes containing values or names that you want to leverage in the Application Plan. The logic of this section remains mostly unchanged by administrators. for ln = LBound(nodes) to UBound(nodes) for s = LBound(search) to UBound(search) if wildcardsearch(nodes(ln), search(s)) then values(s) = GetValue(nodes(ln)) if wildcardsearch(nodes(ln), "div[id") > 0 then ' line has ID in name.. id = GetName(nodes(ln + 1)) Assignment of search results to data dictionary fields In this section, the mapping of the Application Plan data dictionary fields to the search results values from the section above happens. Below is an example where the data dictionary fields are ID, Street Line 1, Street Line 2, City, and Phone. field("id") = id field("street Line 1") = values(0) field("street Line 2") = values(1) field("city") = values(3) & "," & values(4) & " " & values(5) field("phone") = values(2) Apply script in Banner 9 This example script returns data on the Address Information tab on the General Person Identification (SPAIDEN) screen when using the Chrome or Firefox browsers. 1. In Management Console, select the application you want to add the visual basic script and click Modify. 2. In Application Plan Designer, in the Screens pane, select the Address screen. 3. In the Dictionary pane, double-click the dictionary data element for which you want to apply the script. 4. In the Dictionary Field dialog box, under Processing, click Add, and then Script. 5. In the Script dialog box, click Create and then type a name for your script. 6. Select the script you just created and click Modify. 7. In the Script New Script dialog box, copy and paste the Banner 9 sample script from below in the text box under Script. 8. In the script, remove the ` backtick from the following line of code to uncomment the command: debout(tree 9. Click Test to run the script. The system extracts the data on the Address Information tab and opens it in your default text editor. 9

10 10. Use the information in the text editor to find the appropriate text and matching pattern you need to modify your script for that particular screen. nodes = Split(tree, vbcrlf) dim search(5) search(0) = "text[street Line 1*]->" search(1) = "text[street Line 2*]->" search(2) = "text[phone Number*]->" search(3) = "text[city*]->" search(4) = "text[state or Province*]->" search(5) = "text[zip or Postal Code*]->" 11. After you added all the necessary information, add the ` backtick back to the following line of code to comment the command: debout(tree 12. Click OK to save the script. Banner 9 SPAIDEN 10

11 Script template ' return text after -> which represents value field function GetValue(text) splittext = Split(text, "->") if UBound(splitText) > 0 then GetValue = trim(splittext(1)) ' return text between [] which represents name field function GetName(text) if InStr(text, "[") > 0 and InStr(text, "]") > 0 then GetName = Mid(text, InStr(text, "[")+1, InStr(text,"]")-InStr(text, "[")-1) ' true if text contains all substrings in patternstring Function wildcardsearch(text, patternstring) strings = Split(patternString, "*") found = false For Each SubPattern In strings If Instr(1, text, SubPattern, vbtextcompare) < 1 Then found = false exit for else found = true Next wildcardsearch = found End Function ' write tree to text file function debout(tree) fn = "C:\temp\debout.txt" Set objfso = CreateObject("Scripting.FileSystemObject") Set objfile = objfso.createtextfile(fn, True, true) objfile.write(tree) objfile.close CreateObject("WScript.Shell").Run(fn) h = FindWindow("*App*Nav*") treechunks = AppGetTree(h, "parent:document[application Navigator]", treenodes) for c = 0 to treechunks - 1 tree = tree + treenodes(c) debout(tree) nodes = Split(tree, vbcrlf) dim search(5) search(0) = "text[street Line 1*]->" search(1) = "text[street Line 2*]->" search(2) = "text[phone Number*]->" search(3) = "text[city*]->" search(4) = "text[state or Province*]->" search(5) = "text[zip or Postal Code*]->" 11

12 dim values(10) addresstab = false for ln = LBound(nodes) to UBound(nodes) for s = LBound(search) to UBound(search) if wildcardsearch(nodes(ln), search(s)) then values(s) = GetValue(nodes(ln)) if Instr(1, nodes(ln), "div[id", vbtextcompare) > 0 then ' line has ID in name.. id = GetName(nodes(ln + 1)) elseif Instr(nodes(ln),",")>0 and Instr(1,nodes(ln),"span[",vbTextCompare)>0 then name = GetName(nodes(ln)) elseif Instr(nodes(ln), "label[address INFORMATION]") > 0 then addresstab = true elseif Instr(nodes(ln), "text[address INFORMATION]") > 0 then addresstab = true ' firefox if not addresstab then msgbox "Switch to Address tab" field("id") = id field("name") = name field("street Line 1") = values(0) field("street Line 2") = values(1) field("phone") = values(2) field("city") = values(3) & "," & values(4) & " " & values(5) Apply script in Colleague This example script returns data on the Voucher Inquiry (VOUI) screen when using the Chrome or Firefox browsers. 1. In Management Console, select the application you want to add the visual basic script and click Modify. 2. In Application Plan Designer, in the Screens pane, select the Address screen. 3. In the Dictionary pane, double-click the dictionary data element for which you want to apply the script. 4. In the Dictionary Field dialog box, under Processing, click Add, and then Script. 5. In the Script dialog box, click Create and then type a name for your script. 6. Select the script you just created and click Modify. 7. In the Script New Script dialog box, copy and paste the Banner 9 sample script from below in the text box under Script. 8. In the script, remove the ` backtick from the following line of code to uncomment the command: debout(tree 12

13 9. Click Test to run the script. The system extracts the data on the Voucher Inquiry screen and opens it in your default text editor. 10. Use the information in the text editor to find the appropriate text and matching pattern you need to modify your script for that particular screen. nodes = Split(tree, vbcrlf) dim search(6) search(0) = " text\[.*field Name\]->" search(1) = " text\[.*field Address.*->" search(2) = " text\[.*field City.*->" search(3) = " text\[.*field State.*->" search(4) = " text\[.*field Zip.*->" search(5) = " text\[.*field Due Date.*->" search(6) = " text\[.*field Check No.*->" 11. After you added all the necessary information, add the ` backtick back to the following line of code to comment the command: debout(tree 12. Click OK to save the script. 13

14 Colleague VOUI Script template 'Colleague VOUI ' return text after -> which represents value field function GetValue(text) splittext = Split(text, "->") if UBound(splitText) > 0 then GetValue = trim(splittext(1)) ' return text between [] which represents name field function GetName(text) if InStr(text, "[") > 0 and InStr(text, "]") > 0 then GetName = Mid(text, InStr(text, "[") + 1, InStr(text, "]") - InStr(text, "[") - 1) ' write tree to text file function debout(tree) fn = "C:\temp\debout.txt" 14

15 Set objfso = CreateObject("Scripting.FileSystemObject") Set objfile = objfso.createtextfile(fn, True, true) objfile.write(tree) objfile.close CreateObject("WScript.Shell").Run(fn) h = FindWindow("*coll18*") if h = 0 then msgbox "Window not found" treechunks = AppGetTree(h, "parent:document[-", treenodes) for c = 0 to treechunks - 1 tree = tree + treenodes(c) 'debout(tree) nodes = Split(tree, vbcrlf) dim search(6) search(0) = " text\[.*field Name\]->" search(1) = " text\[.*field Address.*->" search(2) = " text\[.*field City.*->" search(3) = " text\[.*field State.*->" search(4) = " text\[.*field Zip.*->" search(5) = " text\[.*field Due Date.*->" search(6) = " text\[.*field Check No.*->" dim values redim values(10) Set RE = New RegExp RE.IgnoreCase = True for ln = LBound(nodes) to UBound(nodes) for s = LBound(search) to UBound(search) RE.Pattern = search(s) If RE.Test(nodes(ln)) Then values(s) = GetValue(nodes(ln)) if Instr(nodes(ln), "[Voucher ID") > 0 then voucherid = GetName(nodes(ln + 3)) if voucherid = "" then voucherid = GetName(nodes(ln + 4)) if Instr(nodes(ln), "[Status Date") > 0 then statusdate = GetName(nodes(ln + 3)) if statusdate = "" then statusdate = GetName(nodes(ln + 4)) if Instr(nodes(ln), "[Status :") > 0 then status = GetName(nodes(ln + 3)) if status = "" then status = GetName(nodes(ln + 4)) field("name") = values(0) field("address") = values(1) field("city") = values(2) & "," & values(3) & " " & values(4) 15

16 field("due Date") = values(5) field("check Num") = values(6) field("voucher ID") = voucherid field("status Date") = statusdate field("status") = status 16