Metadata API Developer’s Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Newer Version Available
Portal
The Portal metadata type represents a partner portal or Customer Portal. It extends Metadata and inherits its fullName field. To use this metadata type, you must have a partner portal or Customer Portal enabled for your organization. For more information, see “Partner Portal Overview” and “Enabling Your Customer Portal” in the Salesforce online help.
Declarative Metadata File Suffix and Directory Location
Force.com Portal components are stored in the portals directory of the corresponding package directory. The file name matches the portal name, and the extension is .portal.
Version
Force.com Portal components are available in API version 15.0 and later.
Fields
| Field | Field Type | Description |
|---|---|---|
| active | boolean | Required. Denotes whether this portal is active. |
| admin | string | The full name of the user designated to administer the portal. |
| defaultLanguage | string | The default language for HTML messages for the portal. Use the abbreviation for the language, for example, en_US for United States English. |
| description | string | The portal description. |
| emailSenderAddress | string | Required. The email address used when sending emails using templates configured from the portal (for example, for resetting the password). |
| emailSenderName | string | Required. The name to display when sending emails using templates configured from the portal (for example, for resetting the password). |
| enableSelfCloseCase | boolean | For the Customer Portal, allows portal users to close their own cases. |
| footerDocument | string | The file to be used as the footer for this portal. |
| forgotPassTemplate | string | The email template to use when a user clicks the Forgot Password link. |
| fullName | string | Required. The name of the portal. Inherited from Metadata, this field is not defined in the WSDL for this metadata type. It must be specified when creating, updating, or deleting. See create() to see an example of this field specified for a call. |
| headerDocument | string | The file to be used as the header for this portal. |
| isSelfRegistrationActivated | boolean | Determines whether self-registration is active or not for this portal. |
| loginHeaderDocument | string | The file to be used as the header for this portal's login page. |
| logoDocument | string | The file to be used as the logo for this portal. |
| logoutUrl | string | The URL that the user should be redirected to on logout. |
| newCommentTemplate | string | The email template to be used for auto-notifications on new case comments. |
| newPassTemplate | string | The email template to be used for auto-notifications on password reset. |
| newUserTemplate | string | The email template to be used for auto-notifications on new user creation. |
| ownerNotifyTemplate | string | The email template to be used for auto-notifications on owner change. |
| selfRegNewUserUrl | string | The URL of the self-registration page. |
| selfRegUserDefaultProfile | string | The default profile for self-registered users. |
| selfRegUserDefaultRole | PortalRoles (enumeration of type string) | The default role for self-registered users. The valid values
are:
|
| selfRegUserTemplate | string | The email template to be used for auto-notifications on self-registration. |
| showActionConfirmation | boolean | Determines whether or not confirmation messages are displayed for actions in the portal. |
| stylesheetDocument | string | The Document object to be used as the CSS stylesheet for this portal. |
| type | PortalType (enumeration of type string) | Required. The type for this portal. The valid values are:
|