Integration with Tricentis Tosca

1 Overview
2 Release Notes
3 Requirements
4 Installation
5 TDO Module for Items
- 5.1 Description of the TDO Item Expert Module attributes
- 5.2 Operations for Items
  - 5.2.1 Create an Item
  - 5.2.2 Updates an Item
  - 5.2.3 Find Items
  - 5.2.4 Lock an Item
  - 5.2.5 Unlock Item
  - 5.2.6 Delete Item
6 TDO Module for Environments
- 6.1 Description of the TDO Environment Expert Module attributes
- 6.2 Operations for Environments
  - 6.2.1 Create Environmenet
  - 6.2.2 Update Environment
  - 6.2.3 Delete Environment
7 TDO Module for Types
- 7.1 Description of the TDO Type Expert Module attributes
- 7.2 Operations for Types
  - 7.2.1 Create Type
  - 7.2.2 Update Type
  - 7.2.3 Delete Type

Overview

Specific TBox Modules for TDO are available to allow interaction from within a Tosca Test Case to the Test Data Orchestrator

Release Notes

Requirements

Tricentis Tosca Commander 14.2 and above

Installation

Please order the TDO Addon DLL (Infometis.TestDataOrchestrator.dll) form our Service Desk, we require the Tosca Version you are using. The Tosca Subset can be downloaded here:

Copy the Infometis.TestDataOrchestrator.dll into the TBOX_HOME Folder, which is usually: C:\Program Files (x86)\TRICENTIS\Tosca Testsuite\TBox\

Import the Subset into your Tosca workspace.

TDO Module for Items

This module allows the following operations for TDO Items:

CreateItem, UpdateItem, Find, LockItem, UnlockItem, DeleteItem

Description of the TDO Item Expert Module attributes

Attribute name	Description	Details

Attribute name	Description	Details
Configuration → JiraBaseURL	The BaseUrl of the Jira-Server
Configuration → JiraProjectKey	The Key of the Jira project
Configuration → Username	Jira Username
Configuration → Password	Jira Password
Item Key	Internal Key of an item
Task	Defines what operation the teststep should perform for an Item	CreateItem, UpdateItem, Find, LockItem, UnlockItem, DeleteItem
Environment	Environment in which the Item Task is performed
Type	Type in which the Item Task is performend
Data structure → attributes	Expandable list of attributes. Used for Find and UpdateItem Task.
Result Buffers → attributes	Expandable list of attributes, used for Find Task. The attribute name represents the name of the buffer which should be filled with the found item value. the attribute value represents the TDO attribute name from which to get the value for the buffer.

Operations for Items

Create an Item

The following Teststepvalues need to be filled. The teststep will create a buffer called TDO_ITEM_KEY. This contains the internal key for further use in UpdateItem or DeleteItem teststeps

Attribute name	Input Value	Example

Attribute name	Input Value	Example
Configuration → JiraBaseURL	The BaseUrl of the Jira-Server	https://yourcompany.atlassian.net
Configuration → JiraProjectKey	The Key of the Jira project	ABC
Configuration → Username	Jira Username	user1
Configuration → Password	Jira Password	yourpassword
Item Key	N/A
Task	CreateItem	CreateItem
Environment	Environment in which the Item Task is performed	UAT
Type	Type in which the Item Task is performend	BusinessPartner
Data structure → attributes	for each attribute: attribute name = TDO Type attribute attribute value = value of the Item attribute	Date = {DATE} Key= {RND[5]} Type = legal State = New
Result Buffers → attributes	N/A

Updates an Item

Updates an item identified by the internal Item Key, which is automatically set into the buffer TDO_ITEM_KEY when creating or finding an item. The following Teststepvalues need to be filled:

Attribute name	Input Value	Example

Attribute name	Input Value	Example
Configuration → JiraBaseURL	The BaseUrl of the Jira-Server	https://yourcompany.atlassian.net
Configuration → JiraProjectKey	The Key of the Jira project	ABC
Configuration → Username	Jira Username	user1
Configuration → Password	Jira Password	yourpassword
Item Key	The internal key of the item you would like to update. This value was automatically put into the buffer TDO_ITEM_KEY when using the TDO CreateItem or FindItem task	{B[TDO_ITEM_KEY]}
Task	UpdateItem	UpdateItem
Environment	Environment in which the Item Task is performed	UAT
Type	Type in which the Item Task is performend	BusinessPartner
Data structure → attributes	for each attribute you would like to update create an entry: attribute name = TDO Type attribute attribute value = value of the Item attribute	Name =Key Value = 1234
Result Buffers → attributes	N/A

