Configure Solution Documentation synchronization

You carry out the initial configuration of Tricentis Tosca when you run the Tosca SAP Solution Manager Wizard.

This chapter describes the steps you perform in Tricentis Tosca to configure Solution Documentation synchronization. You perform these steps after you have successfully completed all configuration steps in the Tosca SAP Solution Manager Wizard. Configuration of these settings is optional.

Refer to the following chapters for instructions on how to:

Define connection properties in Tricentis Tosca.
Edit Tricentis Tosca options and settings.
Configure the synchronization in the configuration file.

Define connection properties in Tricentis Tosca

You need to prepare your workspace before you synchronize objects with SAP Solution Manager. To do so, ensure that the following requirements are met:

Then follow the steps below:

Right-click either the project root element or a ComponentFolder and select Prepare for Integration from the context menu.

Prepare for Integration

In the subsequent dialog, select SAP Solution Manager as external system from the drop-down list.
In the subsequent dialogs, define the following connection properties:

Property	Description	Example
Server	IP of the SAP server.	10.100.8.110
InstanceNumber	ID of the SAP instance.	00
Client	Client in the SAP system.	001
SystemID	Three-digit name that identifies the SAP system.	S01
User	Name of the user who logs in to the system.	admin
Password	Password of the user who logs in to the system.	PWD
ApiEntryPoint	URL for the entry point into the SAP system. APIEntryPoint connects to a default Client. A system can have multiple Clients assigned to it. In rare cases, this situation can cause synchronization issues. For information on how to change a default Client for troubleshooting purposes, refer to the Tricentis Knowledge Base.	https://my.external.network/sap/opu/odata/sap/ProcessManagement
Branch	Name of the Solution Documentation branch.	Development
Solution	Name of the Solution. Use it to distinguish between branches with the same name, but coming from different Solutions.	Test Solution

Edit connection properties

After you have defined connection properties in Tricentis Tosca, you can edit them in the Properties pane of the project root element or ComponentFolder. To do so, follow the steps below:

Check out the objects.
Click on the project root element or ComponentFolder.
Click on the arrow icon on the right side of your window to expand the Properties pane.
Edit the values of connection properties in the Value field.

Connection property Branch set to Maintenance

Edit Tricentis Tosca options and settings

In Tosca Commander, you can access the Options dialog via the menu Project->Options. If you have installed the SAP Solution Manager AddIn, you can configure the following settings in the SAPSolutionManagerAddIn section:

Option	Description	Example
LogfilePath	Path to the log files. These log files are required for troubleshooting.	C:\Temp
LogLevel	Specifies how much information in terms of priority is written to the log file (10=highest level, 3=lowest level).	3
SAPHost	IP address or server name of the SAP Solution Manager system.	10.100.8.110
Client	SAP client where the SAP Solution Manager is running.	001
SAPSystemNumber	System number from the properties of the SAP Logon entry.	00
SAPUsername	User name of the SAP user.	SAPuser
SAPLanguage	Language settings for the internal log-on. Possible values: E for English, D for German.	E
ExecutionListTimeStamp Format	Date format for ExecutionLists that are automatically created.	yyyyMMdd_HHmmss

You can configure the following option in the RemoteControl section:

Option	Description
SilentMode	Enable this setting to suppress pop-up windows during execution without user interaction. The Tosca Executor and Execution Complete windows are also suppressed. Default value: False.

Option

Description

SilentMode

Enable this setting to suppress pop-up windows during execution without user interaction. The Tosca Executor and Execution Complete windows are also suppressed.

Default value: False.

Options dialog

Configure the synchronization (optional settings)

You can create a configuration file in Tosca Commander to specify custom parameters that are applied during the synchronization between Tricentis Tosca and SAP Solution Manager.

To do so, follow the steps below:

Create the configuration file.
Modify the embedded configuration file to specify how you want the synchronization to behave:
- Specify the master system for Requirements synchronization.
- Specify the direction of the Requirements synchronization.
- Synchronize custom Tricentis Tosca attributes, which may help to accelerate test plan creation.
- Specify default property types, which are displayed after the synchronization.
- Specify the time-out.
- Ignore the certificate error (advanced setting).

Create the configuration file

To create the configuration file, right-click the project root element in Tosca Commander and select the option Set synchronization configuration from the context menu.

