OnBase Guide - Exporting and Importing Configurations

Transcription

1 OnBase Guide - Exporting and Importing Configurations Goal: This guide will provide the steps needed to use the import/export framework for migration in OnBase. Complexity Level: Departmental Administrative Users 10/31/2018

2 Table of Contents Background... 3 Prerequisites... 3 Exporting... 3 Studio... 3 Config Client... 7 Importing Studio Config Client Post Import Items to Manually Configure or Check

3 Background As we work in a multi-environment system, it is necessary to migrate configurations you ve made from the test system to the production system. This guide intends to show you how to use both Studio and the Configuration client to perform exports and imports so you can migrate your items into production. This process can also be used to save configurations outside of the OnBase system if there is a refresh occurring, so you do not lose any in progress development work. Prerequisites You will need to have the Studio client and the configuration client installed on your machine. You will also need to have connections to both the environment you are exporting from and the environment you are importing into. NOTE: To export workflow lifecycles, you MUST to use Studio. To export only usergroups, you need to use the Configuration client. Exporting Studio 1. Open OnBase Studio, and connect to the environment you want to export from. Once you are logged in, click the Export button in the ribbon. 2. Click Next on the dialog that appears. 3

4 3. In the leftmost column, there are a list of items that are available for export. Select the item type you want to export. NOTE: If you want to export multiple item types, you will need to select each item type individually. 4. Once you select an item type, the available items of that type will appear in the middle column. Select the item(s) you want to export, and then click the button with the double left arrows. NOTE: You are able to select multiple items for this step. 4

5 5. Once you have selected all the items you want to export, click Next. 6. You are provided with a summary of the export you are about to perform. You are also given the option of encrypting your export. If you want to, provide a password to encrypt the export with, and click Start Export. In this guide, we will not be encrypting the export. As such, uncheck the Encrypt Export File box, then click Start Export. 5

6 7. Your export should be successful, as indicated the by dialog. Click the Download and Save Export Package button. NOTE: If your export is not successful, or partially successful, please review the message provided, and resolve any issues. If you are unsure of the error shown, please review the System Administration MRG in OnBase or contact for additional support. 8. Choose a location to save the export package, and name it appropriately. Then click Save. Typically, the ideal place to save it is on the desktop. 9. Once you have saved, the save dialog will disappear. Click Finish. 6

7 Config Client 1. Open the Configuration client of the environment you want to export from. Once logged in, go to the following menu: Utils > Change Management > Export Configuration Items. 2. Click Next on the dialog that appears. 3. In the leftmost column, there are a list of items that are available for export. Select the item type you want to export. NOTE: If you want to export multiple item types, you will need to select each item type individually. 7

8 4. Once you select an item type, the available items of that type will appear in the middle column. Select the item(s) you want to export, and then click the button with the double left arrows. NOTE: You are able to select multiple items for this step. 5. Once you have selected all the items you want to export, click Next. 8

9 6. You are provided with a summary of the export you are about to perform. You are also given the option of encrypting your export. If you want to, provide a password to encrypt the export with, and click Start Export. In this guide, we will not be encrypting the export. As such, uncheck the Encrypt Export File box, then click Start Export. 7. Your export should be successful, as indicated the by dialog. Click the Download and Save Export Package button. NOTE: If your export is not successful, or partially successful, please review the message provided, and resolve any issues. If you are unsure of the error shown, please review the System Administration MRG in OnBase or contact uis_dm_support@cu.edu for additional support. 9

10 8. Choose a location to save the export package, and name it appropriately. Then click Save. Typically, the ideal place to save it is on the desktop. 9. Once you have saved, the save dialog will disappear. Click Finish. 10

11 Importing NOTE: The import dialog may not fully display on smaller screens. We recommend the process be performed when connected to a larger screen, or decreasing the scale of your current display. Studio 1. Open OnBase Studio, and connect to the environment you want to import to. Once you are logged in, click the Import button in the ribbon. 2. Click the browse button in the upper right hand side of the window that appears. 3. Navigate to the location where you saved your export package. Select the package, and click Open. 11

12 4. You will be presented with a screen showing the items you manually exported. At the top of the screen, click Auto-Resolution. Click the button labeled Automatically Resolve All Items. NOTE: There may be times when you need to manually resolve items when importing configurations. This guide will not cover that. Please review the System Administration MRG in OnBase or contact uis_dm_support@cu.edu for additional support. 5. Click the Run Verification button at the top of your screen. This will evaluate the resolution decisions made to ensure the import will be successful. The verification process may generate errors and/or warnings. Please review these and resolve them as necessary. If there are any errors present, you will not be able to complete the import process. You CAN complete the import process with warnings present, but you should resolve them if able. 6. Once you successfully run the verification, you can click the Proceed to Import button. 7. You are presented with a final summary of your import for review. Once you are satisfied with the import, you can click the Start Import button in the bottom right corner of the 12

13 window. 8. The import should be successful. If so, click the Finish button in the lower right corner of the screen. If the import was partially successful, make a note of the message displayed. NOTE: In previous versions of OnBase, there was an option to commit or revert the changes the import made. This is no longer possible in version

14 Config Client 1. Open the Configuration client of the environment you want to export from. Once logged in, go to the following menu: Utils > Change Management > Import Configuration Items. 2. Click the browse button in the upper right hand side of the window that appears 3. Navigate to the location where you saved your export package. Select the package, and click Open. 14

15 4. You will be presented with a screen showing the items you manually exported. At the top of the screen, click Auto-Resolution. Click the button labeled Automatically Resolve All Items. NOTE: There may be times when you need to manually resolve items when importing configurations. This guide will not cover that. Please review the System Administration MRG in OnBase or contact uis_dm_support@cu.edu for additional support. 5. Click the Run Verification button at the top of your screen. This will evaluate the resolution decisions made to ensure the import will be successful. The verification process may generate errors and/or warnings. Please review these and resolve them as necessary. If there are any errors present, you will not be able to complete the import process. You CAN complete the import process with warnings present, but you should resolve them if able. 6. Once you successfully run the verification, you can click the Proceed to Import button. 15

16 7. You are presented with a final summary of your import for review. Once you are satisfied with the import, you can click the Start Import button in the bottom right corner of the window. 8. The import should be successful. If so, click the Finish button in the lower right corner of the screen. If the import was partially successful, make a note of the message displayed. NOTE: In previous versions of OnBase, there was an option to commit or revert the changes the import made. This is no longer possible in version

17 Post Import Items to Manually Configure or Check Once you ve competed your import there are a few items that will have to be manually configured or checked as they cannot be migrated. Keyword Data Sets: are clearing and need to be repopulated Load Balancing Rules: need to be reconfigured Static addresses: in notifications for workflows User Group Population: Groups get migrated but are not populated Keyword order on document types: Check to make sure they are in the correct order Expressions in workflow: Make sure the right keyword types are being used since keyword numbers may not be the same Unity form custom actions: Especially any involving modified workflow queues. Open form in editor and publish or test drive to ensure that no custom action error messages are displayed Unity form attachment controls Workflow timers (may) need to be re-attached to their life cycles/queues (this seems to no longer be the case in v18!) Actions using Export to Network Location will need to have the file path updated if exporting to an environment-specific location. Refer to UIS s Export to Network Location documentation for file paths if relevant. 17