Microsoft SharePoint connector powered by Jitterbit

The BMC Helix iPaaS Microsoft SharePoint Connector provides an interface for entering user-provided input such as credentials to create an authenticated Microsoft SharePoint connection. That connection provides the foundation to configure associated Microsoft SharePoint activities that interact with the connection. Together, a specific Microsoft SharePoint connection and its activities are referred to as a Microsoft SharePoint endpoint.

The SharePoint Connector enables BMC customers to easily integrate with other applications such as BMC Helix Digital Workplace to interact with the Microsoft SharePoint Server.

Supported API versions and prerequisites

The Microsoft SharePoint connector uses the  Microsoft SharePoint REST API version 1.0  and Microsoft Graph version 1.0 API . Refer to the API documentation for information on the schema fields.

The Microsoft SharePoint connector requires the use of an agent version  10.1  or later. These agent versions automatically download the latest version of the connector when required.

To configure a Microsoft SharePoint connection 

Configure the Microsoft SharePoint connection by using the Microsoft SharePoint connector, establishing access to the Microsoft SharePoint endpoint. Once a connection is established, you can configure one or more Microsoft SharePoint activities associated with that connection to be used either as a source to provide data to an operation or as a target to consume data in an operation.

To configure a Microsoft SharePoint connection, complete the following steps:

  1. From the design canvas, open the Connectivity tab  of the design component palette.
  2. Perform one of the following actions:
    • To configure a new Microsoft SharePoint connection, use the Show dropdown to filter on Connectors, and then click the Microsoft SharePoint connector block:
    • To configure an existing Microsoft SharePoint connection, use the Show dropdown to filter on Endpoints, and then double-click the Microsoft SharePoint connector block:
  3. Click Save Changes.
  4. On the configuration screen, enter the values described in the following table:

    Tip

    Fields with a variable icon  support using  global variables project variables , and  Jitterbit variables . Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

    Field NameAction
    Endpoint NameEnter a name to identify the Microsoft SharePoint connection. The name must be unique for each Microsoft SharePoint connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Microsoft SharePoint endpoint, which refers to both a specific connection and its activities.
    Client IDEnter the client ID from the SharePoint App Information page.
    UsernameEnter the ID of the user to login to SharePoint.
    PasswordEnter the password of the user to login to SharePoint.
    SharePoint Site UrlEnter the SharePoint site URL.

    Important

    If you click Delete while creating a new connection, an error is displayed. For more information, see  Component Dependencies, Deletion, and Removal

  5. Click Save Changes.
    After configuring a Microsoft SharePoint connection, you can configure one or more Microsoft SharePoint activities associated with that connection to be used either as a source (to provide data within an operation) or as a target (to consume data within an operation). For more information about creating an activity, see To create a Microsoft SharePoint activity.

To create a Microsoft SharePoint activity 

  1. From the design canvas, open the Connectivity tab  of the design component palette.
  2. Use the Show dropdown to filter on Endpoints, and then click the Microsoft SharePoint connection block to display activities that are available to be used with a Microsoft SharePoint connection:

    The following activities are available. For more information about configuring these activities, see the specific activity sections.

    Activity nameDescription
    Site ManagementPlaces site data into a Microsoft SharePoint endpoint and is intended to be used as a target in an operation.
    List ManagementPlaces list data into a Microsoft SharePoint endpoint and is intended to be used as a target in an operation.
    List Item ManagementPlaces list item data into a Microsoft SharePoint endpoint and is intended to be used as a target in an operation.
  3. To create an activity that can be configured, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see  Operation Creation and Configuration

To configure a Microsoft SharePoint Site Management activity 

A Microsoft SharePoint Site Management activity places site data into a Microsoft SharePoint endpoint and is intended to be used as a target to consume data in an operation. After configuring a Microsoft SharePoint connection, you can configure as many Microsoft SharePoint activities as you like for each Microsoft SharePoint connection.

To configure a Microsoft SharePoint Site Management activity, complete the following steps:

  1. After you add the activity to an operation, double-click the activity brick.

  2. On the configuration screen, enter a name and specify the activity settings: 

    Field NameAction
    NameEnter a name to identify the Microsoft SharePoint Site Management activity. The name must be unique for each Microsoft SharePoint List Management activity and must not contain forward slashes (/) or colons (:).
    OperationSpecify the operation to be used, one of Create Site, or Get Site, or Delete Site.


    Microsoft SharePoint Site Management Activity Configuration Step 1

  3. Click Next.

  4. Review the request and response data schemas. 
    The data schemas list the fields available for the Microsoft SharePoint Site Management activity. 
    If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more. 

    The Microsoft SharePoint connector uses the  Microsoft SharePoint REST API version 1.0  and Microsoft Graph version 1.0 API . For more information about the schema fields, see the API documentation.

  5. Click Finished.
    After a Microsoft SharePoint activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information about the menu actions, see Activity Actions Menu .

To complete the configuration of the operation, add and configure other activities, transformations, or scripts as steps in an operation. You can also configure an operation's settings, which include the ability to chain operations together that are in the same or different workflows.

Microsoft SharePoint Site Management activity operation patterns

Microsoft SharePoint Site Management activities can be used as a target with these operation patterns:

  • Transformation Pattern
  • Two-Transformation Pattern  (as the first or second target)