Find Items

Attribute name	Input Value	Example

Attribute name	Input Value	Example
Configuration → JiraBaseURL	The BaseUrl of the Jira-Server	https://yourcompany.atlassian.net
Configuration → JiraProjectKey	The Key of the Jira project	ABC
Configuration → Username	Jira Username	user1
Configuration → Password	Jira Password	yourpassword
Item Key	N/A
Task	FindItem	FindItem
Environment	Environment in which the Item Task is performed	UAT
Type	Type in which the Item Task is performend	BusinessPartner
Data structure → attributes	for each attribute: attribute name = TDO Type attribute you would like to search in attribute value = value of the Item attribute you would like to search for	attribute name = Type attribute value = legal (see screenshot below)
Result Buffers → attributes	the attribute name needs to be set to the name of the buffer the attribute value needs to be set to the name of the TDO value you would like	Name = TDO_Test Value = Key (see screenshot below)

Lock an Item

Attribute name	Input Value	Example

Attribute name	Input Value	Example
Configuration → JiraBaseURL	The BaseUrl of the Jira-Server	https://yourcompany.atlassian.net
Configuration → JiraProjectKey	The Key of the Jira project	ABC
Configuration → Username	Jira Username	user1
Configuration → Password	Jira Password	yourpassword
Item Key	item key of the item you would like to lock	{B[TDO_ITEM_KEY]}
Task	LockItem	LockItem
Environment	Environment in which the Item Task is performed	UAT
Type	Type in which the Item Task is performend	BusinessPartner
Data structure → attributes	N/A
Result Buffers → attributes	N/A

Unlock Item

Attribute name	Input Value	Example

Attribute name	Input Value	Example
Configuration → JiraBaseURL	The BaseUrl of the Jira-Server	https://yourcompany.atlassian.net
Configuration → JiraProjectKey	The Key of the Jira project	ABC
Configuration → Username	Jira Username	user1
Configuration → Password	Jira Password	yourpassword
Item Key	item key of the item you would like to unlock	{B[TDO_ITEM_KEY]}
Task	LockItem	UnlockItem
Environment	Environment in which the Item Task is performed	UAT
Type	Type in which the Item Task is performend	BusinessPartner
Data structure → attributes	N/A
Result Buffers → attributes	N/A

Delete Item

Attribute name	Input Value	Example

Attribute name	Input Value	Example
Configuration → JiraBaseURL	The BaseUrl of the Jira-Server	https://yourcompany.atlassian.net
Configuration → JiraProjectKey	The Key of the Jira project	ABC
Configuration → Username	Jira Username	user1
Configuration → Password	Jira Password	yourpassword
Item Key	item key of the item you would like to delete	{B[TDO_ITEM_KEY]}
Task	DeleteItem	DeleteItem
Environment	Environment in which the Item Task is performed	UAT
Type	Type in which the Item Task is performend	BusinessPartner
Data structure → attributes	N/A
Result Buffers → attributes	N/A

TDO Module for Environments

This module allows the following operations for TDO Environments:

Create, Update, Delete

Description of the TDO Environment Expert Module attributes

Attribute name	Description	Example

Attribute name	Description	Example
Configuration → JiraBaseURL	The BaseUrl of the Jira-Server	https://yourcompany.atlassian.net
Configuration → JiraProjectKey	The Key of the Jira project	ABC
Configuration → Username	Jira Username	user1
Configuration → Password	Jira Password	yourpassword
Task	Defines what operation the teststep should perform for an environment	Create, Update, Delete
Environment	Name of the Environment to be created	UAT
Environment Update	Upddated Name of the Environment
Description	Description of the Environment

Operations for Environments

Create Environmenet

Creates a new Environment. You can define the name and the description.

Attribute name	Description	Example

