Targetprocess

The Targetprocess Developer Hub

Welcome to the Targetprocess developer hub. Here you'll find comprehensive guides and documentation to help you start working with Targetprocess as quickly as possible and support you if you get stuck. Let's jump right in!

Docs

Customize Entity detailed view

Now you can customize the detailed view of any entity in any possible way, including:

  • hiding useless tabs, rename existing tabs or add a new ones;
  • hiding or renaming buttons and fields;
  • creating your own sections to group native and custom fields in the way you need.

To modify the detailed view, open Targetprocess Settings > Detailed Views menu item. Here you will find default layouts for every entity. These layouts are described in JSON format and contain the list of all tabs, sections, fields and buttons, represented as objects.

Every entity has its own default layout that is identical to the old uncustomizable detailed view.

You can enable or disable a new view for particular entity in particular process, e.g. Features in a Kanban process will use a new customized view, while Requests in a Scrum process will use the old one.

As an example, let’s modify the detailed view for Feature entity in Scrum process.

Navigate to Targetprocess Settings > Detailed Views menu item. Select ‘Features’ in the entity dropdown and ‘Scrum’ in the process dropdown. Switch on using customizable view. The default layout is loaded.

1. Rename tab

Do you want to rename tab ‘Description’ into ‘Info’? Just find "value": "Description" string on JSON editor and change it to "value": "Info". Click ‘Apply changes’ buttons.

Before

Before

After

After

If there are punctuation or syntax errors in JSON, the layout editor will highlight those errors. The ‘Apply changes’ button will be disabled until you fix the problem. If something went wrong you can restore the edited version to a default layout by clicking the ‘Restore to default’ button.

2. Move tab

Let’s move tab ‘Tests’ in the end of all tabs. Replace the whole object with "value": "Tests" in the end of tabs array.

After

After

3. Add tab

Do you want to add your own tab ‘User Stories and Defects’ with the content from both ‘User Stories’ and ‘Bugs’? It’ really easy. Just combine and edit the content of both object of JSON into one and put it in the place you want.

In the example above we

  • changed value for ‘value’ key from ‘User Stories’ to ‘User Stories and Bugs’, it will be a new name for the tab;
  • removed ‘localize’, ‘useTerms’ and ‘isPlural’ keys as the whole phrase is not a term;
  • removed whole objects with "component": "label.generalCounter" as we do not need user stories and bugs counters to be displayed in the header of the new tab;
  • merged two objects with the lists of user stories and bugs into one array [].
After

After

4. Remove tab

Now we can remove tab ‘Bugs’ as it's not useful anymore: delete the whole object with "value": "Bugs".

Take a look how does the customized view for Feature look after all made changes:

After

After

5. Right column. Remove section

Now let’s customize the right panel of the view. To remove section ‘Lead cycle time’ just delete the whole object with "value": "Lead cycle time".

After

After

6. Right column. Add section

Do you want to group date fields into a new section? In order to not lose JSON formatting duplicate any section e.g. ‘Info’, give a name to a new section by editing "value": "Info" string. Delete fields useless for this section by removing the whole objects related to these fields from JSON.

After

After

7. Right column. Add section for DevOps Integrations

To see Branches and Merge/Requests, related to any Targetprocess entity ID, you have to have this entity type's view customized.
This code will add a new block to the right panel:

 {
   "type": "devops-info/v2",
   "component": "DevOpsInfoV2",
   "componentId": "devops_component"
 },

Let's add it below 'Assignments' section

8. Right column. Hide field

Note that fields hidden from the view are still available through API v.2, so it's not a good idea to hide security things in this way.

As date fields are already shown in the new ‘Dates’ section let's remove them from ‘Info’ section: delete whole objects of usefulness fields from ‘Info’ array.

After

After

9. Rename native field

Do not rename native fields via layout editor as it affects only the detailed view, not all views across the system, and leads to inconsistency.

10. Add custom field

Let’s add custom field ‘Extra’ under ‘Owner’ field of ‘Info’ section. Do not forget to add this field in Targetprocess Settings > Custom Fields menu item. Now add the whole object

                {
                  "type": "property.customField",
                  "properties": {
                    "name": "Extra"
                  }
                }

under ‘Owner’ object in JSON.

There is no need to set componentID, it's generated automatically.

After

After

11. Rename custom field

If you want to rename existing custom field do not forget to change it in two places: Targetprocess Settings > Custom Fields and in the Detailed Views menu items.

12. Add custom field of rich text type

Custom field of rich text type is usually adding in the main part of the view because it needs a lot of space. Let's put ‘Additional info’ field on the ‘Info’ tab under ‘Description’ object in JSON.

13. Add embedded page

You can see the pages by links you've provided in a URL and Template URL custom field as an additional tab on an entity view, so that you can work with the external pages and documents straight in Targetprocess.

Let’s add ‘Doc’ custom field under ‘Effort’ object of ‘Info’ section in JSON.

Now let's add a new tab ‘Google Doc’ after ‘Relations’ tab: add the whole object

{
  "title": {
    "type": "string",
    "value": "Google Doc"
  },
  "component": {
    "type": "embeddedPage",
    "customFieldName": "Doc"
  }
}

under ‘Relations’ object in JSON.

Go to the Feature detailed view and fill in URL custom field with external link to e.g. Google document. Magic!

14. Add Task / Test Case Template

This component helps you to create a set of Test Cases or Tasks and add it to any User Story at once. It works for any project, any team and any process.

The component adds a tab to the User Story view. From this tab you can create templates that contain tasks or test cases you need to apply to multiple user stories. After you create the template and the Tasks and/or Test Cases that you would like to use, they can be applied on any user story by going to the Template tab and selecting Apply Template.

Please add this component to User Story entity:

 {
    "title": {
      "type": "string",
      "value": "Template",
      "localize": true
    },
    "component": {
      "type": "taskTestCaseTemplate"
    }
 }

Updated 14 days ago

Customize Entity detailed view


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.