Importing and Exporting Functional Areas and Functions
Accolade provides Administrators and Process Designers the ability to export functional areas and functions configuration 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 functional areas and functions in each environment, download the information and import it into the new environment.
The download exports the functional areas and functions configuration into a spreadsheet file with the information grouped into the following tabs within the file:
To export functional areas and functions:
- From the System menu, select Security & Groups > Functions.
- Click Download in the top right corner of the page.
By default, the file exports automatically to a temporary internet files directory. Save it 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 functional areas and functions into Accolade:
- Ensure the data within the spreadsheet meets the requirements for a successful import.
- Remove any functional areas and functions that you do not want to include in the upload from the spreadsheet and save the file.
- From the System menu, select Security & Groups > Functions.
- Click Upload in the top right corner of the page.
- Click Load File and select the spreadsheet file to load.
- Click Upload File.
Accolade uploads the changes to the functional areas and functions in the spreadsheet, and adds any new functional areas and functions with unique system names.
- (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.
Functional Areas and Functions Settings Included in the Spreadsheet File
The columns in the downloaded spreadsheet include the settings for each functional area and function in the order listed below. For a description of each function setting, see
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
-
Functional Areas
Column Name Accepted Values on Upload* Additional Notes Functional Area System Name
Alphanumeric characters, underscore**
Used for matching for upload.
If a functional area 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 functional area is created.
Function Area Name
Any
If blank, the functional area 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.
Delete Functional Area
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 ( _ ).
-
Functions
Column Name Accepted Values on Upload* Additional Notes Functional Area System Name
Alphanumeric characters, underscore**
Used for matching for upload.
If a functional area exists, its settings are changed with the values in the uploaded file.
Function System Name
Alphanumeric characters, underscore**
Must be unique. If blank, the function does not upload.
Function Name
Any
If blank, the function does not upload
Active
Yes, Y, True, 1, X*
All other values are treated as No on upload.
Order
Any number
The field is set to 0 on upload if no value is entered or the value is not a number.
Merge To Functional System Name
Alphanumeric characters, underscore**
Used for merging functions. Enter the system name of the function being merged to.
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 ( _ ).
-
Access Groups
Column Name Accepted Values on Upload Additional Notes Function System Name
Alphanumeric characters, underscore**
Used for matching for upload.
If a function exists, its settings are changed with the values in the uploaded file.
Access Groups
Valid access group system name
Include a separate row for each access group.
** Limited to characters between a - z, A - Z, and 0 - 9, and the underscore ( _ ).
-
Members
Column Name Accepted Values on Upload Additional Notes Function System Name
Alphanumeric characters, underscore**
Used for matching for upload.
If a function exists, its settings are changed with the values in the uploaded file.
Members
Valid user system ID
Use the format with which the user accessed Accolade, such as domain\username or username@domain.com.
Include a separate row for each member.
** Limited to characters between a - z, A - Z, and 0 - 9, and the underscore ( _ ).