Overview
A configuration is provided for establishing connections with the SuiteCRM 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 task, we will show you step-by-step how to create a connection to SuiteCRM 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 SuiteCRM. Set [Host] to the desired site in the Server host parameter.
Step 3. If the Authentication is Grant Password, provide the credentials for client_id-client_secret-username-password ** in the grid below. If Authentication is Client Credential, provide the credentials for **client_id-client_secret in the grid below.
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your SuiteCRM instance.
In this guide, we will show how to read data from the SuiteCRM 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 SuiteCRM connection from the combo. Select from available SuiteCRM 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 SuiteCRM 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 SuiteCRM service.
In this guide, we will show how to write data to the SuiteCRM 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 SuiteCRM connection from the combo. Also, select resource action and SuiteCRM 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 SuiteCRM resource.
Configuration
Base URL address: http://[host]/Api/V8.
- Client Credential
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- client_id: Required. Specify client ID.
- client_secret: Required. Specify secret.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://docs.suitecrm.com/developer/api/developer-setup-guide/json-api/#_generate_private_and_public_key_for_oauth2.
- Password
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- client_id: Required. Specify client ID.
- client_secret: Required. Specify client secret.
- username: Required. Specify username.
- password: Required. Specify password.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://docs.suitecrm.com/developer/api/developer-setup-guide/json-api/#_generate_private_and_public_key_for_oauth2.
- [Read] action
-
Endpoint URL address:
/module/{{=resource.external.label}}.
The result is extracted from:{{=_.map(response.data, function(item) { return _.extend(item, item.attributes); })}}.The following request parameters will be automatically processed:
-
fields[{{=resource.external.label}}]:
{{=parameters.fields.join()}}
Documentation: https://docs.suitecrm.com/developer/api/developer-setup-guide/json-api/#_get_collection_of_modules.
-
fields[{{=resource.external.label}}]:
- [Read Single] action
-
Endpoint URL address:
/module/{{=resource.external.label}}/{{=parameters.id}}.
The result is extracted from:{{=[_.extend(response.data, response.data.attributes)]}}.The action has the following user-defined parameters:
- id: Required. Specify the module id.
The following request parameters will be automatically processed:
-
page[size]:
{{=undefined}} -
page[number]:
{{=undefined}} -
fields[{{=resource.external.label}}]:
{{=parameters.fields.join()}}
Documentation: https://docs.suitecrm.com/developer/api/developer-setup-guide/json-api/#_get_a_module_by_id.
- [Create] action
-
Endpoint URL address:
/module.The following request parameters will be automatically processed:
-
application/vnd.api+json:
{{={ data: { type: resource.external.label, attributes: item } } }}
Documentation: https://docs.suitecrm.com/developer/api/developer-setup-guide/json-api/#_create_a_module_record.
-
application/vnd.api+json:
- [Update] action
-
Endpoint URL address:
/module.The following request parameters will be automatically processed:
-
application/vnd.api+json:
{{={ data: { type: resource.external.label, id: item.id, attributes: item } } }}
Documentation: https://docs.suitecrm.com/developer/api/developer-setup-guide/json-api/#_update_a_module_record.
-
application/vnd.api+json:
- [Delete] action
-
Endpoint URL address:
/module/{{=resource.external.label}}/{{=item.id}}.Documentation: https://docs.suitecrm.com/developer/api/developer-setup-guide/json-api/#_delete_a_module_record.
- [External]
-
The external fields URL address:
/meta/fields/{{=resource.external.label}}. The external fields list is extracted from:{{=_.map(response.data.attributes, function(v, k) { return _.extend({ name: k }, v); })}}.- {{=external.name}}
Data type: {{=SuiteCRM.getDataType(external.type)}} ( length {{=parseInt(external.len) || 255}} )
- [Read] action
-
Endpoint URL address:
/module/{{=resource.external.label}}/{{=parameters.id}}/relationships/{{=parameters.related_module}}.
The result is extracted from:{{=_.map(response.data, function(item) { return _.extend(item, item.attributes); })}}.The action has the following user-defined parameters:
- id: Required. Specify the module id.
- related_module: Required. Specify the related module name.
Documentation: https://docs.suitecrm.com/developer/api/developer-setup-guide/json-api/#_generate_private_and_public_key_for_oauth2.
- [Create] action
-
Endpoint URL address:
/module/{{=resource.external.label}}/{{=item.id}}/relationships.The following request parameters will be automatically processed:
-
application/json:
{{= { data: { type: item.related_module, id: item.related_id } } }}
Documentation: https://docs.suitecrm.com/developer/api/developer-setup-guide/json-api/#_create_relationship.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/module/{{=resource.external.label}}/{{=item.id}}/relationships/{{=item.related_module}}/{{=item.related_id}}.Documentation: https://docs.suitecrm.com/developer/api/developer-setup-guide/json-api/#_delete_relationship.
- id
A key field. Template: ShortText.
- related_module
A key field. Template: ShortText.
- related_id
A key field. Template: ShortText.
- [External]
-
The external fields list is extracted from:
{{=function() { var result = []; if (parameters.get('related_module')) { var response = connection.execute({ url: '/module/' + resource.external.label + '/' + parameters.id + '/relationships/' + parameters.related_module, parameters: { 'page[size]': 5 } }); result = _.map(_.keys(response.data[0].attributes), function(v) { return { name: v, length: 255 }; }) } return result; }()}}.- {{=external.name}}
Data type: DT_WSTR ( length {{=external.length}} )
The external resource list URL address: /meta/modules.
The external resource list is extracted from: {{=_.values(response.data.attributes)}}.
Based on resource template Base.
The external resource list URL address: /meta/modules.
The external resource list is extracted from: {{=_.values(response.data.attributes)}}.
Based on resource template Base.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
Accept:
application/vnd.api+json -
page[size]:
{{=parameters.batchSize}} -
page[number]:
{{=parameters.iterator}} -
_includeUserParameters:
{{=parameters}}
-
Accept:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
Accept:
application/vnd.api+json -
_includeUserParameters:
{{=parameters}}
-
Accept:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
Accept:
application/vnd.api+json -
_includeUserParameters:
{{=parameters}}
-
Accept:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
What's New
- New: Introduced connection.
Related documentation
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.