IC MicrosoftSharePointConnector en
IC MicrosoftSharePointConnector en
...
Microsoft SharePoint
Connector
Informatica Cloud Data Integration Microsoft SharePoint Connector
...
October 2022
© Copyright Informatica LLC 2017, 2022
This software and documentation are provided only under a separate license agreement containing restrictions on use and disclosure. No part of this document may be
reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica LLC.
U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial
computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such,
the use, duplication, disclosure, modification, and adaptation is subject to the restrictions and license terms set forth in the applicable Government contract, and, to the
extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License.
Informatica, the Informatica logo, Informatica Cloud, and PowerCenter are trademarks or registered trademarks of Informatica LLC in the United States and many
jurisdictions throughout the world. A current list of Informatica trademarks is available on the web at https://www.informatica.com/trademarks.html. Other company
and product names may be trade names or trademarks of their respective owners.
Portions of this software and/or documentation are subject to copyright held by third parties. Required third party notices are included with the product.
DISCLAIMER: Informatica LLC provides this documentation "as is" without warranty of any kind, either express or implied, including, but not limited to, the implied
warranties of noninfringement, merchantability, or use for a particular purpose. Informatica LLC does not warrant that this software or documentation is error free. The
information provided in this software or documentation may include technical inaccuracies or typographical errors. The information in this software and documentation
is subject to change at any time without notice.
NOTICES
This Informatica product (the "Software") includes certain drivers (the "DataDirect Drivers") from DataDirect Technologies, an operating company of Progress Software
Corporation ("DataDirect") which are subject to the following terms and conditions:
1. THE DATADIRECT DRIVERS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
2. IN NO EVENT WILL DATADIRECT OR ITS THIRD PARTY SUPPLIERS BE LIABLE TO THE END-USER CUSTOMER FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, CONSEQUENTIAL OR OTHER DAMAGES ARISING OUT OF THE USE OF THE ODBC DRIVERS, WHETHER OR NOT INFORMED OF THE POSSIBILITIES
OF DAMAGES IN ADVANCE. THESE LIMITATIONS APPLY TO ALL CAUSES OF ACTION, INCLUDING, WITHOUT LIMITATION, BREACH OF CONTRACT, BREACH
OF WARRANTY, NEGLIGENCE, STRICT LIABILITY, MISREPRESENTATION AND OTHER TORTS.
The information in this documentation is subject to change without notice. If you find any problems in this documentation, report them to us at
[email protected].
Informatica products are warranted according to the terms and conditions of the agreements under which they are provided. INFORMATICA PROVIDES THE
INFORMATION IN THIS DOCUMENT "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND ANY WARRANTY OR CONDITION OF NON-INFRINGEMENT.
Chapter 5: Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Troubleshooting Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Troubleshooting Synchronization Task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Increasing the Secure Agent Memory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Read Data with HTML Tags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Modifying Field Precision. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Table of Contents 3
Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
4 Table of Contents
Preface
Use Microsoft SharePoint Connector to learn how to read from or write to Microsoft SharePoint by using
Cloud Data Integration. Learn to create a connection, develop and run synchronization tasks, mappings, and
mapping tasks in Cloud Data Integration.
Informatica Resources
Informatica provides you with a range of product resources through the Informatica Network and other online
portals. Use the resources to get the most from your Informatica products and solutions and to learn from
other Informatica users and subject matter experts.
Informatica Documentation
Use the Informatica Documentation Portal to explore an extensive library of documentation for current and
recent product releases. To explore the Documentation Portal, visit https://docs.informatica.com.
If you have questions, comments, or ideas about the product documentation, contact the Informatica
Documentation team at [email protected].
https://network.informatica.com/community/informatica-network/products/cloud-integration
Developers can learn more and share tips at the Cloud Developer community:
https://network.informatica.com/community/informatica-network/products/cloud-integration/cloud-
developers
5
https://marketplace.informatica.com/
To search the Knowledge Base, visit https://search.informatica.com. If you have questions, comments, or
ideas about the Knowledge Base, contact the Informatica Knowledge Base team at
[email protected].
Subscribe to the Informatica Intelligent Cloud Services Trust Center to receive upgrade, maintenance, and
incident notifications. The Informatica Intelligent Cloud Services Status page displays the production status
of all the Informatica cloud products. All maintenance updates are posted to this page, and during an outage,
it will have the most current information. To ensure you are notified of updates and outages, you can
subscribe to receive updates for a single component or all Informatica Intelligent Cloud Services
components. Subscribing to all components is the best way to be certain you never miss an update.
For online support, click Submit Support Request in Informatica Intelligent Cloud Services. You can also use
Online Support to log a case. Online Support requires a login. You can request a login at
https://network.informatica.com/welcome.
The telephone numbers for Informatica Global Customer Support are available from the Informatica web site
at https://www.informatica.com/services-and-training/support-services/contact-us.html.
6 Preface
Chapter 1
Introduction to Microsoft
SharePoint Connector
This chapter includes the following topics:
Use Microsoft SharePoint Connector to read data from or write data to Microsoft SharePoint. You can use
Microsoft SharePoint objects as sources and targets in synchronization tasks, mappings, and mapping tasks.
You can switch mappings to advanced mode to include transformations and functions that enable advanced
functionality.
When you run a task or mapping, the Secure Agent uses the Microsoft SharePoint API to perform the
specified operation and reads data from or writes data to Microsoft SharePoint.
Microsoft SharePoint Connector supports only the default port. You cannot use any other port except the
default port.
7
Microsoft SharePoint Supported Objects and Task
Operations
The following table lists the Microsoft SharePoint objects and task operations that you can include in Data
Integration tasks:
Objects Read Write Query Insert Update Upsert Delete Data Preview Lookup
List Yes Yes Yes Yes Yes Yes Yes Yes Yes
To upsert data using a secondary key, you must map the source key field to the target secondary key field
that you intend to use. If you specify the Secondary Key for Upsert field in the advanced target property, you
must not map the target ID field in the Field Mapping.
To insert data using a secondary key, you must ensure that the secondary key field does not contain null
values.
You must specify the ID to delete data from the list object. You must specify the ID, name, and the path to
delete data from the document library object.
Note: You need to create custom objects using list or document libraries in Microsoft SharePoint application.
Use Microsoft SharePoint Connector to download attachments from the custom list object in Microsoft
SharePoint. The document library object supports attachments up to 10 MB.
When you download an attachment and if another file exists with the same name, the Secure Agent
overwrites the existing file in the target folder. Field Length for any object should not exceed 65 characters.
Microsoft SharePoint
Connections
This chapter includes the following topics:
Property Description
Runtime
Runtime environment that contains the Secure Agent used to access Microsoft SharePoint.
Environment
9
Property Description
SharePoint URL Enter the URI for the data source exposed via OData protocol layer. All requests are
extensions of this URI. For example, https://infasharepoint.abcd.com/ Site/
_vti_bin/Data.svc
UTC Offset Select the UTC time offset to be appended with datetime field. The default value is UTC.
When you use the $LastRuntime variable in a data filter, use the time zone to offset the
$LastRuntime variable.
Attachment File Path Optional. Specify the folder path where you want to download and attach the file to Microsoft
SharePoint.
Batch Size Defines the number of rows to be fetched from Microsoft SharePoint server.
Property Description
Display technical names instead of Displays technical names instead of business names.
labels
Display source fields in alphabetical Displays source fields in alphabetical order. By default, fields appear in the
order order returned by the source system.
11
Microsoft SharePoint Targets in Synchronization
Task
You can configure the Microsoft SharePoint target properties on the Target page of the Synchronization Task
wizard.
The following table describes the Microsoft SharePoint target properties:
Property Description
Display source fields in Displays target fields in alphabetical order. By default, fields appear in the order
alphabetical order returned by the target system.
The following table describes the Microsoft SharePoint advanced target properties:
Property Description
Secondary Key for Upsert Specify the name of the secondary key field.
You must enter the same name of the Secondary Key for Upsert field that you specified in
the Microsoft SharePoint application.
Success File Directory This attribute is not applicable for Microsoft SharePoint Connector.
Error File Directory This attribute is not applicable for Microsoft SharePoint Connector.
Data Filters
You can create simple data filters. You can also create a set of data filters for each object included in a
synchronization task.
ContentTypeID
Equals,NotEquals, Startswith Any String
Title
Note:
• You can create custom fields or columns in the Microsoft SharePoint application and assign it in a
synchronization task.
• In boolean data type, zero is considered as false. One and others values are considered as true.
• The above mentioned fields are the default filter fields or columns for Microsoft SharePoint list and
document libraries.
• You can use $LastRunTime and $LastRunDate variables in a data filter.
Note:
• You need to create a Microsoft SharePoint connection before you configure the synchronization task.
• You can upload attachments to the doc library only when you are using the Sharepoint 2013 version.
• When you upgrade from Sharepoint 2013 and run an existing mapping, you need to refresh the existing
mapping and the fields for the task to run successfully.
Field Description
Task Operation Select the task operation that you want to perform.
4. Click Next.
The Source tab appears.
5. Specify the source Connection and Source Object to be used for the task.
6. Click Next.
The Target tab appears.
7. Select the target Connection and Target Object required for the task.
8. Click Next.
The Data Filters tab appears.
9. Select the filter object, filter field, and filter operator to create a data filter on the Data Filters page.
10. Click Next.
The Field Mapping tab appears.
11. Click Automatch on the Field Mapping tab to map source fields to target fields accordingly.
When you insert data in the document library object, you must specify the Name, Body, BodyLength, and
ContentType fields.
• When you select Source connection as Salesforce or any database and Target connection as
Microsoft SharePoint, in the field mapping: Edit Body function and then add DEC_BASE64 expression
to map the body. You need to ensure that “BodyLength” is mapped.
• When you select Source connection as Microsoft SharePoint and Target connection as Salesforce or
any database, in the field mapping: Edit Body function and then add ENC_BASE64 expression to map
the body. You need to ensure that “BodyLength” is mapped.
• To add or edit expression in Field Mapping, click fx.
Note:
• If you exceed the maximum path length of 2048 characters for POST and GET requests in the Field
Mapping tab, the following error message appears:
Read operation failed
• You can upload attachments to the doc library only when you are using the Sharepoint 2013 and 2016
versions.
• When you upgrade from Sharepoint 2013 version and run an existing mapping, if the mapping fails
then refresh the mappings and run the mapping again.
12. Click Validate Mapping to validate the mapping.
13. Click Next.
The Schedule tab appears where you can schedule the task for each requirement and save.
14. Configure the advanced source properties on the Schedule tab.
Specify the name and description of the Microsoft SharePoint source. Configure the source properties for the
source object.
Property Description
Specify the name and description of the Microsoft SharePoint target. You can configure the target and
advanced properties for the target object.
16
The following table describes the Microsoft SharePoint target properties:
Property Description
The following table describes the Microsoft SharePoint advanced target properties:
Property Description
Secondary Key for Upsert Specify the name of the secondary key field.
You must enter the same name of the Secondary Key for Upsert field that you specified in
the Microsoft SharePoint application.
Success File Directory This attribute is not applicable for Microsoft SharePoint Connector.
Error File Directory This attribute is not applicable for Microsoft SharePoint Connector.
Troubleshooting
This chapter includes the following topics:
• Troubleshooting Overview, 18
• Troubleshooting Synchronization Task, 18
• Increasing the Secure Agent Memory, 19
• Read Data with HTML Tags, 20
• Modifying Field Precision, 21
Troubleshooting Overview
Use the following sections to troubleshoot errors in Microsoft SharePoint Connector.
The session log captures the log and exception details of a failed synchronization task. You require special
permission to run the application in debug mode.
If you exceed the maximum path length of 2048 characters for POST and GET requests in the field mapping,
the following error message appears:
Read operation failed
For more information about the maximum path length limitation for POST and GET requests, see
https://support.microsoft.com/en-us/help/208427/maximum-url-length-is-2-083-characters-in-internet-
explorer
18
Increasing the Secure Agent Memory
To increase performance and avoid runtime environment memory issues, perform the following steps:
Note: The minimum and maximum values for the Java heap size are given as an example. Specify the
size according to your requirements.
8. Restart the Secure Agent.
To set the value of the preserveSPHTMLcontent property, perform the following steps:
20 Chapter 5: Troubleshooting
7. Set the Value as true.
8. Click the add icon to add another custom configuration property.
9. Select the Service as Data Integration Server of the newly added custom configuration property.
10. Select the Type as Tomcat.
11. Add preserveSPHTMLcontent in the Name field.
12. Set the Value as true.
The following image shows the Custom Configuration Details section.
Note: It is suggested to modify connection parameters at one file location and then copy the modified file to
other location. The syntax for entering the columns or fields precision in the properties file is as follows:
<ObjectName.Column/Field Name=Column/Field Size >
For example, CTSList.SkillsetDescription=1024
22 Chapter 5: Troubleshooting
Chapter 6
Answer:
Microsoft SharePoint currently supports version 2010, 2013, 2016 and 2019.
What set up should be performed on Microsoft SharePoint to work with Data Integration and Secure Agent?
Answer:
Note: For relevant documentation for Microsoft Sharepoint 2013, see http://msdn.microsoft.com/en-
us/library/office/fp142380(v=office.15).aspx
• The Odata REST URL needs to be accessible from the machine where the Secure Agent is installed.
Answer:
• The connector uses HTTP based authentication from the connection screen by default.
• It supports Windows based authentication directly.
23
• You can start the service by using configured user account of Microsoft SharePoint Windows.
If the Microsoft SharePoint server is configured to use Windows authentication and User identity in
Active Directory Domain Services (AD DS), then you must start the Secure Agent with Windows/AD user
account. The same account which has relevant access to Microsoft SharePoint server.
Answer:
• The mapping fields are not listed as Microsoft SharePoint fields are dynamic and customizable.
• All fields such as standard or custom, exposed by the Microsoft SharePoint Odata REST URI are
supported for mapping.
D S
data filters 12
Data Integration community Secure Agent
URL 5 increasing memory 19
status
Informatica Intelligent Cloud Services 6
I Synchronization task
example 13
Informatica Global Customer Support system status 6
contact information 6
Informatica Intelligent Cloud Services
web site 5 T
troubleshooting
M overview 18
Synchronization task 18
maintenance outages 6 trust site
Microsoft SharePoint description 6
connection properties 9
supported objects and task operations 8
Microsoft SharePoint connections
overview 9
U
Microsoft SharePoint Connector upgrade notifications 6
overview 7
Microsoft SharePoint source
Synchronization task 11
Microsoft SharePoint sources
W
mapping 16 web site 5
27