User Guide. Excel Data Management Pack (EDM-Pack) OnCommand Workflow Automation (WFA) Abstract PROFESSIONAL SERVICES. Date: December 2015

Transcription

1 PROFESSIONAL SERVICES User Guide OnCmmand Wrkflw Autmatin (WFA) Excel Data Management Pack (EDM-Pack) Date: December 2015 Dcument Versin: Abstract The EDM-Pack includes a general-purpse Data Surce that can read frm a Micrsft Excel spreadsheet directly int a WFA custm scheme and dictinaries. Thse dictinary tables are then available t wrkflws fr search and selectin in user interface Queries, Filters, Finders, and Cmmands. This allws wrkflws t align with custmer business rules, rganizatin and envirnmental infrmatin. In additin, a wrkflw is included which will exprt an existing WFA scheme t an Excel spreadsheet allwing viewing and reprting f data within the WFA Cache Database.

2 TABLE OF CONTENTS 1 Intrductin Prerequisites and Installatin Installatin Steps Imprting frm Micrsft Excel int a Custm Scheme Mapping Rules: Excel Table-Clumn t WFA Table-Clumn Single Spreadsheet Table int a Single WFA Dictinary Table Multiple Tables with Relatins Between (the EDM sample) Exprting a Custm r Standard Scheme int Micrsft Excel WFA Excel Data Management Pack 2

3 1 Intrductin The Excel Data Management Pack (i.e.; EDM-Pack) simplifies integrating custmer business rules, rganizatin, and envirnmental infrmatin int the WFA envirnment s they are available within custm WFA wrkflws. Examples might include prduct cdes, cst centers, applicatin prvisining rules, r data center lcatins, all f which can imprve the effectiveness and useablility f custmer specific WFA wrkflws. WFA natively supprts acquiring external data via custm WFA Data Surces Types (Designer tab -> Data Surce Types). Tw methds are available: SQL and Script based. A SQL Data Surce Type acquires infrmatin frm external SQL databases and imprts it int custm WFA scheme tables. A Script Data Surce Type is a custm written script that gathers, frmats and imprts data int custm WFA scheme tables. EDM includes a custm Script based Data Surce Type (the EDM Data Surce) that: Imprts directly frm specially frmatted Excel spreadsheets int WFA Cache DB tables Is general purpse and re-useable. All that is required t re-use the EDM Data Surce Type fr a custmer specific use-case is t clne it int a new WFA Scheme. T illustrate the cncept, the EDM-Pack includes a sample WFA scheme (edm), dictinaries (site and strage) and a crespnding spreadsheet (edm.xlsx) with sample data. After imprting the EDM dar file int WFA a quick test can be perfrmed by creating an executin Data Surce (Executin tab -> Data Surces -> New) and imprt data frm edm.xlsx int the WFA edm scheme and tables (site, strage). NOTE: the edm scheme is just an example and a hlder fr the EDM Data Surce Type. The intentin is a custmer wuld create a new custm scheme and dictinaries and then clne the EDM Data Surce Type setting it t be assciated with the new custm scheme. The cntents f the EDM-Pack are listed belw. Table 1) EDM-Pack cmpnents include: File EDM-Pack_Pv_1_0_0.dar EDM-UserGuide_Dv_1_0_0.pdf Purpse EDM wrkflws, scheme, data surce, dictinaries, samples The EDM User Guide in PDF frmat (this dcument) WFA Excel Data Management Pack 3

