Sharepoint Client Adapter

• Commands can be scripted through Business Process Modeling Language (BPML).
• The adapter is accessible through the following services in a business process:
  • Sharepoint Client Begin Session Service
  • Sharepoint Client LIST Service
  • Sharepoint Client MKDIR Service
  • Sharepoint Client MKDOCLIB Service
  • Sharepoint Client PUT Service
  • Sharepoint Client GET Service
  • Sharepoint Client DELETE Service
  • Sharepoint Client End Session Service

1. Create a SharepointClientadapter configuration.
2. Configure the SharepointClientadapter.

1. Go to Microsoft Entra and log in with your credentials.
2. View SSL Certificates
   You can view and download the SSL certificates using Firefox:

   • Click the lock icon on the left of URL bar.
   • Select Connection secure.
   • Click More Information. A dialog box will appear.
   • Choose View Certificate.
   • Download PEM (chain).
3. Import Certificates into Sterling B2B Integrator
   • Open the Dashboard UI in IBM Sterling B2B Integrator.
   • Go to Trading Partner → Digital Certificates → CA.
   • Upload each certificate from the downloaded PEM chain.
4. Use Certificates in Adapter Configuration
   • Use the imported CA certificates in the SharePoint Client Adapter Configuration to enable secure communication.

1. Select Deployment > Services > Configuration.
2. Search for Sharepoint Client Adapter or select it from the list.
3. Click Edit.
4. Specify the field settings:

   Field	Description
   Name	Unique and meaningful name for the adapter configuration. Required.
   Description	Description of adapter. Required.
   Environment	Select one of the following options: All Adapter Container Nodes All ASI Nodes All ASI nodes plus all Adapter Container Nodes Node1
   Select a Group	Select one of the following options: None – You do not want to include this configuration in a group at this time. Create New Group – You can enter a name for a new group in this field, which will then be created along with this configuration. Select Group – If you have already created one or more groups for this adapter type, they are displayed in the list. Select group from the list.
   Sharepoint URL	Required. Sharepoint URL is the domain of the SharePoint site or resource. For Sterling B2B Integrator v6.2.0.5_1 and later, the Sharepoint Client Adapter supports specifying SharePoint sites hosted under managed paths for both /sites or /teams. For example: https://yourdomain.sharepoint.com/sites/sitename or https://yourdomain.sharepoint.com/teams/teamname
   Tenant ID	Unique identification of the Sharepoint instance, TenantID on Sharepoint. Required.
   Application ID	Application ID of the application as registered in the application registration portal. Optional if it is present in Begin Session or Individual Services.
   System Certificate	Specifies a valid system certificate ID from Digital certificates. This certificate is attached with application (in application registration) registered with Azure and will be used for client authentication.
   Site Name	The name of the Sharepoint site. This parameter is required in Sterling B2B Integrator 6.2.0.5 and all prior versions. For Sterling B2B Integrator 6.2.0.5_1 and later, it is optional. If the Site Name is not provided as a parameter, it must be included in the SharePoint URL. For example: https://<sharepointURL>/<managedpath>/<sitename>
   Document Library	Document Library. Optional. It can be set in individual services. Note: The precedence order of documentlibrary is Individual Services > Begin Session > Adapter Configuration. If documentlibrary is not set in any of the mentioned fields, then the default documentlibrary for site (Shared Documents) is used.
   Minimum Number of Threads	A tuning parameter that indicates the range of threads available for handling events to improve performance. For more information, see Performance Tuning. Must be less than or equal to the maximum number of threads value. Required. The default value is 3.
   Maximum Number of Threads	A tuning parameter that indicates the range of threads available for handling events to improve performance. For more information, see Performance Tuning. Must be greater than or equal to the minimum number of threads value. Required. The default value is 5.
   Timeout	Amount of time in milliseconds after which the connection terminates in case of a connection error and the number of connection retries are attempted. Optional. The default value is 120000 milliseconds.
   Read Timeout	Time out value in milliseconds. Optional. The default value is 120000 milliseconds.
   Proxy Server	Whether to use a proxy server. Valid values are: Yes – Proxy server is used No – No proxy server is used Required. Note: Proxy can be used only on ASI and it is not supported on adapter containers due to the limitation from adapter container environment.
   Proxy hostname	A valid proxy server hostname or IP address to use as a gateway. Required if proxy server is set to Yes.
   Proxy port	Listen port number of the proxy server. Required if proxy server is set to Yes.
   CA Certificate	Multi-picker for all the relevant CA Certificates on the Dashboard.

https://yourdomain.sharepoint.com/sites or https://yourdomain.sharepoint.com/teams

https://yourdomain.sharepoint.com/sites/sitename

https://yourdomain.sharepoint.com/teams/teamname

1. Locate the sharepointclient.properties file in the properties directory where you installed Sterling B2B Integrator.
2. Edit the sharepointclient.properties file.
3. Configure the properties.

