Workflow naming conventions

When you design or develop new workflows, they are easier to understand if you use a naming convention for your tasks and workflows. This convention allows others who review the workflow to know your intentions for the workflow as a whole and for each task in the workflow without interpretation. Use the standard naming conventions for each task type, and add a description to each task that further clarifies its intent.

For business object names, use the business object upon which the task is performing work. If the task could be doing work on any business object in the module, use the module name. You might need to further qualify the business object name to give it a more descriptive context. For example, if multiple employee records could be used in the workflow, you could use "Supervisor" and "Employee" to distinguish them. If you are referencing a business object that is associated to another business object, indicate both business objects and the association relationship.

Name all tasks in a workflow a unique name. Remember to add context where required.

If a workflow task is completely custom, prefix the task name with cst. For example, cstIterate for each triAsset.

If a workflow task is an as-delivered task that has at least one modification, do not change the task name. The object revisioning capabilities eliminate the need to rename and modify as-shipped IBM® TRIRIGA® objects to suit your business needs.

A best practice for a completely custom workflow is to prefix the Start task and all tasks within the workflow with cst. When the business object is also custom and is in a completely custom workflow, use cst only one time. For example, cstWidget - triSave - Trigger Approval Process.

Tip: Microsoft Word often changes the minus sign in a workflow task name or a query name to a hyphen. If you copy workflow task names or query names from a document that you prepared in Word or from a PDF of a Word document, you need to change the hyphen to a minus sign. The Object Migration tool does not recognize the hyphen and does not import your work.

The following table contains naming standards for completely custom workflow and tasks that you create.

Attention: When you modify as-shipped IBM TRIRIGA objects to suit your business needs as opposed to creating your own objects, do not use a cst name prefix or follow the naming conventions. With the new object revisioning and object labeling features in IBM TRIRIGA Application Platform, you can modify as-shipped objects without the need for naming conventions. Your objects are saved in revisions each time you revise them.

For more information on object revisioning capabilities, the new object conversion process, and the upgrade best practices, see Object Labels and Revisions.

Attention: Do not use the ', <, >, =, or % special characters in workflow names or workflow task names. Do not put a space after the “cst” or the “cst-”.

