Importing and Exporting Metrics

Accolade provides Administrators and Process Designers the ability to export metrics from one Accolade environment and import it into another Accolade environment. For example, your company may have a test environment set up during your implementation, or you may have company branches that are new to Accolade that are hosted in a separate environment. Instead of having to recreate metrics in each environment, download the information and import it into the new environment.

The download exports the metrics configuration into a spreadsheet file with the information in the following tabs within the file:

• Metrics (this tab also includes Additional Model Settings)
• List Values

To export metric settings:

1. From the System menu, select Content Sources > Metrics.
2. Select the metrics that you want to download.

Use the Metric ID search field to find the metrics you wish to download. A partial search entry pulls up a list of all matching metric IDs containing those numeric characters.

You can also enter a category, name, and/ or system name when searching by metric ID to find the metrics that match all criteria entered. These filters are case insensitive.

To narrow the list by metric name or system name, add the criteria to filter by in the appropriate filter text box.

To narrow the list by category, select a category to display in the Category list. To download all metrics, select All.

3. Click Download in the top right corner of the page.

Accolade downloads the metrics to a spreadsheet file and saves it to a temporary internet files directory. Save the file to a more accessible location.

Note:  Only components to which you have view and/or edit configuration access group rights will download. Components you can only view may be included in the file, but you can only upload changes to areas to which you have explicit edit permission.

To import metric settings into Accolade:

1. Ensure the data within the spreadsheet meets the requirements for a successful import.
2. Remove any metrics that you do not want to include in the upload from the spreadsheet and save the file.

3. From the System menu, select Content Sources > Metrics.
4. Click Upload in the top right corner of the page.
5. Click Load File and select the spreadsheet file to load.

Accolade uploads the changes to the metrics in the spreadsheet, and adds any new metrics with unique system names.

6. (Optional) Click Print to print the import results for your records.

Note:  Components that are imported are subject to group configuration rules. The user may assign components in a way that the configuration access groups are not consistent. This behavior is not allowed in the UI, and mismatches in either the user's access rights or the component's access group restrictions may result in warning or error messages during the upload, and may result in an incomplete upload.

Metric Settings Included in the Spreadsheet File

The columns in the downloaded spreadsheet include the settings for each metric in the order listed below. For a description of each metric setting, see Creating Metrics.

Important! Using the import and export tools to update configuration can result in unintended changes if information is missing or creates an error during the import process. Sopheon recommends reviewing Importing and Exporting Configuration Components Best Practices before making changes in a production environment.

