Edit

Migrate Digital Workers to Control Tower

Intelligent Automation Cloud is Digital Worker centric. Control Tower users now have a new point of view on their automation—the business cases they have automated including:

• The easier visual distinction of Business Processes into Digital Workers
• Digital Worker level analytics

The instruction provides guidance on how to make automations you develop appear in Control Tower as an instance of a new Digital Worker entity.

I'm developing a brand new Digital Worker to run on Intelligent Automation Cloud

Basic scenario

ODF 2 is a recommended framework for the implementation of Digital Workers if you create your project based on this guide. To proceed, do as follows:

1. Go to the [ARTIFACT]-package module of your project.

2. Open the meta-info.json file.

3. Specify the following attributes in the file:

   • USE_CASE_CODE: set a unique identifier of the Digital Worker entity; it is also used to identify the set of metrics to compare different versions of the Digital Worker.

   Select a unique code that won't overlap with any other codes in the customer's environment. Maintain the same Digital Worker code as you develop your Digital Worker—don't change it from version to version.

   • USE_CASE_VERSION: specify the version number of your Digital Worker, for instance, 10.8.18.
   • NAME: populate it with the Digital Worker name.

4. If you have Analytics dashboards, place their assets into the bundle.

   1. If you use one of your dashboards for Digital Worker overview, rename its workbook so that it ends with overview, for example, en_NSS_overview.twbx.
   2. Put needed Liquibase migration scripts to impact Data Marts into dashboard/site/migration.
   3. Put needed Tableau Data Sources into dashboard/site/datasource.
   4. Put needed Tableau workbooks into dashboard/site_<language>/workbook. If you have multiple workbooks for different environment locales, you need a separate /site_<language>/workbook folder for each workbook.

5. Build your project's Asset Bundle and deploy it to the environment. For more information, refer to Deploy Asset Bundle.

6. To check that everything is done correctly, go to Control Tower and open Digital Workers > View All. You should see something like this.

   

7. To check that your Overview dashboard is also visible, click the Digital Worker version details. The dashboard appears on the page.

Adjustments to project specifics

1. Question: My project is more complex than the one provided in the guide, for example, I have multiple package modules that generate multiple Asset Bundles during the Build phase. What am I supposed to do?

   Answer: You have to modify the respective meta-info.json in every module that generates an Asset Bundle with the same attributes. We don't provide any tools to do it in one action.

2. Question: Will this work for Digital Workers based on the IDP template?

   Answer: Yes, it will. Since an IDP project template is an example of a project with multiple modules that generate an Asset Bundle, the advice above works. You have to modify respective meta-info.json in every module that generates the Asset Bundle specifying the same values of the USE_CASE_CODE, USE_CASE_VERSION, and NAME attributes.

3. Question: We don't use the Asset Bundle Import functionality in our project. It's overkill for us. We deploy BCB to the development environment, build a Business Process there and migrate Business Process to higher environments. How do we make this work for us?

   Answer: The only way to have a Digital Worker entity created in Control Tower is by uploading an Asset Bundle. The deployment via the Asset Bundle isn't overkill, it's an easier way to do the same deployment procedure. All you need is to put your Business Process into the business-process folder of your [ARTIFACT]-package module and build the Asset Bundle that will deploy both BCB and the Business Process to the target environment. See Deploy Asset Bundle for more details.

4. Question: I have a separate team working on analytics dashboards for the Digital Worker. We don't share a common project, how do we make their dashboard appear on the details page for a Digital Worker version?

   Answer: Either you or any other team member has to prepare an Asset Bundle that includes the Overview dashboard. The easiest way is to put the Tableau workbook into the dashboard/workbook folder of your [ARTIFACT]-package module.

I have a skill deployed to earlier 10.x version of Intelligent Automation Cloud

The guide assumes that:

• You have a pre-10.2 installation with IA Cloud Enterprise.
• You have some Business Processes (one or more) that logically belong to the same Digital Worker that you want to view when you dive into the Digital Worker version details.

Recommended approach—I have access to my Digital Worker project

This scenario is similar to creating a new Digital Worker as you can modify the package module of your project, build an Asset Bundle, and deploy it as if it's a new Digital Worker.

1. Go to [ARTIFACT]-package module of your project.

2. Open the /datastore folder and rename the CSV files in the folder. This is needed not to have your Data Stores content overwritten on the Asset Bundle import, which you'll have to do next. If you have any custom solution that allows you to version your project's assets, follow your project guidelines.

3. Open the meta-info.json file.

4. Specify the following attributes in the file:

   • USE_CASE_CODE: set a unique identifier of the Digital Worker entity; it is also used for identifying the set of metrics to compare different Digital Worker versions.

   Select a unique code that won't overlap with any other codes in the customer's environment. Maintain the same Digital Worker code as you develop your Digital Worker—don't change it from version to version.

   • USE_CASE_VERSION: specify the version number of your Digital Worker, for instance, 10.8.18.
   • NAME: populate it with the Digital Worker name.

5. If you have Analytics dashboards, place their assets into the bundle.

   1. If you use one of your dashboards for Digital Worker overview, rename its workbook so that it ends with overview, for example, en_NSS_overview.twbx.
   2. Put needed Liquibase migration scripts to impact Data Marts into dashboard/site/migration.
   3. Put needed Tableau Data Sources into dashboard/site/datasource.
   4. Put needed Tableau workbooks into dashboard/site_<language>/workbook. If you have multiple workbooks for different environment locales, you need a separate /site_<language>/workbook folder for each workbook.

