Modeller Assistant

The ShareDo product is constantly evolving. New functionality is being released, existing functionality is enhanced, and, occasionally, functionality is removed.

The Modeller Assistant can manage your solution through these changes as easily and risk-free as possible. This proactive tool inspects your configuration to identify potential issues (we call these “jobs”). 

Only admin users can run upgrade jobs.

 

Understanding Assistant Jobs

At the time of release, the Modeller Assistant runs two types of jobs.

  • Upgrade Jobs – Whenever your solution is upgraded to a new version, a number of upgrade jobs may be added to the list. These are designed to highlight any potential issues with the upgrade and give you a mechanism to either fix them or mark them as verified manually.
  • Configuration Monitoring Jobs – these jobs continually run in your solution, watching for potential issues in your configuration and guiding you to fix them.

Both types of jobs will inspect your system configuration, and if they find any issues, they will either fix them automatically or provide an easy mechanism for you to do so.

When you go to the Modeler Assistant, it will show you a list of jobs in the system (as shown in the image above) as well as their progress (the green bar in the image below).

The following jobs are available at the time of release (v7.6.0), but more will be added in future releases.

Job Description
v7 Template Upgrade Previously, a page within Document Template Admin highlighted any issues with document template configuration. To make it more readily available, this has now been moved to the Modeller Assistant.
Visual workflow deprecated toolbox items We have replaced a number of workflow toolbox items that were present in the beta version of the visual workflow designer. This job will highlight any workflows that still have these toolbox items present.
Legacy Tag Libraries Prior to Data Composer Tags, ShareDo used a concept called Tag Libraries, which will be completely deprecated in version 8. This job analyses your document template configuration to highlight these legacy tags.
Upgrade from Matching Rules to Business Rules In v7.7, we will be upgrading all of the rules within the system from our Matching Rules engine to the new Business Rules engine. As part of this upgrade, any possible changes in functionality will be highlighted by these jobs.

Clicking on a job opens a list view showing you the activities it has performed. The filter buttons at the top of the page allow you to show only the activities in the chosen filter: Pending, Action Required, Failed, Completed.

Selecting an activity provides you with more detail.

You can perform the following actions:

Open the configuration item and make whatever changes are required.
Rescan or re-inspect the item to verify if your change has fixed the issue.
Or manually verify that the issue has been fixed by checking the box and clicking Verify.

Managing Jobs as Part of a Solution Upgrade

Every time your ShareDo solution is upgraded to a new version, new jobs will most likely become available. Sharedo will warn you of these new jobs via a toast message to system modellers.

Clicking on this message will take you to the Modeler Assistant, highlighting the pending jobs.

If upgrading your Development environment, you will most likely choose to Run Pending Jobs to have these inspect your solution configuration. Once the jobs have run, you can begin to address these issues. 

Import fixed rules to UAT/Production

In the case of other environments, such as UAT or Production, you should choose to Import Configuration first. By importing your fixed configuration, the Modeler Assistant should find few, if any, errors, enabling you to streamline your production upgrades.