imported>Aeric |
imported>Aeric |
| Line 33: |
Line 33: |
| :* When a tenant is deleted and if the Root Folder Id is set in the configuration, then the given root folder and its contents are removed from CMS. | | :* When a tenant is deleted and if the Root Folder Id is set in the configuration, then the given root folder and its contents are removed from CMS. |
| :* If root folder Id is not specified then the files are not deleted when deleting tenant. This approach is used to not accidentally delete the files in case if the default repository root folder is used for many tenants. | | :* If root folder Id is not specified then the files are not deleted when deleting tenant. This approach is used to not accidentally delete the files in case if the default repository root folder is used for many tenants. |
|
| |
| ===Effect on User Profiles===
| |
| When a user has an entry in an LDAP directory, most of their profile information is maintained in the LDAP server. The platform reads that information from the server. It can no longer be modified in the platform. The exception is profile information that is specific to the platform.
| |
|
| |
| In particular:
| |
| :* In the initial dialog a user sees when they log in, the '''Reset Password''' option is disabled.
| |
| :* In the user's [[Personal Settings]] page, only the user's [[Team]] affiliation and default [[Application]] can be modified. Other settings can be viewed, but not changed.
| |
| :* In the admin's [[Access Management]] > [[Users]] page:
| |
| ::* The option to [[Users#Reset a User Password|Reset Password]] is disabled for LDAP users.
| |
| ::* The user's [[Team]] affiliation and default [[Application]] can be modified. Other settings can be viewed, but not changed.
| |
|
| |
| ===LDAP Address Expressions===
| |
| In its simplest form, LDAP can be thought of as a hierarchy of directories, each of which contains entries for users and other entities. But instead of using a URL to address those directories, you use a combination of syntax elements.
| |
|
| |
| For example, consider the URL <tt><nowiki>http://yourCompany.com/united_states/california/users/yourLDAPdata</nowiki></tt>.
| |
| <br>That path is specified in LDAP elements using the elements below:
| |
|
| |
| :*'''DC (Domain Controller)''' Used to specify the LDAP domain.
| |
| ::: For example: <tt>DC=yourCompany, DC=com</tt>, which corresponds to <tt>yourCompany.com</tt> in the URL.
| |
|
| |
| :*'''OU (Organizational Unit)''' A group that can contain other groups. (Effectively, an "intermediate" group.)
| |
| ::: For example: <tt>OU=california, OU=united_states</tt>, which corresponds to the URL path <tt>/united_states/california</tt>.
| |
|
| |
| :*'''CN (Common Name)''' A group that can contain individual entries, but which cannot contain subgroups.
| |
| ::: For example: <tt>CN=users</tt>, which corresponds to the final directory in the URL.
| |
| ::: Within that directory, the entry <tt>yourLDAPdata</tt> can be found.
| |
|
| |
| ===Considerations and Limitations===
| |
| :* '''Active Directory''' is currently supported.
| |
| :* A single LDAP server is supported, for now.
| |
| :* The search for a matching user does not yet span multiple groups, so a <tt>CN</tt> entry must be included either in the specification of the search directory, in the user or group directory designation, or in one of their filters. The search path cannot terminate at an Organizational Unit (<tt>OU</tt>) directory, as that would require searching the multiple subdirectories it contains.
| |
| :* The user's Team cannot currently be configured using LDAP attributes. The default team is always used for a new user.<br>(The team setting can be changed in the platform after the user logs in.)
| |
| :* Similarly, to give a user access to multiple applications, or to change the user's initial application modify the [[Application Access]] settings after the user has logged in to the platform.
| |
|
| |
| ==Working with LDAP ==
| |
|
| |
| ===Configuring LDAP ===
| |
| # Examine the configuration settings below to see which individual-user attributes can be populated from LDAP.
| |
| # If desired, create attributes for those settings in your LDAP server.
| |
| #: (If all users will have the same settings, this step is not necessary. They'll use the default settings you configure below.)
| |
| # Go to '''[[File:GearIcon.png]] > Administration > Account Management > LDAP Configuration'''
| |
| # Fill in the configuration settings
| |
| # Click '''[Save]'''
| |
|
| |
| ===Configuration Settings===
| |
|
| |
| :*'''Server Type -''' The type of LDAP server. '''Active Directory''' is the default.
| |
| :*'''Server URL -''' The server domain and optional portal. Secure portal #636 is the default.
| |
| ::: For example: <tt>our.LDAPserver:998</tt>
| |
|
| |
| ::<hr width="500">
| |
| :* '''Login DN -''' The ''Distinguished Name'' of a user that has admin privileges.
| |
| :* '''Password -''' The admin user's password.
| |
|
| |
| ::<hr width="500">
| |
| :* '''Starting Search Directory'''
| |
| ::: A comma-separated list of <tt>DC</tt> and <tt>OU</tt> expressions that leads to the start of the search path.
| |
| ::: Optionally, include a <tt>CN</tt> directive as well, to completely specify the directory to be searched.
| |
|
| |
| ::<hr width="500">
| |
| :* '''User DN -''' Optional. An LDAP expression that designates a path to an LDAP user directory, starting from the initial directory.
| |
| :* '''User DN Filter -''' Optional. An expression that limits the LDAP entries that will be examined.
| |
| ::: For example, use a setting like this one to exclude disabled users: <tt>!(userAccountControl=514)</tt>
| |
| ::: '''Note:''' The <tt>(objectCategory=person)</tt> and <tt>(objectClass=user)</tt> parameters do not need to be specified. They are included automatically.
| |
| ::<hr width="500">
| |
| :* '''Group DN -''' Optional. An LDAP expression that designates a path to an LDAP "group" (distribution list) directory, starting from the initial directory.
| |
| :* '''Group DN Filter -''' Optional. An expression that limits the LDAP entries that will be examined.
| |
| ::: For example, use a setting like this to exclude entries that include the word "test": <tt>!(mail=*test*)</tt>
| |
| ::: '''Note:''' The <tt>(objectCategory=group)</tt> parameter does not need to be specified. It is included automatically.
| |
|
| |
| ::<hr width="500">
| |
| {{:Common:SAML_LDAP_Settings}}
| |
| <noinclude>
| |
|
| |
| [[Category:Installable Version]]
| |
| </noinclude>
| |
|
| |
|
| |
|
| |
|
| |
| Overview
| |
| Ability to connect to an external Content Management System for document storage for File Fields and Image Fields of AgileApps Live.
| |
| Please Note: This functionality is highly recommended to use only in new tenants after 10.6 upgrade. Enabling it in existing tenants (before 10.6) will make the File and Image fields usage unavailable.
| |
| Configuration
| |
| Configuration to Content Management System can be set by users with 'Manage Company Capabilities' enabled in their access profile.
| |
| Configuration can be set by clicking on the Gear icon --> Administration --> Account Management --> External Document Storage
| |
| Following fields are available for providing connection and authentication information to CMS
| |
| Enabled (Checkbox to enable External Document Storage)
| |
| AtomPub URL (e.g., Alfresco AtomPub URL is http://{host}:{port}/alfresco/cmisatom)
| |
| Username
| |
| Password
| |
| Repository Id
| |
| Root Folder Id
| |
| If External Document Storage is enabled, URL, Username, Password and Repository Id are required fields. Root Folder Id is not a required field and if dedicated root folder is not provided for this tenant, Repository's root folder will be used to store the documents.
| |
| Functionality
| |
| After the configuration has been set, files and images uploaded to the File Fields and Image Fields are stored in the CMS. The path used to store the documents is in the format {objectId}/{recordId}/{fieldTableColumn}/FileName under the root folder.
| |
| Clicking on file field and image field values in the record page, downloads the files from CMS server and shows it to the user.
| |
| Files from CMS are deleted when
| |
| a file/image is removed from the AAL record by editing the record and removing it
| |
| an object record with file/image fields is deleted forever from Recycle Bin.
| |
| a file or image field is deleted from the Object Fields page (Customization in setup).
| |
| an object is deleted forever from Recycle Bin (Customization in setup)
| |
| When a tenant is deleted and if the Root Folder Id is set in the configuration, then the given root folder and its contents are removed from CMS.
| |
| If root folder Id is not specified then the files are not deleted when deleting tenant. This approach is used to not accidentally delete the files in case if the default repository root folder is used for many tenants.
| |
> Administration > Account Management > External Document Storage
If the enterprise has an external Content Management System (CMS), the platform can use it for Document Storage for File Fields and Image Fields of AgileApps Live.
Caveat
This functionality is highly recommended to be used by only new tenants after 10.6 upgrade. Enabling it in existing tenants created before 10.6 version will make the File and Image fields usage unavailable.
Configuration
Configuration to Content Management System can be set by users with 'Manage Company Capabilities' enabled in their access profile.
Configuration can be set by clicking on the > Administration > Account Management > External Document Storage .
Following fields are available for providing connection and authentication information to CMS
- Enabled (Checkbox to enable External Document Storage)
- AtomPub URL (e.g., Alfresco AtomPub URL is http://host:port/alfresco/cmisatom)
- Username
- Password
- Repository Id
- Root Folder Id
If External Document Storage is enabled, URL, Username, Password and Repository Id are required fields. Root Folder Id is not a required field and if dedicated root folder is not provided for this tenant, Repository's root folder will be used to store the documents.
Platform Behavior and User Experience
After the configuration has been set, files and images uploaded to the File Fields and Image Fields are stored in the CMS. The path used to store the documents is in the format {objectId}/{recordId}/{fieldTableColumn}/FileName under the root folder.
Clicking on file field and image field values in the record page, downloads the files from CMS server and shows it to the user.
Files from CMS are deleted when
- a file/image is removed from the AAL record by editing the record and removing it
- an object record with file/image fields is deleted forever from Recycle Bin.
- a file or image field is deleted from the Object Fields page (Customization in setup).
- an object is deleted forever from Recycle Bin (Customization in setup)
- When a tenant is deleted and if the Root Folder Id is set in the configuration, then the given root folder and its contents are removed from CMS.
- If root folder Id is not specified then the files are not deleted when deleting tenant. This approach is used to not accidentally delete the files in case if the default repository root folder is used for many tenants.
> Administration > Account Management > External Document Storage