Modeller assistant jobs and advisories

Was this article helpful?

What you do depends on the job. Some jobs fix everything themselves. Some change configuration and ask you to check the result. Others list items for you to fix. Advisories never change configuration, so you always fix the item yourself.

The job and advisory names in the tabs below match the names in the Modeller Assistant. See the Work with jobs and advisories for how Scan Again and Verify work.

  • Jobs by release lists every job and advisory under the release that added it. Use it when you plan an upgrade. Find the releases you are upgrading through to see which jobs to expect.
  • The other sub-tabs group jobs by area, such as Business Rules or Fees and rate cards. Each one explains what a job flags and how to resolve it. Use them when you work through a job in the Modeller Assistant. The First release column shows the release that added each job or advisory. An upgrade adds every job your environment has not run yet. For example, an upgrade from 7.9 to 7.12 adds the jobs first released in 7.10, 7.11 and 7.12 together. 

Jobs by release

Find the releases you are upgrading through, then open the sub-tab named against each job.

7.13.0

  • Fees and rate cards
    • Fees - Convert Template Goods/Service References to Compound Key
    • Fees - Reconcile Section Goods/Service Item Types After Rate-Card Currency Split
    • Fees - Convert Additional Fee Templates To Alternative Models
    • Fees - Close Draft Actual Fee Structures
    • Fees - Verify commercial model widget pages
    • Fees - Custom code using removed fee endpoints
    • Fees - Visual workflows using removed fee endpoints
    • Rate variations set against a Person rather than a User
 
 

7.12.0

  • Fees and rate cards
    • Rate cards created from currency mismatches
  • Finance
    • Time Internal Costs - Convert CoA Ids to Code Paths
    • Tax - Convert CoA Ids to Code Paths
  • Job roles
    • Job Roles Convert Calculated Fields
    • Job Roles Convert Business Rules
    • Job Roles Convert Email Signatures
    • Job Roles Convert Document Template Expressions
  • Document templates
    • Bundle Template Migration
  • Advisories
    • User Profile Checks
    • Inactive Segment Code Deletion Advisory
 
 

7.11.0

  • Jobs that need no action
    • Create Invoice Interest Transaction Toolbox Item - Convert CoA Ids to Code Paths
  • Other
    • Data Table Upload - Custom Plugins Migration
  • Advisories
    • List views configuration using a deprecated data provider identified
    • SCIM Feature
 
 

7.10.0

  • Jobs that need no action
    • Create Invoice/Payment Request Toolbox Item Add Code Path
  • Business Rules
    • Business Rules - Convert Document Template Legacy Display Rules
  • Document templates
    • Document Templates - Convert Markdown Templates
  • Other sub-tab
    • Convert obsolete key facts widgets to the newer type
 
 

7.9.1

  • Other
    • Visual Plan Host Functions
 
 

7.9.0

  • Business Rules
    • Business Rules - Convert Goods and Service Item Applicable Work Types to Business Rules
 
 

7.8.0

  • Finance
    • Chart of Accounts Code Special Characters converter
    • Budget Structures - Convert Calculated Position Types
  • Other
    • Form Evo Convert Linked Service
  • Advisories
    • Menus with deprecated Finance v1 Commands and/or Providers
    • User Menus with deprecated Finance v1 Commands and/or Providers
    • Portal Pages with deprecated Finance v1 Widgets and/or Commands
 
 

