Download the Reporting SDK

Last updated: Nov 09, 2020 12:07

This section explains how to download the Reporting SDK client for your programming language and framework.

When the download is complete, your next step is to implement the reporting framework.

Click a section to view detailed steps.

Download Java (licensed under the Apache License, Version 2.0):
1. Go to the direct download page.
2. Click the latest version and download the reportium-java-<version>.jar file.
Add the file to your classpath.

Note: To determine the features of the SDK version, read the release notes.

Note: If you use Allure annotations, you need to download and set the latest Reportium-allure integration SDK instead of the latest Reportium SDK version and then add that file to your classpath.

Maven

Download Maven.
Create a Maven project in your IDE.
Update your pom.xml file.
Sample pom.xml file including reporting property and dependencies is available here.
1. Add the version number of the Reporting SDK that you downloaded (as described above) into the <properties> section as the <reportium-sdk.version> property.
2. Add the identification of the SDK repository, as defined below, into the <repositories> section.
3. Add the Reporting SDK dependency into the <dependencies> section.
  If you are using Allure annotations, add the dependency for the Allure-integration as well.

Use the following skeleton if your installation uses the latest Selenium version:

<properties>
		...
     <!-- Add the following line into the "properties" section and supply the correct version number -->
     <reportium-sdk.version>2.3.1</reportium-sdk.version>
		...
</properties>

<!-- Perfecto Repository -->
<repository>
    <id>perfectomobile</id>
    <name>Perfecto mobile</name>
    <url>https://repo1.perfectomobile.com/public/repositories/maven</url>
</repository>

<!-- Reporting SDK -->
<dependency>
    <groupId>com.perfecto.reporting-sdk</groupId>
    <artifactId>reportium-java</artifactId>
    <version>${reportium-sdk.version}</version>
</dependency>

<!-- Reporting SDK addition for Allure users -->
<dependency>
    <groupId>com.perfecto.reporting-sdk</groupId>
    <artifactId>reportium-allure-integration</artifactId>
    <version>${reportium-sdk.version}</version>
</dependency>

If your installation is using a previous Selenium version, use the following skeleton (that excludes the Selenium dependency of the Smart Reporting SDK).

<properties>
		...
     <!-- Add the following line into the "properties" section and supply the correct version number -->
     <reportium-sdk.version>2.3.1</reportium-sdk.version>
		...
</properties>

<!-- Perfecto Repository -->
<repository>
    <id>perfectomobile</id>
    <name>Perfecto mobile</name>
    <url>https://repo1.perfectomobile.com/public/repositories/maven</url>
</repository>

<!-- Reporting SDK -->
<dependency>
    <groupId>com.perfecto.reporting-sdk</groupId>
    <artifactId>reportium-java</artifactId>
    <version>${reportium-sdk.version}</version>
    <exclusion>
       <groupId>org.seleniumhq.selenium</groupId>
       <artifactId>selenium-api</artifactId>
    </exclusion>
</dependency>

<!-- Reporting SDK addition for Allure users -->
<dependency>
    <groupId>com.perfecto.reporting-sdk</groupId>
    <artifactId>reportium-allure-integration</artifactId>
    <version>${reportium-sdk.version}</version>
</dependency>

Ivy

Add Perfecto’s repository to your ivysettings.xml:

<ivysettings>
    <settings defaultResolver="perfecto"/>
    <property name="perfecto-public"
              value="https://repo1.perfectomobile.com/public/repositories/maven"/>
    <resolvers>
        <ibiblio name="perfecto" m2compatible="true" root="${perfecto-public}"/>
    </resolvers>
</ivysettings>

Add Perfecto jars to ivy.xml:

<!-- Reportium SDK -->
<dependency org="com.perfecto.reporting-sdk" name="reportium-java" rev="${reportium-sdk.version}"/>
<!-- Reportium SDK addition for Allure users -->
<dependency org="com.perfecto.reporting-sdk" name="reportium-allure-integration" rev="${reportium-sdk.version}"/>

Gradle

Update your build.gradle file with:

Perfecto’s SDK download repository URL
Define the SDK version in the reportium-sdk.version (supply the version number of the SDK that you have available).
Add the dependencies on creating the Reporting SDK jar.

// Perfecto's artifact repository
repositories {
    maven {
        url 'https://repo1.perfectomobile.com/public/repositories/maven'
    }
}

// definition of the Reporting-SDK version
def reportium-sdk.version = 2.3.1		// supply correct version number

dependencies {
   // Reportium SDK
    compile "com.perfecto.reporting-sdk:reportium-java:$reportium-sdk.version"
    // Reportium SDK addition for Allure users
    compile "com.perfecto.reporting-sdk:reportium-allure-integration:$reportium-sdk.version"
}

JavaScript

For NodeJS installation use:

npm install --save-dev perfecto-reporting

C#

Download the Reporting C# client, available as a NuGet package from here.

Run the following command in the Package Manager Console:

Install-Package Perfecto-Reporting

Ruby

For Gem installation use:

gem install perfecto-reporting

Python

For pip installation use:

pip install perfecto

Page tree

Download the Reporting SDK