Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation for ATS 1.7.0 release #2

Merged
merged 30 commits into from
Sep 30, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
01fb54d
updated support for mendix and chrome
Sep 30, 2016
b7c8747
Merge branch 'development' of https://github.com/MansystemsDE/docs in…
Sep 30, 2016
8a90041
updated support for mendix and browsers
Sep 30, 2016
4f5baa8
Added new dashboard into Introduction [WIP]
kesslera Sep 30, 2016
e6613f0
fixed table layout
Sep 30, 2016
a19d4bf
added missing info about 6.9.0 testing
Sep 30, 2016
708eb37
Completed dashboard documentation
kesslera Sep 30, 2016
13b18f0
Updated Navigation section
kesslera Sep 30, 2016
a749039
Revert "Updated Navigation section"
kesslera Sep 30, 2016
f37538a
Updated Navigation Image
kesslera Sep 30, 2016
07a982d
Added Documentation for Test Case documentation export
kesslera Sep 30, 2016
47aa942
Updated administration documentation
kesslera Sep 30, 2016
3f1b898
testcommit
kesslera Sep 30, 2016
ff2ca92
deleted images
kesslera Sep 30, 2016
a6aafd9
Added images with lowercase extension
kesslera Sep 30, 2016
277ef4a
Revert "testcommit"
kesslera Sep 30, 2016
7dc2618
Cross-site link test
kesslera Sep 30, 2016
5b62d4c
Removed {% markdown%} and {% endmarkdown %}
kesslera Sep 30, 2016
a86f9a6
Fixed navigation links
kesslera Sep 30, 2016
886a154
Fix #2 for navigation
kesslera Sep 30, 2016
38651f1
Changed navigation documentation from list to table
kesslera Sep 30, 2016
d22d615
Update Administration.md
Sep 30, 2016
a28958d
Update Configuration.md
Sep 30, 2016
a1cd124
Update Custom+Actions.md
Sep 30, 2016
12e6501
Update General.md
Sep 30, 2016
35d7525
Update Introduction.md
Sep 30, 2016
de14591
Update Introduction.md
Sep 30, 2016
360d64b
Update Projects.md
Sep 30, 2016
d512a21
Proofread
Sep 30, 2016
848a0a0
Proofread
Sep 30, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 38 additions & 31 deletions ATS/Administration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "Administration"
---
As an administrator in the ATS you have access to additional functionality:

As an administrator in the ATS, you have access to additional functionality:

* Manage Projects system wide
* Create new user/administrator accounts
Expand All @@ -12,68 +13,74 @@ As an administrator in the ATS you have access to additional functionality:

When you log in as an administrator the _Projects_ page is shown:

![Projects page when logged in as administrator](attachments/20644068/21168199.png)
![Projects page when logged in as administrator](attachments/Administration/startpage.png)

On this page you can see all the projects that exist on this ATS instance. Here you can create new _Projects_ and _Action Libraries_. Also as an admin user you have the rights to delete projects and libraries from the system. When creating a new library you can choose to _Include by default in new projects_ , so this library is included by default in any project that is created on the system. For more information on project/library creation see the ReferenceGuide_Projects page of the reference guide.

<div class="alert alert-info">{% markdown %}
<div class="alert alert-info">

When creating a new library on the _Projects_ page, the created library is empty at first and you can import action libraries into it or include available libraries.

{% endmarkdown %}</div>

## Create Accounts

On the _Accounts_ page you can create new users and administrators for the system. Administrators only have access to the administration part of ATS. They can see test cases and test results, but they can't create new test cases or run them.
</div>

![Accounts page](attachments/20644068/21168200.png)
### Create or Edit a Project/Action Library

When editing accounts you can set accounts to inactive or block them, which will both deactivate the account.
If you create a new Project/Action Library or you want to edit an existing one, the following page will open:

![Create new administrator dialog](attachments/20644068/21168201.png)
![New/Edit Project or Action Library](attachments/Administration/newEditProject.png)