1. Go to Business Process > Manager.
2. Search for SharepointClientDemoAllServices.
3. Click Execution Manager > Execute.
4. Click Go.

<process name="SharepointClientDemoAllServices">
  <sequence>

    <operation name="Sharepoint Client Begin Session Service">
      <participant name="SharepointClientBeginSession"/>
      <output message="SharepointClientBeginSessionTypeInputMessage">
        <assign to="sharepointclientadapter">SharepointClientAdapter</assign>
        <assign to="systemcertid">systemcertid</assign> 
        <assign to="certificateid">certificateid</assign> 
        <assign to="applicationid">applicationidValue</assign> 
        <assign to="documentlibrary">documentlibraryValue</assign> 
        <assign to="connectiontimeout">30</assign>
        <assign to="readtimeout">30</assign>   
        <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>  

	<operation name="Sharepoint Client MKDOCLIB Service">
         <participant name="SharepointClientMkdoclib"/>
         <output message="SharepointClientMkdocibServiceTypeInputMessage">
          <assign to="documentlibrary">documentlibrary</assign>
          <assign to="." from="*"></assign>
         </output>
         <input message="inmsg">
           <assign to="." from="*"></assign>
         </input>
     </operation>
	 
	 <operation name="Sharepoint Client MKDIR Service">
         <participant name="SharepointClientMkdir"/>
         <output message="SharepointClientMkdirServiceTypeInputMessage">
          <assign to="documentlibrary">documentlibrary</assign>
          <assign to="foldername">foldername</assign> 
          <assign to="." from="*"></assign>
         </output>
         <input message="inmsg">
           <assign to="." from="*"></assign>
         </input>
     </operation>
	 
	 <operation name="Sharepoint Client PUT Service">
         <participant name="SharepointClientPut"/>
         <output message="SharepointClientPutServiceTypeInputMessage">
          <assign to="documentlibrary">documentlibrary</assign>
          <assign to="documentlist">documentlist</assign> 
          <assign to="documentid">documentid</assign> 
          <assign to="foldername">sourcefolder</assign> 
          <assign to="remotefilename">renmaedocument</assign> 
          <assign to="sourcefilelist">listof files</assign> 
          <assign to="filepattern">pattern</assign>   
          <assign to="." from="*"></assign>
         </output>
         <input message="inmsg">
           <assign to="." from="*"></assign>
         </input>
     </operation>
	 
	 <operation name="Sharepoint Client Get Service">
	  <participant name="SharepointClientGet"/>
	  <output message="SharepointClientGetServiceTypeInputMessage">
	    <assign to="." from="*"></assign>
		<assign to="foldername">testDir</assign>		
		<assign to="filepattern">test\d.txt</assign>             
		<assign to="remotefilename">backend1.pdf</assign>         
		<assign to="remotefilelist">backend1.pdf,abc.pdf</assign>  
        	<assign to="documentlibrary">documentlibrary</assign>
	  </output>
	  <input message="inmsg">
		<assign to="." from="*"></assign>
	  </input>
	</operation>
	 
    <operation name="Sharepoint Client List Service">
      <participant name="SharepointClientList"/>
      <output message="SharepointClientListServiceTypeInputMessage">
        <assign to="." from="*"></assign>
        <assign to="documentlibrary">documentlibrary</assign>
        <assign to="foldername">testDir</assign>
        <assign to="filepattern">test\.txt</assign>
        <assign to="maxItems"></assign>
     </output>
    <input message="inmsg">
        <assign to="." from="*"></assign>
    </input>
    </operation>
         
     <operation name="Sharepoint Client DELETE Service">
         <participant name="SharepointClientDelete"/>
         <output message="SharepointClientDeleteServiceTypeInputMessage">
          <assign to="documentlibrary">documentlibrary</assign> 
          <assign to="foldername">foldername</assign> 
		  <assign to="remotefilename">filename</assign> 
          <assign to="." from="*"></assign>
         </output>
         <input message="inmsg">
           <assign to="." from="*"></assign>
         </input>
     </operation>

    <operation name="Sharepoint Client End Session Service">
      <participant name="SharepointClientEndSession"/>
      <output message="SharepointClientEndSessionServiceTypeInputMessage">
          <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
          <assign to="." from="*"></assign>
      </input>
    </operation>
	
  </sequence>
</process>    

<!-- To catch all onFault handling to log an error to SharepointClientAdapter -->
<onFault>
<sequence name="End Session">
<operation name="Sharepoint Client End Session Service">
	<participant name="SharepointClientEndSession"/>
    <output message="SharepointClientEndSessionServiceTypeInputMessage">
	  <assign to="session_token" 
            from="SharepointClientBeginSession/session_token/text()">
	  </assign>
	  <assign to="." from="*"></assign>
    </output>
    <input message="inmsg">
	  <assign to="SharepointClientEndSessionServiceOnFaultResults" from="*"></assign>
    </input>
</operation>
</sequence>
</onFault>