Credits: Mark Dobbie

Design Pattern

Objective

Tags can be used to create specific smart folders making it easy to manage and account for the development cycle of the assets being created. Using the “By Tag” library view, a user will be able to sort through a large asset library quickly.


View By Tag

 
You’re not limited to just one tag per component. For instance, if you have a service/BPD/integration that tests your database connections it would be tagged as both a test and a database service.

General (Pre-Exist in TW7)

Tag
Purpose
Data Access General data access integrations (CRUD)
Data Transform Transforms data from one form to another (e.g. when coming out of web services into a BPD)
Database To distinguish Integration services that interact with databases
Exceptions Used to handle exceptions
Deprecated Items that are kept around for backward compatibility but are no longer the recommended implementation
Installation Used for the installation of a process app or toolkit
Integration A specific integration implementation
Report Implementation that is used for reporting purposes
Reporting To distinguish which services, variables, tracking groups, etc are linked to reporting
Security Anything that is dealing with security, such as users and groups
Task Specifically used to implement a task in a process. Can be used on all first-level task services
Test To distinguish Test Harnesses
Top Level The top-level BPD or a top-level service. Can be useful with an associated Smart folder to know where the top items are
UI Helpers for human services, such as getting lists of text for a list
Utility A utility service
Web Services To distinguish Integration services that interact with web services

Naming Convention

Tag services as required in the Naming Conventions Pattern

Other Tagging Options

If your developers are the compulsively organizational type, try the following ideas for tags, and let us know the results. We’re always looking for feedback.

  • Development Status Based Tags - Tag each and every artifact with its development status (To Do, In Progress, Completed, etc.).
  • User Based Tags – Tag Task Services, Reports, and BPDs by the users/participant groups that will be using them.
  • Process Based Tags – If you have a process app with multiple processes, tag each process-specific artifact with a tag of the BPD it’s associated with.

Smart Folders

Objective

While the new library in IBM BPM versions 7 and up eliminates the cluttered, confusing nested library structure of previous Teamworks versions, it also eliminated the ability to quickly access top-level services and business process diagrams.  We can eliminate this deficiency, and improve our development experience, by using tagging and smart folders.

Application

There are 4 types of IBM BPM artifacts that we want to be easily accessible.  Create a shared smart folder for each tag listed in the table below.

Smart Folder
Tag
Description
Example
Top-Level BPDs
Top-Level BPD
These BPDs should be the highest level BPDs in your process app. You may only have a few, but the ability to get to them quickly is important. An enterprise HR Onboarding process BPD. This may live in the HR Process App, alongside other processes, but it stands alone from others (i.e. offboarding, conflict resolution, etc.). We would tag the HR Onboarding process with “Top-Level BPD”, and it would add itself the top-level BPD smart folder. We would not tag any sub-processes this  BPD has (i.e. background check, adding to payroll system, etc)
Top-Level Services
Top-Level Service
These stand-alone services (primarily Human Services) do not exist in any BPDs.
  • A CRUD (create, read, update, delete) service used to allow users to manually manage database content, event schedules, etc.
  • A service that contains a report embedded in a coach, which will be deployed on the Left Side Navigation bar in the IBM BPM Portal.
  • A service that allows users to drilldown through process instances and the data/statuses associated with each.
Integrations (Use system specific tag)
These are services which contain integrations with other systems.

Note: To create this folder, use system specific tags (i.e. Database, Document Management, Legacy System). This way, you’ll be able to sort your smart folder by integration (sort by tag).
  • A service that updates customer information using a webservice
  • A service that writes a document to a content management system.
Test Services
Unit Test
Services/BPDs  used to test User Interfaces, Integrations, Process flow, etc.
  • A service used to test an integration with a document management system.
  • A service used to test a user interface’s validation on a customer service coach.
  • A BPD used to test proper process flow.

Examples

Smart Folder
Example Screenshot
Top-Level BPDs

Top Level BPD Smart Folder

Top-Level Services

Top Level Services Smart Folder

Integrations
Integration Smart Folder
Test Services

Test Services Smart Folder

1 comment on"Smart Folder and Tagging"

  1. Is the smart folder data present in any of the LSW tables?

Join The Discussion

Your email address will not be published. Required fields are marked *