Other patterns are not valid using Microsoft SharePoint Site Management activities. For more information, see the validation patterns on the  Operation Validity  page.

A typical use case is to use a Microsoft SharePoint Site Management activity in the Two-Transformation Pattern. In this example, the first transformation (Microsoft SharePoint Site Management Request) creates a request structure that is passed to the Microsoft SharePoint Site Management activity. The second transformation (Microsoft SharePoint Site Management Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Microsoft SharePoint Site Management Response) and a message is then logged by the Write to Operation Log script:

Microsoft SharePoint Site Management operation

Tip

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the  operation logs .

To configure a Microsoft SharePoint List Management activity 

A Microsoft SharePoint List Management activity places list data into a Microsoft SharePoint endpoint and is intended to be used as a target to consume data in an operation. After configuring a Microsoft SharePoint connection, you can configure as many Microsoft SharePoint activities as you like for each Microsoft SharePoint connection.

For more information about the parts of an operation and adding activities to operations, see  Operation Creation and Configuration .

To configure a Microsoft SharePoint List Management activity, complete the following steps:

  1. After you add the activity to an operation, double-click the activity brick.

  2. On the configuration screen, enter a name and specify the activity settings: 

    Field NameAction
    NameEnter a name to identify the Microsoft SharePoint List Management activity. The name must be unique for each Microsoft SharePoint List Management activity and must not contain forward slashes (/) or colons (:).
    OperationSpecify the operation to be used, one of Create List, or Get List, or Delete List.


  3. Click Next.

  4. Review the request and response data schemas. 
    The data schemas list the fields available for the Microsoft SharePoint List Management activity. 
    If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
    The Microsoft SharePoint connector uses the  Microsoft SharePoint REST API version 1.0  and Microsoft Graph version 1.0 API . For more information about the schema fields, see the API documentation.

  5. Click Finished.
    After a Microsoft SharePoint activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information about the menu actions, see  Activity Actions Menu .

To complete the configuration of the operation, add and configure other activities, transformations, or scripts as steps in an operation. You can also configure an operation's settings, which include the ability to chain operations together that are in the same or different workflows.

Microsoft SharePoint List Management activity operation patterns

Microsoft SharePoint List Management activities can be used as a target with these operation patterns:

  • Transformation Pattern
  • Two-Transformation Pattern  (as the first or second target)

Other patterns are not valid using Microsoft SharePoint List Management activities. For more information, see the validation patterns on the  Operation Validity  page.

A typical use case is to use a Microsoft SharePoint List Management activity in the Two-Transformation Pattern. In this example, the first transformation (Microsoft SharePoint List Management Request) creates a request structure that is passed to the Microsoft SharePoint List Management activity. The second transformation (Microsoft SharePoint List Management Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Microsoft SharePoint List Management Response) and a message is then logged by the Write to Operation Log script:

Tip

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the  operation logs .

To configure a Microsoft SharePoint List Item Management activity 

A Microsoft SharePoint List Item Management activity places list item data into a Microsoft SharePoint endpoint and is intended to be used as a target to consume data in an operation. After configuring a Microsoft SharePoint connection, you can configure as many Microsoft SharePoint activities as you like for each Microsoft SharePoint connection.

To configure a Microsoft SharePoint List Item Management activity, complete the following steps:

  1. After you add the activity to an operation, double-click the activity brick.

  2. On the configuration screen, enter a name and specify the activity settings: 

    Field NameAction
    NameEnter a name to identify the Microsoft SharePoint List Item Management activity. The name must be unique for each Microsoft SharePoint List Item Management activity and must not contain forward slashes (/) or colons (:).
    OperationSpecify the operation to be used, one of Create List Item, or Get List Item, or Delete List Item.


  3. Click Next.

  4. Review the request and response data schemas. 
    The data schemas list the fields available for the Microsoft SharePoint List Item Management activity. 
    If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
    The Microsoft SharePoint connector uses the  Microsoft SharePoint REST API version 1.0  and Microsoft Graph version 1.0 API . For more information about the schema fields, see the API documentation.

  5. Click Finished.
  6. After a Microsoft SharePoint activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information about the menu actions, see Activity Actions Menu .

To complete the configuration of the operation, add and configure other activities, transformations, or scripts as steps in an operation. You can also configure an operation's settings, which include the ability to chain operations together that are in the same or different workflows.

Microsoft SharePoint List Item Management activity operation patterns

Microsoft SharePoint List Item Management activities can be used as a target with these operation patterns:

  • Transformation Pattern
  • Two-Transformation Pattern  (as the first or second target)

Other patterns are not valid using Microsoft SharePoint List Item Management activities. For more information, see the validation patterns on the  Operation Validity  page.

A typical use case is to use a Microsoft SharePoint List Item Management activity in the Two-Transformation Pattern. In this example, the first transformation (Microsoft SharePoint List Item Management Request) creates a request structure that is passed to the Microsoft SharePoint List Item Management activity. The second transformation (Microsoft SharePoint List Item Management Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Microsoft SharePoint List Item Management Response) and a message is then logged by the Write to Operation Log script:

Tip

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the  operation logs

Was this page helpful? Yes No Submitting... Thank you

Comments