Requirements for integrating webforms with SharePoint

This template is for gathering requirements to integrate your webforms with Microsoft List in your agency's SharePoint instance. Business Analysts or Delivery Managers should fill out this template and attach it to the relevant feature request.

Fill in this template for every webform

Each webform integration needs a separate feature request. For instance, if you have three webforms to integrate, you must complete this template for each one. Some information in this template can be reused and should be marked as such.

---

General information

1. Agency Name: <Your agency's name>
   • Contact Person: <Full name of the primary contact>
   • Contact Email: <Email address of primary contact>
2. Project Name/ID: SharePoint Integration Project
   • Brief Project Description: <Brief description on what kind of data your customer will submit to your agency’s sharepoint>

SharePoint site information

• Sandbox:
  • Site URL: https://xyzcorp.sharepoint.com/sites/integration
  • List Name
• Production: 
  • Site URL: https://production.sharepoint.com/sites/integration
  • List name

Webform details

1. Webform Location: https://nsw.gov.au/webform
2. Webform Approval:
   • Confirm if the PIA for the webform is approved: Yes/No. If yes, add the Jira link/ID for the PIA approval.
   • If the PIA is not approved, fill in the Privacy Enquiries form selecting Privacy Impact Assessment (PIA) as the enquiry type.

Webform to SharePoint List mapping

Provide the mappings between webform and SharePoint List as shown here.

Web form field name	Webform key	Webform type	Required	List field name	Key	Type
Serial Number	serial	integer	yes	Serial Number	serial_number	Number
Submission ID	sid	integer	yes	Submission ID	submission_id	Number
Completed	completed	timestamp	yes	Date/Time completed	date_time_completed	Date/Time
Remote IP address	remote_addr	string	yes	Remote IP address	remote_ip_address	Text(255)
<Field 1>	field_1	Text	yes	Field one	field_one	Text(255)
<Field n>	field_n	Text	no	Field Two	field_two	Text(255)

* Highlighted fields are required for security and auditing purposes.

 

Access and permissions

1. Client Credentials: Client ID and secret to connect with Salesforce instance
   1.  
      1. Non Prod:
      2. Prod:
2. Authentication Method: OAuth 2.0 (Client Credentials Flow)

Testing and validation

Postman script: Share the Postman script used to verify the credentials and successful data submission to the Salesforce instance.

---

Additional information

1. Documentation: SharePoint API Documentation
2. Support: If your agency needs technical support in setting up Microsoft API for your SharePoint, send an email to our Platform team.
3. Coming soon: Documentation on creating client for connecting with SharePoint list.

Need any more help?

If you have any questions, or require assistance with anything mentioned in this article, submit a request via the webform.