Altair Engineering, Inc. Software Asset Optimization Admin Guide

Transcription

1 Altair Engineering, Inc Software Asset Optimization Admin Guide

2 Table of Contents Software Asset Optimization Admin Guide... 4 Overview... 4 Vendor Alias... 5 A. Modify Vendor Alias... 6 Feature Alias... 7 A. Modify Feature Alias... 8 Vendor Listing... 9 Vendor Pool A. Create New Vendor Pool B. Update Existing Vendor Pool C. Delete a Vendor Pool Feature Pool for Vendor Pool A. Create a New Feature Pool for Vendor Pool B. Update Feature Pool for Vendor Pool C. Delete Feature Pool for Vendor Pool Feature Pool for Single Vendor A. Create a New Feature Pool B. Update Existing Feature Pool C. Delete Feature Pool Manage Notification A. Adding an to receive notifications B. Update to receive notifications C. Delete to stop receiving notifications Manage Feature Alerts' Manage Emp Region/Dept Hierarchy A. Creating Excel Files SAO Admin Guide v14 Page 2 of 52

3 B. Loading Excel Files Manage User Account A. User Accounts B. User Roles C. Feature Access Control Preferences A. Change Password Real-Time Reporting B. Enable Specific RT Features SAO Configuration Help SAO Admin Guide v14 Page 3 of 52

4 Software Asset Optimization Admin Guide Overview This guide will explain all the available administration tools and illustrate how to use them to manage the data needed for license usage. SAO provides a variety of administrative tools, utilities to address slow moving data and helpful documentation. The following are options found in the Admin panel: Vendor Lists and Pools Feature Lists and Pools Alerts and Notifications User-Region-Department Hierarchy User Accounts and Role Access SAO Configuration Tool SAO Admin Guide v14 Page 4 of 52

5 Vendor Alias The Vendor Alias admin tool can be used to modify the alias name of a vendor. SAO Admin Guide v14 Page 5 of 52

6 A. Modify Vendor Alias 2. Once the vendor alias name has been modified, you will need to upload it back to the server for processing into the database by using the file upload utility. 1. Click "Download Excel" to download an Excel file which contains all of filtered vendors. Search Options: Vendor name Alias name Location Show same (displays the vendor and alias' with the equivalent name) Click for pagination. SAO Admin Guide v14 Page 6 of 52

7 Feature Alias The Feature Alias admin tool can be used modify the alias name of a feature. SAO Admin Guide v14 Page 7 of 52

8 A. Modify Feature Alias 2. Once the feature alias name has been modified, you will need to upload it back to the server for processing into the database by using the file upload utility. 1. Click "Download Excel" to download an Excel file which contains all of filtered features. Search Options: Feature name Alias name Location Show same (displays the feature and alias' with the same name) Click for pagination. SAO Admin Guide v14 Page 8 of 52

9 Vendor Listing The Vendor Listing shows a tabular list of all vendors installed and tracked by the system. The continent, state and city reflect the parameters defined in the vendor(s) configuration file. <vendor>.ini configuration file example: SAO Admin Guide v14 Page 9 of 52

10 The column headers can be sorted in ascending and descending order. You can also sort by specific columns by dragging and dropping the header name in the Sort order section. SAO Admin Guide v14 Page 10 of 52

11 Icon indicates the report has a Chart Drill through option. Right-click on a row to see the drill through options: A) Feature Details: The table shows the available number of licenses, amount reserved, start and end date plus original time zone of the pre-selected feature. B) Usage Breakdown by Features: Users can get reports for different date ranges, and vendors, and get a further breakdown by Region and Department by selecting the required values in the Navigation panel. SAO Admin Guide v14 Page 11 of 52

12 Vendor Pool The Vendor Pool section allows admins to create vendor pools by grouping together 2 or more license servers as if they were a single vendor. For instance, if three vendors [license servers] were named as the following: Altair_Asia Altair_Americas Altair_Europe Then a new Vendor Pool could be created, given the name Altair_Global and contain the selected vendors above. A. Create New Vendor Pool 1. To create a new vendor pool, select "New Vendor Pool". 2. Enter a name for the new vendor pool and click OK. SAO Admin Guide v14 Page 12 of 52