7.7.0

  • Jobs that need no action
    • Business Rules - Convert Menu Items
    • Business Rules - Convert Portals
    • Business Rules - Convert Portal Pages
    • Business Rules - Convert Portal Widgets
    • Business Rules - Convert Portal Widgets - Configured Menus
    • Business Rules - Convert Work Type Aspects - Configured Menus
    • Business Rules - Convert Work Type Data Quality Rules
    • Business Rules - Convert Option Set Value Display Rules
    • Business Rules - Convert Key Date Association Display Rules
    • Business Rules - Convert Approval Auto Approval Rules
    • Business Rules - Convert Goods Services
    • Business Rules - Convert Valuation Guidance Providers
    • Business Rules - Convert Document Template Display Rules
    • Business Rules - Convert Budget Structure Position Types
    • Business Rules - Convert Chart of Accounts Codes
    • Business Rules - Convert Payment Plan Instalment Types
    • Vehicle Lookup Providers
  • Business Rules
    • Business Rules - Convert Matching Rules
    • Business Rules - Convert Work Type Aspects
    • Business Rules - Convert Participant Role Aspects
    • Business Rules - Convert Participant Role Connections Aspects
    • Business Rules - Convert Participant Type Aspects
    • Business Rules - Convert User Profile Aspects
    • Business Rules - Convert ODS Entity Type Aspects
    • Business Rules - Convert Budget Structure Aspects
    • Business Rules - Convert Document Template Data Quality Rules
    • Business Rules - Convert Document Template Data Pack Sources
  • Advisories
    • Custom plugin workflow blocks with legacy type identifiers
    • Custom IDE workflow blocks with legacy type identifiers
 
 

7.6.0

  • Document templates
    • V7 Document Templates Upgrade
    • Document Template Legacy Tags
  • Other
    • Blade ribbon conversion
  • Advisories
    • Visual Workflows with Deprecated Toolbox Actions
 
 
 
 

Jobs that need no action

These jobs make their changes automatically and raise no issues. Their activities complete without you doing anything.

Job First release Notes
Create Invoice Interest Transaction Toolbox Item - Convert CoA Ids to Code Paths 7.11.0  
Create Invoice/Payment Request Toolbox Item Add Code Path 7.10.0 Displays no activities at all.
Business Rules - Convert Menu Items 7.7.0  
Business Rules - Convert Portals 7.7.0  
Business Rules - Convert Portal Pages 7.7.0  
Business Rules - Convert Portal Widgets 7.7.0  
Business Rules - Convert Portal Widgets - Configured Menus 7.7.0  
Business Rules - Convert Work Type Aspects - Configured Menus 7.7.0  
Business Rules - Convert Work Type Data Quality Rules 7.7.0  
Business Rules - Convert Option Set Value Display Rules 7.7.0  
Business Rules - Convert Key Date Association Display Rules 7.7.0  
Business Rules - Convert Approval Auto Approval Rules 7.7.0  
Business Rules - Convert Goods Services 7.7.0  
Business Rules - Convert Valuation Guidance Providers 7.7.0  
Business Rules - Convert Document Template Display Rules 7.7.0  
Business Rules - Convert Budget Structure Position Types 7.7.0  
Business Rules - Convert Chart of Accounts Codes 7.7.0  
Business Rules - Convert Payment Plan Instalment Types 7.7.0  
Vehicle Lookup Providers 7.7.0 Moves the Vehicle Lookup global feature to the DvlaSearch provider. Select Open to check the settings.
 
 

Business Rules

These jobs move configuration from Matching Rules to Business Rules. Business Rules - Convert Matching Rules creates a business rule from each matching rule. The other jobs link each configuration area to those business rules.

Each of these jobs runs once and does not offer Scan Again. Review each issue, then verify it.

Job First release What it flags How to resolve
Business Rules - Convert Document Template Legacy Display Rules 7.10.0 Templates that already had more than one display rule. The job combines all of them with the converted phase rules using AND, which may be stricter than intended. Select Open and review the template's display rules. Verify the issue.
Business Rules - Convert Goods and Service Item Applicable Work Types to Business Rules 7.9.0 Goods and services items that already had business rules. The job replaces each item's applicable work types and sub-types with business rules, and combines them with any existing rules using AND. Select View, find the item by its code, and check the combined rules give the result you want. Verify the issue.
Business Rules - Convert Matching Rules 7.7.0 Matching rules that are not in use, rules it could not read, and rule blocks that may not convert exactly. Problems with a rule display here, not on the job for the area that uses it. Select Business Rule to review the converted rule, or Matching Rule to compare it with the original. Verify each issue. Where a rule was not in use, consider deleting the converted business rule.
Business Rules - Convert Work Type Aspects, Participant Role Aspects, Participant Role Connections Aspects, Participant Type Aspects, User Profile Aspects, ODS Entity Type Aspects, Budget Structure Aspects 7.7.0 Aspects with several matching rules plus a view permission or personas. The job converts the permission and personas to business rules too, so it cannot keep the OR logic between the original rules. Select Open to open the aspects and review the business rule selection. Verify the issue. For Budget Structure Aspects, Open searches the global features for Budgets.
Business Rules - Convert Document Template Data Quality Rules 7.7.0 Data quality rules whose matching rule had the wrong context. These rules need a Doc Gen context. Select Open to open the template. Check the data quality rule uses a business rule with a Doc Gen context. Verify the issue.
Business Rules - Convert Document Template Data Pack Sources 7.7.0 Pack source rules whose matching rule had the wrong context. These rules need a Doc Gen context. Open the template and check the pack source rules use a Doc Gen context. Verify the issue.
 
 