Table 1. Naming conventions for completely custom workflows
Task	Naming Convention	Example
Start Task Asynchronous Workflow Workflow is completely custom and is against an as-delivered object	cst + Business Object Name - Event that triggers the workflow - Description or cst + Business Object Name - Associate - Secondary Business Object Name - Description or cst + Module Name - Event that triggers the workflow - Module Level Description	cstTriSpace - triSave - Trigger Approval Process or cstTriPeople - Associate - triSpace - Primary Location or cstTriContract - triCreateDraft - Module Level Call Update Dependent Records
Start Task Asynchronous Workflow Workflow is completely custom and is against a custom object	Business Object Name - Event that triggers the workflow - Description or Business Object Name - Associate - Secondary Business Object Name - Description or Module Name - Event that triggers the workflow - Module Level Description	cstWidget - triSave - Trigger Approval Process or cstWidget - Associate - triSpace - Primary Location or cstWidget - triCreateDraft - Module Level Call Update Dependent Records
Start Task Asynchronous Workflow Workflow is a modification of an as-delivered workflow	Business Object Name - Event that triggers the workflow - Description or Business Object Name - Associate - Secondary Business Object Name - Description or Module Name - Event that triggers the workflow - Module Level Description	triLand - Cancel - Reset Meta-data or triPeople - Associate - triSpace - Primary Location or triPayment - triComplete - Module Level Action Item to get Response
Start Task Subflow Workflow Workflow is completely custom and is against an as-delivered object	cst + Business Object Name - Subflow - Description	cstTriAsset - Subflow - Count asset inventory
Start Task Subflow Workflow Workflow is completely custom and is against a custom object	Business Object Name - Subflow - Description	cstWidget - Subflow - Count asset inventory
Start Task Subflow Workflow Workflow is a modification of an as-delivered workflow	Business Object Name - Subflow - Description	triAsset - Subflow - Count asset inventory
Start Task Synchronous Workflow Workflow is completely custom and is against an as-delivered object	cst + Business Object Name - Synchronous - Description	cstTriLocation - Synchronous - Populate parent fields on create
Start Task Synchronous Workflow Workflow is completely custom and is against an a custom object	Business Object Name - Synchronous - Description	cstWidget - Synchronous - Populate parent fields on create
Start Task Synchronous Workflow Workflow is a modification of an as-delivered workflow	Business Object Name - Synchronous - Description	triLocation - Synchronous - Populate parent fields on create
Create Record Task	If the task is completely custom: cst + Create Business Object Name from Business Object Name (source) or If the task is a modification of an as-delivered task: Create Business Object Name from Business Object Name (source)	cstCreate triAddress from Building Primary Address or Create triAddress from Building Primary Address
Modify Records Task	If the task is completely custom: cst + Set Business Object Name (target) from Business Object Name (source) or If the task is a modification of an as-delivered task: Set Business Object Name (target) from Business Object Name (source)	cstSet triProperty from Location or Set triProperty from Location
Retrieve Records Task	If the task is completely custom: cst + Get Business Object Name (target) from Business Object Name (source) or If the task is a modification of an as-delivered task: Get Business Object Name (target) from Business Object Name (source)	cstGet triProfile from triGroup associated to triBuilding or Get triProfile from triGroup associated to triBuilding
Associate Records Task	If the task is completely custom: cst + Assoc Business Object Name (source) to Business Object Name (target) or cst + DeAssoc Associate Business Object Name (source) from Business Object Name (target) or If the task is a modification of an as-delivered task: Assoc Business Object Name (source) to Business Object Name (target) or DeAssoc Associate Business Object Name (source) from Business Object Name (target)	cstAssoc triNotification to triLocation or cstDeAssoc triPeople from triLocation or Assoc triNotification to triLocation or DeAssoc triPeople from triLocation
Trigger Action Task	If the task is completely custom: cst + Action [space] Business Object Name or If the task is a modification of an as-delivered task: Action [space] Business Object Name	cstRemove Temp triAddress; Issue triPurchaseOrder or Remove Temp triAddress; Issue triPurchaseOrder
Delete Reference Task	If the task is completely custom: cst + Delete Reference to Business Object Name (source) from Business Object Name (target) or If the task is a modification of an as-delivered task: Delete Reference to Business Object Name (source) from Business Object Name (target)	cstDelete Reference to triProfile from triGroup Associated to triBuilding or Delete Reference to triProfile from triGroup Associated to triBuilding
Add Child Task	If the task is completely custom: cst + Add Child Business Object Name (source) to Business Object Name (target) or If the task is a modification of an as-delivered task: Add Child Business Object Name (source) to Business Object Name (target)	cstAdd Child triSpace to triFloor or Add Child triSpace to triFloor
Set Project Task	If the task is completely custom: cst + Set Project of Business Object Name (target) from Business Object Name (source) or If the task is a modification of an as-delivered task: Set Project of Business Object Name (target) from Business Object Name (source)	cstSet Project of triInvoiceItem from triContract or Set Project of triInvoiceItem from triContract
Attach Format File Task	If the task is completely custom: cst + Attach File Name to Business Object Name or If the task is a modification of an as-delivered task: Attach File Name to Business Object Name	cstAttach Deleted Cost Code.rpt to triNotification or Attach Deleted Cost Code.rpt to triNotification
Query Task	If the task is completely custom: cst + Get query or If the task is a modification of an as-delivered task: Get query	cstGet triPeople Associated with triBuildings or Get triPeople Associated with triBuildings
User Action Task	If the task is completely custom: cst + Assign User or Group Name to Action Business Object Name or If the task is a modification of an as-delivered task: Assign User or Group Name to Action Business Object Name	cstAssign Admin Group to Remove triContactRoles Associated to Retired triPeople or Assign Admin Group to Remove triContactRoles Associated to Retired triPeople
Approval Task	If the task is completely custom: cst + Assign User or Group Name to Approve Business Object Name or If the task is a modification of an as-delivered task: Assign User or Group Name to Approve Business Object Name	cstAssign At Bat triPeople to Approve triPurchaseOrder or Assign At Bat triPeople to Approve triPurchaseOrder
Schedule Task	If the task is completely custom: cst + Schedule Action for Business Object Name or If the task is a modification of an as-delivered task: Schedule Action for Business Object Name	cstSchedule triFinalIssue for triBidResponse or Schedule triFinalIssue for triBidResponse
Get Temp Record Task	If the task is completely custom: cst + Get Temp Business Object Name Note: When performing other tasks to the results of a Get Temp Record task, use the modifier "Temp" for the Business Object Name. For example, if you are using a Modify Records task, cstAdd Temp triProperty:triAddressOther with triAddress"	cstGet Temp triPeople
Modify Metadata Task	If the task is completely custom: cst + Set Context for Business Object Name, Form Name (if to a particular form) or If the task is a modification of an as-delivered task: Set Context for Business Object Name, Form Name (if to a particular form)	cstSet ID to Read Only for triPeople or Set ID to Read Only for triPeople
Save Permanent Record Task	If the task is completely custom: cst + Commit Temp Business Object Name or If the task is a modification of an as-delivered task: Commit Temp Business Object Name	cstCommit Temp triPeople or Commit Temp triPeople
Iterator Task	If the task is completely custom: cst + Iterate for each Business Object Name or If the task is a modification of an as-delivered task: Iterate for each Business Object Name	cstIterate for each triPeople or Iterate for each triPeople
Custom Task	If the task is completely custom: cst + Call Context or If the task is a modification of an as-delivered task: Call Context	cstCall Update triTask triAcutalEndDT or Call Update triTask triAcutalEndDT
Populate File Task	If the task is completely custom: cst + Populate Context with Business Object Name or If the task is a modification of an as-delivered task: Populate Context with Business Object Name	cstPopulate bid.xls with triBid or Populate bid.xls with triBid
Distill File Task	If the task is completely custom: cst + Distill Context into Business Object Name or If the task is a modification of an as-delivered task: Distill Context into Business Object Name	cstDistill bid.xls into triBid or Distill bid.xls into triBid
Call Workflow Task	If the task is completely custom: cst + Call Business Object Name - Context or If the task is a modification of an as-delivered task: Call Business Object Name - Context	cstCall triTask - Permanent Save Validation (this is the synchronous workflow name with the " - Synchronous" removed) or Call triTask - Permanent Save Validation (this is the synchronous workflow name with the " - Synchronous" removed)
DataConnect Task	If the task is completely custom: cst + Process Business Object Name or If the task is a modification of an as-delivered task: Process Business Object Name	cstProcess triPOBody or Process triPOBody
Variable Definition Task	If the task is completely custom: cst + Define Variable Name or If the task is a modification of an as-delivered task: Define Variable Name	cstDefine triInvoiceCount or Define triInvoiceCount
Variable Assignment Task	If the task is completely custom: cst + Assign Variable Name or If the task is a modification of an as-delivered task: Assign Variable Name	cstAssign triInvoiceCount or Assign triInvoiceCount