Creating Macros David Giusto, Technical Services Specialist, Synergy Resources

Transcription

1 Creating Macros David Giusto, Technical Services Specialist, Synergy Resources

2 Session Background Ever want to automate a repetitive function or have the system perform calculations that you may be doing by hand? Learn how to utilize macros in VISUAL to extend its capabilities, and fill company specific needs. Macros can be written in basic SQL language, or VB script. Some knowledge of both is recommended for this session. Description Track: Extended Audience: IT and Scripting users Skill Level: Intermediate Room Info: Room 3 2

3 Session Outcomes What will the outcomes of the session be? Understand capabilities and limitations of Macros Where and how to use Macros Basic syntax and controls usage Management and distribution of Macros 4

4 Creating Macros Session Description Learn how to utilize macros in VISUAL to extend the capabilities, and fill company specific needs. Macros can be written in basic SQL language, or VB script. Some knowledge of both is recommended for this session. 5

5 Creating Macros - Syllabus I. Macro 101 Introduction II. Basic Macro Concepts For the Non Programmer Audience III. Intermediate Macro Concepts Script Writers and/or SQL Novices IV. Advanced Topics Application Programmers 6

6 Creating Macros Part I Macro 101 Introduction 7

7 Macro 101 The Introduction Macro (def.) A set of instructions used to automate certain tasks within the host program. Visual provides hooks in most of the windows for user defined macros. The macro language implemented within Visual is VBScript. For a brief history of VBScript check out: 8

8 Macro 101 Who You can create your own Macros What Custom & Automated Processing When On Events or On Demand Where Most Windows, varies by version Why Productivity & Efficiency How is the object of this session 9

9 Macro 101 Who can create macros? You can do this! Non Programmer Basic field checks User reminders via simple pop-ups Script Writer and/or SQL Novice Database lookups More complex algorithms Applications Programmer Practically anything you want 10

10 Macro 101 What can they do? Custom & Automated Processing right in many Visual windows. Implemented in VBScript; which can be as simple as a pop-up reminder message or as complex as any window or function in Visual. Access to the Visual or other databases, file systems, other computers, web services, and third part APIs are all possible. 11

11 Macro 101 When can they be used? On Demand Any macro can be triggered at any time by the user, even the event macros. Automatically on certain events OnNew, OnLoad, OnSave, AfterSave There is no Delete event 12

12 Macro 101 Where are macros available? All the standard business process windows Sales Process Estimating Window, Customer Order Entry, Shipping Entry, Order Management, RMA Purchasing Process Order Entry, Purchase Requisition, Receiving Engineering/Manufacturing Process Part Maintenance, Manufacturing Window, Labor Ticket Entry, Inventory Transaction Entry Admin/Maintenance/Other Doc Maint., Customer Maint., Invoice Entry, Accounting Windows, Vendor RFQ, and many more No Macros Customer Inquiry, Vendor Inquiry, Scheduling, Invoice Forms 13

13 Macro 101 Why use macros? Business rule enforcement Time savings Data entry error avoidance Task Automation Productivity Efficiency Launching other processes, reports, etc. 14

14 Macro 101 How can you create macros? See Parts Two through Four for details on how to take advantage of macros. 15

15 Part II Creating Macros Basic Macro Concepts For the Non Programmer Audience 16

16 Special Macro Variables MACRO_SUCCESS MACRO_MESSAGE On Demand vs. Event Macros Is there a difference? Macro Events OnNew OnLoad OnSave OnAfterSave OnDelete (new in 8.0) OnAfterDelete (New in 8.0) Macro integration architecture An overview The Manufacturing Window a Special Case VBScript interface MsgBox and InputBox Basic Macro Concepts 17

17 MACRO_SUCCESS Special Macro Variables A Boolean (True/False; 1/0) flag indicating successful completion of the macro. This will abort a Save operation if set to False or Zero. MACRO_MESSAGE A string that the describes the error or failure mode indicated by setting Macro_Success to False or Zero. This message will pop-up in a message box. 18

18 On Demand vs. Event Macros On Demand and Event Macros are exactly the same in every way except that Event Macros will fire automatically on certain conditions based on user actions. On Demand Invocation Macro Menu Toolbars > Visual.ini UserToolbar=Y Events New Load Save After Save Delete (New in 8.0) After Delete (New in 8.0) 19

19 On Demand (User Fired) Macro Process Flow VM Window Script Engine Fire Macro from Menu Load Script Variables Run User Macro Script Process Changed Variables Macro_Message Pop-Up Resume GUI NO = 0 Macro_Success 1 20

