Open topic with navigation

CapWiz Integration

The netFORUM integration with Capwiz, a product of CQ Roll Call, is a two-way integration that involves sending netFORUM customer data into Capwiz and importing activity records back into netFORUM from Capwiz.

This integration does not include importing legislator information into netFORUM.

This integration is designed to work with the January 2008 version of Capwiz Web Services API. If Capitol Advantage should change its API resulting in the integration to fail the client will be responsible to pay for Abila to make the necessary modifications to make the integration be functional.

Before Your CapWiz Integration

This section describes the setup that needs to be done before the implementation can be done.

1. Unique email addresses in netFORUM.This integration requires the customers' email address be used as a unique login identifier on the Capwiz site. This means that when customers identify themselves on the CapwizXC site, they will enter an email address along with personal information. Email address will be used to match against customers exported from netFORUM into Capwiz. In , each email address has to be unique and not shared among customers.If this integration is implemented, will customize to enforce this rule programmatically, or clients can enforce this rule via SOP's and by running reports/queries to identify if there are duplicate email addresses.

2. CapwizXC site needs to be setup. Client must have a contract with Capitol Advantage and a CapwizXC site must be setup. Please visit http://www.capitoladvantage.com for detailed information about CapwizXC product. Client is responsible to set up the CapWiz site with Capitol Advantage.
3. CapwizXC API fee paid by client to Capitol Advantage. This integration requires consuming the CapwizXC API. Client needs to obtain license to use Capwiz API before this can be implemented.
4. CapwizXC integration fee paid by client to Abila.
5. An SFTP software must be installed on the computer that will be used for uploading the files to CapWiz. One such software is WinSCP that can be downloaded from http://winscp.net/eng/index.php. This software is free, and it supports both Windows graphic interface and command line options. Abila will set this up for the client provided has administrator privileges.
6. WinSCP.exe must be run to connect to CapWiz using the credentials provided by Capwiz, and the session should be saved. The saved session will be used to automatically upload files. Abila will set this up for the client provided has administrator privileges.
7. Client must build a one time export of the client's customer records to be imported into Capwiz's system to start the integration. The export file must contain the 'customer record number' (cst_recno) to send into Capwiz.
8. Schedule a nightly SQL job to export customer data for the ones that are newly added or newly updated since the last export to Capwiz. This will keep the basic contact information for customers to be synchronized in both the systems. This is done through a SQL job through scheduling with SQL Server.
9. Client must set up Advocacy Issues in netFORUM and Action IDs in Capwiz.

Capwiz Integration

Capwiz has been integrated to work with the netFORUM implied interest functionality.

FTP netFORUM Data to Capwiz

Complete the following steps to setup the Capwiz integration:

1. If needed, run the Sample Capwiz Query.To run the Sample Capwiz Query, complete the following steps:

   1. Launch the CRM module by expanding the Module Menu and clicking the CRM link.
   2. Mouse over the Individuals tab and click the Query Individual link located on the Individuals fly-out menu.
   3. Expand the Load an Existing Query drop-down menu and select the Sample Capwiz Query option.
   4. Click the Run Query button.
   5. After the query completes running, export the query as a CSV file.
2. Modify the exported file in the following ways:
   • Move the Primary Key field to the last column in the file.
   • Rename all of the fields to match the CapWiz field names in the following order:
     • FIRST
     • LAST
     • EMAIL
     • ADDRESS
     • CITY
     • STATE
     • BZIP
     • EXTERNAL ID
3. Save the modified file as a Tab Delimited .txt file type, using Save As command.
4. FTP the tab delimited file to CapWiz.

Set Up Issues and Alerts in CapWiz

After FTP'ing the tab-delimited file into Capwiz, you must set up the issues and alerts in Capwiz. You can refer to Capwiz Online Help for information on the steps to complete this process in CapWiz.

As you set up your issues and alerts in Capwiz, you will get an Alert ID code that you will plug into your advocacy issues in netFORUM.

Setting the Capwiz Alert ID on a netFORUM Advocacy Issue

After your issues and alerts are created in Capwiz, you must include your Capwiz account information and Alert ID on your Advocacy Issue profile.

