User Guide. ACE Data Source. OnCommand Workflow Automation (WFA) Abstract PROFESSIONAL SERVICES

Transcription

1 PROFESSIONAL SERVICES User Guide OnCmmand Wrkflw Autmatin (WFA) ACE Data Surce Prepared fr: ACE Data Surce - Versin Date: Octber 2015 Dcument Versin: Abstract The ACE Data Surce (ACE-DS) is a general purpse WFA Data Surce that can read frm Micrsft Excel spreadsheets directly int a WFA scheme and and custm tables. Thse tables are then available fr search and selectin in custm WFA user interface Queries, Filters, Finders and Cmmands. This allws wrkflws t align with and reflect custmer business-rules, rganizatin and envirnment infrmatin.

2 TABLE OF CONTENTS 1 Intrductin Prerequisites and Installatin Installatin Steps Setup Custm Dictinary(s), Scheme and Spreadsheet Mapping Rules: Excel Table-Clumn t WFA Table-Clumn Single Spreadsheet Table int a Single WFA Table Multiple Tables with Relatins Between (ACE-DS Example Tables)... 8 Dcument Histry WFA ACE Data Surce 2

3 1 Intrductin The ACE Data Surce (ACE-DS) simplifies integrating custmer business and envirnment infrmatin int the WFA envirnment and hence usable within their custm WFA wrkflws. Prduct Cdes, Cst Centers, r Data Center Lcatins are examples f the srt f business infrmatin that can imprve the effectiveness and useablility f WFA wrkflws. WFA natively supprts acquiring this kind f external data via custm WFA Data Surces Types (Designer tab -> Data Surce Types). Tw methds can be used by a Data Surce Type: SQL r Script based. SQL Data Surce Types can acquire infrmatin in external relatinal database. A Script Data Surce Type is a custm script written in PwerShell than btains data and frmats it such that WFA can imprt it int custm scheme tables (defined by WFA Dictinaries). The ACE-DS is a Script based Data Surce Type 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 ACE Data Surce Type fr a custmer specific use-case is t clne it int a new WFA Scheme. The ACE-DS bundle cmes with a sample WFA Scheme named ace, sample WFA Dictinaries (ace.site and ace.strage) as well as a crespnding spreadsheet named ace.xlsx with sample data. After imprting the 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 the included ace.xlsx spreadsheet int the WFA ace scheme and tables (site, strage). NOTE: the ace scheme is just an example and a hlder fr the ACE Data Surce Type. The intentin is a custmer wuld create a new scheme and dictinaries and then clne the ACE Data Surce Type and set it t be assciated with the new scheme. The cntents f the ACE-DS bundle zip file are listed in the table belw. Table 1) ACE-DS Bundle Cntents (ACE_DS_Bundle_Bv_#_#_#.zip) File ACE_DS_Package_Pv_#_#_#.dar ACE_DS_UserGuide_Dv_#_#_#.dcx ace.xlsx Purpse ACE Data Surce Type with example scheme and dictinaries This User Guide dcument in Micrsft Wrd frmat Example Excel spreadsheet fr the ACE-DS Where #_#_# indicates actual versin number. WFA ACE Data Surce 3

4 2 Prerequisites and Installatin The ACE Data Surce Versin 2.x.x has the fllwing prerequisites: Windws Server 2008R2 r 2012R2 as WFA Server OnCmmand Wrkflw Autmatin - WFA Versin 3.0P1 r later It is assumed WFA is already installed and setup With WFA 3.1 and later the Linux flavr f WFA is nt supprted Micrsft Access Database Engine 2010 Redistributable The ACE Data Surce utilizes the free Micrsft Access Database Engine (aka: ACE driver / prvider). 2.1 Installatin Steps In summary, the installatin prcess is installing the ACE driver / prvider and imprting the ACE-DS dar file int the WFA system. Install the Micrsft Access Database Engine 2010 Search the Micrsft web site fr the Micrsft Access Database Engine 2010 Redistributable installer file. This search string can be cut/pasted and used with ggle (fr example) t quickly find the package: site:micrsft.cm micrsft access database engine 2010 redistributable On the Micrsft.cm web-page, click the [Dwnlad] buttn. On the next page check the bx t select the AccessDatabaseEngine_x64.exe installer file and dwnlad (~27MB) and execute this installer file. The dwnlad and install takes n mre than 1 t 2 minutes. The nly questins are t accept the license agreement and the installatin lcatin. Taking the default install lcatin is fine (C:\Prgram Files\Micrsft Office\) The ACE Data Surce is distributed within a bundled.zip file cntaining the WFA dar file, an example excel spreadsheet and this dcumentatin. Obtain the bundled zip file and unpack it n yur lcal system (nt nessecarily the WFA server but culd be if yu are running a brwser n the WFA Server itself) Access the WFA system via a brwser ( and lgin in as a WFA admin user. Use the Administratin -> Imprt menu selectin t brwse t the lcatin where yu have unpacked the bundle cmpnents and select the WFA.dar file: ACE_DS_Package_Pv_x_x_x.dar. Yu will be shwn the cntents f the.dar cntainer (tw dictinaries, a scheme and a ScriptDataPrvider). Click [Imprt] t cntinue. At this pint the ACE Data Surce is installed. Cntinue t the next sectin f this dcument t create yur wn scheme and custm dictinaries r test with the included example ace.xlsx spreadsheet data. WFA ACE Data Surce 4

5 3 Setup Custm Dictinary(s), Scheme and Spreadsheet The ACE Data Surces 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 (ACE-DS Example Tables) 3.1 Mapping Rules: Excel Table-Clumn t WFA Table-Clumn The verall cncepts and mapping rules f the ACE Data Surces 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\ace.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 dictinart entries can be created under any new scheme yu'd like. Just clne this 'ACE Data Surce' and place it int yur new scheme. 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 ACE-DS relatinships using the example spreadsheet (ace.xlsx) that is supplied with the ACE Data Surce bundle. Jump frward t that sectin: Multiple Tables with Relatins (ACE Example) which allws yu t quickly imprt and test the ace example tables. WFA ACE Data Surce 5

6 3.2 Single Spreadsheet Table int a Single WFA 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 the Excel spreadsheet named acme.xlsx. Rename the first wrksheet tab t department. Fill ut the rw-1 headings (cde, name, cluster) and ppulate sme r all f the data rws. See example spreadsheet which fllws. NOTE: Determine where yu will place the acme.xlsx file and later yu will tell the ACE Data Surce where it is lcated. Nrmal practice has been t place the file smewhere n the WFA server itself. Having a directry n the WFA server which is shared 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. Click [Save] t create the WFA Dictinary department within the new scheme named acme Next yu will clne the ACE 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: ACE Data Surce Click the Clne icn buttn r right-click and select Clne Fill ut the New Data Surce Type windw as fllws: Leave the Data surce type: name field as is (r change it if yu like) 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 Data Surce (fr example) Data surce type: ACE Data Surce 2.x.x (unless yu changed the clned Data Surce Type name abve) Hst name: C:\WFA-Data\acme.xlsx (r where ever yu placed it) WFA ACE Data Surce 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 {may shuld will?} 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 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 WFA Dictinary: department - Scheme: acme - Excel Spreadsheet: acme.xlsx Ntes 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 1) Create the 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 WFA ACE Data Surce 7

8 3.3 Multiple Tables with Relatins Between (ACE-DS Example Tables) The ACE-DS imprts assciated within the WFA scheme named ace which als includes tw WFA Dictinaries: site and strage as shwn belw. These dictinaries map t the clumns f the Excel spreadsheet included in the ACE-DS bundle, ace.xlxs. The site table defines data data center lcatins. The strage table is a list f strage system names (such as a cluster_mgmt LIF DNS names) alng with a reference t which site that system is lcated in. See previus sectin 3.1 Mapping Rules. The ntes belw describe hw this relatinship is setup. WFA Dictinary: site,strage - Scheme: ace - Excel Spreadsheet: ace.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 ADC-DS mapping rules, site is set as a freign key int the ace.site table. Select ace.site as the Type. 3) The strage table name field is a natural key and hence name values must be unique WFA ACE Data Surce 8

9 WFA Dictinary: site,strage - Scheme: ace - Excel Spreadsheet: ace.xlsx Ntes 1) The ace.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 ACE- DS 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 ace.xlsx file cntains tw tabs: site and strage which must match the dictinary names. 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 ACE-DS mapping rules, is treated as 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 tables shw hw t create an executin Data Surce n yur WFA server t acquire frm the example acs tables. WFA ACE Data Surce 9

10 Creating Executin Data Surce, Reset Scheme, Acquire Nw Ntes 1) The Name: is what ever yu like. ACE-DS Quick Test in this example. 2) Select the Data surce type: as ACE Data Surce 2.#.# 3) Enter the path t ace.xlsx in the Hst name: field such as: C:\WFA-Data\ace.xlsx 4) Yu may need t Reset Scheme immediately after the abve step which creates the scheme and tables 5) Then d an Acquire Nw t invke the ACE Data Surce t read the Excel file WFA ACE Data Surce 10

11 Dcument Histry Versin Date Dcument Versin Histry Versin Octber 12th, 2015 First shared 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 ACE Data Surce ther brands r prducts are trademarks r registered trademarks f their respective hlders and shuld be treated as such. TR- 11 XXXX-MMYR