Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Platform URL

https://[enterprise].cvtr.io/v2/forms

API Endpoints

Muge Budak Retrieves the collection of Active Forms:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/forms&enabled=true

Retrieving a Form:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/form/{id}

Replaces/Creates a Form:

Code Block
PUT/POST https://{enterprise}.cvtr.io/api/v4/forms

Creates a Form preview:

Code Block
POST https://{enterprise}.cvtr.io/api/v4/form-preview

Removes the campaign from the Form:

Code Block
POST https://{enterprise}.cvtr.io/api/v4/can-disassociate-form

Epic

Jira Legacy
serverSystem JIRA
serverId47839f05-61cf-355f-8da7-a069f30ee70e
keyGFR-50

Document status

Status
colourGreen
titleDRAFTREVIEWED

Document owner

Danny Hannah Adam Carter

Technical writers

Arunima Kurup Prasad

Related Content

Forms Add and Edit Form https://convertr.atlassian.net/wiki/spaces/PF/pages/edit-v2/3058434062

...

All active forms created on the platform are listed under the Active Forms tab in Global Forms page. The Active Forms listing page is as shown below.

...

The table shows:

  • ID: unique ID of the form. Users can search for forms using the ID.

  • Form: name of the form. Users can search for forms using the name.

  • Type: identifies if the form is a ‘Master’ form or ‘Translated’ form

  • Associated campaigns: provides a link to all campaigns using the form. Any changes made in a form will be reflected on all associated campaigns.

  • Actions column shows the various actions possible on forms.

  • Checkbox: A checkbox column is provided for selecting the forms that need to be archived.

  • The forms listing page provides options for ‘Edit’, ‘Preview’ and ‘Save as New’. These are detailed in the pagination option so users can select how many forms they want to view on a page.

Apart from these, the following options are also available on the Active Forms listing page:

  • ‘Add’ button to add new forms

  • ‘Add via CSV’ to add import forms via CSV file

  • ‘Archive’ button to archive forms

  • ‘Edit’ form

  • ‘Preview’ form

  • ‘Save As New’ form

These are described in the page: 'Add and Edit Form‘

...

, available in 'Related Content’ section.

...

Checkbox: A checkbox column is provided for selecting the forms that need to be archived.

Associated Campaigns

  • Clicking on the hyperlink opens the below modal showing all associated campaigns and option to associate new campaigns with the form.

...

Clicking on the ‘Advertiser Name’ hyperlink takes the user to the advertiser’s campaign listing page.

Once campaigns are added for association, clicking on ‘Save’ will associate the form with the selected campaigns. If the form has any translations, they will also be automatically associated with the campaign.

Removing Associations

A campaign association can be removed using the ‘Remove’ button if the form does not have any associations to:

...

Once the changes to form associations are made in the modal, the changes can be persisted by clicking on the Save button.

Archiving Forms

Forms can be archived by selecting the associated checkbox(es) and clicking on the ‘Archive’ button on the form Active Forms listing page. The ‘Archive’ button will be enabled only when at least 1 form is selected.

...

By clicking on ‘Yes’ in the ‘Archive Forms’ modal, the form will be archived and will move to the ‘Archived Forms’ tab.

Active Forms cannot be deleted, only archived forms can be deleted.

The forms listing page provides pagination option so users can select how many forms they want to view on a page.

\uD83D\uDDD2 Summary

Summarise the functionalities in a table

Functionality

User Story

1

Add form

Allows the user to add forms via the interface

2

Add via CSV

Allows the user to add forms via CSV file

3

Archive (see Related Content section - ‘Archived Forms > Listing’ for details)

Allows the user to archive multiple forms

4

Active forms listing

Lists all active forms, their type and associations

5

Associated campaigns

Allows user to view all campaign association, add and remove campaign associations

6

Edit Forms (see Related Content section - ‘Add and Edit Form’ for details)

Allows the user to edit forms

7

Preview (see Related Content section - ‘Add and Edit Form’ for details)

Allows the user to preview forms form fields page and thanks page

8

Save As New (see Related Content section - ‘Add and Edit Form’ for details)

Allows the user to save a form as new form

9

Table Filtering

Allows the user to filer the table values Form Id and Form Name

...