20 OnNew Event Process Flow VM Window Script Engine Clear Fields & Set Defaults OnNew Event Load Script Variables Run User Macro Script Process Changed Variables Macro_Message Pop-Up Resume GUI NO = 0 Macro_Success 1 21

21 OnLoad Event Process Flow VM Window Script Engine Record Read from DB OnLoad Event Load Script Variables Run User Macro Script Process Changed Variables Macro_Message Pop-Up Resume GUI NO = 0 Macro_Success 1 22

22 OnSave Event Process Flow VM Window OnSave Event Script Engine Load Script Variables Run User Macro Script Process Changed Variables Macro_Message Pop-Up NO = 0 Macro_Success Resume GUI Save Record to DB 1 23

23 OnAfterSave Event Process Flow VM Window Script Engine Record Saved to DB OnAfterSave Event Load Script Variables Run User Macro Script Process Changed Variables Macro_Message Pop-Up Resume GUI NO = 0 Macro_Success 1 24

24 OnDelete Event Process Flow VM Window OnDelete Event Script Engine Load Script Variables Run User Macro Script Process Changed Variables Macro_Message Pop-Up NO = 0 Macro_Success Resume GUI Delete Record to DB 1 25

25 OnAfterDelete Event Process Flow VM Window Script Engine Record Deleted from DB OnAfterDelete Event Load Script Variables Run User Macro Script Process Changed Variables Macro_Message Pop-Up Resume GUI NO = 0 Macro_Success 1 26

26 Main Windows Event Loop Handles Keyboard / Mouse and Drawing Events Process Flow is not Program Flow VM Window Start a Macro Script Engine Load Script Variables A Dialog Box Modality Blocks Other Event Activity Non-Modal Allows Other Event Activity Run User Macro Script Process Changed Variables Macro_Message Pop-Up is Modal Resume GUI NO = 0 Macro_Success 1 27

27 Integration with Visual Mfg Macro Menu 28

28 Integration with Visual Mfg Selecting Edit from the Macro Menu opens this window: 29

29 Integration with Visual Mfg Type in a Macro Name Click the Edit Area 30

30 Integration with Visual Mfg Pull-Down Lists the Macro Variables Insert Button Pastes a variable name into the editor area. 31

31 Basic Macro Example MsgBox "On Load" - pops-up this message: 32

32 Most Windows All Event Driven Macro Names Work Order Header Manufacturing Window Only Operation Card Material Card These Macro names are case sensitive Leg/Detail Header OnNew OnNewWO OnNewOP OnNewMAT OnNewLEG OnLoad OnLoadWO OnLoadOP OnLoadMAT OnLoadLEG OnSave OnSaveWO OnSaveOP OnSaveMAT OnSaveLEG OnAfterSave OnAfterSaveWO OnAfterSaveOP OnAfterSaveMAT OnAfterSaveLEG OnDelete N/A N/A N/A N/A OnAfterDelete N/A N/A N/A N/A 33

33 Manufacturing Window Context Mfg window macros show in all cards so we sometimes need to know the context that the macro is running under. 'Determine what type of MFG card we are running from IF VarType(WO_TYPE) <> vbempty THEN MsgBox "Header" ELSEIF VarType(RESOURCE_ID) <> vbempty MsgBox "Operation" ELSEIF VarType(LEG_DETAIL) <> vbempty MsgBox "Leg/Detail" ELSEIF VarType(LEG_DETAIL) <> vbempty ELSE MsgBox "Material" MsgBox "???" END IF THEN AND LEG_DETAIL = TRUE THEN AND LEG_DETAIL = FALSE THEN 34

34 VBScript Interface VBScript Language Reference, Help and examples on-line: These reference sites are listed in no particular order and each has its own benefits and drawbacks. Since VBScript is popular in web page programming there are many examples that are HTML biased. Try to stay with basic scripting engine examples or the HTML will just cause confusion. 35

35 MsgBox and InputBox Built in VBScript functions for basic user interaction. MsgBox Pops up a message and waits for the user to click a button Returns a value indicating which button was pressed Can Operate in Application Modal Mode InputBox Pops up a message and allows user entry of data Returns a string value input by the user; Cancel = Empty Does not operate in any Modal Mode (not ideal for us) 36

36 MsgBox Details MsgBox(prompt[,buttons][,title][,helpfile,context]) Prompt the message to display Buttons appearance and behavior bit mask Title the window title bar label 37