4 2 Prerequisites and Installatin The EDM-Pack has the fllwing prerequisites: Windws Server 2008R2 r 2012R2 fr WFA Server OnCmmand Wrkflw Autmatin - WFA Versin 3.1P1 r later It is assumed WFA is already installed and setup The Linux flavr f WFA is nt supprted 2.1 Installatin Steps In summary, the installatin prcess is imprting the EDM-Pack dar file and executing an initializatin wrkflw. In mre detail: The EDM-Pack cde is distributed as a WFA dar file. Dwnlad and have the EDM-Pack dar file accessible t yur brwser. Access the WFA system ( and lgin in as a WFA admin user. Use the Administratin -> Imprt menu selectin t brwse t the lcatin where yu have dwnladed and saved the EDM-Pack dar file. Once yu chse r select the dar file yu will be presented with the list f cmpnents within the dar cntainer file t verify it s cntents. Click [Imprt] t cntinue. After a few secnds yu get a Imprt Success windw. Click [OK] and the brwser windw will refresh and return t the WFA Prtal tab page. The left panel n the Prtal page will nw include the Excel Data Management categry. Click n that categry t select it and view the wrkflws within. Click the EDM000 Pack Initializatin wrkflw t execute it. Chse the default Install actin and the wrkflw lads prerequisite mdules and files. At this pint the EDM-Pack is fully installed. Cntinue t the next sectins f this dcument t: Create yur wn new scheme, dictinaries and spreadsheet, r Test EDM with the included sample edm.xlsx spreadsheet data. WFA Excel Data Management Pack 4

5 3 Imprting frm Micrsft Excel int a Custm Scheme The EDM Data Surce Type supprts a cmbinatin f: single r multiple independent table(s) multiple tables with relatinships between them The fllwing sectins step thrugh: Mapping Rules: Excel Table-Clumn t WFA Table-Clumn, Single Spreadsheet Table int a Single WFA Table, Multiple Tables with Relatins Between (the EDM sample) 3.1 Mapping Rules: Excel Table-Clumn t WFA Table-Clumn The verall cncepts and mapping rules f the EDM Data Surce are: This data surce reads an existing Excel.xlsx file specified in the executin Data Surce's 'Hst name:' field, fr example: C:\WFA-Data\acme.xlsx The name f the excel file must match the WFA scheme name. The names f each wrksheet/tab in the.xlsx file shuld match the names f a WFA Dictinary entity that yu create with a matching name The names f clumns shuld be placed in rw 1 f each wrksheet/tab and thse names shuld match up with WFA Dictinary field names Specific dictinary entries can be created under any new scheme yu'd like. Just clne the EDM Data Surce Type' and place it int yur new scheme as yu clne it. Dn't frget t generate yur tables using reset scheme, befre first use. T use relatinships between tables, fllw these additinal rules: Yur primary key shuld be the first clumn and called "id" Yur primary key shuld be unique, and can be text Yur freign key clumns shuld end with "_id" and match its parents id. It can be text. If yu dn't have a primary key clumn, the id clumn will be added autmatically with NULL values. NOTE: All WFA tables have an id clumn internally which is nt visible in the WFA Dictinary fr the table. WFA autmatically creates the id field with an incrementing value when the data is acquired. Fr example, yu see it as a clumn f the cluster table f the cm_strage scheme/database as cm_strage.cluster.id Next Steps: The next sectin illustrates a simple table example with instructins fr a mythical cmpany named Acme. The sectin is: Single Spreadsheet Table int a Single WFA Table. The sectin after illustrates EDM-Pack relatinships using the example spreadsheet (edm.xlsx) that is included with the EDM-Pack. Jump frward t that sectin: Multiple Tables with Relatins (the EDM sample) which allws yu t quickly imprt and test the edm sample tables. WFA Excel Data Management Pack 5

6 3.2 Single Spreadsheet Table int a Single WFA Dictinary Table The first example is fr a mythical cmpany named Acme. We want t create a table f the varius departments in Acme alng with the names f the strage systems used by each department. A WFA Scheme named acme and a Dictinary named department will be created The WFA Dictinary clumns will be: cde, name, cluster The Excel spreadsheet clumn headings will be: cde, name, cluster The steps t set this all up wuld be: Create an Excel spreadsheet named acme.xlsx. Rename the first wrksheet tab t department. Fill ut the rw-1 headings (A1=cde, B1=name, C1=cluster) and ppulate sme r all f the data rws. See the example acme.xlsx spreadsheet n the fllwing page. NOTE: Determine where yu will place the acme.xlsx file and later yu will tell the EDM Executin Data Surce where it is lcated. Nrmal practice has been t place the file smewhere n the WFA server itself. Having that directry n the WFA server shared ut lets users access and update the spreadsheet frm their desktp r laptp instance f Micrsft Excel. Create the WFA Dictinary named department. This is dne by: Designer tab -> Dictinary -> click New icn buttn (page+) As yu create this Dictinary, use the [Add New Scheme] buttn t create the new scheme named acme which this dictinary will be within. Add the Dictinary clumns (cde, name, cluster). Set the type f each clumn t String. Check the bx [x] t make the cde clumn a natural key, leave ther fields as default. See the example acme department Dictinary n the fllwing page. Click [Save] t create the WFA Dictinary department within the new scheme named acme. Next yu will clne the EDM Data Surce Type and set it t be assciated with the new acme scheme. This is dne by: Designer tab -> Data Surce Types Select and highlight the data surce named: EDM Data Surce Click the Clne icn buttn r right-click and select Clne Fill ut the New Data Surce Type windw as fllws: Change the Data surce type: name t Acme EDM Data Surce Leave Entity Versin: and Data surce versin: as they are Fr Scheme: select the scheme name created abve: acme Leave Default Prt, Methd and the Script itself alne and click [Save] Next create an Exectin Data Surce that will read the spreadsheet n a recurring schedule. This is dne by: Executin tab -> Data Surces -> click New icn buttn On the New Data Surce windw: Name: Acme EDM Tables (fr example) Data surce type: EDM Data Surce 1.x.x Hst name: C:\WFA-Data\acme.xlsx (r whereever yu place the file) WFA Excel Data Management Pack 6

7 Leave Prt, User Name, Passwrd and ther fields as is Under the lwer Scheduler Cnfiguratin sectin, click n the Scheme name acme and enter an interval such as 30 r 60 minutes r maybe 1440 minutes (daily) and click [Save] When saving this Executin Data Surce it shuld autmatically d it's first acquire. It may be nessecary t right-click Reset Scheme befre the first acquire. T quickly acquire again after changes have been made t the spreadsheet right-click Acquire Nw. Fr this Acme example, the fllwing table shws what the crrespnding WFA Dictinary, Scheme, and Excel Spreadsheet wuld lk like. Table 2) Simple Acme Single Table Example Excel Spreadsheet: acme.xlsx, WFA Scheme: acme, Dictinary: department Ntes 1) Create the spreadsheet file as acme.xlsx 2) Rename the first tab t department and remve any ther tabs 3) Ensure the rw-1 values match the abve dictinary clumns names 4) As a natural key, the cde clumn values in each rw must be unique 1) Use the Add New Scheme buttn t create and select the acme scheme 2) Set each clumn type t string 3) Make cde a Natural Key WFA Excel Data Management Pack 7

8 3.3 Multiple Tables with Relatins Between (the EDM sample) Fr this example we will lk at the sample included with the EDM-Pack. The sample includes a WFA scheme named edm with tw WFA Dictinaries: site and strage within that scheme. These dictinaries map t the clumns f the Excel sample spreadsheet edm.xlxs (lcated in C:\Temp n the WFA server). The site table defines data center lcatins. The strage table is a list f strage system names (a cluster_mgmt LIF DNS name) alng with a reference t which site that system is lcated in. The ntes belw shw the edm sample WFA scheme, dictinaries, and Excel spreadsheet and demnstrate hw a simple relatinship is setup. WFA Scheme: edm, Dictinaries: site,strage - Excel Spreadsheet: edm.xlsx Ntes 1) The site table as defined by the dictinary has name and descriptin clumns 2) The name clumn is marked as natural key and it s value must be unique. NOTE: Internally the MySQL site table als has an id clumn (site.id) which is the primary key and is nrmally ppulated with incrementing numeric values. 1) The strage table as defined by the dictinary has name and site clumns 2) Fllwing EDM mapping rules, site is set as a freign key int the edm.site table. Select edm.site as the Type. 3) The strage table name field is a natural key and hence name values must be unique WFA Excel Data Management Pack 8