13 Optional: Check box to auto create feature pool for the Vendor Pool. 3. Use the arrows to move the available vendors to the Selected Vendors table. 4. Once the available vendors are selected, click Save. SAO Admin Guide v14 Page 13 of 52

14 B. Update Existing Vendor Pool 1. Select a Vendor Pool from the drop-down list. 2. Use the arrows to move the available vendors to the Selected Vendors table. 3. Once the available vendors are selected, click Save. SAO Admin Guide v14 Page 14 of 52

15 C. Delete a Vendor Pool 1. Select a Vendor Pool to remove. 2. Next, click "Delete Vendor Pool". 3. Click Yes to confirm the removal of the vendor pool. SAO Admin Guide v14 Page 15 of 52

16 Feature Pool for Vendor Pool The Feature Pool for Vendor Pool section allows admins to create new feature pools belonging to a vendor pool by grouping available features. The vendor must be selected in order to group features. The feature pool is a group of 2 or more features picked from a list of all the features belonging to the vendors contained in the vendor pool. For example, Vendor 1 (V1) Vendor 2 (V2) Vendor 3 (V3) VP = V1+V2+V3 Altair_ASIA Altair_EUROPE Altair_AM Altair_Global Features: HM HM HM HM_Global HG HG HG HQ HQ HQ The Feature Pool for Vendor Pool Altair_Global could be defined as HM_WorldWide = HM(Asia) + HM(Europe) + HM(AM) SAO Admin Guide v14 Page 16 of 52

17 A. Create a New Feature Pool for Vendor Pool Note: A Vendor Pool must already be created to use this Admin tool. 1. To create a New Feature Pool for Vendor Pool, select "New Feature Pool". 2. Enter the Feature Pool name and click OK. SAO Admin Guide v14 Page 17 of 52

18 3. Next, select a Vendor Pool and Vendor from the drop-down list. 4. Use the arrows to move the available features to the Selected Features table. 5. Once the available features are selected, click Save. SAO Admin Guide v14 Page 18 of 52

19 B. Update Feature Pool for Vendor Pool 1. Select a Feature Pool from the drop-down list. SAO Admin Guide v14 Page 19 of 52

20 2. Select a Vendor Pool from the drop-down list. 3. Use the arrows to move the available features to the Selected Features table. 4. Once the available features are selected, click Save. SAO Admin Guide v14 Page 20 of 52

21 C. Delete Feature Pool for Vendor Pool 1. Select a Feature Pool to remove from the drop-down list. 2. Next, click "Delete Feature Pool". 3. Click Yes to confirm. SAO Admin Guide v14 Page 21 of 52

22 Feature Pool for Single Vendor Feature Pool for Single Vendor tool is used to define a new feature by grouping several features belonging to the same vendor [single license server]. For example, if an admin wanted to view usage of HyperMesh and HiQube as they were a single feature. The admin could create a feature pool call 'HMQ' that contains HyperMesh and HiQube. A. Create a New Feature Pool Caution: Please make sure to group only features that make sense logically. 1. To create a new feature pool, select "New Feature Pool". 2. Enter a name for the new feature pool and click OK. SAO Admin Guide v14 Page 22 of 52

23 3. Next, select from the list of available Vendors. SAO Admin Guide v14 Page 23 of 52

24 4. Use the arrows to move the available features to the Selected Features table. 5. Once the available features are selected, click Save. SAO Admin Guide v14 Page 24 of 52

25 B. Update Existing Feature Pool 1. Select a Feature Pool and Vendor from the drop-down list. 2. Use the arrows to move the available features to the Selected Features table. 3. Once the available features are selected, click Save. SAO Admin Guide v14 Page 25 of 52

26 C. Delete Feature Pool 1. Select a Feature Pool and Vendor. 2. Click "Delete Feature Pool" 3. Click Yes to confirm. SAO Admin Guide v14 Page 26 of 52