Fees and rate cards

Before you run pending jobs: give every goods and services item a code, and make sure no two items share the same item type and code. Fees - Convert Template Goods/Service References to Compound Key converts fee template elements in the same run that checks this. Elements that point to an item with no code lose their reference.

Job First release What it flags How to resolve
Fees - Convert Template Goods/Service References to Compound Key 7.13.0 Goods and services items with no code, and item type and code pairs that are not unique. The job changes fee template elements to refer to items by item type and code. Fix the codes before the upgrade, as above.
Fees - Reconcile Section Goods/Service Item Types After Rate-Card Currency Split 7.13.0 Fee templates whose sections gain the per-currency rate card item types their elements need. If old element references remain, the job changes nothing and reports them. Review each listed fee template. Verify the issue.
Fees - Convert Additional Fee Templates To Alternative Models 7.13.0 Work items whose fee templates, assigned before Fees v3, could not all convert to alternative commercial models. Activities show the work type name, not the work item title. Select Open work item. Fix the cause shown against each template, then add those templates by hand from the work item's Financial Frameworks widget. Verify the issue.
Fees - Close Draft Actual Fee Structures 7.13.0 Draft actual fee structures. The job approves each one and closes its approval task. It runs only when the Fee Structures global feature is on. The issue says a structure "will be approved", but it is already approved. Select Draft Fee Structure or Work Item to check the result. Verify the issue.
Fees - Verify commercial model widget pages 7.13.0 Every portal page and user defined portal template that holds the commercial model widget, which the upgrade moved. This job changes nothing. Select Review to open the page in the portal designer. If the page has several widgets, keep one and delete the rest. If it has one, check the page. Turn off Estimate, Actual, Estimate / Actual or Notes if you do not want them. If the widget has a display rule, compare its audience before you remove it. The Actual tab also needs the fee actuals read permission and the work type actuals feature. For a template, fix an equivalent live portal, select Save portal to template with a new name, then delete the old template from Manage templates. Delete the template if no portal matches. Verify each issue.
Fees - Custom code using removed fee endpoints 7.13.0 IDE files that call api/fees endpoints removed in the Fees upgrade. These calls no longer respond. This job changes nothing. Select View to open the IDE. Change each call to the equivalent public API (api/v1/public/...). Select Scan Again.
Fees - Visual workflows using removed fee endpoints 7.13.0 Visual workflows that call removed endpoints, and running instances pinned to a published version that calls one. This job changes nothing. Select View, fix the workflow and publish it. Move the running instances to the corrected published version. Select Scan Again.
Rate variations set against a Person rather than a User 7.13.0 Hourly rate cards with a rate that varies by a person who is not a user. The rate still prices as before, but cannot be reselected in the rate table. Select Open Rate Card. Point the rate at the equivalent user, or remove the variation. Verify the issue.
Rate cards created from currency mismatches 7.12.0 Rate cards created when the migration split an item type whose items used more than one currency. This job changes nothing. Select Open Rate Card and check the items and pricing. Verify the issue.
 
 

Finance

Each of these jobs runs once and does not offer Scan Again.

