3.2. Add a New Source Connection
Items are migrated from the system specified by a source connection. Relevant security credentials will be required
Select the source platform to migrate from.
Only platforms that are licensed for migration will be listed above.
NOTE: In most sources below, it’s possible to filter the folders that are displayed using the icon. This only affects the folders that are displayed and is NOT the way to apply a filter to what should be discovered. Use Change Settings on Discovery to apply filters to discovery.
3.2.1. Adding a File Share as a Source
Provide a name for this Source and specify the location or select the Browse icon.
Source Plugin: Select "Default Source Plugin"
Test the Connection before adding the Source Connection.
3.2.2. Adding ShareFile as a Source
The following fields needs to be configured for a ShareFile Connection:
Name: Name of connection, to uniquely identify the connection within the workspace.
Base URL: URL of the system ShareFile. E.g. https://sfacme.sharefile.com
The Client id and client secret below can be obtained by clicking on Get an API Key on the following site https://api.sharefile.com
Client id: Client ID of the Source ShareFile.
Client Secret: Client Secret of the Source ShareFile.
Username: Username for connecting to ShareFile. The user should be an administrator.
Password: Password for the above-mentioned user or application specific password if using MFA.
Note: If system is using Multi Factor Authentication (MFA) then it’s necessary to generate an application specific password and use the password it generates here.
Steps:
Log into customer domain e.g. https://sfacme.sharefile.com
Go to Personal Settings > Personal Security > Two-Step Verification > scroll down to Application-Specific Passwords and click Generate Password.
Full details here https://support.citrix.com/article/CTX277723#generate
Time Zone: If Source and Target are in different time zones.
Specify the exact parent folder to migrate from
Browse and select Folder using the folder selection dialog.
See Error! Reference source not found. for more information on migrating from ShareFile e.g. how to create API Key etc. Personal Files, Content types etc.
3.2.3. Adding Documentum Source
Documentum has a database and a file storage component so access details to both may be required. The exact information required depends upon several factors.
- Whether to use Documentum API for Discovery and retrieval of items.
- Whether Documentum is using an Oracle database or a Microsoft SQL database.
- Whether using retrieval method of File Store or API
If the option to use API for Discovery and Migration below is selected then the API is for Discovery and retrieval so then only server URL, username and password are required.
Retrieval Method controls how items should be retrieved from Documentum. The API retrieval method means that PMA will call the Documentum API to retrieve items. The File Store method means that PMA will access the Documentum files on disk directly to retrieve content. API method provides improved compatibility/reliability in some scenarios, but File Store can provide faster retrieval because it will bypass the Documentum system.
Name: Name of connection, to uniquely identify the connection within the workspace.
If the option to use API for Discovery and Migration is selected, then the API is for Discovery and retrieval so only the following details are required. This can make configuration easier, but API methods can be slower than using PMA to access the underlying system directly.
Server URL: REST URL of the target Documentum Content Server. This is normally the hostname/IP address of the Documentum server followed by “:8080/dctm-rest/services” e.g. http://192.162.19.29:8080/dctm-rest/services.
Username: This is the Username for connecting to Documentum. The user should be an Administrator of Documentum.
Password: This is the password for the above user.
Ignored Cabinets - Cabinets not to be processed e.g. System,Temp,Resources
If not using API for Discovery and Retrieval(this is the default recommended option)
Select DB Type : SQL or Oracle (type of database used by Documentum)
If using Oracle:
Host Database Server: Name of Oracle database server hosting Documentum database.
Port: Port number for Oracle database system
Whether to use SID or Service Name
SID/Service Name:
Database Schema:
Username & Password- Details of account with access to Documentum database.
If using SQL:
Server: Name of SQL database server hosting Documentum database.
Port: Port number for Microsoft SQL server database system
Name of Documentum database: Documentum database name
Option to use Integrated Security. It selected the PMA service account (i.e. the account it runs under will be used to access SQL. If not selected, then required to specify details username and password of a SQL login account with access.
Content Retrieval Method
This setting controls whether items are retrieved using requests to the Documentum API or by PMA accessing the information directly.
API
Server URL: REST URL of the target Documentum Content Server. This is normally the hostname/IP address of the Documentum server followed by “:8080/dctm-rest/services” e.g. http://192.162.19.29:8080/dctm-rest/services
Username: : This is the Username for connecting to Documentum. The user should be an Administrator of Documentum.
Password: Password for the above user
Ignored Cabinets - Cabinets not to be processed e.g. System,Temp,Resources
File Store
Path Overrides: If the path in the database cannot be resolved from the PMA server, this feature can be used to ‘map’ that entry to an accessible location. Can also be used when source data is copied to another location.
The details of path overrides can also be specified in a .CSV file and imported. Below is example of formatting required.
fileStore,overrideFilepathValue
fileloc_1,\\fileserv1.acmecorp.com\Fin\US\storage_1
fileloc_19,\\fileserv1.acmecorp\Fin\UK\storage_19
NOTE: The override information is used during the discovery process to create source path URI for items. If the path override is edited after discovery, it may be necessary to reset and rerun discovery for these changes to be processed.
Ignored Cabinets: Cabinets not to be processed e.g. System,Temp,Resources
NOTE: Virtual documents will be migrated as Document Sets in SharePoint so it is necessary to enable this feature on the SharePoint site collection.
3.2.4. Adding BOX Source
Name: Name of connection, to uniquely identify the connection within the workspace.
Box URL: URL of the Box system. Usually this will be https://app.box.com
Box User: Username of Box enterprise admin account
Load JWT from:
The PMA Box connector supports the JWT (JSON web token) method of authentication. The token can either be located in a .JSON file or select ‘Inline text’ and enter the token in the specified field.
File: Location of a file containing JWT token
Inline text: String containing JWT token
NOTE: When migrating from BOX, API calls are used to discover and retrieve data. This is likely to have an impact on the API limits associated with your BOX system. Therefore it’s essential to discuss your API call limits with your BOX Account Manager. See 14.2.2. for details of how migration consumes BOX API
3.2.5. Adding iManage Source
To discovery and therefore migrate from iManage it’s necessary to place a copy of the iManage database onto the same SQL server that the PMA Staging database is hosted on. If a hosted iManage system is being used, then contact iManage to request a copy of your database.
Name: Name of connection, to uniquely identify the connection within the workspace.
Server Name: Name of SQL server hosting iManage database.
Use Integrated Security – If selected then the account currently logged into will be used to access the iManage database.
Username and password: If Use Integrated Security is unselected then specify the username and password of an SQL Login account with access to the iManage database.
Content Retrieval Method:
There are two methods that can be used to retrieve iManage data, “API” or “File Store”. If the iManage system is hosted or encrypted then you MUST use the API method. The File Store method means that PMA will retrieve the underlying iManage files rather than use the iManage API. You may choose to copy the files to the PMA server to reduce network impact and improve performance.
File Store retrieval method:
File Location: Optional. If the iManage files have been copied from the iManage server to another location for migration, specify the location here.
Database Alias (optional) Can be used to identify a specific iManage instance.
API retrieval method:
URL: IManage URL
Username: IManage Username
Password: IManage Password
Database Alias (optional) Can be used to identify a specific iManage instance.
NOTE: Migration of Workflows from iManage is not supported
3.2.5. Adding Source Connection iManage-Cloud
When select iManage Cloud option in Source System dropdown, it will show following fields to add details related to it.
- Name: Enter a unique name to identify this connection within the CPS application.
- Location: If iManage files have been copied from the original server to a different location for migration, specify that location here.
-
Content Retrieval Method: Choose how to retrieve data from iManage:
- API: Recommended if iManage is hosted or encrypted.
- File Store: Retrieves files directly from the iManage file system. This method can improve performance and reduce network load by copying files to the CPS server.
Note: If you select File Store, an additional field will appear on the screen for further configuration.
- Server Location: If iManage files have been moved from the original server to a different location for migration, enter that location here.
If Select API, following additional field will be displayed on screen
- iManage URL: Enter the URL of your iManage cloud tenant.
- iManage Username: Provide the username used to connect to the iManage cloud tenant.
- iManage Password: Enter the password for the above iManage user.
Setting Up Client ID and Secret:
To set up the Client ID and Client Secret, refer to the guide:
Adding an application. When configuring the Client ID and Secret, use the following recommended settings:
- Application Type: Choose Web (recommended) or Native.
- Client Type: Choose Public (recommended) or Confidential.
- Client ID: Enter the Client ID value used to connect to the iManage instance.
- Client Secret: Enter the Client Secret associated with the above Client ID.
- Grant Type: Specify the OAuth 2.0 flow used for authentication. Current supported value for this field are “password” or “client_credentials”.
a. Password Credentials (ROPC)
- User provides username + password directly to client application.
- This method is not recommended except for trusted first-party apps (like internal tools) and is typically used in PowerShell scripts where credentials are entered directly.
b. Client Credentials
- No user involved.
- It is used for server-to-server or machine-to-machine communication, where the application authenticates using a client ID and client secret.
- Scope: Enter the required permissions to allow the CPS tool to connect to the iManage cloud. Minimum required value for this field is work.read. Other accepted values are listed below (refer to the full documentation for details).
| Scope | Access Level |
| work.read | Read-only access to Work resources (documents, workspaces, folders). |
| work.write | Read & write access to Work resources (create, update, delete). |
| email.read | Read email-related content in iManage. |
| email.write | Read & write email-related content in iManage. |
| user.read | Read user profile & settings. |
| user.write | Modify user profile & settings. |
| settings.read | Read system and user settings. |
| settings.write | Modify system and user settings. |
| manage.read | Read administrative settings (e.g., metadata, security). |
| manage.write | Modify administrative settings. |
| security.read | Read security-related configurations. |
| security.write | Modify security settings. |
| admin | Tenant level admin privileges of iManage cloud |
- Customer ID: Enter the Customer ID to connect to your iManage cloud tenant (organization). For instructions on how to obtain your Customer ID, refer to the guide: - Registering an iManage application
- Library Name: Specify the name of the document library in your iManage cloud instance where workspaces, folders, and documents are stored.
- Database Alias: (Optional) This field is not required for iManage cloud connections.
- Timezone: (Optional) Use this field to select the appropriate time zone if your iManage data requires conversion due to time zone differences.
Click the Test Connection button to verify the connection settings. Once the test is successful, click the Add button to save and add the connection.
Note:
|
The standard iManage cloud API cannot retrieve certain metadata for Email content types, which may be specific to the customer. To retrieve this metadata, set the following app config key to True. <add key="Worksite.WorkSiteCloudAPIConnector.ExtractEmailEndPointMetadata" value="false" /> |
Some other app config files related to iManage cloud connections
| iManage Cloud Api config key's | Usage |
| <add key="Worksite.WorkSiteCloudAPIConnector.PageSize" value="1000" /> |
Controls how many items are fetched at once. For example, if there are 100,000 items, the system retrieves them in batches of 1,000 to avoid overload and improve speed. |
| <add key="Worksite.WorkSiteCloudAPIConnector.ApiMaxRetries" value="10" /> |
Adds resilience. If the system faces a timeout or temporary issue while connecting to iManage, it will retry up to 10 times before giving up. |
| <add key="Worksite.WorkSiteCloudAPIConnector.IsDocumentSecurityRequired" value="false" /> |
When enabled (true), the system also fetches document-level security details. This is optional and depends on client- specific requirements. |
|
<add key="Worksite.WorkSiteCloudAPIConnector.PreferredLocale" value="1033" /> |
Sets the language for metadata discovery. The value 1033 refers to English. This helps ensure metadata appears in the preferred language. |
| <add key="Worksite.WorkSiteCloudAPIConnector.LinkDocumentDiscoveryThreadLimit" value="5" /> |
Limits how many parallel threads are used when discovering shortcut- linked documents. A value of 5 balances performance and system load. |
| <add key="Worksite.WorkSiteCloudAPIConnector.ExtractEmailEndPointMetadata" value="false" /> |
When enabled, it pulls extra metadata from emails. Helpful for deeper email analysis. |
|
<add key="Worksite.WorkSiteCloudAPIConnector.ApiCustomHeaders" value="Accept-Encoding:identity;ConnectionClose:true;User-Agent:Mozilla/5.0" /> |
These headers are added to API calls to ensure compatibility and proper communication with the iManage Cloud. Think of them as special instructions for smoother data exchange. |
| <add key="Worksite.WorkSiteCloudAPIConnector.ApiMaxBufferLimit" value="131072" /> |
Controls how much content is downloaded in each loop—here, 131,072 bytes (128 KB). This helps manage large files efficiently without overwhelming the system. |
3.2.7. Adding FileNet P8 Source
PMA can either use the Filenet API for both discovery and retrieval or be configured to access the Filenet database directly. It supports Filenet using Microsoft, Oracle or DB2 databases.
The following fields needs to be configured for a FileNet P8 Connection:
Name: Name of connection, to uniquely identify the connection within the workspace.
Service URL: URL of the FileNet Web API service hosted on Content Engine server.
Username: Filenet Username for connecting to FileNet Content Engine. The user should have Administrator privileges. Domain accounts are not supported.
Password: Password for the above user.
WorkPlace XT URL: Normally of the form, e.g. “http://acmecorpfilenet:9080/WorkplaceXT”. The FileNet WorkplaceXT is normally hosted on FileNet XT Server.
API for Discovery and Migration: With this toggle off(default), PMA will access the Filenet database directly during discovery and use the FileNet API for retrieval. If toggle selected, the Filenet API will be used for both discovery and retrieval.
Connection Types: Specify the database product used by Filenet. It can either be SQL, Oracle or DB2.
Filenet p8 using Oracle Database
Host Database Server: Name of Oracle database server hosting Filenet database.
Port: Port number for Oracle database system
Whether to use SID or Service Name
Username and Password: Credentials of account with access to Oracle database
SID/Service Name: Name of SID/Service
SQL Schema: Oracle SQL schema
Filenet p8 using SQL Database
Object Store name – Filenet Object store
Host Database Server: Name of SQL database server hosting Filenet database.
Option to use Integrated Security. It selected the PMA service account (i.e. the account it runs under will be used to access SQL. If not selected, then required to specify details username and password of a SQL login account with access.
Database: Name of Filenet SQL database.
SQL Schema: e.g. dbo
Filenet p8 using DB2 Database
Object Store name – Filenet object store
Host Database Server: Name of DB2 database server hosting Filenet database.
Database: Name of Filenet SQL database.
Port: Port used to connect to DB2 database.
Username and password: Credentials to access DB2 database.
3.2.8. Adding Alfresco Source
Name: Name of connection, to uniquely identify the connection within the workspace.
SiteURL: URL for Alfresco API. This is either in the format
http://<Alfresco server>:<port>/alfresco/api/-default-/public/cmis/versions/1.1/browser
e.g. http://prodcms:8080/alfresco/api/-default-/public/cmis/versions/1.1/browser
or
http://<Alfresco server>:<port>/alfresco/api/-default-/public/cmis/versions/1.0/atom
Username and Password: Details of account with access to Alfresco server
Use Kerberos: Select to use Kerberos
3.2.9. Adding OpenText CS Source
NOTE: Only OpenText CS using Microsoft SQL is supported at this time. Contact Technical Support for more information.
Name: Name of connection, to uniquely identify the connection within the workspace.
Server URL: URL of OpenText system. http://<opentextserver>/otcs/cs.exe/
Username and Password: Details of account with access to OpenText CS server
Source Database: Select whether OpenText is using SQL Server or Oracle as it’s backend database.
If using SQL Server
Database server name: Name of Microsoft SQL server storing OpenText database.
Database name: Name of OpenText SQL database
Use Integrated Security – If selected then the account currently logged into will be used to access the database.
Username and password: If Use Integrated Security is unselected then specify the username and password of an SQL Login account with access to the database.
SQL Schema: SQL schema name of OpenText Database.
3.2.10. Adding OpenText Edocs Source
To discover and therefore migrate from EDocs, it’s necessary to place a copy of the EDocs database onto the same SQL server that the PMA Staging database is hosted on.
Name: Name of connection, to uniquely identify the connection within the workspace.
Server: Name of SQL server hosting EDocs database.
Use Integrated Security – If selected then the account currently logged into will be used to access the EDocs database.
Username and password: If Use Integrated Security is unselected then specify the username and password of an SQL Login account with access to the EDocs database.
Database Name: Name of EDocs SQL database
File location: Location where EDocs files are stored. If the documents to be discovered are located across multiple file locations this can be customised by Proventeq with Premium Support or Professional Services.
3.2.11. Adding M-Files Source
Name: Name of connection to uniquely identify the connection within the workspace.
ServerUrl: URL of the source M-Files server.
Port Number: Port number for the COM API utilization
Username: Username for connecting to M-Files server. The user should be an administrator for the source M-Files system.
Password: Password for the above-mentioned user.
COM API Connection Type: HTTPS or TCP connection.
3.2.12. Adding Oracle UCM Source
PCS support migrations from Oracle UCM that use either Microsoft SQL or Oracle as their underlying database.
Name: Name of connection to uniquely identify the connection within the workspace.
Server Url: URL of the source Oracle UCM server. e.g. http://ucmsys.acmecorp.com/16200/_dav/cs/idcplg
Username & Password: Credentials of account with Oracle UCM access
Use UCM Profiles –
Oracle UCM using SQL Server
Host Server: Name of SQL database server hosting Oracle UCM database.
Name of Oracle UCM database:
Port: Port number used by SQL server
Option to use Integrated Security. It selected the PMA service account (i.e. the account it runs under will be used to access SQL. If not selected, then required to specify details username and password of a SQL login account with access.
SQL Schema: e.g. dbo
Oracle UCM using Oracle Database
Host Database Server: Name of Oracle database server hosting Oracle UCM database.
Port: Port used by Oracle database server
Whether to use SID or Service Name
SID/Service Name:
Username & Password- Details of account with access to Oracle UCM database.
OCS Schema:
3.2.13. Adding Source Connection - Meridio
Once select Meridio option in Source System dropdown, it will show following fields to add details related to it. CPS support migrations from Meridio that use Microsoft SQL as their underlying database.
- Name: Name of connection, to uniquely identify the connection within the workspace.
- Server Name: Name of the database instance hosting the Meridio database. Proventeq Migration Accelerator staging database and Meridio database should be hosted on the same SQL Server instance. e.g. DBServer\Instance.
- Toggle button to use Integrated Security – It toggle is ON, the CPS service account (i.e. the account it runs under) will be used to access SQL. If toggle is OFF, then required to specify details username and password of a SQL login account with access.
- Username: Username for connecting to Meridio database hosted on SQL server. The user should be an Administrator for this database.
- Password: Password for the above-mentioned user.
- Database Name: Database Name of the Meridio database hosted on SQL server.
- File Location: Full path to the folder storing the Meridio Files.
- Time zone: Dropdown to select relevant time zone in case Meridio data need conversion due to time zone difference.
3.2.14. Adding Source Connection - SharePoint Online
Comments