Task Management module search workflows

This section describes the following prebuilt workflows contained in the Searches folder, which can help you manage tasks:

Get Relationship by Instance ID workflow

This workflow finds the relationship for a specified instance ID.

Get Relationship by Instance ID workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration

Valid value: BMC_AR_System, BMC_Remedyforce

Yes

instance id

Specifies the instance ID

Yes

Get Relationship by Instance ID workflow outputs

Output

Description

tasks

Contains an XML document that provides the data template for concept elements

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Get Relationships by Configuration Item Name workflow

This workflow finds the relationships for specified configuration items.

Get Relationships by Configuration Item Name workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BMC_AR_System, HP_ServiceCenter, BMC_Remedyforce

Yes

configuration item name

Specifies the configuration item name

Yes

Get Relationships by Configuration Item Name workflow outputs

Output

Description

tasks

Contains an XML document that provides the data template for concept elements

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Get Relationships by Task ID workflow

This workflow finds the relationships for a specified task ID.

Get Relationships by Task ID workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: BMC_AR_System, BMC_Remedyforce

Yes

task id

Specifies the unique task identifier

Yes

Get Relationships by Task ID workflow outputs

Output

Description

tasks

Contains an XML document that provides the data template for concept elements

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Get Relationships workflow

This workflow uses key/value pairs to find relationships.

Get Relationships workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: BMC_AR_System, BMC_Remedyforce

Yes

key 1

Specifies the name or the ID of the field against which you want to search

No

value 1

Specifies the value you are searching for in the key 1 field

No

key 2

Specifies a name or an ID of a field against which you want to search

No

value 2

Specifies the value you are searching for in the key 2 field

No

query

Specifies a query based upon the key/value pairs

No

Get Relationships workflow outputs

Output

Description

tasks

Contains an XML document that provides the data template for concept elements

success status

Indicates whether the workflow finished successfully Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Get Task by Task ID workflow

This workflow finds a task by a specified task ID.

Get Task by Task ID workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BMC_AR_System, HP_ServiceCenter, BMC_Remedyforce

Yes

task id

Specifies the unique task identifier

Yes

Get Task by Task ID workflow outputs

Output

Description

tasks

Contains an XML document that provides the data template for concept elements

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Get Tasks by Assigned Group workflow

This workflow finds tasks assigned to the specified group.

Get Tasks by Assigned Group workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BMC_AR_System, HP_ServiceCenter, BMC_Remedyforce

Yes

assigned group

Specifies the group assigned to the task

Yes

Get Tasks by Assigned Group workflow outputs

Output

Description

tasks

Contains an XML document that provides the data template for concept elements

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Get Tasks by Change ID workflow

This workflow finds tasks by using a specified change ID.

Get Tasks by Change ID workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BMC_AR_System, HP_ServiceCenter, BMC_Remedyforce

Yes

change id

Specifies a unique change record identifier

Yes

Get Tasks by Change ID workflow outputs

Output

Description

tasks

Contains an XML document that provides the data template for concept elements

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Get Tasks workflow

This workflow finds task records for a specified set of variables.

Get Tasks workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BMC_AR_System, HP_ServiceCenter, BMC_Remedyforce

Yes

key 1

Specifies the name or the ID of the field against which you want to search

No

value 1

Specifies the value that you are searching for in the key 1 field

No

key 2

Specifies a name or an ID of a field against which you want to search

No

value 2

Specifies the value that you are searching for in the key 2 field

No

query

Specifies a query based on the key/value pairs

No

Get Tasks workflow outputs

Output

Description

failed tasks

Provides descriptions of the failed tasks

success count

Provides a count of successful tasks

failure counter

Provides a count of failed tasks

tasks

Contains an XML document that provides the data template for concept elements

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Get WorkInfo by Task Instance ID workflow

This workflow finds work notes for a specified task instance ID.

Get WorkInfo by Task Instance ID workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BMC_AR_System, HP_ServiceCenter, BMC_Remedyforce

Yes

task instance id

Specifies the unique identifier of a task instance

Yes

Get WorkInfo by Task Instance ID workflow outputs

Output

Description

tasks

Contains an XML document that provides the data template for concept elements

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Get WorkInfo by WorkInfo Instance ID workflow

This workflow finds work notes (workinfo) by a specified note instance ID.

Get WorkInfo by WorkInfo Instance ID workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BMC_AR_System, HP_ServiceCenter, BMC_Remedyforce

Yes

workinfo instance id

Specifies the unique identifier of a workinfo instance

Yes

Get WorkInfo by WorkInfo Instance ID workflow outputs

Output

Description

tasks

Contains an XML document that provides the data template for concept elements

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Get WorkInfo workflow

This workflow finds tasks with specific text in their notes.

Get WorkInfo workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BMC_AR_System, HP_ServiceCenter, BMC_Remedyforce

Yes

key 1

Specifies the name or the ID of the field against which you want to search

No

value 1

Specifies the value that you are searching for in the key 1 field

No

key 2

Specifies a name or an ID of a field against which you want to search

No

value 2

Specifies the value that you are searching for in the key 2 field

No

query

Specifies query based upon the key/value pairs

No

Get WorkInfo workflow outputs

Output

Description

tasks

Contains an XML document that provides the data template for concept elements

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments