Documents: Difference between revisions

Jump to navigation Jump to search

Documents (view source)

Revision as of 09:03, 6 April 2021

154 bytes added ,  6 April 2021
→‎SharePoint integration
Line 40: Line 40:


== SharePoint integration ==
== SharePoint integration ==
{{Note|Out of the box, the integration with SharePoint document storage is only available on Microsoft Dynamics CRM.}}
 
Out of the box, the integration with SharePoint document storage is only available on Microsoft Dynamics CRM and Resco Cloud.
# Configure your backend server (Resco Cloud or Dynamics).
# Configure your Woodford app project.


=== Server-side prerequisites ===
=== Server-side prerequisites ===
Mobile CRM application supports both Sharepoint List Component base integration and Server-Side Integration. Both will result in the creation of the required records. The difference is in the CRM web user interface, which is not important for Mobile CRM. The List Component is deprecated, but please read the following [https://technet.microsoft.com/en-us/library/dn792527.aspx guidelines] to make sure you pick the right choice.
Resco mobile apps support both Sharepoint List Component base integration and Server-Side Integration. Both will result in the creation of the required records. The difference is in the CRM web user interface, which is not important for Resco Mobile CRM. The List Component is deprecated, but please read the following [https://technet.microsoft.com/en-us/library/dn792527.aspx guidelines] to make sure you pick the right choice.


Mobile CRM requires that sharepointsite and documentLocation records are correctly configured. This means that these records must exist:
Resco Mobile CRM requires that sharepointsite and documentLocation records are correctly configured. This means that these records must exist:
* At least one sharepointsite record with the sharepoint url
* At least one sharepointsite record with the sharepoint url
* At least one documentLocation per Sharepoint-enabled-entity root
* At least one documentLocation per Sharepoint-enabled-entity root
=== Configure Resco Cloud ===
To enable SharePoint in Resco Cloud, perform the following settings in the [[Admin Console]].
# Select '''Data > Manage Data''' from the menu, then click '''Show System Entities'''.
# Go to the '''SharePoint Site''' entity and click '''New''' to create a new record.
#* Click '''Show System Fields''' to access all fields for the record.
#* Enter a '''Name''' and the '''Absolute URL''' parameter, enable '''Default Site''', then click '''Save'''.<br>[[File:Sharepoint site record.png|300px]]
# Go to the '''Document Location''' entity and click '''New''' to create a new record for each entity for which you want to enable SharePoint.
:* Enter a '''Name''' and as '''Parent Site or Location''' select the site created in step 2, and as '''Relative URL''', enter the logical name of the entity. Click '''Save'''.<br>[[File:Sharepoint document location record.png|300px]]
The settings used in this example allow adding documents for account records. The Resco Mobile CRM app creates a Document Location record for each account record with a SharePoint document. If you want to create such records manually in advance:
* Set '''Relative URL''' to {account_name}_{Guid} (for example, Apollo Appartments_3EB67D9478414AAAAD06E06AD8D15C2B).
* Set '''Regarding''' to 'Apollo Appartments' (lookup for account record).
* Set '''Parent Site or Location''' to 'Accounts Docs' (lookup to the document location record created in the previous step).
An additional configuration step is necessary directly on your SharePoint server: Create a document library with the name equal to the logical entity name. If such a document library does not exist, synchronization of documents fails.
You can now enable SharePoint in Woodford as [[Documents#Enable_SharePoint_in_Woodford|described below]].
=== Configure Dynamics ===


{{Note|Don't create these records manually! Use the wizard instead.|Warning}}
{{Note|Don't create these records manually! Use the wizard instead.|Warning}}
Line 78: Line 102:
SharePoint documents can only be used when the documents and associated records are available in the offline database (even if you are using the app in online mode). The records that you are using in online mode must be synchronized. Adjust [[Sync Filter]]s for specific entities to ensure that the necessary records are downloaded and available in offline mode.
SharePoint documents can only be used when the documents and associated records are available in the offline database (even if you are using the app in online mode). The records that you are using in online mode must be synchronized. Adjust [[Sync Filter]]s for specific entities to ensure that the necessary records are downloaded and available in offline mode.


Document Location records need to be downloaded to the offline database. They are needed (among other things) to define the folder structure, i.e., the path to SharePoint server documents. Clear the entire [[Sync Filter]] for Document Location entity. If the documents become available in the app, but you need to limit the Document Location records, continue with the next step.
Document Location records need to be downloaded to the offline database. They are needed (among other things) to define the folder structure, i.e., the path to SharePoint server documents. Clear the entire [[Sync Filter]] for the Document Location entity. If the documents become available in the app, but you need to limit the Document Location records, continue with the next step.


The document location defining the CRM entity root folder must have its ''regarding'' set to NULL (empty). Otherwise, they are treated as file location records; this breaks the folder structure used in the app. If you need to filter Document Location entity records, make sure that records with an empty ''regarding'' are OR-ed with the other conditions; for example:
The document location defining the CRM entity root folder must have its ''regarding'' set to NULL (empty). Otherwise, they are treated as file location records; this breaks the folder structure used in the app. If you need to filter Document Location entity records, make sure that records with an empty ''regarding'' are OR-ed with the other conditions; for example:
Line 104: Line 128:
* Enable the '''SharePoint REST API''' configuration setting to use ListService partially using REST API. This interface is more efficient than the first because it does not need GetList API calls.
* Enable the '''SharePoint REST API''' configuration setting to use ListService partially using REST API. This interface is more efficient than the first because it does not need GetList API calls.
* Enable '''New SharePoint REST API''' configuration setting to use the full REST API. It is just as efficient at the second option. Additionally, it uses the OAuth authorization, with a single sign-on with Dynamics possible.
* Enable '''New SharePoint REST API''' configuration setting to use the full REST API. It is just as efficient at the second option. Additionally, it uses the OAuth authorization, with a single sign-on with Dynamics possible.
=== Resco Cloud ===
To enable SharePoint in Resco Cloud, perform the following settings in the [[Admin Console]].
# Select '''Data > Manage Data''' from the menu, then click '''Show System Entities'''.
# Go to the '''SharePoint Site''' entity and click '''New''' to create a new record.
#* Click '''Show System Fields''' to access all fields for the record.
#* Enter a '''Name''' and the '''Absolute URL''' parameter, enable '''Default Site''', then click '''Save'''.<br>[[File:Sharepoint site record.png|300px]]
# Go to the '''Document Location''' entity and click '''New''' to create a new record for each entity for which you want to enable SharePoint.
:* Enter a '''Name''' and as '''Parent Site or Location''' select the site created in step 2, and as '''Relative URL''', enter the logical name of the entity. Click '''Save'''.<br>[[File:Sharepoint document location record.png|300px]]
The settings used in this example allow adding documents for account records. The Resco Mobile CRM app creates a Document Location record for each account record with a SharePoint document. If you want to create such records manually in advance:
* Set '''Relative URL''' to {account_name}_{Guid} (for example, Apollo Appartments_3EB67D9478414AAAAD06E06AD8D15C2B).
* Set '''Regarding''' to 'Apollo Appartments' (lookup for account record).
* Set '''Parent Site or Location''' to 'Accounts Docs' (lookup to the document location record created in the previous step).
An additional configuration step is necessary directly on your SharePoint server: Create a document library with the name equal to the logical entity name. If such a document library does not exist, synchronization of documents fails.
You can now enable SharePoint in Woodford as [[Documents#Enable_SharePoint_in_Woodford|described above]].


== External document synchronization filter options ==
== External document synchronization filter options ==
Retrieved from "https://docs.resco.net/wiki/Special:MobileDiff/4492"

Navigation menu