9 WFA Scheme: edm, Dictinaries: site,strage - Excel Spreadsheet: edm.xlsx Ntes 1) The edm.xlsx file cntains tw tabs: site and strage which must match the dictinary names. Shwn at left is the site tab 2) The first clumn is id which based n EDM mapping rules means values must be unique and can be used in ther Excel tabs t reference int rws f this table. 3) The name clumn hlds the custmer s desired site-name and it is unique s in Excel we ve used the name clumn t create unique values fr the id clumn, thus creating unique id values (Nte: cell A1=B2 which is carried dwn thrugh each rw) 1) The edm.xlsx file cntains tw tabs: Shwn at left is the strage tab 2) The clumns include name and site_id. The name clumn hlds the strage system names. The site_id clumn, based n EDM mapping rules, is treated as a freign key int the site table. S it s values must match an id value in the site table. Such as Nrth which matches ne f the id rws in the site table abve. NOTE: nce laded int WFA tables, id and site_id are replaced with unqiue numeric incrementing values which reflect the relatinship(s). The fllwing shw hw t create an executin Data Surce n yur WFA server t acquire frm the example edm tables. WFA Excel Data Management Pack 9

10 WFA Scheme: edm, Dictinary: site,strage - Excel Spreadsheet: edm.xlsx Ntes 1) The site table as defined by the dictinary has name and descriptin clumns 2) The name clumn is marked as natural key and it s value must be unique. NOTE: Internally the MySQL site table als has an id clumn (site.id) which is the primary key and is nrmally ppulated with unique incrementing numeric values. 1) The strage table as defined by the dictinary has name and site clumns 2) Fllwing EDM mapping rules, site is set as a freign key int the edm.site table. Select edm.site as the Type. 3) The strage table name field is a natural key and hence name values must be unique WFA Excel Data Management Pack 10