Set synchronization configuration in the context menu

The file IntegrationSynchronizationConfiguration.xml appears in the Attachments section of the project root element. This is the file you have to modify to configure the synchronization.

IntegrationSynchronizationConfiguration.xml file in Tosca Commander

The configuration file contains the following default values:

<MasterSystemForRequirements>External</MasterSystemForRequirements>
<!-- Possible values [External | Internal]-->
<RequirementsSynchronizationDirections>BothDirections</RequirementsSynchronizationDirections>
<!-- Possible values [NoSynchronization | ImportToTosca | ExportFromTosca | BothDirections]-->

Specify the master system for Requirements synchronization

You can set either Tricentis Tosca or SAP Solution Manager as a master system, i.e. the system from which the Requirements are synchronized to the other system. The default option is External, which means that the Requirements from SAP Solution Manager are synchronized to Tricentis Tosca.

Set this parameter to Internal if you want to change the Requirements in Tricentis Tosca and then synchronize them with SAP Solution Manager.

Specify the direction of Requirements synchronization

The default value for the direction of Requirements synchronization is BothDirections, which means that the Requirements are synchronized from both Tricentis Tosca and from SAP Solution Manager. If you want to change the direction, you can choose from the following options:

NoSynchronisation: synchronization is not performed
ImportToTosca: synchronization is performed to Tricentis Tosca
ExportFromTosca: synchronization is performed from Tricentis Tosca

For example, if you want to delete or rename a Requirement in Tricentis Tosca, use the value ExportFromTosca or BothDirection and set Internal as the MasterSystemForRequirements. After synchronization, the Requirement is deleted or renamed in SAP Solution Manager.

Synchronize custom attributes

In addition to Tricentis Tosca attributes and properties, which are synchronized by default, you can specify additional attributes and properties of objects in the IntegrationSynchronizationConfiguration.xml file. For this purpose, you have to specify how each property is marked in Tricentis Tosca and in external systems. You can specify additional attributes for each object type.

To accelerate test plan creation, you can synchronize the following custom Tricentis Tosca attributes in SAP Solution Manager:

Damage Class
Frequency Class
Risk Weight
Required Test Cases

To synchronize custom attributes, follow the steps below:

Create the custom attributes you want to synchronize in SAP Solution Manager.
Define the attributes in the IntegrationSynchronizationConfiguration.xml file.

Tricentis Tosca synchronizes the attributes from SAP Solution Manager.

In the example below, you have specified that the Tricentis Tosca Requirement property FrequencyClass must be synchronized with the SAP Solution Manager field FREQUENCY.

<?xml version="1.0! encoding="ISO-10646-UCS-2" standalone="yes"?>
<IntegrationSynchronizationConfiguration>
[...]
  <CustomProperties>
    <entry artifactType="Requirement" externalLabel="FREQUENCY" toscaLabel="FrequencyClass" propertyType="String"/> 
  </CustomProperties>
[...]
</IntegrationSynchronizationConfiguration>

Specify default property types

In the IntegrationSynchronizationConfiguration.xml file you can specify the property types that are displayed after the synchronization. If you don't specify them, the following default property types are displayed:

E2EROOT
FOLDER
PROC
REF_PROCSTEP
ROOT
SCN

Default property types

In the example below, you have specified two property types FOLDER and ROOT . These property types are displayed after the synchronization.

<IntegrationSynchronizationConfiguration>
	<SolManAllowedTypes>
		<Type>FOLDER</Type>
		<Type>ROOT</Type>
		</SolManAllowedTypes>
</IntegrationSynchronizationConfiguration>

Specify the time-out

In the IntegrationSynchronizationConfiguration.xml file, the default time-out is set to 1200 seconds. This is how long Tricentis Tosca waits for SAP to prepare the branch information to be synchronized.

To change the time-out, edit the default value 1200 in the following line of code in the IntegrationSynchronizationConfiguration.xml file:

Ignore the certificate error (advanced setting)

On the SAP server side, a security certificate error can occur. In this case, the synchronization stops. You can add a setting that tells Tricentis Tosca to ignore the certificate error. This is an advanced setting and you should use it when you are sure that this error can be ignored.

To ignore the certificate error and continue the synchronization, add the following line of code at the end of the IntegrationSynchronizationConfiguration.xml file: