Assign Master Profile and Custom Profile Permissions to User Profiles

You can define Master Profile and custom profile permissions for user profiles that allow the users to access the following X-Author Contracts features:

Contracts tab
Templates tab
Check-in as final
Check-in without redlines
Check-in with redlines
Unprotect document
Unlock read-only clause
Open and Open and Update option
Disable Auto check out option
Retain document name
Enable Create PDF/A option at check-in

Tip: Irrespective of the user profile permissions, any user can check-in a document with redlines using X-Author for Contracts Advanced.

You need to perform one of the following actions for all the user profiles in your org to permit users to access X-Author Contracts features:

Define the APTS_ProfilePermissions Master Profile permissions and any custom permissions.
Assign custom permissions to a user profile and enable the View Setup & Configuration permission.

The following conditions apply when a user accesses the X-Author Contracts features:

Any user profile not assigned with custom permissions will use the permissions set in the Master Profile.
If a user profile is assigned a custom permission, the system will give priority to the custom permission.
- If a permission is missing for your custom permission, the system will check for and use the permission in the Master Profile. For example, if xa_displaycheckincreatepdfa is missing from your custom permission, but is set to false in your Master Profile, the system will not all the user to access that feature.

Note: If a permission is missing from both the Master Profile and a custom profile, users will encounter an error. All permissions in the sample code below must be included. If you don't want users to access a feature, set the permission to false.

Profile Permission Priority


If APTS_ProfilePermissions custom permissions are assigned to a specific Profile in the ADMIN tab	If APTS_ProfilePermissions are available for the Master Profile in the ADMIN tab	Result
Present	Present	The user has access to the custom permissions assigned to their specific profile.
Not Present	Present	The user has access to the permissions assigned in the Master Profile.
Not Present	Not Present	The user receives an error.
Present	Not Present	The user has access to the custom permissions assigned to their specific profile.

Configuring APTS_ProfilePermissions Master Profile and Custom Profile Permissions

APTS_ProfilePermissions allows you to define Master Profile and custom permissions for user profiles.

To configure APTS_ProfilePermissions Master Profile and Custom Profile Permissions

Navigate to Admin tab.
Click New.
Enter APTS_ProfilePermissions in the Name field.
Enter JSON in the Value field.

In the Code field, you must define the following parameters.

Master Profile Parameters:


Name	Type	Description
id	ID	MasterProfile
name	string	Master Profile
Permission	string	The X-Author Contracts Advanced feature name.
Value	boolean	Indicates whether the user profile has the feature access.

Master Profile Code

{
	"profiles": [
		{
			"id": "MasterProfile",
			"name": "Master Profile",
			"permission": {
				"xa_contracts": "<value>",
				"xa_template": "<value>",
				"xa_checkinasfinal": "<value>",
				"xa_checkinwithredlines": "<value>",
				"xa_checkinwithoutredlines": "<value>",
				"xa_unlockreadonlyclause": "<value>",
				"xa_unprotectdocument": "<value>",
				"xa_hidecheckoutmenu": "<value>",
				"xa_disableautocheckout": "<value>",
				"xa_displaycheckinretaindocumentname": "<value>",
				"xa_displaycheckincreatepdfa": "<value>"
			}
		}
	]
}

Custom Profile Parameters:


Name	Type	Description
id	ID	The id of a user profile.
name	string	The name of a user profile.
Permission	string	The X-Author Contracts Advanced feature name.
Value	boolean	Indicates whether the user profile has the feature access.

Custom Profile Code

{
	"profiles": [
		{
			"id": "<UserProfileID>",
			"name": "<UserProfileName>",
			"permission": {
				"xa_contracts": "<value>",
				"xa_template": "<value>",
				"xa_checkinasfinal": "<value>",
				"xa_checkinwithredlines": "<value>",
				"xa_checkinwithoutredlines": "<value>",
				"xa_unlockreadonlyclause": "<value>",
				"xa_unprotectdocument": "<value>",
				"xa_hidecheckoutmenu": "<value>",
				"xa_disableautocheckout": "<value>",
				"xa_displaycheckinretaindocumentname": "<value>",
				"xa_displaycheckincreatepdfa": <"value">
			}
		}
	]
}

Sample

{
	"profiles": [
		{
			"id": "MasterProfile",
			"name": "Master Profile",
			"permission": {
				"xa_contracts": "true",
				"xa_template": "true",
				"xa_checkinasfinal": "true",
				"xa_checkinwithredlines": "false",
				"xa_checkinwithoutredlines": "true",
				"xa_unlockreadonlyclause": "true",
				"xa_unprotectdocument": "true",
				"xa_hidecheckoutmenu": "false",
				"xa_disableautocheckout": "false",
				"xa_displaycheckinretaindocumentname": "true",
				"xa_displaycheckincreatepdfa": "false"
			}
		}
	],
	"profiles": [
		{
			"id": "00eW0000000EKg8",
			"name": "System Administrator",
			"permission": {
				"xa_contracts": "true",
				"xa_template": "false",
				"xa_checkinasfinal": "true",
				"xa_checkinwithredlines": "false",
				"xa_checkinwithoutredlines": "true",
				"xa_unlockreadonlyclause": "true",
				"xa_unprotectdocument": "true",
				"xa_hidecheckoutmenu": "false",
				"xa_disableautocheckout": "true",
				"xa_displaycheckinretaindocumentname": "true",
				"xa_displaycheckincreatepdfa": "false"
			}
		},
		{
			"id": "00eA0000000nWXj",
			"name": "Custom Sys Admin",
			"permission": {
				"xa_contracts": "true",
				"xa_template": "true",
				"xa_checkinasfinal": "true",
				"xa_checkinwithredlines": "true",
				"xa_checkinwithoutredlines": "true",
				"xa_unlockreadonlyclause": "true",
				"xa_unprotectdocument": "true",
				"xa_hidecheckoutmenu": "false",
				"xa_disableautocheckout": "true",
				"xa_displaycheckinretaindocumentname": "true",
				"xa_displaycheckincreatepdfa": "false"
			}
		}
	]
}

Tip: If the Code field has multiple entries for the same user profile, the first entry is used for feature access.

Configuring View Setup & Configuration Permission

For information on how to configure View Setup & Configuration permission, see Profile Settings and Security.

Configuration Priority

The following table provides the details about which configuration is given priority.


APTS_ProfilePermissions	Custom Permissions	View Setup & Configuration	User Access
Yes	Yes	Not applicable	User is able to access the features according to the APTS_ProfilePermissions configuration.
Yes	No	Not applicable	User is able to access the features according to the APTS_ProfilePermissions configuration.
No	No	Not applicable	User is unable to access the features.
No	Yes	Yes	User is able to access the features according to the custom permission.
No	Yes	No	User is unable to access the features.

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Assign Master Profile and Custom Profile Permissions to User Profiles

Profile Permission Priority

Configuring APTS_ProfilePermissions Master Profile and Custom Profile Permissions

Configuring View Setup & Configuration Permission

Configuration Priority

Footer Section

Explore