To set the Capwiz information on an Advocacy Issue, complete the following steps:

1. Go to the Advocacy Issue Profile page.
2. Expand the capwiz account drop-down menu and select the Capwiz account you will be using for this advocacy issue. It is possible for organizations to have multiple CapWiz accounts.

3. Enter the Alert ID you obtained in Capwiz into the external alert id field.

4. Click the Save button.

The Advocacy Issue has now been tied to the Issue/Alert you set up in Capwiz earlier.

The significance of this is that netFORUM runs a nightly process where it pulls data from CapWiz surrounding all of the issues/alerts tied to Advocacy Issues. This data is returned as an action record for each individual who participated. These actions will also trigger an implied interest to be set for their profile based on this issue. In addition, this data is also used to help calculate an individuals A Score.

Set Up Your Capwiz Account Information

The capwiz account drop-down menu on the Advocacy Issue Profile is populated by entering your Capwiz account information in netFORUM.

To enter Capwiz account information, complete the following steps:

1. Click the Customer Setup link located on the CRM Overview page.

2. Click the More tab to view the entire list of child forms available to you.

3. Click the System Options tab to view the System Option and related child forms.

4. Click the Add icon located on the crm capwiz details child form.The Add - Capwiz Task form appears.
5. Enter your Capwiz account ID in the client id field.
6. Enter your Capwiz login ID in the username field.
7. Enter your Capwiz password in the password field.
8. Click the Save button.

Running the Capwiz Task from the Task Dashboard

The Capwiz task contacts Capwiz and import all activities taken in Capwiz and creates implicit interest codes based on the advocacy issue that's related to the alert code.

To run the Capwiz task from the Task Dashboard, complete the following steps:

1. Expand the Module Menu.
2. Click the Admin link to launch the Admin module.
3. Click the Task Scheduler tab located in the top navigation bar.

   The Task Dashboard appears.

4. Click the Capwiz Task link located on the Task Dashboard.

   The Add - Capwiz Task form appears.

5. Enter the scheduling information for the task.

   You may set this task up to run one time, or expand the recurrence drop-down menu and select the frequency with which you would like it to occur. When you select a value from the recurrence drop-down menu, additional fields will become available that will allow you to exactly specify how often you would like this task to occur. These fields vary by the value selected in the recurrence drop-down menu.

6. Click the Save button.

Client Tasks

Below are a list of items the client is responsible before integrating with Capwiz.

• Client should have valid user license for Abila.
• Client should have purchased proper license from Capwiz.
• Client needs to be familiar with Capwiz operations.

Abila Tasks

As clients are directed to the client's Capwiz site to perform advocacy actions, the users will be required to enter personal information before a message can be sent. The key piece of information that the user has to enter is the constituent's email address. Based on the email address entered, the Capwiz system will create an activity record regarding the message that was sent. This activity will be linked to a netFORUM customer by matching the email address entered with the email address imported from netFORUM.

In addition, Abila will build a nightly pull to pull action records from the client's Capwiz site and populate the netFORUM table so the client's staff can view the actions that a customer sends via the Capwiz system. There is no user interaction with the pull of these records; it is all done behind the scenes.

The action records will be pulled from CapwizXC and inserted into a baseline netFORUM table with a communication type of "CapWizXC". These records will be displayed on the communications child form of the correspondence tab in the Individual's profile. This value of "CapWizXC" will be hard-coded and can not be changed as part of the standard offering.

Assumptions and Limitations

Below are a list of assumptions and limitations regarding the Capwiz integration:

• Capwiz API does not return the content of the email sent from netFORUM customers to their representatives. As a result of this, netFORUM users will not be able to know what the customers wrote to their representatives. However, the users will know what the customers wrote about as the subject field is returned by the Capwiz API.
• The cost for this integration covers an initial set up with up to 150,000 customer records. The client will be responsible to pay additional fees based on the number of records above this limit.
• This integration is designed to work with the January 2008 version of Capwiz Web Services API. If Capitol Advantage should change its API resulting in the integration to fail the client will be responsible to pay for Abila to make the necessary modifications to make the integration be functional.

Note: netFORUM integration with Capwiz does not include importing legislator data into netFORUM.