Overview
Configuration is provided for establishing connections with Gravity Forms service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this guide, we will show you step-by-step how to create a connection to Gravity Form REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Gravity Forms configuration. Set Domain to desired domain in the server host parameter.
Step 3. Specify Username and Password parameters in the grid below.
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Gravity Forms instance.
In this guide, we will show how to read data from the Gravity Forms service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Gravity Forms connection from the combo. Select from available Gravity Forms resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select Gravity Forms resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Gravity Forms service.
In this guide, we will show how to write data to the Gravity Forms service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Gravity Forms connection from the combo. Also, select resource action and Gravity Forms resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Gravity Forms resource.
Configuration
Base URL address: https://[domain]/wp-json/gf/v2.
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Key: Required. Specify the key.
- Secret: Required. Specify the secret.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Basic {{=Base64.encode(connection.user.Key + ':' + connection.user.Secret)}}
Documentation: https://docs.gravityforms.com/rest-api-v2-authentication/#basic-authentication.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/forms.
The result is extracted from:{{=_.values(response)}}.
The result is paginated.Documentation: https://docs.gravityforms.com/rest-api-v2/#h-get-forms.
- [Read single] action
-
Endpoint URL address:
/forms/{{=GravityForms.UI.FormEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- form_id: Required. Specify form identifier.
Documentation: https://docs.gravityforms.com/rest-api-v2/#h-get-forms-form-id.
- [Create] action
-
Endpoint URL address:
/forms.Documentation: https://docs.gravityforms.com/rest-api-v2/#h-post-forms.
- [Update] action
-
Endpoint URL address:
/forms/{{=item.id}}.Documentation: https://docs.gravityforms.com/rest-api-v2/#h-put-forms-form-id.
- [Delete] action
-
Endpoint URL address:
/forms/{{=item.id}}.Documentation: https://docs.gravityforms.com/rest-api-v2/#h-delete-forms-form-id.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- entries
Data type: DT_I4
- description
Template: ShortText.
- labelPlacement
Template: ShortText.
- descriptionPlacement
Template: ShortText.
- button
Field components:
-
Uses template:
ShortText. - Contains the following components: type, text, imageUrl.
-
Uses template:
- fields
Field components:
- An array.
-
Uses template:
FieldT.
- version
Template: ShortText.
- useCurrentUserAsAuthor
Data type: DT_BOOL
- postContentTemplateEnabled
Data type: DT_BOOL
- postTitleTemplateEnabled
Data type: DT_BOOL
- postTitleTemplate
Template: ShortText.
- postContentTemplate
Template: ShortText.
- lastPageButton
Template: ShortText.
- pagination
Template: ShortText.
- firstPageCssClass
Template: ShortText.
- nextFieldId
Data type: DT_I4
- notifications
The gathered value is processed with
{{=_.values(value)}}expression. Field components:- An array.
- Contains the following components: id, to, toField, name, event, toType, subject, from, type, message.
- confirmations
The gathered value is processed with
{{=_.values(value)}}expression. Field components:- An array.
- Contains the following components: id, name, conditionalLogic, isDefault, type, message, url, pageId, disableAutoformat, queryString.
- is_active
Template: ShortText.
- date_created
Template: DateTime.
- is_trash
Template: ShortText.
- survey_stats
The value is gathered from
/forms/{{=item.id}}/resultsaddress. The gathered value is processed with{{=GravityForms.getSurveyData(response)}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: status, timestamp, data.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/forms/{{=GravityForms.UI.FormEditor.getValue(parameters)}}/entries.
The result is extracted from:{{=GravityForms.getFormEntriesData(resource.getFields(parameters), response.entries)}}.The action has the following user-defined parameters:
- form_id: Required. Specify form identifier.
Documentation: https://docs.gravityforms.com/rest-api-v2/#h-get-forms-form-id-entries.
- [Create] action
-
Endpoint URL address:
/forms/{{=GravityForms.UI.FormEditor.getValue(parameters)}}/submissions.The action has the following user-defined parameters:
- form_id: Required. Specify form identifier.
The following request parameters will be automatically processed:
-
application/json:
{{=GravityForms.getEntryPayload(resource.getFields(parameters), item, 'input_')}}
Documentation: https://docs.gravityforms.com/rest-api-v2/#h-post-forms-form-id-submissions.
- [Update] action
-
Endpoint URL address:
/entries/{{=item.id}}.The action has the following user-defined parameters:
- form_id: Required. Specify form identifier.
The following request parameters will be automatically processed:
-
application/json:
{{=_.extend( { form_id: GravityForms.UI.FormEditor.getValue(parameters) }, GravityForms.getEntryPayload(resource.getFields(parameters), item), )}}
Documentation: https://docs.gravityforms.com/rest-api-v2/#h-put-entries-entry-id.
- [Delete] action
-
Endpoint URL address:
/entries/{{=item.id}}.Documentation: https://docs.gravityforms.com/rest-api-v2/#h-delete-entries-entry-id.
- id
A key field. Data type: DT_I4
- form_id
Data type: DT_I4
- post_id
Data type: DT_I4
- date_created
Template: DateTime.
- date_updated
Template: DateTime.
- is_starred
Template: ShortText.
- is_read
Template: ShortText.
- ip
Template: ShortText.
- source_url
Template: ShortText.
- user_agent
Template: ShortText.
- currency
Template: ShortText.
- payment_status
Template: ShortText.
- payment_date
Template: Date.
- payment_amount
Data type: DT_R8
- payment_method
Template: ShortText.
- transaction_id
Data type: DT_I4
- is_fulfilled
Template: ShortText.
- created_by
Template: ShortText.
- transaction_type
Template: ShortText.
- status
Template: ShortText.
- helpscout_conversation_id
Data type: DT_BOOL
- [External]
-
The external fields URL address:
/forms/{{=GravityForms.UI.FormEditor.getValue(parameters)}}. The external fields list is extracted from:{{=GravityForms.getFormFields(response.fields)}}.
- [Read] action
-
The result is paginated.The action has the following user-defined parameters:
- include: Specify comma (,) separated list of records to include.
The following request parameters will be automatically processed:
-
paging[page_size]:
{{=parameters.batchSize}} -
paging[offset]:
{{=parameters.iterator}} -
include[]:
{{=parameters.get('include') && parameters.include.split(',')}} -
_includeUserParameters:
{{=parameters}}
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 4000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Numeric
Data type: DT_R8
- Integer
Data type: DT_I4
- MultiselectT
Template: LongText. A composite field. The gathered value is processed with
{{=value && value.join(',')}}expression.- FileT
Data type: DT_IMAGE The gathered value is processed with
{{=value && connection.execute({ url: value })}}expression.- ImageT
Data type: DT_IMAGE The gathered value is processed with
{{=value && connection.execute({ url: value.split('|')[0] })}}expression.- NameT
Field components:
-
Uses template:
ShortText. - Contains the following components: Prefix, First, Middle, Last, Suffix.
-
Uses template:
- AddressT
Field components:
-
Uses template:
ShortText. - Contains the following components: Street Address, Address Line 2, City, State / Province, ZIP / Postal Code, Country.
-
Uses template:
- ProductT
Field components:
-
Uses template:
ShortText. - Contains the following components: Name, Price, Quantity.
-
Uses template:
- ChoicesT
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: text, value, isSelected, price.
-
Uses template:
- FieldT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, type, isRequired, size, errorMessage, label, inputs, formId, inputType, displayOnly, nameFormat, labelPlacement, descriptionPlacement, subLabelPlacement, placeholder, multipleFiles, maxFiles, calculationFormula, calculationRounding, enableCalculation, disableQuantity, displayAllCategories, inputMask, inputMaskValue, allowsPrepopulate, useRichTextEditor, defaultValue, description, choices, conditionalLogic, visibility, productComponent, Components, layoutGroupId, inputMaskIsCustom, checkboxLabel, adminLabel, maxLength, cssClass, inputName, noDuplicates, enableAutocomplete, autocompleteAttribute, pageNumber.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.