Use the Share Files activity to share an existing file in MS SharePoint.
About this task
Use this task to share file with internal or external users in MS SharePoint instance. The call
to this activity is a synchronous call where the input data is sent to the activity for processing
and the response is sent back to the orchestration.
Procedure
- Right click the Orchestrations section and select new orchestration.
- Drag the newly created MS SharePoint endpoint to the orchestration and select Share
Files activity. The Share Files activity will be added to the orchestration.
Double click the activity. MS SharePoint Share Files Checklist is
displayed.
- In the Checklist, click Retry. Review the default settings and make the
required changes.
- Select the Map Inputs in the Checklist. The XML
Schemas generated from that operation are displayed as nodes under the request input parameter in
the To Activity panel.
- Create a map between the orchestration variables and the input parameter of the activity.
Mandatory Fields:
- resourceAddress (the full URL to the document you want to share)
- additiveMode
- UserRoleAssignments
- Role (The Role property represents which permission you are assigning. 1 = View, 2 = Edit, 3 =
Owner, 0 = None)
- userId (The UserId property can be the name of the user or a role.)
Note: AdditiveMode: A flag indicating whether the permission setting uses the additive or strict
mode. If this value is "true", the permission setting uses the additive mode, which means that the
specified permission will be added to the user’s current list of permissions if it is not there
already, and if this value is "false", the permission setting uses the strict mode, which means that
the specified permission will replace the user’s current permissions. This parameter is useful when
you want to stop sharing a document with a person or group. In this case you would set AdditiveMode
to false using the Role = 0.
Sample input request:
<ShareFile xmlns="http://www.IBM.com/xmlns/prod/websphere/j2ca/Sharepoint/sharefile">
<ShareFileRequestDetails xmlns="">
<resourceAddress>/shared documents/file1.txt</resourceAddress>
<UserRoleAssignments>
<Role>1</Role>
<UserId>khushbu_khatuja@persistent.com</UserId>
</UserRoleAssignments>
<validateExistingPermissions>true</validateExistingPermissions>
<additiveMode>true</additiveMode>
<sendServerManagedNotification>true</sendServerManagedNotification>
<customMessage>hello</customMessage>
<includeAnonymousLinksInNotification>true</includeAnonymousLinksInNotification>
</ShareFileRequestDetails>
</ShareFile>
Note: Values must be provided at run time for the mandatory elements of the input structure. A
value can be provided by specifying a default value for element or by linking the element with an
input node. During run time if no value is provided for a mandatory element, the activity throws an
exception, which is reported by the Web Management Console. If a value is not provided at run time
for an optional input parameter, no exception is thrown during run time.
- Select the Map Outputs in the Checklist. The XML
Schema generated to hold the response of the activity is displayed as nodes under the response
output parameter in the From Activity panel.
- Create a map between the output parameters and orchestration variables.
Results
You have configured the MS SharePoint Share Files activity.
Note: You can share multiple files at one go using this activity since the input variable is unbounded.