Create a data group in the " Connector for SharePoint Server/Online "

SharePoint Lists and SharePoint Document Libraries

Data groups in the Connector for SharePoint Server/Online differ depending on whether they reference a SharePoint list or a SharePoint document library. For SharePoint lists, you only need to add a data field of type FILE if you manage file attachments in the SharePoint list.

For SharePoint document libraries, you must always add a data field of type FILE.

Background: In SharePoint lists, the individual data records—or list items—are the primary objects. In SharePoint document libraries, files are the primary objects.

Requirements

To create a data group in Connector for SharePoint Server/Online, you should have the following information from SharePoint:

  • Technical field names and data types of the fields in SharePoint that you want to access.

Step-by-Step

To create a data group in the Connector for SharePoint Server/Online, follow these steps:

  1. Launch the "Integration" module.

  2. Under "Consume Data," select "Connector for Connector API."

    The " Connector for SharePoint Server/Online " you created is displayed.

  3. Select the " Connector for SharePoint Server/Online " and right-click it.

  4. Select "Edit" from the context menu.

    The "Edit Data Source" dialog box appears.

  5. Click the "Data Groups" menu item.

    The data groups "SharepointFiles" and "SharepointList," which were already created as examples, are displayed.

  6. Click the " " icon.

    The "Data Groups Settings - Data Groups" dialog box appears.

    Data Group Name

    You can choose any name you like for the data group.

    The name of the data group will be used (later) when creating the external data group (Create an External Data Group in an Intrexx Application).

    Data Group Adapter

    Here, you must define the following class:

    de.uplanet.lucy.server.odata.consumer.sharepoint.SharePointDataGroupAdapter

  7. In the Data Fields section, click the " " icon ().

    The "Data Groups Settings - Data Field" dialog box appears.

    Enter Data Fields

    When entering data into the fields, please keep the following in mind.

    Required fields

    To enable the Intrexx Connector for SharePoint Server/Online to access the desired SharePoint list or SharePoint document library and the information stored there, you must fill in the following required fields.

    SharePoint List SharePoint Document Library
    without file attachments with file attachments
    Id (long) Id (long) Id (long)
      File (file) File (file)
      FileLeafRef (string) FileLeafRef (string)
      FileSystemObjectType (long) FileSystemObjectType (long)

    If you want to add file attachments to a SharePoint list, the required fields are the same for both a SharePoint list and a SharePoint document library.

    Field Names

    The field names included in the data group must match the technical field names in SharePoint.

    You can find the technical field name (among other ways) by clicking on the corresponding data field in the List Settings.

    The technical field name appears at the end of the displayed URL.

    For detailed information on including file attachments in lists, see the section " Add a File Field (Attachment) to a Data Group."

    Field Type

    The field types included in the data group must match the field types in SharePoint.

    Below is an overview of which SharePoint field type you need to map to which Intrexx field type.

    SharePoint Intrexx
    String and Textarea Fields String
    IntegerField Long
    DecimalField Double
    BooleanField Boolean
    User or Group Field Long
    CurrencyField Long
    DateTimeField DateTime
    File File
    FileLeafRef String
    FileSystemObjectType Long
    SelectField

    String
    (Note that only the selected
    must be set up as in SharePoint.)

    MultiSelectField String
    (Note that only the selected
    must be set up as in SharePoint.)
    Location (GeoLoc/Altitude) Long (Read-Only)
    Location (GeoLic/Latitude) Double (Read-Only)
    Location (GeoLic/Longitude) Double (Read-Only)
    Location (GeoLoc/Measure) Long (Read-Only)
    ImageField(ImageField.fileName) String (Read-only)
    ImageField(ImageField.serverRelativeUrl) String (Read-only)
    ImageField(ImageField.serverUrl) String (Read-only)

    "FILE" field type

    You need the "FILE" field type to access file attachments or to upload and download them via your Intrexx portal.

    The "FILE" field type requires its own configuration.

    For detailed information on this topic, see the section " Add a File Field (Attachment) to a Data Group."

    Primary Key

    You must designate a field as the primary key.

    Id

    In SharePoint, every object contains a field named "Id." This field does not appear in SharePoint. You must still include this field in the data group in Intrexx. At the same time, it makes sense to use the "Id" field as the primary key.

  8. Select the data fields you want to access in SharePoint.

  9. In the Data Group Settings section, click the " " icon ().

    You can now edit the "Data Group Settings" section.

    Enter the following attributes and their corresponding values:

    Attribute Value
    sharepoint.list.name [ListName]
    sharepoint.list.type List
    sharepoint.service.uri https://[TenantName].sharepoint.com
    sharepoint.site.name

    [SiteName]

    SharePoint Online

    Enter the name of the "site" here (sites/mysite).

    SharePoint On-Premises

    Enter the name of the "site" and the "site collection path" (websites/mysite) here.

  10. Click "Finish."

    The newly created data group is displayed.

Your Next Steps

Add a File Field (Attachment) to a Data Group (if you want to manage file attachments in a list or access a document library)

Configure the Redirect URI in Microsoft Azure