6. Build your project's Asset Bundle and deploy it to the environment. Refer to Deploy Asset Bundle. To ensure correct deployment, your Digital Worker's Business Processes shouldn't be running at the target environment.

7. To check that everything is done correctly, go to Control Tower and open Digital Workers > View All. You should see something like this:

   

8. To check that your Overview dashboard is also visible, click the Digital Worker version details. The dashboard appears on the page.

9. To continue maintaining the project, rename the CSV files in the /datastore folder to the original state.

Workaround—I don't have access to my Digital Worker project, but I have an Asset Bundle

If you have an Asset Bundle file but don't have access to the Digital Worker project, you can modify your Asset Bundle to let the platform know about your Digital Worker. Note that if your Digital Worker project development continues and new versions are going to be deployed, you have to follow the recommended approach or repeat this workaround for every new version of the Digital Worker.

1. Unzip your Asset Bundle.

2. Open the meta-info.json file in the root of the folder.

3. Modify the file specifying the following attributes. The order doesn't matter, but you have to maintain a valid JSON file structure:

   • USE_CASE_CODE: set a unique identifier of the Digital Worker entity; it is also used for identifying the set of metrics to compare different Digital Worker versions.

   Select a unique code that won't overlap with any other codes in the customer's environment.

   Maintain the same Digital Worker code as you develop your Digital Worker—don't change it from version to version.

   • USE_CASE_VERSION: specify the version number of your Digital Worker, for instance, 10.8.18.
   • NAME: populate it with the Digital Worker name.

4. If you have the /datastore folder, open it and remove all CSV files.

5. Archive the assets into an Asset Bundle. Make sure it has the same structure and meta-info.json is still at the root level of the Asset Bundle structure.

6. Open Control Tower and go to Digital Workers > View All. You should have the Manage Digital Workers permission to view this page.

7. Click the Upload New button. You should have Export/Import and Advanced Package Import permissions.

   

8. Click the Add button in the popup window and select your Asset Bundle file in the file selection dialog.

   

9. After you confirm the file selection, the Asset Bundle file uploads to your environment, and you can cancel the process until the upload finishes. After that, the import process begins. You can track the import progress on the screen. If you see a disabled Finish and show Digital Worker button at the bottom of the screen, it indicates that your meta-info.json file is modified correctly. You can see the attributes you provided in the Asset bundle details section containing the Digital Worker name, code, and version.

   

10. After the successful installation, the imported Asset Bundle appears as a Digital Worker in the corresponding group. You can also access the import log to see if there were any warnings during the import procedure. For details, click View import log file.

    

Not recommended—I don't have access to my Digital Worker project and I don't have the Asset Bundle but I have the Digital Worker deployed to my environment

Although the approach might seem the easiest, it's not recommended as it doesn't tie all Digital Worker assets except Business Processes to the Digital Worker. It can cause some new functionality that will use the internal Digital-Worker-Asset relation to malfunction. You also won't be able to see the Overview dashboard on the Digital Worker details page if you follow this approach. However, there might be some reasons to follow this approach. For example, you know your next version is almost ready and packaged in a way that supports its display on the Digital Workers view, and the current one is getting obsolete soon.

1. Export all Business Processes related to your Digital Worker using the Business Process Package Export feature.

2. Create a folder named business-process.

3. Put all BP Packages in the business-process folder.

4. Create an empty meta-info.json file in the same place where the business-process folder resides. The structure should look like this:

   

5. Edit the meta-info.json file specifying the following attributes:

   • USE_CASE_CODE: set a unique identifier of the Digital Worker entity; it is also used for identifying the set of metrics to compare different Digital Worker versions.

   Select a unique code that won't overlap with any other codes in the customer's environment.

   Maintain the same Digital Worker code as you develop your Digital Worker—don't change it from version to version.

   • USE_CASE_VERSION: specify the version number of your Digital Worker, for instance, 10.8.18.
   • NAME: populate it with the Digital Worker name.
   • WF_VERSION: specify your platform version, for example, 10.2 or 10.2.1.

6. Archive the folder and file into the Asset Bundle. Make sure it has the correct structure and meta-info.json is at the Asset Bundle structure's root level.

7. Open Control Tower and go to Digital Workers > View All. You should have the Manage Digital Workers permission to view this page.

8. Click the Upload New button. You should have the Export/Import and Advanced Package Import permissions.

   

9. Click the Add button in the popup window and select your Asset Bundle file in the file selection dialog.

   

10. After you confirm the file selection, the Asset Bundle file uploads to your environment, you can cancel the process until the upload finishes. After that, the import process begins. You can track the import progress on the screen. If you see a disabled Finish and show Digital Worker button at the bottom of the screen, it indicates that your meta-info.json file is modified correctly. You can see the attributes you provided in the Asset bundle details section containing the Digital Worker name, code, and version.

    

11. After the successful installation, the imported Asset Bundle appears as a Digital Worker in the corresponding group. You can also access the import log to see if there were any warnings during the import procedure. For details, click View import log file.