• Metrics

  If you want to import metric settings without associating the metric to a process model, complete this section of the spreadsheet only. You will need to include the Additional Model Settings columns listed below, but they can be left blank.

  Column Name	Accepted Values on Upload*	Additional Notes
  System Name	Alphanumeric characters, underscore**	Used for matching in the upload. If a metric exists, its settings are changed with the values in the uploaded file. If a new, unique system name exists in the file when uploaded, a new metric is created.
  Display Name	Any	If blank, the metric does not upload.
  Order	Any number	The field is set to 0 on upload if no value is entered or the value is not a number.
  Metric ID	(Read Only) The metric ID is included in the download file, but is not editable on upload.
  Description	Any	Can be blank.
  Category	Alphanumeric characters	If a new, unique category name exists in the file when uploaded, a new category is created. If left blank, the metric is placed in the Default category.
  Data Type	String Number Date List Long String Multi-Select List	Can only upload changes for rows that create new metrics. Existing metrics must match their Data Type along with System Name and Display Name. If the Data Type selected is List or Multi-Select List and the list is manually defined within the metric, enter the list values on the List Values spreadsheet tab. See Creating Single and Multi-Select List Metrics.
  Decimal Places	Any number	Applies only to Number type metrics. Is set to 0 on upload if no value is entered or the value is not a number.
  Is Filter	Yes, Y, True, 1, X*	All other values are treated as No on upload.
  Is Matrix	Yes, Y, True, 1, X*	All other values are treated as No on upload.
  Available to Reporting	Yes, Y, True, 1, X*	All other values are treated as No on upload.
  Available to Portfolio Optimizer	Yes, Y, True, 1, X*	All other values are treated as No on upload.
  Available to Planning	Yes, Y, True, 1, X*	This setting is only changeable on upload if the setting on download is No. All other values are treated as No on upload.
  Milestone Shape	Arrow Bar Checkmark InvertedTriangle Marker Pin Rocket Starburst Target	Applies only to Date type metrics that have Available to Planning selected as Yes. If blank, defaults to InvertedTriangle.
  Available to Resource Editor	Yes, Y, True, 1, X*	All other values are treated as No on upload.
  Is Inherited	Yes, Y, True, 1, X*	All other values are treated as No on upload.
  Is Calculated	Yes, Y, True, 1, X*	All other values are treated as No on upload.
  Calculated Expression	A valid expression	Applies only to metrics with Is Calculated set to Yes. The row does not upload if the expression is invalid. See Calculated Metric Expressions Overview and Calculated Metric Expressions Reference.
  Calculated Event Triggers	AssociatedChange ProjectCreate ProjectMigrate ProjectClose ProjectReOpen	Applies only to metrics with Is Calculated set to Yes. To apply more than one trigger, separate events using a pipe ( | ) character. If the metric value is invalid, the trigger will not be assigned. See Scheduling Metric Calculations.
  Calculated Timed Triggers	Daily Weekly Monthly EndOfMonth Quarterly Yearly	Applies only to metrics with Is Calculated set to Yes. Use the format <type>;<yyyy/MM/dd> <hh:mm:ss> For example, Daily;2018/06/18 10:00:00. Only one interval of the same type may be assigned. If more than one interval is uploaded the first displayed will be set. For example, two-day events cannot be assigned, but day and month can be assigned. To apply more than one trigger, separate timed events using a pipe ( | ) character. Timed event accepted values use international dates, and 24 hour times. EndOfMonth dynamically changes based on the date each month falls on. If the metric value is invalid, the trigger will not be assigned. See Scheduling Metric Calculations.
  Initialized From	Valid metric system name	The row does not upload if the indicated system name is not a valid system name for an existing metric.
  Metric Query	Valid SQL query expression	Applies only to List and Multi-Select List metrics that use a query to determine the list values. The row does not upload if the expression is invalid. See Queries Overview.
  Office Format	#, 0	Applies only to Number type metrics in Microsoft Word or PowerPoint. See Custom Format for Number Metrics.
  Track History	Yes, Y, True, 1, X*	All other values are treated as No on upload.
  Reference Table	Valid reference table system name	Applies only to List and Multi-Select List metrics that use a reference table column to determine the list values.
  Reference Table Column	Valid column system name within the table	Applies only to List and Multi-Select List metrics that use a reference table column to determine the list values.
  Reference Table Constraints	Valid reference table column value or valid query code	Applies only to List and Multi-Select List metrics that use a reference table column to determine the list values. Separate list items using a pipe ( | ) character. See Creating Cascading List Metrics.
  Active	Yes, Y, True, 1, X*	All other values are treated as No on upload.
  Milestone Shape Color Metric System Name	Valid metric system name	Applies only to Date type metrics that have Available to Planning selected as Yes. The row does not upload if the indicated system name is not a valid system name for an existing metric. If blank, defaults to [None].
  Restrict to These Roles	Valid Accolade user role	Separate roles using a pipe ( | ) character.
  Allow Updates from All My Work page	Yes, Y, True, 1, X*	All other values are treated as No on upload.
  Available to Workflow Lineup	Yes, Y, True, 1, X*	All other values are treated as No on upload.
  Configuration Access Groups	Valid access group display name	Separate access groups using a pipe ( | ) character.
  Available to BI	Yes, Y, True, 1, X*	All other values are treated as No on upload.
  Available to Search	Yes, Y, True, 1, X*	Applies only to String, Long String, and Multi-Select List metrics. All other values are treated as No on upload.
  Rich Text	Yes, Y, True, 1, X*	Applies only to Long String metrics. All other values are treated as No on upload.
  Delete	Yes, Y, True, 1, X*	All other values are treated as No on upload.

  * For any column that accepts Yes, Y, True, 1, or X, you can also enter No, N, False, or 0 if it helps you when entering data in the spreadsheet. All values other than Yes, Y, True, 1, or X are treated as No when you upload the spreadsheet.

  ** Limited to characters between a - z, A - Z, and 0 - 9, and the underscore ( _ ).

   

In addition, the Metrics spreadsheet includes the association setting for each process models (active and inactive) to which each metric is associated. Each process model to which the metric is associated contains the following set of columns, and each set of columns is identified by the process model name.

• Additional Model Settings

  For a description of each metric association setting, see Associating Metrics to Process Models.

  Note:  The columns in this portion of the spreadsheet are used for associating a metric with a model, and do not create new process models in Accolade.

  Column Name	Accepted Values on Upload	Additional Notes
  Associated	Yes, Y, True, 1, X*	This column defaults to Yes if any of the related model columns are defined. All other values are treated as No on upload.
  Project Creation	Edit Show	Can be blank.
  Project Metrics	Edit Show	Can be blank.
  Status Report	Edit Show	Can be blank.
  Portfolio	Edit Show	Can be blank.
  Planning Favorite	Yes, Y, True, 1, X*	The Available to Planning column for the metric must be set to Yes, Y, True, 1, X* if this column is set to Yes, Y, True, 1, X*. All other values are treated as No on upload.
  Milestone	Yes, Y, True, 1, X*	Applies only to Date type metrics. The Available to Planning column on the metric must be set to Yes, Y, True, 1, X* if this column is set to Yes, Y, True, 1, X*. All other values are treated as No on upload.
  Required	Yes, Y, True, 1, X*	All other values are treated as No on upload.

  * For any column that accepts Yes, Y, True, 1, or X, you can also enter No, N, False, or 0 if it helps you when entering data in the spreadsheet. All values other than Yes, Y, True, 1, or X are treated as No when you upload the spreadsheet.

   

• List Values

  If the Data Type selected is List or Multi-Select List and the list is manually defined within the metric, the list values should be entered on this tab. For a description of each list value setting, see Creating Single and Multi-Select List Metrics.

  This worksheet must be included in the spreadsheet file, but can be left blank if the metrics do not include defined lists.

  Column Name	Accepted Values on Upload	Additional Notes
  Metric System Name	Alphanumeric characters, underscore**	Used for matching in the upload. If a metric exists, its settings are changed with the values in the uploaded file.
  List Value Name	Any	If blank, the list value does not upload.
  List Value System Name	Alphanumeric characters, underscore**	Can be blank.
  Order	Any number	The field is set to 0 on upload if no value is entered or the value is not a number.
  Color	Valid hex color code	Can be blank.

  ** Limited to characters between a - z, A - Z, and 0 - 9, and the underscore ( _ ).