37 MsgBox Details. Buttons value add no more than one from each group Buttons to display 0 = vbokonly - OK button only 1 = vbokcancel - OK and Cancel buttons 2 = vbabortretryignore - Abort, Retry, and Ignore buttons 3 = vbyesnocancel -Yes, No, and Cancel buttons 4 = vbyesno -Yes and No buttons 5 = vbretrycancel - Retry and Cancel buttons Icon to display 16 = vbcritical - Critical Message icon 32 = vbquestion - Warning Query icon 48 = vbexclamation - Warning Message icon 64 = vbinformation - Information Message icon Cont. 38

38 MsgBox Details Buttons value add no more than one from each group Default button 0 = vbdefaultbutton1 Default is the First button 256 = vbdefaultbutton2 - Default is the Second button 512 = vbdefaultbutton3 - Default is the Third button Modality 0 = vbapplicationmodal - Application modal - the current Visual window is blocked until the user responds to the MsgBox (doesn t work as advertised??) 4096 = vbsystemmodal - System modal - all applications are blocked until the user responds to the MsgBox (just makes the window stay on top of others) ApplicationModal in newer versions of Windows no constant so use (vbsystemmodal*2) 39

39 MsgBox Details MsgBox return values 1 = vbok - OK was clicked 2 = vbcancel - Cancel or the X was clicked 3 = vbabort - Abort was clicked 4 = vbretry - Retry was clicked 5 = vbignore - Ignore was clicked 6 = vbyes -Yes was clicked 7 = vbno - No was clicked 40

40 MsgBox Details an Example Prompt can be multi-line with the vbcrlf keyword ( & will concatenate strings; + should be avoided for Strings) button = vbyesno + vbquestion + vbsystemmodal*2 prompt = "Yes for Purchased" & vbcrlf & "No for Fabricated" Val = MsgBox(prompt, button,"new Part Type") If val = vbyes Then PURCHASED = True FABRICATED = False ElseIf val = vbno Then PURCHASED = False FABRICATED = True Else 'Notice that the 'X' is grayed out no cancel button End If 'Should never get here 41

41 MsgBox Details Parentheses To use parentheses or not to use parentheses? When returning a value from a function use parentheses When calling a subroutine (no return) use no parentheses MsgBox("My Prompt", button,"a title") Val = MsgBox "My Prompt", button,"a title Correct syntax: Val = MsgBox("My Prompt", button,"a title") MsgBox "My Prompt", button,"a title MsgBox ("Why does this example work with parentheses?") Hint: it only has one argument 42

42 InputBox Details InputBox(prompt[,title][,default][,xpos][,ypos][,helpfile,context]) prompt the message to display title the window title bar label default pre-populated input string xpos, ypos screen display location Returns the input string on Ok or the empty string on a user Cancel which includes the X InputBox is not modal - so there is no way to prevent multiple instances of the macro from running at the same time - be careful with this. 43

43 InputBox an Example (Poor Man s Multi-Select) Prompt = "a. Purchased" & vbcrlf & _ "b. Fabficated" & vbcrlf & _ "c. Hardware" & vbcrlf & _ "d. Drawing" & vbcrlf & _ "e. Other" key = InputBox(Prompt,"Select a Part Type") If ucase(key) = "A" Then Fabricated PURCHASED = True FABRICATED = False ElseIf ucase(key) = "B" Then Purchased PURCHASED = False FABRICATED = True ElseIf ucase(key) = "C" Then Hardware PURCHASED = True FABRICATED = False PREF_VENDOR_ID = "MMC PRIMARY_WHS_ID = "HW" ElseIf ucase(key) = "D" Then Drawing PURCHASED = False FABRICATED = True DETAIL_ONLY = True ElseIf ucase(key) = "E" or key = "" Then 'do nothing Else MsgBox "Input not valid", vbsystemmodal*2 End If 5/23/

44 What s Really Going On? The Macro variable interface only manipulates the GUI fields in Visual windows. Read only fields are available for reference but can t be modified from a macro Read/Write fields can be accessed and modified All Visual business logic is maintained Any changes are as if the user typed them from the keyboard 45

45 Part III Creating Macros Intermediate Macro Concepts Script Writers and/or SQL Novices 46

46 Automate Time-Consuming Tasks with Macros Intermediate macro concepts Working with Grids and Lines Creating New Lines with Macros Using Sendkeys Editing and Debugging A Sidebar Scripting Engine restrictions Funky Behavior in Some Windows? Toolbars that Run Macros 47

47 Working with Grids The Lines Collection The Grid is a collection of lines A line is a collection of columns A 2 Dimensional array of values 48