27 Manage Notification The admin can use the Manage Notification tool to notify recipients about MySQL database, LDAP, and feature errors such as denials, excessive session length and high saturation percentages. There are three different types of alerts: MySQL this is the alert type for any MySQL query issues (this alert type is for the SAO administrator) LDAP this is the alert type for the historical management of users information (this is currently not being used except for the case where LDAP integration was provided as a custom service) Feature this is the alert type for excessive denials, excessive session length and token saturation Feature types of alert/notification include: 1. Excessive Denials this will trigger alert when number of denials Excessive Session Length this will trigger an alert when a user check-out a license for a feature for an extended period of time is reached at or above the number of denials over the pre-set time period. For example, send alert when 10 denials or more occurs over a period of 60 minute for Feature A. Alerts will continue to be sent as long as this criterion is met every five minutes. For example, send an alert when feature A has been checked out for 10 hours (600 minutes) or more. Alerts will continue to be sent as long as this criteria is met every five minutes 2. Token Saturation this will trigger an alert when the used tokens reach a certain level. For example, if saturation is set for 75%, and a feature has 100 tokens available out of which 75 or more has been check-out, an alert will be sent out. Alerts will continue to be sent as long as this criteria is met every five minutes SAO Admin Guide v14 Page 27 of 52

28 A. Adding an to receive notifications 1. Click New to add a new to receive alert notifications. 2. and Full name are both required fields. After the information is entered click Update to save the entry. SAO Admin Guide v14 Page 28 of 52

29 B. Update to receive notifications 1. Click on a row of the notification that you wish to update. 2. Once the updates have been made, click Update to save changes. C. Delete to stop receiving notifications Select the record and click Delete. SAO Admin Guide v14 Page 29 of 52

30 Manage Feature Alerts' Admins can use the Manage Feature Alerts to submit and download Feature Alert Definitions. [Excel 2003/2007 format]. Once you downloaded the Excel file and made your changes, you will need to upload it back to the server for processing into the database by using the file upload utility. If you are interested in only New Features, click on the Show New Only checkbox and the grid will reload with new features ( Is New is set to 1). Click "Download Results" to download an Excel file. Check the Excel 2003 box if you wish to download the file in 2003 format. Click for pagination. SAO Admin Guide v14 Page 30 of 52

31 Downloaded Feature Definition Feature Definition Terms KEY This is the key field. Do not modify this field or change its content. This key is the internal id that will be used when updating the feature definition Feature This is the feature name. It is shown here for clarity and does not get populated back into the database Vendor This is the vendor name. It is shown here for clarity and does not get populated back into the database Location This is the location of the vendor. It is shown here for clarity and does not get populated back into the database Is New This flag indicates that the feature is new Weight This is currently not being used Num Denials Number of denials occurred over Time Denial. If this parameter is defined, the time denial parameter must be defined as well and vice versa Time Denial (Mins) The length of time in minutes Excessive Duration (Mins) The length of time in minutes a feature has been checked out by a user Token Saturation (Percent) Percent of used tokens. For example, a 75% token means for a feature that has 100 tokens, 80 tokens has been checked-out Real Time Monitor - This flag indicates features to be shown in Real-time reporting chart. 1 = Show and 0=Hide SAO Admin Guide v14 Page 31 of 52

32 Manage Emp Region/Dept Hierarchy To observe usage broken down by region, department and employee, association excel files must be created. The region and department information should be defined prior to the employee region and department information. The excel files created are your master copies. A. Creating Excel Files i. Region The association for Region is the following: World >> Continent >> Country >> State >> City However World >> Continent >> Country >> City is shown below. 1. World >> Continent World is the parent of NA, EMEA and APAC, which are continents of the world (region_id 1 = parent_id 1). 2. Continent >> Country NA (region_id 2) is the parent of the United States (parent_id 2), EMEA (region_id 3 ) is the parent of Germany (parent_id 3) and APAC (region_id 4) is the parent of India (parent_id 4). 3. Country >> City United States (region_id 5) is the parent of Troy (parent_id 5), Germany (region_id 6) is the parent of Frankfurt (parent_id 6) and India (region_id 7) is the parent of Bombay (parent_id 7). Therefore, the parent_id must match the related region_id. SAO Admin Guide v14 Page 32 of 52

33 ii. Department The association for Department is the following: Organization >> Department >> Sub Department 1. Organization >> Department Organization is the parent of Human Resources and System Services. (parent_id 1 = dept_id 1). 2. Department >> Sub Department Human Resources (dept_id 2) is the parent of Administration (parent_id 2) and System Services (dept_id 3) the parent of Web Engineering ( parent_id 3). Hence, the parent_id must match the corresponding dept_id. SAO Admin Guide v14 Page 33 of 52

34 iii. Employee Region and Department column: The department column corresponds to the dept_id of the "Department excel file". The region column corresponds with the region_id of the "Region excel file." Employee John Doe has two records/effective dates due to a change in department. Dept 2 Dept 5 For example: John Doe region is 5 = United States and department is 2 = Human Resources. Enter the effective date into G2 and copy down [column G and H] for all records. The date string (auto) column will automatically convert the string to a TEXT (yyyy-mm-dd). All employee information MUST be historical Let's use employee John Doe (empid1) as an example. If the excel file is modified with John Doe starting July 1, 2012 [See Row 2], then all usage prior to July 1, 2012 will be allocated to "UNKNOWN" for region/department. Therefore, it is important that another employee/region/dept must be defined with a new effective date [See Row 5]. SAO Admin Guide v14 Page 34 of 52

35 B. Loading Excel Files After the excel files are created, load the files in the order of Department Region Employee. If you receive any errors or warnings while loading the Excel files, go back make corrections to the file(s). i. Using Admin Tool to load excel file 1. Select the association category, browse to file and click "Upload. The server will process that data into the database. Click here to download sample Employee, Region, Department Excel files. SAO Admin Guide v14 Page 35 of 52

36 Note: A full calculation must be performed to view hierarchy changes in the SAO portal. (See #2 of Using SAO Terminal to load files.) 2. The "Log" tab displays results from the server processing the file. 3. Check the "Show Uploaded" box to view uploaded files. Click "Download Excel" to download an Excel file of the selected tab records. Note: The file will include the entire data set. Search Options: Emp ID First and Last name Region and Dept ID Region and Dept Desc (Description) Click for pagination. SAO Admin Guide v14 Page 36 of 52

37 ii. Using SAO terminal to load excel files Launch the SAO VMware terminal and execute the following commands. 1. Loads dept/region/emp information into database: # cd /sao/admin #./loaddept.pl /path/to/files/department_excel_file.xlsx #./loadregion.pl /path/to/files/region_excel_file.xlsx #./loademployee.pl /path/to/files/employee_excel_file.xlsx 2. Perform a FULL refresh to apply dept/region/emp association modifications: # cd /sao/scripts # nohup./sao_calculate_full.sh & Next, launch SAO in browser. To verify your changes, view the following Usage reports: o Users Ranking by Session Length o Session Length Breakdown by Region o Session Length Breakdown by Department SAO Admin Guide v14 Page 37 of 52

38 Manage User Account The Manage User Account admin tool can be used to define access rights for users. User accounts can be assigned to user roles like IT Admin, Engineering Manager and Reporter. The Feature Access Control tab allows admins to control which features are allowed for the selected User Role. A. User Accounts i. Add New User Accounts 1. Click New to add a User Account. SAO Admin Guide v14 Page 38 of 52

39 2. Enter a user id and address for the new user. 3. Next, select the User Profile type. (required) A) The sao_admin has complete access of the Admin panel and all reports. B) The sao_user can access all reports but will not see the Admin section in the panel. 4. Once all the info is entered, click Update to save the new user account. SAO Admin Guide v14 Page 39 of 52

40 ii. Modify User Accounts To DELETE a user account, select a row in the table. Once the row is highlighted, click the Delete icon to remove the user account. Confirm the removal of the account by clicking Yes. Click Reset Password to reset a user s password. Next, enter the new password in the textbox and click OK. SAO Admin Guide v14 Page 40 of 52

41 B. User Roles i. Create New Role 1. Click Create New Role to generate a new role. 2. Next, enter a name for the new role and click OK. SAO Admin Guide v14 Page 41 of 52

42 ii. Add Users to a Role 1. Select a Role from the drop-down list. 2. Next, select the row of the user id(s) from the Available Users table. After the rows are selected, click Add to insert users to the Users Assigned to selected Role table. 3. The added users can be viewed in the Users Assigned to selected Role table. To REMOVE an assigned user, click on the user row. Once the row is highlighted, select Remove to delete them from the list. SAO Admin Guide v14 Page 42 of 52

43 C. Feature Access Control i. Add Allowed Available Features 1. Select a Role from the drop-down list. Note: After a role is selected, Available Vendors will load in this table. SAO Admin Guide v14 Page 43 of 52

44 2. Select row(s) from the Available Vendors table and click + Load Features to fill the Available Features table. SAO Admin Guide v14 Page 44 of 52

45 3. Select row(s) from the Available Features table and click + Add to insert the features into the Allowed Features table. To pick every available feature click Select All. 4. To REMOVE pre-selected features click row(s) from the Allowed Features table and select Remove. To pick every available feature click Select All. SAO Admin Guide v14 Page 45 of 52

46 Preferences A. Change Password Note: Demo is the current logged in user. 1. Enter the current password for the logged in user. 2. Enter the new password for the logged in user and verify it by typing it a second time in the last textbox. 3. After all of the required fields are entered, clicked Change Password. SAO Admin Guide v14 Page 46 of 52

47 Real-Time Reporting The RT (real-time reporting) chart is accessible via the following address: This report provides current license usage information without having to login to the SAO portal. Up close view of the RT tab options: 1. Software Status: This report displays all vendors being tracked and includes information like feature, location, available, in-use, remaining and saturation percent. To learn how to enable only the features you would like to view, See A. Enable Specific RT Features below. 2. Software Denials: This report shows software denials up until the time period located at the top right of the chart. 3. Vendor Status: The report list all the vendors tracked by the system and outlines information such as port, location, last usage run, last received date, last daemon stat, usage age, file age and stat age. 4. Open Sessions: This report displays all open sessions for each feature checked out. Some of the information displayed about the feature is the user who checked-out, lic type, host name and location of where it was retrieved from. SAO Admin Guide v14 Page 47 of 52

48 A. Enable Specific RT Features Perform the following to enable real-time software features: 1. In the Manager Feature Alerts admin tool, click Download Results. 2. Open the excel file and filter on the vender/features you want to track. Change the value from 0 (hide) to 1 (show) in the corresponding rows and save file. SAO Admin Guide v14 Page 48 of 52

49 3. Go back to the Manager Feature Alerts admin tool and upload the file back to the system. 4. Navigate to and verify if data is loaded in the Software Status tab without checking the Include Realtime Features (when this option is checked it lists every software feature being tracked). SAO Admin Guide v14 Page 49 of 52

50 SAO Configuration The SAO Configuration admin tool can be used to manage License Servers latitude and longitude as well as parameters in the sao config database table. The following table explains each option in the tool: SAO Configuration Click Save after entering any new information to retain configuration details. Information Charset First Date/End Date Last Refresh Date Open Run Criteria (Minute) Working Days Calculation SAO Procedure Version Configurable Long Expired Days (This setting is for Alert notification s) Default character encoding collation First date files were sent to DB / Last date files were received Last time HiQube service was refreshed Amount of time open runs are captured Working time days of the week - 1=Sund 2=Mon 7=Sat Status of SAO nightly calculation MySQL procedure release version The total number of days for expired features Long/Short Exp Days Range Long Greatest num. of days for features to expire Short Least num. of days for features to expire Work Time Time Zone (UTC) SMTP Server UserID Display Realtime User Privacy Start time and end time of company working time range Time settings for SAO web portal IP or domain name of server If defined as UPPERCASE, then USERIDs will be displayed in UPPERCASE, else Default. Show Display user info in RT report Hide Conceal user info in RT report SAO Admin Guide v14 Page 50 of 52

51 License Server Lat/Long The License Server Lat/Long tab of the SAO Configuration admin tool is used to set the coordinates for the License Servers & Vendor Daemon Status chart (located on the Dashboard). The server and location data in this table will be pre-populated from the license usage information and you will only have the option to modify the Latitude and Longitude of the license manager servers. Please contact your SAO admin to learn how to get server location coordinates. 1. Double-click on the server row you would like to update. 2. Enter the Lat/Long values in the corresponding columns. 3. Once changes are made, click Update to save your input. The chart will automatically refresh with the new coordinates. Navigate to License Servers & Vendor Daemon Status chart to verify server(s) location point(s) placement is in the correct area of the map. SAO Admin Guide v14 Page 51 of 52

52 Help User Guide: This guide explains SAO components and capabilities thoroughly by giving a breakdown of the system architecture and available reports. Admin Guide: This guide gives a high level view of all the available administration tools and demonstrates how to use them to manage the data required for license usage. Terminology: This document explains commonly used SAO language by describing how it was derived or computed. SAO Admin Guide v14 Page 52 of 52