It doesn't matter if you create an administrator or a normal user the options for both are the same:
You can edit the name, the Mendix Project ID and the Mendix API key. Furthermore you can add users to the project by selecting the appropriate user roles.

**Full Name**
You can also add existing Action Libraries.

The full name of the user
## Add Selenium Configurations

**User Name**
As an admin user you can configure Selenium hubs as you normally would. For more information, see [SeleniumHub](Configuration.md#configure-test-applications-).

The name the user logs in with
![Selenium Overview](attachments/Administration/selenium.png)

**Email**
Additionally, as an administrator, you can assign a Selenium hub to a specific project, or you can make the hub available for all projects on the ATS instance. You can do this by creating a new Selenium hub or editing an existing one.

Email adress of the user
![Edit Selenium hub dialog as admin](attachments/20644068/21168202.png)

**Active**
## Add Applications

Set the account to active/inactive
As an admin user, you can add and configure applications to test.

**Time Zone**
![Add Test Applications](attachments/Administration/applications.png)

Set the timezone the user works in
For more information, see [Configure Test Applications](Configuration.md#Applications).

**Password**
## Create Accounts

The initial password of the user
On the _Accounts_ page you can create new users and administrators for the system. Administrators only have access to the administration part of ATS. They can see test cases and test results, but they can't create new test cases or run them.

The initial password of the user should be changed by the user when logging in.
![Accounts page](attachments/Administration/accounts.png)

## Configure Selenium Hubs
When editing accounts you can set accounts to inactive or block them, which will both deactivate the account.

As an admin user you can configure Selenium hubs as you normally would, see ref-SeleniumHub for more information.
![Create new account dialog](attachments/Administration/newUser.png)

Additionally as an administrator you can assign a Selenium hub to a specific project or make the hub available for all projects on the ATS instance. You can do this by creating a new or editing an existing Selenium hub.
It doesn't matter if you create an administrator or a normal user, as the options described below are the same for both:

![Edit Selenium hub dialog as admin](attachments/20644068/21168202.png)
Field | Description
--- | ---
Full Name | The full name of the user.
Name | The name the user logs in with.
Email | The e-mail address of the user.
Blocked | Mark the account as unblocked/blocked.
Active | Set the account to active/inactive.
Time Zone | Set the timezone the user works in.
Tester | Adds the tester user role.
Tenant Administrator | Adds the tenant administrator role.
Password | The initial password of the user (which should be changed by the user when logging in).

## Recorder Config

Admin users have access to the _Recorder Config_ page where recorder setting can be changed.

<div class="alert alert-info">{% markdown %}
<div class="alert alert-info">

Recorder settings should not be changed under normal circumstances

{% endmarkdown %}</div>
</div>
78 changes: 27 additions & 51 deletions ATS/Configuration.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,52 @@
---
title: "Configuration"
---
<div class="alert alert-info">{% markdown %}
<div class="alert alert-info">

Only a user with the _Project Administrator_ role in the current project can access the configuration page.
Only a user with the Project Administrator role in the current project can access the configuration page.

{% endmarkdown %}</div>
</div>

On the configuration page under the _Project_ tab you can see the current project settings. You can change the settings and add users or libraries to your project by clicking the _Edit Project Settings_ button.
On the configuration page under the **Project** tab you can see the current project settings. You can change the settings and add users or libraries to your project by clicking the **Edit Project Settings** button.

![Configuration Page Project Tab](attachments/20644064/21168209.png)

## Configure Selenium hubs
## Configure the Selenium Hubs

Under the _Selenium_ tab you can see a list of Selenium hubs that are configured for this project. Project users can run tests on the listed hubs.
On the **Selenium** tab, you can see a list of the Selenium hubs that are configured for this project. Project users can run tests on the listed hubs:

![Configuration Selenium Tab](attachments/20644064/21168210.png)
![Configuration Selenium Tab ](attachments/20644064/21168210.png)

To add a new Selenium hub click the _New_ button in the top bar.
To add a new Selenium hub, click the **New** in the top bar:

![Edit Selenium hub dialog](attachments/20644064/21168211.png)

In the Selenium hub dialog you can set the following parameters:
In the **Selenium hub** dialog box, you can set the following parameters:

Name
Field | Description
--- | ---
Name | The name of the Selenium hub.
URL | The URL of the Selenium server.
Parallel Sessions | The number of tests that can run in parallel on the Selenium hub.
Proxy URL | The URL of an optional proxy server. Normally there should be no need to use a proxy server
Custom Capabilities | Set the Selenium DesiredCapabilities (for more information, see the Selenium documentation).

Name of the Selenium hub
## Configure Test Applications <a name="Applications"></a>

**URL**

URL of the Selenium server

**Parallel Sessions**

Number of tests that can run in parallel on the Selenium hub

**Proxy URL**

URL of an optional proxy server. Normally there should be no need to use a proxy server

**Custom Capabilities**

Set Selenium DesiredCapabilities, see Selenium documentation for mor info

## Configure Test Applications

Under the _Applications_ tab you see a list of test applications that are configured for the current project.
On the **Applications** tab, you can see a list of test applications that are configured for the current project:

![Configuration Applications tab](attachments/20644064/21168212.png)

You can edit, create and delete applications by pressing the buttons in the top bar.
You can edit, create, and delete applications by pressing the buttons in the top bar:

![New Application Dialog](attachments/20644064/21168213.png)

When creating a new Application you can set the following parameters:

**Name**

The name of the Application

**URL**

URL under which the Mendix application to test is running

**Details**

You can put a description of the application here

**Mendix Version**

Mendix Version of the Application.

**Use Proxy**
When creating a new application, you can set the following parameters:

Check if a proxy should be used. Should be off in most cases
Field | Description
--- | ---
Name | The name of the application.
URL | The URL under which the Mendix application to test is running.
Details | The description of the application.
Mendix Version | The Mendix version of the application.
Use Proxy | Check if a proxy should be used (should be off in most cases).
98 changes: 35 additions & 63 deletions ATS/Custom+Actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,112 +2,84 @@
title: "Custom Actions"
category: "Test Development"
---
Based on the existing actions, you can build up your own actions (custom action). Also if you are fluent in JavaScript, you can add a whole variety of functionalities by using the generic “Execute JavaScript” action.

To create a custom action you have to first select the test steps you need to achieve your desired action in your test case:
Based on the existing actions, you can build up your own actions (custom actions). Also, if you are fluent in JavaScript, you can add a whole variety of functionalities by using the generic “Execute JavaScript” action.

To create a custom action, first select the test steps you need to achieve the desired action in your test case:

![Select multiple Test Steps in a Test Case](attachments/20644057/21168181.png)

Then extract the actions into one test step which contains your selected actions using the _Extract Action_ button.
Then extract the actions into one test step that contains your selected actions using the **Extract Action** button:

![Extract action dialog](attachments/20644057/21168182.png)

Here you can give your new custom action a _Name_ and a _Description_. Click the _Close_ button to finish. You can now add your action to any test case like you would with any other action.
On this dialog box, you can give your new custom action a **Name** and a **Description**. Click **Close** to finish. You can now add your action to any test case, like you would with any other action.

### **Changing Custom Actions**
### Changing Custom Actions

When selecting a custom action you can click on the _Open_ button under the _Test Step Settings_ to go inside the custom action.
When selecting a custom action, click **Open** under **Test Step Settings** to go inside the custom action:

![Open custom action under test step settings](attachments/20644057/21168183.png)

While inside your custom action, you can change the action just like you would in a test case. Additionally, you can set input and a output parameters for your action under the settings tab.
While inside your custom action, you can change the action just like you would in a test case. Additionally, you can set input and output parameters for your action under the settings tab.

### Setting Input Parameters

![Costum action settings screen](attachments/20644057/21168184.png)

By clicking _New_ under _Input Parameters_ you open the _Edit Input Parameter_ dialog where you set the properties of your new input parameter
By clicking **New** under **Input Parameters**, you open the **Edit Input Parameter** dialog box, where you set the properties of your new input parameter:

![Edit input parameter dialog](attachments/20644057/21168185.png)

When adding a new input parameter you have the following options:

**Name**

Sets the name of the input parameter

**Description**

Give a description of your input parameter

**Datatype**

Sets the datatype of the parameter

**Required/Optional**

Set if parameter is required or can be left open

**Show as Password**

Set if the parameter is readable in cleartext or hidden
When adding a new input parameter, you have the following options:

**Type**
Field | Description
--- | ---
Name | Sets the name of the input parameter.
Description | The description of your input parameter.
Datatype | The datatype of the parameter.
Required/Optional | Sets if the parameter is required or can be left open.
Show as Password | Sets if the parameter is readable in cleartext or hidden.
Type | Sets if the parameter is used as an input for a Selenium or internal function (should normally be **Default**).

Set if parameter is used as an input for a selenium or internal function, should normally be **Default**
### Enumerations

### **Enumerations**
When creating a new input parameter, you can choose the datatype enumeration. An enumeration is a predefined list of values. When using an enumeration, as an input parameter you can choose which value of the enumeration to use.

When creating a new input parameter you can choose the datatype enumeration. An enumeration is a predefined list of values. When using an enumeration as an input parameter you can choose which value of the enumeration to use.

To create a new enumeration choose enumeration as datatype when creating a new input parameter and click the new button:
To create a new enumeration, choose **Enumeration** as the **Datatype** when creating a new input parameter and click **New**:

![Create new enumeration](attachments/20644057/21168186.png)

On the _Edit Enumeration_ dialog you can add new _Enumeration Entries_ to your enumeration.
On the **Edit Enumeration** dialog box, you can add new **Enumeration Entries** to your enumeration.

Enumeration entries have two attributes:

**Caption**

The name of the entry that is shown when selecting an entry

**Value**

The actual value of the entry that is used in the test execution
* **Caption** – the name of the entry that is shown when selecting an entry
* **Value** – the actual value of the entry that is used in the test execution

![Edit enumeration dialog](attachments/20644057/21168187.png)

### Setting an Output Parameter

Setting an output parameter works similar to setting an input parameter, the difference is that you can only have one output parameter per action. To set an output parameter click the _Set_ button under _Output Parameter_
Setting an output parameter, works in a similar way to setting an input parameter. The difference is that you can only have one output parameter per action. To set an output parameter, click **Set** under **Output Parameter**.

![Set output parameter](attachments/20644057/21168188.png)

For an output parameter you can set:

**Name**

Set the name of the output parameter

**Description**

Set the description of the output parameter

**Datatype**

Set the datatype of the output parameter

**Required/Optional**
For an output parameter you can set the following:

Set if parameter is required to be set
Field | Description
--- | ---
Name | The name of the output parameter.
Description | The description of the output parameter.
Datatype | The datatype of the output parameter.
Required/Optional | Sets if the parameter is required to be set.

After an output parameter has been set, this parameter needs to be returned manually by using the _Set Return Value_ action.

<div class="alert alert-info">{% markdown %}
<div class="alert alert-info">

To return a value from an action you need use the _Set Return Value in a test step._
To return a value from an action, you need use the **Set Return Value in a test step**.

{% endmarkdown %}</div>
</div>

![Set return Value action to return output parameter](attachments/20644057/21168189.png)
4 changes: 2 additions & 2 deletions ATS/Data+Driven+Tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ Shows parameters that require a different data type than the datatype of the fie

For each error the test step and parameter are listed so they can be easily identified.

<div class="alert alert-info">{% markdown %}
<div class="alert alert-info">

If you change the selected data set the system will remember your set parameters and will match them again if you select a data set containing the same field names.

{% endmarkdown %}</div>
</div>

When you have selected a master data set you can use the the contained field as input values for your test steps.

Expand Down
Loading