Attribute name	Description	Example
Configuration → JiraBaseURL	The BaseUrl of the Jira-Server	https://yourcompany.atlassian.net
Configuration → JiraProjectKey	The Key of the Jira project	ABC
Configuration → Username	Jira Username	user1
Configuration → Password	Jira Password	yourpassword
Task	Create	Create
Environment	Environment in which the Item Task is performed	APIEnvironment
Environment Update	N/A
Description	Description of the environment	Text about the environment

Update Environment

Updates the name and description of an environment

Attribute name	Description	Example

Attribute name	Description	Example
Configuration → JiraBaseURL	The BaseUrl of the Jira-Server	https://yourcompany.atlassian.net
Configuration → JiraProjectKey	The Key of the Jira project	ABC
Configuration → Username	Jira Username	user1
Configuration → Password	Jira Password	yourpassword
Task	Update	Update
Environment	Environment in which the Item Task is performed	APIEnvironment
Environment Update	New name of the environment	API
Description	Description of the environment	Updated text about the environment

Delete Environment

Deletes an environment. Exact name of the environment to be deleted has to be given, it is case sensitive.

Attribute name	Description	Example

Attribute name	Description	Example
Configuration → JiraBaseURL	The BaseUrl of the Jira-Server	https://yourcompany.atlassian.net
Configuration → JiraProjectKey	The Key of the Jira project	ABC
Configuration → Username	Jira Username	user1
Configuration → Password	Jira Password	yourpassword
Task	Delete	Delete
Environment	Environment in which the Item Task is performed	API
Environment Update	N/A
Description	N/A

TDO Module for Types

This module allows the following operations for TDO Types:

Create, Update, Delete

Description of the TDO Type Expert Module attributes

Attribute name	Description	Details

Attribute name	Description	Details
Configuration → JiraBaseURL	The BaseUrl of the Jira-Server
Configuration → JiraProjectKey	The Key of the Jira project
Configuration → Username	Jira Username
Configuration → Password	Jira Password
Task	Defines what operation the teststep should perform for an environment	Create, Update, Delete
Type	Name of the Environment to be created
Type Update	Updated Name of the Type. Needed when you update the name of the Type
Attributes	List of attributes of the Type.

Operations for Types

Create Type

Creates a new Type. Name and the attributes of the Type have to be defined. Be sure to include alle attributes at the beginning. Modification after creation will come in a future version.

Attribute name	Description	Example

Attribute name	Description	Example
Configuration → JiraBaseURL	The BaseUrl of the Jira-Server	https://yourcompany.atlassian.net
Configuration → JiraProjectKey	The Key of the Jira project	ABC
Configuration → Username	Jira Username	user1
Configuration → Password	Jira Password	yourpassword
Task	Create	Create
Type	Name of the Type to be created	BusinessPartner
Type Update	N/A
Attributes	list of attributes to be created under thie type.	Name = Key Name = Name Name= Status Name = Date

Example of creating a Type “BusinessPartner” with Key, Name Status and Date as attributes:

Update Type

Update a Type name. Attributes cannot be modified

Attribute name	Description	Example

Attribute name	Description	Example
Configuration → JiraBaseURL	The BaseUrl of the Jira-Server	https://yourcompany.atlassian.net
Configuration → JiraProjectKey	The Key of the Jira project	ABC
Configuration → Username	Jira Username	user1
Configuration → Password	Jira Password	yourpassword
Task	Update	Create
Type	Name of the Type to be created	TestType
Type Update	Updated Name of the Type	NewTestTypename
Attributes	N/A

Example of renaming the Type from “TestType” to “NewTestTypename”:

Delete Type

Delete a Type identified by its name

Attribute name	Description	Details

Attribute name	Description	Details
Configuration → JiraBaseURL	The BaseUrl of the Jira-Server	https://yourcompany.atlassian.net
Configuration → JiraProjectKey	The Key of the Jira project	ABC
Configuration → Username	Jira Username	user1
Configuration → Password	Jira Password	yourpassword
Task	Delete	Delete
Type	Name of the Type to be deleted	Person
Type Update	N/A
Description	N/A

Example of deleting a Type witht the Name “Person”