48 LINES Collection Structure LINES Collection of Grid Lines EditFlag Modified indicator Name LINES Value Collection of Rows _NewEnum Enumeration object Count Count of Rows Item Array of Row Items EditFlag Modified indicator Name LINE_0, LINE_1, LINE_2, LINE_n Value Collection of Columns _NewEnum Enumeration object Count Count of Columns Item Array of Column Items EditFlag Modified indicator Name Column Name Value Cell Value 49

49 Working with Grids The Lines Collection These syntax methods yield all the same result LINES.Value.Item(i).Value.Item(j).Value LINES.Value.Item( LINE_0 ).Value.Item( column_name ) LINES.Value(0).Value(0).Value LINES(0)(0).Value LINES(0)(0) LINES("LINE_0")("LINE_NO").VALUE LINES("LINE_0")("LINE_NO") Another common method is to use intermediate variables: Set ORDERLINES = LINES.Value ORDERLINE = ORDERLINES(i).VALUE ORDERLINE( Column_Name ) 50

50 Working with Grids The Lines Collection A classic example to access line data Set ORDERLINES = LINES.Value Lcnt = ORDERLINES.Count For i = 0 To (Lcnt - 1) Set ORDERLINE = ORDERLINES(i).VALUE Get the lines Get the count of lines Loop through the Lines Get one line If ORDERLINE("USER_ORDER_QTY") > 0 Then Access column data MsgBox("Ln # " & ORDERLINE("LINE_NO") & _ " Part: " & ORDERLINE("PART_ID") & _ " Qty = " & ORDERLINE("USER_ORDER_QTY")) Else MsgBox( "Setting line # " & ORDERLINE("LINE_NO") & " Quantity to = 1") ORDERLINE("USER_ORDER_QTY") = 1 End if Next 51

51 Working with Grids The Lines Collection A different method that does exactly the same as the previous example accessing the LINES variable only For i = 0 To (LINES.Value.Count - 1) next If LINES(i)("USER_ORDER_QTY") > 0 Then MsgBox("Ln # " & LINES(i)("LINE_NO") & _ " Part: " & LINES(i)("PART_ID") & _ " Qty = " & LINES(i)("USER_ORDER_QTY")) Else MsgBox( "Setting line # " & LINES(i)("LINE_NO") & _ " Quantity to = 1") LINES(i)("USER_ORDER_QTY") = 1 End if 52

52 Retrieving the Grid Column Names 'Dump out all the LINE column names 'Assumes at least one line is loaded in the grid Names = "" 'Initialize the Names variable If LINES.Value.Count > 0 Then 'Check that there are lines Set objdataline = LINES(0) 'Get the first line into an object For i = 0 to (objdataline.value.count - 1) 'Loop through the columns Names = Names & _ objdataline(i).name & vbcrlf 'Accumulate the names if len(names) > 400 then 'Chunk it up because MsgBox has a limit msgbox Names 'Output the information Names = "" 'Reset the Names variable end if Next If Names <> "" Then msgbox Names 'Output the last chunk if required Else MsgBox ("Load a line into the grid") 'Handle the error condition end if 53

53 Retrieving the Grid Column Names - COE 54

54 Creating New Lines with Macros Using SendKeys Insert Lines Macro (Note: Next Macro does not work in 7.0 w/o SP3) DO CNT = 0 CNT = INPUTBOX("How many Line Items to add?","line Creator","0") IF CNT = "" THEN CNT = -1 'Cancel was selected IF NOT IsNumeric(CNT) THEN cnt = 26 If CNT > 25 THEN MSGBOX("Invalid Entry - 25 Line Items MAX.") END IF LOOP UNTIL CNT <= 25 IF CNT > -1 THEN 'Not Cancel Set ObjShell = CreateObject ("Wscript.shell") objshell.appactivate("estimating Window") If CNT > 0 THEN FOR i = 1 TO CNT ' Send an INSERT for each Line Item to add objshell.sendkeys("{insert}") NEXT END IF 'Send the Alt-M-N sequence to launch the Next Macro objshell.sendkeys("%mn") END IF 5/23/

55 Creating New Lines with Macros & Cascading &Next Macro (Note: Next Macro does not work in 7.0 w/o SP3) For i = 0 to (LINES.VALUE.COUNT - 1) If LINES(i)("PART_ID") = "" Then LINES(i)("PART_ID") = "Foo1" End If Next Notice the & before the N in &Next Macro this makes it the keyboard accelerator or hot Key. 56

56 Editing Macros and Naming Conventions If you want to use another editor you need to know where the files are located and the naming conventions. Macro files are found in the VM local configuration directory and are of the.vms extension type. The VM local configuration directory is stored in the registry: HKEY_CURRENT_USER\SOFTWARE\Infor Global Solutions\VISUAL Manufacturing\Configuration\Local Directory The format for macros file names is: APPLICATION_MacroName.VMS Examples: VMPRTMNT_OnSave.vms VMORDENT_MyMacro.vms VM 8.0/9.0 for saving in the DB see the MACRO and MACRO_PROFILE tables. 57

57 Setting Up a VBScript Editor/Debugger Editors Visual Studio for applications comes with SQL Server & other MS products Notepad++ Vbsedit Debuggers: Visual Studio (non-express versions) Other script debuggers are no longer available (scd10en.exe, MSE7, etc.) Breakpoints Enable/disable by setting "JITDebug"=1 or 0 [HKEY_CURRENT_USER\Software\Microsoft\Windows Script\Settings] [HKEY_CURRENT_USER\Software\Wow6432Node\Microsoft\Windows Script\Settings\] The STOP keyword Exception handling 58

58 Script Engine Restrictions The embedded script engine runs a subset of the standard CScript/WScript functionality No sleep function There are other ways to accomplish a time delay No Wscript.Echo There is no console you have to use a MsgBox 59

59 sub sleep(mili) A Sleep Substitute using WMI sleepseconds = Cint(mili / 1000) wakeat = Second(DateAdd("S",sleepSeconds,Time())) Set objswbemservices = GetObject("WinMgmts:Root\Cimv2") Set colevents = objswbemservices.execnotificationquery _ ("Select * From InstanceModificationEvent " _ & "Where TargetInstance Isa 'Win32_LocalTime' " _ & "And (TargetInstance.Second = " & wakeat & ")") Set objevent = colevents.nextevent end sub 60

60 Funky Behavior in Some Windows? Some windows have unexpected event trigger points because of how the particular user interface is designed. (Version dependencies apply) Shipping Entry OnLoad doesn t fire in early 6.5.2, Edit PackList does not trigger any macros but after a Save the OnLoad fires in shipping window Purchase Order Entry Saving triggers -> OnSave, OnLoad, OnAfterSave Inventory Transaction Entry The UI clears the ID when saving a new entry so it is not available in the OnSave or OnAfterSave macros Create four macros -> MsgBox OnEvent and test Msgbox OnLoad, MsgBox OnSave, etc. 62

61 Toolbars that Run Macros In the Visual.ini or Preferences Maintenance set UserToolbar=Y On the Admin Menu ->Toolbar Maintenance Use a.vms macro for the Execute File field (8.0/9.0 different with Macro in DB) Search for "User Toolbars" in VM Help Use 16x16.bmp icon files for 7.0 Plenty in the Visual directory or make your own Use 24x72 (stacked).bmp icon files for and beyond (Active, Inactive, Highlighted) 63

62 Part IV Creating Macros Advanced Topics Application Programmers 64

63 Automate Time-Consuming Tasks with Macros Advanced topics DLL Integration Custom GUI Examples Login Box Modal InputBox Modal MsgBox Notes and Specs Indicator 65

64 DLL Integration Microsoft Visual Studio Express Editions Free! The Examples are in VB Express 2008 Create a new Project Windows Forms Application 66

65 DLL Integration Add some controls to the form 67

66 DLL Integration Add the Properties and Button Handler 68

67 DLL Integration Project Properties Note the Namespace Make it a Class Library and COM-Visible 69

68 DLL Integration Compile the DLL Deploy to the MacroServer Root Directory 70

69 DLL Integration Using the Macro Server Create a Macro VMPRTMNT_DLLTest 71

70 DLL Integration Running the Macro If you run into.net permission issues make sure to include the Macro Server URL in the trusted Local Intranet sites list IE -> Internet Options -> Security Tab 72

71 Example Project Login Box Modal InputBox Modal MsgBox Custom GUI Examples Notes and Specs Indicator Behaves Like Part View Panel 73

72 Custom GUI Examples Attached is the example VB.Net project source code Includes the Macro Examples (change the server name) Click on the Icon to open the ZIP file It takes a minute to extract the zip from the presentation 74

73 Q & A For more information Visit us in One-on-One Consulting 75

74 Questions? 76

75 Thank You for Attending! Thank you for attending this session and making VISUAL Focus all about you the customer! We look forward to hearing all the great feedback about the sessions and how to make your next session and next years conference even better! Feedback can be submitted via the conference schedule website by navigating to the event on either your computer or mobile phone at: Look for the Session Feedback section on the session 77