11 T test the the sample EDM spreadsheet yu must imprt it int the included sample edm scheme and dictinaries. T d this yu need t create an Exceutin Data Surce. This is dne by: Click n the Executin tab Click n Data Surces in the left panel Click n the New icn buttn The fllwing ntes describe hw t create the sample edm Executin Data Surce. WFA Executin Data Surce, Reset Scheme, Acquire Nw Ntes 1) The Name: is what ever yu like, such as EDM Quick Test in this example. 2) Select the Data surce type: as EDM Data Surce ) Enter the path t edm.xlsx in the Hst name: field such as: c:\temp\edm.xlsx 4) When yu click [Save] the EDM Data Surce shuld begin it s first acquisitin frm the edm.xlsx file Nte-1: fr simplicity the EDM000 Pack Initialize wrkflw places the sample edm.xlsx in this lcatin Nte-2: Prt, User name, passwrd, Database are nt used and can be left as shwn 4) Yu may need t perfrm a Reset Scheme as shwn at left. This creates the scheme and tables in the MySQL database 5) Nrmal status after creating the Executin Data Surce is that it runs and then shws a Cmpleted. If yu d nt get status Cmpleted, then d an Acquire Nw t invke the EDM Data Surce t acquire frm the Excel acquire again. 6) The Data Surce reprts detailed a errr message next t status clumn. Nte-3: Entering a value f 1 in the Executin Data Surce Prt field enables debug mde which lgs mre infrmatin t the data surce file lcated n the WFA server under the WFA install lcatin:..\wfa\jbss\standalne\lg\edm.lg WFA Excel Data Management Pack 11

12 4 Exprting a Custm r Standard Scheme int Micrsft Excel In additin t the ability t imprt int the WFA Cache DB, the EDM-Pack includes a wrkflw which will exprt WFA Cache DB Schemes ut t Excel spreadsheet files. This is useful t view what is currently in any current WFA Cache DB scheme. This may be used fr viewing, reprting, r ptentially WFA debugging purpses when a SQL Database tl is nt available fr viewing the WFA Cache DB directly. Wrkflw: EDM Exprt Scheme t Excel Ntes 1) G t the Prtal tab and select the Excel Data Management categry f wrkflws. 2) Click n the EDM100 Exprt Scheme t Excel wrkflw, 3) The Exprt Scheme t Excel wrkflw lets yu pick a scheme and a target directry n the WFA server t exprt t. The example at left, will create the file: c:\temp\cm_strage.xlsx 4) After executing the wrkflw, the spreadsheet file can be pened with Excel after being mved t a system with Excel r accessed remtely via a share. Nte-1: The Overwrite exising file? ptin allws yu t indicate if the wrkflw can verwrite the utput file if ne with that name already exists. Nte-2: The Structure nly? ptin instructs the wrkflw t utput an Excel file with n data, nly the tabs and rw headings that map t an existing WFA scheme. Creating structure-nly spreadsheets can be useful t create an empty Excel file t be ppulated by the user and then later imprted via the assciated custm scheme s EDM Data Surce. WFA Excel Data Management Pack 12

13 Dcument Histry Versin Date Dcument Versin Histry Versin December 7th, 2015 First versin (re-written frm previusly ACE versin) NetApp prvides n representatins r warranties regarding the accuracy, reliability, r serviceability f any infrmatin r recmmendatins prvided in this publicatin, r with respect t any results that may be btained by the use f the infrmatin r bservance f any recmmendatins prvided herein. The infrmatin in this dcument is distributed AS IS, and the use f this infrmatin r the implementatin f any recmmendatins r techniques herein is a custmer s respnsibility and depends n the custmer s ability t evaluate and integrate them int the custmer s peratinal envirnment. This dcument and the infrmatin cntained herein may be used slely in cnnectin with the NetApp prducts discussed in this dcument NetApp, Inc. All rights reserved. N prtins f this dcument may be reprduced withut prir written cnsent f NetApp, Inc. Specificatins are subject t change withut ntice. NetApp, the NetApp lg, G further, faster, xxx, and xxx are trademarks r registered trademarks f NetApp, Inc. in the United States and/r ther cuntries. <<Insert third-party trademark ntices here.>> All WFA Excel Data Management ther Pack brands r prducts are trademarks r registered trademarks f their respective hlders and shuld be treated as such. TR- 13 XXXX-MMYR