Job First release What it flags How to resolve
Time Internal Costs - Convert CoA Ids to Code Paths 7.12.0 Segment codes in the Time Internal Costs global feature that the job could not find. It converts the rest to code paths. Correct the code in the Time Internal Costs configuration. Verify the issue.
Tax - Convert CoA Ids to Code Paths 7.12.0 Segment codes on tax accounts in the Tax global feature that the job could not find. It converts the rest to code paths. Correct the code on the tax account named in the issue. Verify the issue.
Chart of Accounts Code Special Characters converter 7.8.0 Chart of Accounts codes that contained anything other than letters and digits. The job removes those characters. A code that clashes with another code under the same parent gains a number. A code with nothing left becomes TemporaryCode. Select Open to see the segment values. Check each renamed code against the issue. Update any calculated fields or external references that used the old code. Verify each issue.
Budget Structures - Convert Calculated Position Types 7.8.0 Calculated budget position types it converts to data composer expressions. It flags types it cannot convert, and expressions where it had to choose a work type or could not find one. Where the issue asks, replace unknown in the expression with the right work type, or check the root type it chose. Regression test the budget. Verify the issue.
 
 

Job roles

These jobs find expressions that use the old role properties. They change nothing. Replace each property with its new one.

Old property New property
user.primaryTeam.role user.activeRole
user.teams.role user.roleAssignments
employmentDetails.primaryRole user.activeRole
user.primaryTeam.role.name (email signatures) ods.user.activeRole.roleType.name
Job First release What it flags How to resolve
Job Roles Convert Calculated Fields 7.12.0 Calculated fields whose expressions use an old property. Fields that do not use one complete automatically. Select Open, replace the property named in the issue, and save. Select Scan Again.
Job Roles Convert Business Rules 7.12.0 Business rules, and their custom parameters, that use an old property. Select Open, replace the property in the rule or its parameters, and save. Select Scan Again.
Job Roles Convert Email Signatures 7.12.0 Global, team and personal email signatures that use an old property. Global signatures are checked only when they are set to be added for new emails or for replies and forwards. Select Open. It opens the Email Signatures global feature, the team's signatures or the person's signature. Replace the property and save. Select Scan Again.
Job Roles Convert Document Template Expressions 7.12.0 Document template tags and display rules that use an old property. Select Open to open the template. Replace the property in each listed tag or display rule. Select Scan Again.

Each issue clears itself on Scan Again once the property is replaced.

 
 

Document templates

Job First release What it flags How to resolve
Bundle Template Migration 7.12.0 Bundle separators and content blocks that use legacy bundle tags, legacy tags in display rules, or context paths that navigate through the bundle activity. The issue names the Data Composer replacement. Select Migrate and confirm to replace the tags automatically, or Open to edit the template by hand. Fix any tag found in a content block from that content block's own activity. Select Scan Again, then verify each issue. These issues do not clear on a rescan.
Document Templates - Convert Markdown Templates 7.10.0 Markdown templates it converts to HTML or plain text, with warnings where the conversion may need rework, such as tables, style sheets, fonts and links built from tags. When the job completes, it removes the markdown template types no template uses. Select Document Template to open the converted template, and Markdown Template to see the original. Correct the converted template where needed. Verify each issue.
V7 Document Templates Upgrade 7.6.0 Templates upgraded to the V7 format whose data context was set to a different work type, and To or Regarding roles the new data context cannot fulfil. Templates linked to several work types get their shared parent type, or one chosen by schema. Runs once. Select View to open the template. Check the data context and any roles named in the issue. Verify the issue.
Document Template Legacy Tags 7.6.0 Templates that use tags from a legacy tag library. The job runs only when the LegacyTagLibraries global feature is on. It unlinks tag libraries a template does not use. Select View to open the template. Remove the legacy tags listed in the issue, including any in content blocks. Select Scan Again. When every activity is complete, the job turns off LegacyTagLibraries.
 
 

Other

