Form Integration
- Christopher Rushing (Unlicensed)
Contents
Overview
The IT Audit Machine is designed to create forms that can be easily integrated into an organization's existing website. Through the use of the multiple embedded code options, administrators can link or deploy an ITAM form within an existing website utilizing a familiar coding method.
Integration Options
[Back To Top]
ITAM comes with multiple options to integrate your forms and/or your data depending on the nature of the integration your organization desires. If you are looking to work with one of the 3rd party providers that have already provided an integration with ITAM, that option is available. If you are looking to have data from your ITAM Forms sent to your website via an API or other Webhook, that option can be configured on your form. Finally, if you want to link to or embed an ITAM form in your existing website, there is a way to do that as well.
Existing Platform Integrations
[Back To Top]
Several 3rd party providers have created integrations for the IT Audit Machine forms. These integrations are specific to each platform and new integrations are added periodically.
To see what integration options are available for a form, use the Integration icon on a form.
Clicking on the Integration icon on a form will bring you to the Integration Settings page which displays the available integrations. Clicking on an available integration will display the fields which are required by the provider for integration with their environment. Each provider has their own requirements for integrating with their system.
To find out more about existing platform integrations please contact the ITAM Service Desk.
Webhook integrations
[Back To Top]
If your website has the ability to receive custom data via an API or other methodology, ITAM can send information either via the Notification interface or the Logic interface. See Form Notifications and Form Logic pages for more information.
Embedding Forms and Fields
[Back To Top]
If your organization desires to integrate an ITAM form directly into your website, you can do so using the Embed options, either at the form level or the field level. The form and field embedding options work in similar ways except the former embeds the whole form whereas the latter embeds a single field.
Embedding a Form
The form embed options are found by editing the form and selecting the Form Properties from the Toolbox on the right.
Clicking the show more options link will expand the Toolbox to display additional form options. At the bottom of the options, the Form Embed Options will be available.
Embedding a Field
[Back To Top]
Embedding a field is similar to embedding a Form except it is available from the Field Options tab of the Toolbox. Selecting a field in the form or adding a new field will enable the Field Options. On the field types where it is available, at the bottom of the options, the Field Embed Options will be displayed.
Configuring the Embed Options
[Back To Top]
Whether you intend to embed a form or a field the options are the same. Between the User Types and Code Types, there are six ways to configure your embedded code.
Choosing a User Type
The user type controls the type of user who can interact with the embedded code. There are two options available.
User Types
The type of user selected controls how the form will be used and to whom it will be available. Select Admin if you intend to provide an embedded form with which Administrative Users can interact. Choose Portal if you are embedding a form with which your clients will interact.
Choosing a Code Type
[Back To Top]
Whether you are embedding a form or a field, there are three embedding code type options available. The code type to select will depend on several factors including the web architecture of the existing target site and the familiarity of the website administrator/designer with available code types.
To view and select a Code Type click the dropdown field located at the right side of the Form Code screen. Note that it may be necessary to use the scroll bars to adjust the display of the code window. After selecting the desired Code Type, copy and paste the generated code in the display window into the existing target website as appropriate.
Code Type Options
The following examples are representations of the code generated for integrating an ITAM form into an existing website. They are meant for example purposes only. Each form will generate its own embed code.
Using The Iframe Code
[Back To Top]
The Iframe Code option is intended to allow an organization to embed a form directly into their website using an iframe. The code generated will insert the form into your existing web page seamlessly, suppressing the form background, border, and logo header to avoid conflicting with your website design. It may be necessary to manually adjust the height of the iframe to ensure that the Submit button of the form is displayed properly.
Sample Code:
<iframe onload="javascript:parent.scrollTo(0,0);" height="1139" allowTransparency="true" frameborder="0" scrolling="no" style="width:100%;border:none" src="https://auditmachine.com/auditprotocol/embed.php?id=62826" title="Data Risk Calculator - Sample 0%-100%"><a href="https://auditmachine.com/auditprotocol/view.php?id=62826" title="Data Risk Calculator - Sample 0%-100%">Data Risk Calculator - Sample 0%-100%</a></iframe>
Using a Simple Link
[Back To Top]
If an organization cannot or does not wish to embed an iframe, it is almost always possible to embed a link. The Simple Link option creates a link that will, in most cases, redirect the current page to the Form. In some cases, depending on the configuration of the organization's website the Simple Link may work like the Popup Link.
It can also be used to share your form with others through email.
Sample Code:
<a href="https://demonstration.auditmachine.com/portal/view.php?id=293876" title="Continuous Monitoring Activities and Deliverables Index">Continuous Monitoring Activities and Deliverables Index</a>
Using a Popup Link
[Back To Top]
If an organization cannot or does not wish to embed an iframe, it is almost always possible to embed a link. The Popup Link option creates a link that will open a new browser window/tab to the Form.
Sample Code:
<a href="https://demonstration.auditmachine.com/portal/view.php?id=293876" onclick="window.open(this.href, null, 'height=750, width=800, toolbar=0, location=0, status=0, scrollbars=1, resizable=1'); return false;">Continuous Monitoring Activities and Deliverables Index</a>
Integrating an ITAM form with another website is a complex task requiring a certain level of technical acumen to achieve success. The options provided by ITAM are there to simplify the process, but technical knowledge of the remote site is a necessity for success.
Next we will explore the simple yet powerful concept of automapping, what it does and how to harness its power in your forms.
[Previous Topic → Form Logic] Navigation [Next Topic → Automapping]