Change to Workflow
In January 2022, the following record types have been renamed:
Change
toWorkflow
Change Template
toWorkflow Templates
Change Types
toWorkflow Types
Similarly, many attributes that contain the word change
have also been renamed.
The sections below describe the adjustments to various parts of 4me in more detail.
The APIs remain backward compatible until February 4, 2023. After February 4, 2023, API endpoints and attributes containing the word ‘change’ will no longer be available. To ensure that your own API integrations continue to work after February 4, 2023, please adjust them to use ‘workflow’ instead of ‘change’.
Please make sure to go through the Breaking changes section, to ensure that you are not affected by any of them.
Contents
- Actions for the account designer of your 4me account
- User Interface
- URLs
- Email templates
- PDF Designs
- Dashboards and Reports
- Automation rules
- UI Extensions
- Status Workflow Pending
- GraphQL API
- REST API
- Bulk API
- Events API
- Mail API
- Webhooks API
- Breaking changes
Actions for the account designer of your 4me account
For the most part, all occurrences of the word “Change” in the 4me Service have been renamed by 4me. However, you may still encounter the word “Change” in user-generated content of your 4me account. In particular:
- Existing dashboards and dashboard reports have not been migrated and may still refer to “Changes”. Consider updating these dashboards and dashboard reports to refer to “Workflows” instead.
- The subject and body attributes of your existing email templates (including translations) have not been migrated and may still refer to “Change”. Consider updating these fields to refer to “Workflow” instead.
- The name and HTML attributes of your existing PDF Designs (including translations) have not been migrated and may still refer to “Change”. Consider updating these fields to refer to “Workflow” instead.
User Interface
The following adjustments have been made to the user interface (4me Self Service and the Specialist interface).
Renamed attributes
- Account Trusts:
- Renamed ‘Roles from us: Change manager’ to ‘Roles from us: Workflow manager’
- Renamed ‘<account> can assign change approval tasks to us’ to ‘<account> can assign workflow approval tasks to us’
- Renamed ‘<account> can assign change tasks to our key contacts and specialists’ to ‘<account> can assign workflow tasks to our key contacts and specialists’
- Renamed ‘<account> can view our time spent on their change tasks’ to ‘<account> can view our time spent on their workflow tasks’
- Renamed ‘<account> can view our change notes and attachments’ to ‘<account> can view our workflow notes and attachments’
- Change Templates:
- Renamed ‘Change type’ to ‘Workflow type’
- Renamed ‘Recurrence - Change manager’ to ‘Recurrence - Workflow manager’
- Changes:
- Renamed ‘Change type’ to ‘Workflow type’
- Invoices:
- Renamed ‘Change’ to ‘Workflow’
- People:
- Renamed ‘Roles - Change manager’ to ‘Roles - Workflow manager’
- Problems:
- Renamed ‘Change’ to ‘Workflow’
- Request Templates:
- Renamed ‘Change template’ to ‘Workflow template’
- Renamed ‘Change manager’ to ‘Workflow manager’
- Requests:
- Renamed ‘Change’ to ‘Workflow’
- Task Template
- Renamed ‘Assign to change manager’ to ‘Assign to workflow manager’
- Renamed ‘Planned effort change manager’ to ‘Planned effort workflow manager’
- Renamed ‘Copy notes to change’ to ‘Copy notes to workflow’
- Task
- Renamed ‘Change’ to ‘Workflow’
- Renamed ‘Copy note to change’ to ‘Copy note to workflow’
- Timesheet Settings
- Renamed ‘Default effort class for workflow tasks’ to ‘Default effort class for workflow tasks’
Note: The ‘Change manager’ field of Services has not been renamed.
Other renamings
- Change Templates:
- Renamed section ‘Changes’ to ‘Workflows’
- Problems:
- Renamed status ‘Change Pending’ to ‘Workflow Pending’ (see Status Workflow Pending)
- Request Templates:
- Renamed status ‘Change Pending’ to ‘Workflow Pending’ (see Status Workflow Pending)
- Requests:
- Renamed status ‘Change Pending’ to ‘Workflow Pending’ (see Status Workflow Pending)
- Releases:
- Renamed section ‘Changes’ to ‘Workflows’
- Projects:
- Renamed section ‘Changes’ to ‘Workflows’
- Analytics:
- Renamed all reports containing ‘… Change …’ to ‘… Workflow …’
- Renamed all filters (in views and reports) containing ‘… Change …’ to ‘… Workflow …’
- Email Templates:
- Renamed ‘Change - New Change’ to ‘Workflow - New Workflow’
- Renamed ‘Change - Change Set to Progress Halted’ to ‘Workflow - Workflow Set to Progress Halted’
- Renamed ‘Change - Change Manager Changed’ to ‘Workflow - Workflow Manager Changed’
- Renamed ‘Change - Note Added to Change’ to ‘Workflow - Note Added to Workflow’
- Renamed ‘Change - Person Mentioned in Note of Change’ to ‘Workflow - Person Mentioned in Note of Workflow’
- Renamed ‘Release - Change Added to Release’ to ‘Release - Workflow Added to Release’
- Renamed ‘Release - Change Removed from Release’ to ‘Release - Workflow Removed from Release’
- PDF Designs:
- Renamed category ‘Change Summary’ to ‘Workflow Summary’
- UI Extensions:
- Renamed category ‘Change Template’ to ‘Workflow Template’
- Custom Views:
- Renamed record type ‘Change Template’ to ‘Workflow Template’
- Webhooks:
- Renamed events:
change.create
toworkflow.create
change.update
toworkflow.update
change.note-added
toworkflow.note-added
change.status-changed
toworkflow.status-changed
change.manager-changed
toworkflow.manager-changed
- Note The old events can no longer be selected when creating new webhooks, but they continue to work in existing webhooks.
- Renamed events:
- Exports:
- Renamed types ‘Changes’, ‘Change Templates’ and ‘Change Template Automation Rules’ to ‘Workflows’, ‘Workflow Templates’ and ‘Workflow Template Automation Rules’
- Note The old types can no longer be selected when creating new exports, but they continue to work in existing (recurring) exports.
URLs
- The URL
/changes
redirects to/workflows
- The URL
/changes/:id
redirects to/workflows/:id
- The URL
/change_templates
redirects to/workflow_templates
- The URL
/change_templates/:id
redirects to/workflow_templates/:id
- The URL
/change_types
redirects to/workflow_types
- The URL
/change_types/:id
redirects to/workflow_types/:id
Email templates
- The subject, body and translations of your existing email templates have not been migrated and may still refer to “Change”. Consider updating these fields to refer to “Workflow” instead.
- All email template fields starting with
change_
are now deprecated. They will continue to work in existing email templates, even after February 4, 2023, but you are encouraged to update your email templates.
PDF Designs
- The name and HTML attributes of your existing PDF Designs have not been migrated and may still refer to “Change”. Consider updating these fields to refer to “Workflow” instead.
- All occurrences of the word
change
in dynamic content (e.g.:change.id
andfor change.requests
) are now deprecated. They will continue to work in existing PDF Designs, even after February 4, 2023, but you are encouraged to update your PDF designs. Replace such occurrences withworkflow
(e.g.:workflow.id
andfor workflow.requests
).
Dashboards and reports
- Existing dashboards and dashboard reports have not been migrated and may still refer to “Changes”. Consider updating these dashboards and dashboard reports to refer to “Workflows” instead.
Automation rules
- In automation rule expressions, any references to
change
are deprecated in favor ofworkflow
. Examples:change.tasks[first]
toworkflow.tasks[first]
find(change, 1674)
tofind(workflow, 1674)
- In automation rule expressions, any references to
changes
are deprecated in favor ofworkflows
. Example:change.release.changes[first].subject
toworkflow.release.workflows[first].subject
- In automation rule expressions, any references to
change_pending
are deprecated in favor ofworkflow_pending
. Example:change.status = change_pending
toworkflow.status = workflow_pending
- Existing automation rules that refer to
change
,changes
orchange_pending
will continue to work, even after the deprecation period. However: - When editing an automation rule that refers to
change
,changes
orchange_pending
, all these occurrences will be marked as errors in the user interface. You must rename all these occurrences before you can save the automation rule.
UI Extensions
- In UI Extensions which category is ‘Workflow Template’ (previously ‘Change Template’), it is no longer allowed to add custom fields with an
id
that starts withworkflow_
. Existing fields with this prefix will continue to work.
Status Workflow Pending
The status ‘Change Pending’ has been renamed to ‘Workflow Pending’. Similarly, the id
of the status has been renamed from change_pending
to workflow_pending
.
However, because renaming the id
could break many integrations, you can adjust this behavior via the Account Settings of your account.
To continue using the id change_pending
in the REST API, GraphQL API, Export API and Webhooks API, enable the account setting “Use deprecated change_pending status in API responses”.
By default, this setting is enabled in existing 4me accounts, and disabled in new 4me accounts. This setting is available until the end of the deprecation period. Once the deprecation period expires, workflow_pending
will always be used.
GraphQL API
- Queries:
- Deprecated change in favor of workflow
- Deprecated changeTemplate in favor of workflowTemplate
- Deprecated changeType in favor of workflowType
- Mutations:
- Deprecated changeCreate in favor of workflowCreate
- Deprecated changeUpdate in favor of workflowUpdate
- Deprecated changeTemplateCreate in favor of workflowTemplateCreate
- Deprecated changeTemplateUpdate in favor of workflowTemplateUpdate
- Deprecated changeTypeCreate in favor of workflowTypeCreate
- Deprecated changeTypeUpdate in favor of workflowTypeUpdate
- Attributes:
- Invoice: deprecated
change
in favor ofworkflow
- Problem: deprecated
change
in favor ofworkflow
- Project: deprecated
changes
in favor ofworkflows
- Release: deprecated
changes
in favor ofworkflows
- Request: deprecated
change
in favor ofworkflow
- RequestTemplate: deprecated
changeManager
in favor ofworkflowManager
- RequestTemplate: deprecated
changeTemplate
in favor ofworkflowTemplate
- Task: deprecated
change
in favor ofworkflow
- TaskTemplate: deprecated
assignToChangeManager
in favor ofassignToWorkflowManager
- TaskTemplate: deprecated
plannedEffortChangeManager
in favor ofplannedEffortWorkflowManager
- TaskTemplate: deprecated
changeTemplates
in favor ofworkflowTemplate
- WorkflowTaskTemplateRelation: deprecated
changeTemplate
in favor ofworkflowTemplate
- WorkflowTemplate: deprecated
changeManager
in favor ofworkflowManager
- WorkflowTemplate: deprecated
changeType
in favor ofworkflowType
- Workflow: deprecated
changeId
in favor ofworkflowId
- Workflow: deprecated
changeType
in favor ofworkflowType
- Invoice: deprecated
- Sort orders:
- Filters:
- AutomationRule: deprecated
changeTemplate
in favor ofworkflowTemplate
- Invoice: deprecated
change
in favor ofworkflow
- Request: deprecated
change
in favor ofworkflow
- Request: deprecated
changeStatus
in favor ofworkflowStatus
- RequestTemplate: deprecated
changeManager
in favor ofworkflowManager
- RequestTemplate: deprecated
changeTemplate
in favor ofworkflowTemplate
- Task: deprecated
change
in favor ofworkflow
- Task: deprecated
changeType
in favor ofworkflowType
- Task: deprecated
changeCategory
in favor ofworkflowCategory
- Task: deprecated
changeJustification
in favor ofworkflowJustification
- TaskTemplate: deprecated
changeJustification
in favor ofworkflowJustification
- TimeEntry: deprecated
change
in favor ofworkflow
- Workflow: deprecated
changeType
in favor ofworkflowType
- WorkflowTemplate: deprecated
changeType
in favor ofworkflowType
- AutomationRule: deprecated
- Other:
- Problem: the id of the status
change_pending
has been renamed toworkflow_pending
(see Status Workflow Pending) - Request: the id of the status
change_pending
has been renamed toworkflow_pending
(see Status Workflow Pending) - RequestTemplate: the id of the status
change_pending
has been renamed toworkflow_pending
(see Status Workflow Pending)
- Problem: the id of the status
REST API
- Endpoints:
- Deprecated (all endpoints starting with)
/changes
in favor of Workflows API - Deprecated (all endpoints starting with)
/change_templates
in favor of Workflow Templates API - Deprecated (all endpoints starting with)
/change_types
in favor of Workflow Types API - Deprecated
services/:id/change_templates
in favor of Services - Workflow Templates API - Deprecated
task_templates/:id/change_templates
in favor of Task Templates - Workflow Templates API - Deprecated
projects/:id/changes
in favor of Projects - Workflows API - Deprecated
releases/:id/changes
in favor of Releases - Workflows API - Deprecated
change_templates/:id/changes
in favor of Workflow Templates - Workflows API
- Deprecated (all endpoints starting with)
- Fields:
- Problems API: deprecated
change
in favor ofworkflow
- Requests API: deprecated
change
in favor ofworkflow
- Request Templates API: deprecated
change_manager
in favor ofworkflow_manager
- Request Templates API: deprecated
change_template
in favor ofworkflow_template
- Tasks API: deprecated
change
in favor ofworkflow
- Task Templates API: deprecated
assign_to_change_manager
in favor ofassign_to_workflow_manager
- Task Templates API: deprecated
planned_effort_change_manager
in favor ofplanned_effort_workflow_manager
- Task Templates API: deprecated
copy_notes_to_change
in favor ofcopy_notes_to_workflow
- Workflows API: deprecated
change_type
in favor ofworkflow_type
- Workflow Templates API: deprecated
change_manager
in favor ofworkflow_manager
- Problems API: deprecated
- Filterable fields:
- Requests API: deprecated
change
in favor ofworkflow
- Request Templates API: deprecated
change_template
in favor ofworkflow_template
- Tasks API: deprecated
change
in favor ofworkflow
- Requests API: deprecated
- Predefined filters:
- Automation Rules API: deprecated
for_change_templates
in favor offor_workflow_templates
- Automation Rules API: deprecated
- Other:
- Audit Entries API: if one of the renamed attributes is modified, the
changes
field of the corresponding audit entry contains both the deprecated attribute and the renamed attribute - People - Permissions API: the field
roles
will return bothworkflow_manager
andchange_manager
for people with the “Workflow Manager” role. The rolechange_manager
is deprecated. - Problems API: the id of the status
change_pending
has been renamed toworkflow_pending
(see Status Workflow Pending) - Requests API: the id of the status
change_pending
has been renamed toworkflow_pending
(see Status Workflow Pending) - Request Templates API: the id of the status
change_pending
has been renamed toworkflow_pending
(see Status Workflow Pending) - Audit Entries API: the id of the status
change_pending
has been renamed toworkflow_pending
(see Status Workflow Pending)
- Audit Entries API: if one of the renamed attributes is modified, the
Bulk API
- Export API: deprecated the export types
changes
,change_templates
andchange_template_automation_rules
in favor ofworkflows
,workflow_templates
andworkflow_template_automation_rules
.- When a deprecated export type is used, the exported file name will refer to the deprecated type. The naming convention for export files is explained at the end of this section.
- Columns in export files and import files:
- Invoices: deprecated
Change
in favor ofWorkflow
- People Roles: deprecated
Change Manager
in favor ofWorkflow Manager
- Problems: deprecated
Change
in favor ofWorkflow
- Projects: deprecated
Change
in favor ofWorkflow
- Releases: deprecated
Change
in favor ofWorkflow
- Request Templates: deprecated
Change Template
in favor ofWorkflow Template
- Request Templates: deprecated
Change Manager
in favor ofWorkflow Manager
- Requests: deprecated
Change
in favor ofWorkflow
- Task Templates: deprecated
Copy notes to change
in favor ofCopy Notes to Workflow
- Task Templates: deprecated
Assign to Change Manager
in favor ofAssign to Workflow Manager
- Task Templates: deprecated
Planned Effort Change Manager
in favor ofPlanned Effort Workflow Manager
- Tasks: deprecated
Change
in favor ofWorkflow
- Time Entries: deprecated
Change
in favor ofWorkflow
- Timesheet Settings: deprecated
Default Effort Class for Change Tasks
in favor ofDefault Effort Class for Workflow Tasks
- Workflow Template Automation Rules: deprecated
Change Template
in favor ofWorkflow Template
- Workflow Templates: deprecated
Recurrence - Change Manager
in favor ofRecurrence - Workflow Manager
- Workflows: deprecated
Change Type
in favor ofWorkflow Type
- Invoices: deprecated
Events API
- Deprecated the parameter
change_id
in favor ofworkflow_id
.
Mail API
- Deprecated the parameter
change_id
in favor ofworkflow_id
.
Webhooks API
- Deprecated events
change.<action>
in favor ofworkflow.<action>
- When existing webhooks use one of the deprecated events, the
event
parameter of the webhook callback body contains the deprecated event name.
- When existing webhooks use one of the deprecated events, the
- The status
change_pending
in the webhook body attributepayload[status]
has been renamed toworkflow_pending
(see Status Workflow Pending)
Breaking changes
- Invoices API: the field
invoice_type
will now returnworkflow
instead ofchange
for invoices related to a workflow- The same is true for Audit Entries that are created when an invoice is related to a workflow
- NodeIDs are used mainly in the GraphQL API. A
nodeID
uniquely identifies an object across record types and across systems. Technically,nodeID
s in 4me are Base64 strings, encoding the combinationenvironment/record_type/ID
. Because thechange
related record types have been renamed, thenodeID
change accordingly. For example, if the nodeID of Change #123456 previously wasNG1lLmNvbS9DaGFuZ2UvMTIzNDU2
, it now becomesNG1lLmNvbS9Xb3JrZmxvdy8xMjM0NTY
. This affects the API responses of all APIs where nodeIDs are included in the response.- Referring to a Workflow or Workflow Template record using an old
nodeID
in an API request is still allowed. For example, when you use the old nodeIDNG1lLmNvbS9DaGFuZ2UvMTIzNDU2
in an API request, 4me will resolve this as a reference to Workflow #123456.
- Referring to a Workflow or Workflow Template record using an old
- UI Extension Javascript API: if you stick to the officially supported API for interacting with form fields, there are no breaking changes. However, if you used any other (unsupported) method to interact with form fields in UI Extensions which category is ‘Workflow Template’, these UI Extensions may no longer work.