Job First release What it flags How to resolve
Data Table Upload - Custom Plugins Migration 7.11.0 Custom data table uploaders that use the old interfaces. A developer updates the uploader to IDataTableUploadPlugin, or removes it if no template uses it. Recreate the template in the Data Table Upload global feature, using Old Template and New Global Feature. Select Scan Again.
Convert obsolete key facts widgets to the newer type 7.10.0 Fields it could not move when it upgraded legacy key facts widgets to the newer widget. Runs once. Select Review to open the portal designer. Add the missing field to the new widget's template by hand. Verify the issue.
Visual Plan Host Functions 7.9.1 Visual workflows that used the deprecated host.newArr(lib.System.String, ...) function. The job replaces it with collections.stringArray(...) and saves the workflow. With version pinning on, it publishes a new version and flags running instances still on an older one. Select Manage Published and move running instances to the latest published version. Select Scan Again.
Form Evo Convert Linked Service 7.8.0 The FormEvo linked service, which the job moves to OAuth. It removes all user configuration and tokens. If the service had no configuration, the job deletes it. Runs once. If the service converted, select View, relink it, and ask users to relink their accounts. If it was deleted, recreate the FormEvo linked service. Verify the issue.
Blade ribbon conversion 7.6.0 Custom blade ribbon options missing from a work type's menus. The issue lists each option's type and command details. Runs once. Select View to open the work type's menus. Re-add the option if you still need it. Verify the issue.
 
 

Advisories

Advisories check your configuration every time they run and change nothing. You cannot verify an advisory issue. Fix the item, then select Scan Again. The issue clears once the item no longer has the problem.

The Workflows page and the all users admin page display a banner when an advisory finds issues there. Select View.. on the banner to open them.

Advisory First release What it flags How to resolve
User Profile Checks 7.12.0 Users with no job role where their user type needs one, users with no permissions, and users who share an email address with another user. Select View to open the user. Assign a current job role, assign a permission set or system permission to the user or one of their teams, or give the user a unique email address. Select Scan Again.
Inactive Segment Code Deletion Advisory 7.12.0 Inactive Chart of Accounts segment codes with no child codes and no use in transactions, code combinations or budget structures. Select Review. Delete the code if appropriate. Select Scan Again.
List views configuration using a deprecated data provider identified 7.11.0 List views that use a deprecated provider. core-sharedos, core-sharedo-instructions and core-sharedo-payments move to core-sharedos-elastic. core-legal-invoice-receipts-recently-paid moves to finance-invoice-payments. core-report-list-admin and core-report-list-workbench move to core-reports. Select View to open the list views. Recreate the list view with the provider named in the issue. Update any references to the old list view, then delete it. Select Scan Again.
SCIM Feature 7.11.0 Runs only when the SCIM global feature is on. Flags when no identity client holds the core.users.scim-provisioning permission. It also displays on the SCIM global feature screen. Select Identity Clients. Give the client used for SCIM authentication the core.users.scim-provisioning permission. Select Scan Again.
Menus with deprecated Finance v1 Commands and/or Providers 7.8.0 Work type menu options that use a Finance v1 reserves or settlements command or provider. Commands move to edit-budgets, and providers move to budgets-provider. Select View to open the work type's menus. Change each listed option to the command or provider named in the issue. Select Scan Again.
User Menus with deprecated Finance v1 Commands and/or Providers 7.8.0 User menu items that use the same deprecated commands or providers. Select View. Change each listed item to the command or provider named in the issue. Select Scan Again.
Portal Pages with deprecated Finance v1 Widgets and/or Commands 7.8.0 Portal pages with a deprecated Finance v1 widget, such as the reserves and finance summary widgets, or a deprecated page command. The issue names the replacement widget. Select View to open the work type's portal. On the named page, replace each widget with the one named in the issue, or change the page command to edit-budgets. Select Scan Again.
Custom plugin workflow blocks with legacy type identifiers 7.7.0 Custom plugin workflow blocks that require /Identifier/Work Type Identifier, which is now /Identifier/Work Item Identifier. No button displays. A developer changes the required type in the block's .wf-action.json file. Select Scan Again.
Custom IDE workflow blocks with legacy type identifiers 7.7.0 Workflow blocks in the IDE whose JavaScript refers to /Identifier/Work Type Identifier. Select View to open the folder in the IDE. Replace it with /Identifier/Work Item Identifier and save. Select Scan Again.
Visual Workflows with Deprecated Toolbox Actions 7.6.0 Workflows that use a deprecated action, such as Create action plan item, Prepare a document, Create task or Create call to action. The issue names the replacement action. Select View to open the workflow. Replace each deprecated action with the one named in the issue, and save. Select Scan Again.
 
 

 

 

Was this article helpful?

Related articles

Related articles in the knowledge base