diff --git a/docs/platgovsalesforce/changemanagement/change_and_approval_policy.md b/docs/platgovsalesforce/changemanagement/change_and_approval_policy.md index 9970fa22a1..2bcdd36773 100644 --- a/docs/platgovsalesforce/changemanagement/change_and_approval_policy.md +++ b/docs/platgovsalesforce/changemanagement/change_and_approval_policy.md @@ -25,13 +25,13 @@ process are analyzed against the policy for compliance. For example, a company may have multiple policies: -1. A **Default Policy** that applies to any customization or process without a specific policy. This +1. **Default Policy** that applies to any customization or process without a specific policy. This generally requires that scripted changes go through a relatively high level of review compared to non-scripted changes. -2. A **Controls Policy** that specifically applies to key reports and controls listed on the policy +2. **Controls Policy** that specifically applies to key reports and controls listed on the policy that need very specific approval to modify and ensures there are no changes without a proper audit review. -3. A **Custom Object Policy** to manage Custom fields and object. +3. **Custom Object Policy** to manage Custom fields and object. Once in place, policies remind users of the level of change management required as well as monitors the changes that do occur and raises alerts to IT by custom reports if there are any change diff --git a/docs/platgovsalesforce/changemanagement/change_management_overview.md b/docs/platgovsalesforce/changemanagement/change_management_overview.md index d2052c06bd..e6c4742422 100644 --- a/docs/platgovsalesforce/changemanagement/change_management_overview.md +++ b/docs/platgovsalesforce/changemanagement/change_management_overview.md @@ -42,9 +42,11 @@ The **Advanced Change Management** Module provides additional functionality: - Archive fields. - Delete customizations. +:::note Change Management can be integrated with other change tracking systems using the External Change Request Number field. It is beneficial to use the change records since they can be linked to processes, customizations and clean up activities. +::: ### Confirm with a Deployment Record diff --git a/docs/platgovsalesforce/changemanagement/change_management_reports.md b/docs/platgovsalesforce/changemanagement/change_management_reports.md index 97f973899a..2bdb4bf6e0 100644 --- a/docs/platgovsalesforce/changemanagement/change_management_reports.md +++ b/docs/platgovsalesforce/changemanagement/change_management_reports.md @@ -18,33 +18,14 @@ To access the Change Reports: Open **Netwrix Dashboard** > **Reports** > **Change Enablement** and select one of the reports: -> **Approval Override**: shows all changes approved with an approval override. -> -> **What Changed?**: shows all changes that have occurred. -> -> **Unresolved Non-Compliant Changes**: displays open non-compliant changes. A non-compliant change -> indicates something was changed without the required approvals. By looking at this report, you can -> investigate changes and get an understanding of what the impacts are and see if any additional -> changes need to be made. This report is used to track changes that require action. -> -> **Managed Package Updates**: displays managed package update details for auditing. -> -> **Resolved Non-Compliant Changes**: displays resolved non-compliant changes with the change -> overview and the difference summary. -> -> **Compliant Changes**: displays all compliant changes. Compliant changes are automatically marked -> as closed. This report is used to review changes that have been automatically cleared. -> -> **Consolidated Change By Type**: displays changes summarized and grouped by Salesforce Type. -> -> **Deployed Changes**: displays an end to end summary of deployed changes to enable tracking and -> reporting of changes to the system. -> -> **Data Tracking Change Logs**: displays changes on objects set for data tracking. -> -> **Change/Approval Policy Changes**: this report is based on Field History Tracking. You can track -> up to 20 fields from the Policy Record. Salesforce starts tracking field history from the date and -> time you turn it on a field. -> -> **Fast Scan for Permissions Changes**: displays all changes detected in PermissionSet, -> PermissionSetGroup, and Profiles by the Fast Scan. +- **Approval Override**: shows all changes approved with an approval override. +- **What Changed?**: shows all changes that have occurred. +- **Unresolved Non-Compliant Changes**: displays open non-compliant changes. A non-compliant change indicates something was changed without the required approvals. By looking at this report, you can investigate changes and get an understanding of what the impacts are and see if any additional changes need to be made. This report is used to track changes that require action. +- **Managed Package Updates**: displays managed package update details for auditing. +- **Resolved Non-Compliant Changes**: displays resolved non-compliant changes with the change overview and the difference summary. +- **Compliant Changes**: displays all compliant changes. Compliant changes are automatically marked as closed. This report is used to review changes that have been automatically cleared. +- **Consolidated Change By Type**: displays changes summarized and grouped by Salesforce Type. +- **Deployed Changes**: displays an end to end summary of deployed changes to enable tracking and reporting of changes to the system. +- **Data Tracking Change Logs**: displays changes on objects set for data tracking. +- **Change/Approval Policy Changes**: this report is based on Field History Tracking. You can track up to 20 fields from the Policy Record. Salesforce starts tracking field history from the date and time you turn it on a field. +- **Fast Scan for Permissions Changes**: displays all changes detected in PermissionSet, PermissionSetGroup, and Profiles by the Fast Scan. diff --git a/docs/platgovsalesforce/changemanagement/creating_change_request.md b/docs/platgovsalesforce/changemanagement/creating_change_request.md index 02bf4c204d..55aa4e559c 100644 --- a/docs/platgovsalesforce/changemanagement/creating_change_request.md +++ b/docs/platgovsalesforce/changemanagement/creating_change_request.md @@ -14,7 +14,9 @@ types of Change Requests to match the change you want to manage. Here are two op - **Data Record** - Change request is used for Data Changes to Revenue Cloud/ [CPQ](/docs/platgovsalesforce/changemanagement/enhanced_cpq_support.md). +:::note Data Record Change Requests are only available with an Enterprise Compliance license. +::: 1. Open the **Change Requests** tab. 2. Click **New** @@ -147,8 +149,11 @@ add additional approvers, approver notes and begin the approval process. 5. Click **Submit for Approval** to start the process. Approval notifications are sent to the approvers. +:::note If you created the Change Request in your sandbox to determine the scope of the change, recreate it -in your Production environment to enable approvals and ongoing tracking. +in your Production environment to enable approvals and ongoing tracking. +::: + For new objects that do not yet exist in Production, edit the Change Request and enter the full API Names of these objects into the Proposed Customization fields in the Scope Section. You can add multiple API Names by using the Add button. Save the Change Request when complete. diff --git a/docs/platgovsalesforce/changemanagement/documented_metadata_types.md b/docs/platgovsalesforce/changemanagement/documented_metadata_types.md index 76bef48438..026fb789f2 100644 --- a/docs/platgovsalesforce/changemanagement/documented_metadata_types.md +++ b/docs/platgovsalesforce/changemanagement/documented_metadata_types.md @@ -6,7 +6,7 @@ sidebar_position: 110 # Documented Metadata Types -You can view the documented Metadata by Type or by Category. +You can view the documented Metadata by [Type](#metadata-by-type) or by [Category](#metadata-by-category). ## Metadata by Type diff --git a/docs/platgovsalesforce/changemanagement/set_up_data_tracking.md b/docs/platgovsalesforce/changemanagement/set_up_data_tracking.md index 9d5df521d6..5c0682ec09 100644 --- a/docs/platgovsalesforce/changemanagement/set_up_data_tracking.md +++ b/docs/platgovsalesforce/changemanagement/set_up_data_tracking.md @@ -10,8 +10,10 @@ Data tracking is used for Salesforce CPQ and any sensitive data fields you want data tracking enables Platform Governance for Salesforce to track data and create change logs for any data changes. +:::note If you track an object, all changes to the object and fields are tracked. Consult with your security and audit teams to develop a list of objects before enabling data tracking. +::: ## Prerequisites diff --git a/docs/platgovsalesforce/changemanagement/setting_up_policies.md b/docs/platgovsalesforce/changemanagement/setting_up_policies.md index 8c08c06a1d..f20f65a9e1 100644 --- a/docs/platgovsalesforce/changemanagement/setting_up_policies.md +++ b/docs/platgovsalesforce/changemanagement/setting_up_policies.md @@ -17,46 +17,26 @@ You can create a New Policy, or edit an existing one: ## Details -> Information general information about the policy. -> -> Code and Data Model Changes change control level for code and data model changes. -> -> Automation Changes change control level for approval process, business process, flow, workflow and -> process builder changes. -> -> Sharing and Visibility Changes change control level for role, profile, permission set, data -> security, sharing non material and indirect changes to profile changes. -> -> Integration Changes change control level for external site, identity, and access changes. -> -> Configuration Changes change control level for data quality and general settings changes. -> -> Display and UI Changes change control level for application, label and translation, layout and -> template changes. -> -> Analytics Changes change control level for reports, dashboards, list view, and Einstein changes. -> -> Control Changes change control level for control changes. -> -> Application Configuration Changes (Data) -> -> Health Check Changes change control level for health check changes. -> -> IT Policies preliminary and final approvers. -> -> Customization Policies impacted customization approval. -> -> Management Policies executive approver and approval settings. -> -> Change Enablement Defaults merge approval list, non conforming alerts, and sequential approval -> requests. -> -> **System Information**, **Created By** and **Last Modified By** dates. Informational only, cannot -> be edited. +- **Information** general information about the policy. +- **Code and Data Model Changes** change control level for code and data model changes. +- **Automation Changes** change control level for approval process, business process, flow, workflow and process builder changes. +- **Sharing and Visibility Changes** change control level for role, profile, permission set, data security, sharing non material and indirect changes to profile changes. +- **Integration Changes** change control level for external site, identity, and access changes. +- **Configuration Changes** change control level for data quality and general settings changes. +- **Display and UI Changes** change control level for application, label and translation, layout and template changes. +- **Analytics Changes** change control level for reports, dashboards, list view, and Einstein changes. +- **Control Changes** change control level for control changes. +- **Application Configuration Changes (Data)** +- **Health Check Changes** change control level for health check changes. +- **IT Policies** preliminary and final approvers. +- **Customization Policies** impacted customization approval. +- **Management Policies** executive approver and approval settings. +- **Change Enablement Defaults** merge approval list, non conforming alerts, and sequential approval requests. +- **System Information**, **Created By** and **Last Modified By** dates. Informational only, cannot be edited. Once the policy is saved, **System Information** is added show the **Created By** and **Last Modified By** user and time stamp. The information you entered on the form is shown on the -**Details** tab. The Related tab is now available to add Customizations and view additional +**Details** tab. The Related tab is available to add Customizations and view additional information and history. ### Information @@ -72,10 +52,10 @@ Set the required Change Level for each Metadata Type. The Default is shown in th | **Change Level** | **Description** | | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Log Changes Only** | Since the system automatically logs all changes, this change level requires no actions for compliance. Any changes to these objects are automatically marked compliant. | -| **Change Request** | Any changes to these objects require an Approved Change Request. | -| **Sandbox Development & Testing** | Any changes to these objects require an Approved Change Request in the Stage Development Project. It also requires that a parent Change Request is attached to the Development Project. | -| **Full Software Development Lifecycle** | Any changes to these objects require an Approved Change Request. | +| Log Changes Only | Since the system automatically logs all changes, this change level requires no actions for compliance. Any changes to these objects are automatically marked compliant. | +| Change Request | Any changes to these objects require an Approved Change Request. | +| Sandbox Development & Testing | Any changes to these objects require an Approved Change Request in the Stage Development Project. It also requires that a parent Change Request is attached to the Development Project. | +| Full Software Development Lifecycle | Any changes to these objects require an Approved Change Request. | ### Code and Data Model Changes diff --git a/docs/platgovsalesforce/changemanagement/using_change_logs.md b/docs/platgovsalesforce/changemanagement/using_change_logs.md index e17cbb72a3..72376a03da 100644 --- a/docs/platgovsalesforce/changemanagement/using_change_logs.md +++ b/docs/platgovsalesforce/changemanagement/using_change_logs.md @@ -27,60 +27,31 @@ Here is an example change log for a **Profile** Metadata type. ## Details Tab -> **Actual Change Date**: Date the Customization was last modified. -> -> **Customization Created By**: User who created the customization. -> -> **Customization Modified By**: User who last modified the customization. -> -> **Customization**: Linked Customization(s) that have changed. -> -> **Metadata Type**: Salesforce metatdata type of the Customization. -> -> **Field Name**: Name of the changed field. -> -> **Active**: Checked if the Customization is active. -> -> **New Customization**: Checked if new customization. -> -> **Package**: Name of the Managed Package if the customizations belong to a managed package. -> -> **Operation**: Flag this field if a change or a new record is created. -> -> **Change Overview**: Overview of the change. -> -> **Data Record Id**: ID of the data record changed. This field is not in all Metadata Types. -> -> **Data Record Name**: Name of the data record changed. This field is not in all Metadata Types. -> -> **Data Record SObject API**: API name of the parent SObject of the data record changed. This field -> is not in all Metadata Types. -> -> **Related Change Request**: Change request related to the change or used to perform regression -> analysis of a non-compliant change. -> -> **Compliant Indicator**: Green flag indicates compliant, red flag indicates non-compliant. -> -> **Non-Compliant**: Checked if the change is non-compliant. -> -> **Compliance**: The change status: **Compliant** or **Non-compliant**. -> -> **Policy**: Policies associated with the Change Log. -> -> **Reason**: Name of the policy violated by the change. -> -> **Filters**: List of filters satisfied for the data record change. If blank, no filters specified. -> This field is not in all Metadata Types. -> -> **Parent Change Log**: Name of the parent change log if applicable. -> -> **Resolution Description**: Description of any steps taken to bring the change back into -> compliance. This field is not in all Metadata Types. -> -> **Short Resolution Description**: Summary description of any steps taken to bring the change back -> into compliance. -> -> **Status**: Current state of the Change Log. This field is manually set. +- **Actual Change Date**: Date the Customization was last modified. +- **Customization Created By**: User who created the customization. +- **Customization Modified By**: User who last modified the customization. +- **Customization**: Linked Customization(s) that have changed. +- **Metadata Type**: Salesforce metadata type of the Customization. +- **Field Name**: Name of the changed field. +- **Active**: Checked if the Customization is active. +- **New Customization**: Checked if new customization. +- **Package**: Name of the Managed Package if the customizations belong to a managed package. +- **Operation**: Flag this field if a change or a new record is created. +- **Change Overview**: Overview of the change. +- **Data Record Id**: ID of the data record changed. This field is not in all Metadata Types. +- **Data Record Name**: Name of the data record changed. This field is not in all Metadata Types. +- **Data Record SObject API**: API name of the parent SObject of the data record changed. This field is not in all Metadata Types. +- **Related Change Request**: Change request related to the change or used to perform regression analysis of a non-compliant change. +- **Compliant Indicator**: Green flag indicates compliant, red flag indicates non-compliant. +- **Non-Compliant**: Checked if the change is non-compliant. +- **Compliance**: The change status: **Compliant** or **Non-compliant**. +- **Policy**: Policies associated with the Change Log. +- **Reason**: Name of the policy violated by the change. +- **Filters**: List of filters satisfied for the data record change. If blank, no filters specified. This field is not in all Metadata Types. +- **Parent Change Log**: Name of the parent change log if applicable. +- **Resolution Description**: Description of any steps taken to bring the change back into compliance. This field is not in all Metadata Types. +- **Short Resolution Description**: Summary description of any steps taken to bring the change back into compliance. +- **Status**: Current state of the Change Log. This field is manually set. ### Diff Summary @@ -107,21 +78,14 @@ The **Created By** and **Last Modified By** users and dates are displayed at the The **Audit** section displays all fields related to an audit. Click the edit icon to edit the record. -> **Sampled For Audit**: Select **None**, **Internal** or **External**. -> -> **Audited By**: Auditor selects their user name from the list. -> -> **Internal Audit Comments**: Internal notes added by the Auditor. -> -> **Internal Audit Status**: Select **None**, **Approved**, **Rejected** or **Under Investigation**. -> -> **Last Internal Audit**: User who made the last change in the Internal Audit fields. -> -> **External Audit Comments**: External notes added by the Auditor. -> -> **External Audit Status**: Select **None**, **Approved**, **Rejected** or **Under Investigation**. -> -> **Last External Audit**: User who made the last change in the External Audit fields. +- **Sampled For Audit**: Select **None**, **Internal** or **External**. +- **Audited By**: Auditor selects their user name from the list. +- **Internal Audit Comments**: Internal notes added by the Auditor. +- **Internal Audit Status**: Select **None**, **Approved**, **Rejected** or **Under Investigation**. +- **Last Internal Audit**: User who made the last change in the Internal Audit fields. +- **External Audit Comments**: External notes added by the Auditor. +- **External Audit Status**: Select **None**, **Approved**, **Rejected** or **Under Investigation**. +- **Last External Audit**: User who made the last change in the External Audit fields. ## Related Tab diff --git a/docs/platgovsalesforce/cleanup/cleanup_customizations.md b/docs/platgovsalesforce/cleanup/cleanup_customizations.md index 9be5ed7900..6aba524c05 100644 --- a/docs/platgovsalesforce/cleanup/cleanup_customizations.md +++ b/docs/platgovsalesforce/cleanup/cleanup_customizations.md @@ -53,9 +53,9 @@ Use these processes to Clean up Individual Customization or Clean Up Multiple Cu 6. Restrict Visibility. You can choose to have the list view: -- Only visible to you, -- Visible to all users or -- Visible to certain groups of users. + - Only visible to you, + - Visible to all users or + - Visible to certain groups of users. 7. Click **Save**. 8. Once your list view has been created, you can multi-select customizations for clean up by diff --git a/docs/platgovsalesforce/cleanup/cleanup_overview.md b/docs/platgovsalesforce/cleanup/cleanup_overview.md index 8172c99b22..f993f0543a 100644 --- a/docs/platgovsalesforce/cleanup/cleanup_overview.md +++ b/docs/platgovsalesforce/cleanup/cleanup_overview.md @@ -10,8 +10,8 @@ Clean up involves some or all of the following steps: 1. Identify and remove unused customizations (either individual or multiple): -- Completely unused -- Useless or inefficient + - Completely unused + - Useless or inefficient 2. Identify and fix improperly set-up customizations (eg. no help text, inactive owner). 3. Describe each object and its clean up task (under the improvements tab.) @@ -29,8 +29,10 @@ same steps: 4. Manage the clean up as appropriate 5. Run the scanner +:::note Always check the Last Date Scanned on any object and re-scan that object if necessary to ensure the information about that object is up to date. +::: ### Select the Approach @@ -55,9 +57,11 @@ Strongpoint homepage under Strongpoint Features and Reports. You can clean up individual or multiple customizations by going to the Customization tab and selecting **Create New View**. Use the filters to generate your list. +:::note Before moving on to other clean up activities, it is often a good idea to delete unused customizations that are highly likely safe to delete, such as fields that have not been used in years or that are not used by any other customization. +::: ### Analyze and Organize the Results diff --git a/docs/platgovsalesforce/cleanup/date_last_used.md b/docs/platgovsalesforce/cleanup/date_last_used.md index ca0100c64d..211ccb8845 100644 --- a/docs/platgovsalesforce/cleanup/date_last_used.md +++ b/docs/platgovsalesforce/cleanup/date_last_used.md @@ -11,15 +11,11 @@ last date the Customization, or the data it contains, was created, changed, acce used.The DLU value indicates that the customization was used at least as late as the DLU. It does not indicate if it was used earlier. If DLU is blank, it indicates there in no verified date. -> DLU CustomField Details -> -> Setting the DLU Expiration -> -> DLU Metadata Types -> -> Excluded Metadata Extended Types -> -> DLU Scheduler +- DLU CustomField Details +- Setting the DLU Expiration +- DLU Metadata Types +- Excluded Metadata Extended Types +- DLU Scheduler ## DLU CustomField Details @@ -29,7 +25,9 @@ make better decisions about the value of maintaining specific CustomFields. Usag - how often the field has data (_frequency_) - how recently the field has been used (_recency_) +:::note DLU analysis should only be performed in Production orgs. Sandbox orgs do not reflect actual usage. +::: **Usage data fields:** @@ -46,16 +44,15 @@ DLU analysis should only be performed in Production orgs. Sandbox orgs do not re the CustomField populated. This provides usage recency information when Field History Tracking is disabled. **CreatedDate** is more accurate for the CustomField than the **LastModifiedDate** for the record. -- **DLU Status** displays the current status: - | DLU Status | DLU | Field History Tracking | Date DLU Analyzed | Parent Last Update Date | | --- - | --- | --- | --- | --- | | Unavailable | Blank | Never enabled for this field. | Blank | - Populated | | Pending | Blank | Enabled. Waiting for the scanner to run. | Blank | Populated | | - Current | Populated | Enabled. DLU is current and accurate using automated nightly scans. | Today - | Blank | | Recent | Populated, May be stale | Disabled. Last scan when enabled was within the - past three months. Three months is the default time period. See Setting the DLU Expiration. | - Within set time period | Populated | | Expired | Populated, May be stale | Disabled. Last scan - when enabled was longer than three months ago. Three months is the default time period. See - Setting the DLU Expiration. | Older than set time period | Populated | +- **DLU Status** displays the current status: + + | DLU Status | DLU | Field History Tracking | Date DLU Analyzed | Parent Last Update Date | + | --- | --- | --- | --- | --- | + | Unavailable | Blank | Never enabled for this field. | Blank | Populated | + | Pending | Blank | Enabled. Waiting for the scanner to run. | Blank | Populated | + | Current | Populated | Enabled. DLU is current and accurate using automated nightly scans. | Today | Blank | + | Recent | Populated, May be stale | Disabled. Last scan when enabled was within the past three months. Three months is the default time period. See [Setting the DLU Expiration](#setting-the-dluexpiration). | Within set time period | Populated | + | Expired | Populated, May be stale | Disabled. Last scan when enabled was longer than three months ago. Three months is the default time period. See [Setting the DLU Expiration](#setting-the-dluexpiration). | Older than set time period | Populated | If **Field History Tracking** is enabled for a CustomField with a **DLU Status** of either **Recent** or **Expired**, the status is changed to **Pending**. Here is an example: @@ -67,7 +64,7 @@ If **Field History Tracking** is enabled for a CustomField with a **DLU Status* - When Field History Tracking is enabled, the **DLU** is accurate, and the **Parent Last Update Date** is blank. - If Field History Tracking has never been enabled, only **Parent Last Update Date** has a value. - Use **Parent Last Update Date**and **% Populated** together to get a sense of the usage. + Use **Parent Last Update Date** and **% Populated** together to get a sense of the usage. - If Field History Tracking was enabled and later disabled, there are values in **DLU** and **Parent Last Update Date**. Generally, you would use the most recent of the two together with **% Populated** to get a sense of usage. If **DLU Status** is Expired, it is probably safe to ignore @@ -104,59 +101,59 @@ DLU can be used for the following metadata types: | Salesforce Family Types & Joins | Metadata Types | DLU | | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | Workflow | Workflow Rule | Date workflow rule was last run. | -| Workflow Approva lProcess Flow Validation Rule | Last date base record updated, if enabled | | -| Scripts | Apex Class**\*** Apex Trigger**\*** Apex Component**\*** Lightning Component Lightning Web Component | The last date the code was triggered by any script based on the log of the last time it was run. | -| Forms | Layout Compact Layout | If assigned to a profile, it is the date the last record that belongs to the layout was updated . | -| Apex Page**\*** | The last date the page was accessed (the code was triggered). | | +| | Workflow
Approval Process
Flow
Validation Rule | Last date base record updated, if enabled | | +| Scripts | Apex Class\*
Apex Trigger\*
Apex Component\*
Lightning Component
Lightning Web Component | The last date the code was triggered by any script based on the log of the last time it was run. | +| Forms | Layout
Compact Layout | If assigned to a profile, it is the date the last record that belongs to the layout was updated . | +| | Apex Page\* | The last date the page was accessed (the code was triggered). | | | Reports | Report | Last date report was run. | -| Dashboard | Last date dashboard report was run. | | -| Report Type | Last date report using the report type was run. | | -| Analytic Snapshot | Last date a dashboard it is on or dependent script was run. | | -| List View | Last date the List View was accessed. | | +| | Dashboard | Last date dashboard report was run. | | +| | Report Type | Last date report using the report type was run. | | +| | Analytic Snapshot | Last date a dashboard it is on or dependent script was run. | | +| | List View | Last date the List View was accessed. | | | Data Sources | Standard Field | Last date the value changed. | -| Standard Object Custom Object | Last date a record was saved. | | -| Custom Field | Last date the value changed or if formula field, the maximum last date of the fields in the formula. | | +| | Standard Object
Custom Object | Last date a record was saved. | | +| | Custom Field | Last date the value changed or if formula field, the maximum last date of the fields in the formula. | | | Dependent Fields | Custom Field Lookup | Minimum of the DLU of the record it exists on and the DLU of the source field. | | Profiles and Roles | User | Last login by the user. | -| Role | Calculated based on the last time someone logged in with that role. | | -| Profile | Calculated based on the last time someone logged in with that profile. | | -| Permission Set | Calculated based on the last time someone logged in with that permission set. | | +| | Role | Calculated based on the last time someone logged in with that role. | | +| | Profile | Calculated based on the last time someone logged in with that profile. | | +| | Permission Set | Calculated based on the last time someone logged in with that permission set. | | | Package | Text that displays the name of the package | Maximum DLU of object in the package. | | Extended Types (Other) | App Menu | DLU of the parent Custom Application. | -| Assignment Rules | Date rule was last run. | | -| Auto Response Rules | Date Auto Response rule was last run. | | -| Call Center | | | -| Connected App | Date App was last run. | | -| Custom Application | Maximum DLU of customizations belonging to the application. | | -| Criteria Based Sharing Rule | Maximum of related Sharing Rules. | | -| Custom Application Component | Maximum DLU from parent applications. | | -| Custom Label | Maximum DLU of related field. | | -| Custom Metadata | Date modified of the object that has the value in the metadata. | | -| Custom Object Translation | DLU of the parent object. | | -| Custom Page Web Link | DLU of the APEX page. | | -| Custom Permission | DLU of a profile that has the custom permission. | | -| Custom Tab | DLU of the parent Custom Application. | | -| Document | Last time the file was opened or accessed by the system. | | -| Email Template | Date Template was last used to send emails. | | -| Escalation Rules | Date rule was last run. | | -| Field Set | Last date a field value changed. | | -| Flow Definition | Date flow last accessed. | | -| Global Picklist | Maximum DLU of fields that use the picklist. | | -| Group | Last time someone from the group accessed the system (always employees). | | -| Installed Package | Maximum DLU of component of the package | | -| Letterhead | Last date template accessed. | | -| Matching Rule | Date rule was last run. | | -| Post Template | Date Template was last used to send emails. | | -| Queue | Maximum DLU of code / workflow run on the Queue. | | -| Record Type | Maximum DLU of fields that use the record type. | | -| Sharing Rules | Date rule was last run. | | -| Static Resource | Max of last access date (document) or DLU code referencing it. | | -| Synonym Dictionary | Maximum DLU of related fields. | | -| Territory2 | Date Territory2 rule was last run. | | -| Territory2 Model | Date Territory2 rule was last run. | | -| Territory2 Rule | Date rule was last run. | | -| Territory2 Type | Date Territory2 rule was last run. | | -| Translations | Maximum DLU of related fields. | | +| | Assignment Rules | Date rule was last run. | | +| | Auto Response Rules | Date Auto Response rule was last run. | | +| | Call Center | | | +| | Connected App | Date App was last run. | | +| | Custom Application | Maximum DLU of customizations belonging to the application. | | +| | Criteria Based Sharing Rule | Maximum of related Sharing Rules. | | +| | Custom Application Component | Maximum DLU from parent applications. | | +| | Custom Label | Maximum DLU of related field. | | +| | Custom Metadata | Date modified of the object that has the value in the metadata. | | +| | Custom Object Translation | DLU of the parent object. | | +| | Custom Page Web Link | DLU of the APEX page. | | +| | Custom Permission | DLU of a profile that has the custom permission. | | +| | Custom Tab | DLU of the parent Custom Application. | | +| | Document | Last time the file was opened or accessed by the system. | | +| | Email Template | Date Template was last used to send emails. | | +| | Escalation Rules | Date rule was last run. | | +| | Field Set | Last date a field value changed. | | +| | Flow Definition | Date flow last accessed. | | +| | Global Picklist | Maximum DLU of fields that use the picklist. | | +| | Group | Last time someone from the group accessed the system (always employees). | | +| | Installed Package | Maximum DLU of component of the package | | +| | Letterhead | Last date template accessed. | | +| | Matching Rule | Date rule was last run. | | +| | Post Template | Date Template was last used to send emails. | | +| | Queue | Maximum DLU of code / workflow run on the Queue. | | +| | Record Type | Maximum DLU of fields that use the record type. | | +| | Sharing Rules | Date rule was last run. | | +| | Static Resource | Max of last access date (document) or DLU code referencing it. | | +| | Synonym Dictionary | Maximum DLU of related fields. | | +| | Territory2 | Date Territory2 rule was last run. | | +| | Territory2 Model | Date Territory2 rule was last run. | | +| | Territory2 Rule | Date rule was last run. | | +| | Territory2 Type | Date Territory2 rule was last run. | | +| | Translations | Maximum DLU of related fields. | | ## Excluded Metadata Extended Types diff --git a/docs/platgovsalesforce/customizations/old_customization_record.md b/docs/platgovsalesforce/customizations/old_customization_record.md index 07c9f1dc24..358f930e0d 100644 --- a/docs/platgovsalesforce/customizations/old_customization_record.md +++ b/docs/platgovsalesforce/customizations/old_customization_record.md @@ -39,23 +39,15 @@ Customization record fields include: These are the tabs inside a customization record: -> Metadata -> -> Improvement -> -> Permissions -> -> Health Settings -> -> Data Classification -> -> Control -> -> DRD -> -> Raw Data -> -> Related Lists +- Metadata +- Improvement +- Permissions +- Health Settings +- Data Classification +- Control +- DRD +- Raw Data +- Related Lists ### Metadata diff --git a/docs/platgovsalesforce/customizations/understanding_customization_record.md b/docs/platgovsalesforce/customizations/understanding_customization_record.md index 17fb3fa68e..f0716e97f9 100644 --- a/docs/platgovsalesforce/customizations/understanding_customization_record.md +++ b/docs/platgovsalesforce/customizations/understanding_customization_record.md @@ -38,17 +38,12 @@ Customization record fields include: These are the tabs inside a customization record: -> Metadata -> -> Custom -> -> DRD -> -> Change Enablement -> -> Clean Up -> -> Related Lists +- Metadata +- Custom +- DRD +- Change Enablement +- Clean Up +- Related Lists ### Metadata @@ -85,20 +80,19 @@ customizations and their relationships and dependencies. The Change Enablement tab accesses the policy and data tacking settings, and the add to change request feature. -- **Change/Approval Policy**: This field designates the approval policy related to a customization. +- **Change/Approval Policy**: designates the approval policy related to a customization. - **Add to Change Request**: Lookup tool to associate the clean up to an existing change request. -- Data Change Tracking: tracking status. - **Not Tracked**: changes in data records are not tracked. - **Tracked, Blocking**: changes in data records are blocked if there is no approved Change - Request. - **Tracked, Non-Blocking**: changes in data records are logged. +- **Data Change Tracking**: tracking status. + - **Not Tracked**: changes in data records are not tracked. + - **Tracked, Blocking**: changes in data records are blocked if there is no approved Change Request. + - **Tracked, Non-Blocking**: changes in data records are logged. ### Clean Up The Clean Up tab provides information customization clean up: -- **Clean Up Status**: This is the clean-up status of customizations that are to be deleted. -- **Clean-up Classification**: This field shows an overview of the clean-up classification. +- **Clean Up Status**: clean-up status of customizations that are to be deleted. +- **Clean-up Classification**: overview of the clean-up classification. ### Related Lists diff --git a/docs/platgovsalesforce/faq.md b/docs/platgovsalesforce/faq.md index 7faf3fd37c..c06d9aa663 100644 --- a/docs/platgovsalesforce/faq.md +++ b/docs/platgovsalesforce/faq.md @@ -10,16 +10,11 @@ Platform Governance for Salesforce is a stress-free change management and compli NetSuite and Salesforce. It helps companies manage change in their systems, enabling them to drive growth with confidence and certainty. Here are answer to Frequently Asked Questions: -> Can Platform Governance for Salesforce provide a SOC1 Report? -> -> Can I install Platform Governance for Salesforce in the Sandbox or Release Preview? -> -> Is our private data being transmitted or shared in any way? -> -> What is the time or effort required to use Platform Governance for Salesforce? -> -> Who needs a Platform Governance for Salesforce License? What is the difference between an editor -> and a viewer? +- Can Platform Governance for Salesforce provide a SOC1 Report? +- Can I install Platform Governance for Salesforce in the Sandbox or Release Preview? +- Is our private data being transmitted or shared in any way? +- What is the time or effort required to use Platform Governance for Salesforce? +- Who needs a Platform Governance for Salesforce License? What is the difference between an editor and a viewer? #### Can Platform Governance for Salesforce provide a SOC1 Report? diff --git a/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md b/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md index 0879f29787..db1ff3fdf5 100644 --- a/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md +++ b/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md @@ -20,19 +20,15 @@ The **License Type** displays your current license. The report is divided into multiple tabs: -> Scanner Status -> -> > Documentation Stats -> > -> > Scanner Logs -> > -> > Scanner Additional Information -> > -> > Change Log Creation (sandbox option) -> -> Jira Configuration -> -> Orgs Credentials +- Scanner Status + - Documentation Stats + - Scanner Logs + - Scanner Additional Information + - Change Log Creation (sandbox option) +- Jira Configuration + - Credentials + - Status Mapping +- Orgs Credentials ## Scanner Status diff --git a/docs/platgovsalesforce/installingstrongpoint/features_by_license_type.md b/docs/platgovsalesforce/installingstrongpoint/features_by_license_type.md index 328bc70ca2..c4ca4919d9 100644 --- a/docs/platgovsalesforce/installingstrongpoint/features_by_license_type.md +++ b/docs/platgovsalesforce/installingstrongpoint/features_by_license_type.md @@ -8,27 +8,25 @@ sidebar_position: 80 Platform Governance for Salesforce offers three license types: -> Automated Documentation -> -> Intelligent Change Enablement -> -> Enterprise Compliance +- Automated Documentation +- Intelligent Change Enablement +- Enterprise Compliance This table summarizes what is included in each type. | Feature | Automated Documentation | Intelligent Change Enablement | Enterprise Compliance | -| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| Customization, Scanners and DRD | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | -| Field-Level Scanner | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | -| Clean Up: Reports, and Scheduler, Processes, DLU | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | -| Profile / Permission Set Comparison | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | -| User Access Assistance | | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | -| User Activity | | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | -| Implementation, Planned Customizations, Map Customizations | | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | -| Change Request (Change Management) | | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | -| Release & Deployment (Deployment, Rollback & Sync Tool) | | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | -| Compare Environments | | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | -| Financial Controls | | | ![orangecheck](/img/product_docs/platgovsalesforce/installing_strongpoint/orangecheck.webp) | +| ---------------------------------------------------------- | :-----------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------: | +| Customization, Scanners and DRD | **✓** | **✓** | **✓** | +| Field-Level Scanner | **✓** | **✓** | **✓** | +| Clean Up: Reports, and Scheduler, Processes, DLU | **✓** | **✓** | **✓** | +| Profile / Permission Set Comparison | **✓** | **✓** | **✓** | +| User Access Assistance | | **✓** | **✓** | +| User Activity | | **✓** | **✓** | +| Implementation, Planned Customizations, Map Customizations | | **✓** | **✓** | +| Change Request (Change Management) | | **✓** | **✓** | +| Release & Deployment (Deployment, Rollback & Sync Tool) | | **✓** | **✓** | +| Compare Environments | | **✓** | **✓** | +| Financial Controls | | | **✓** | ## Automated Documentation diff --git a/docs/platgovsalesforce/installingstrongpoint/installing_strongpoint.md b/docs/platgovsalesforce/installingstrongpoint/installing_strongpoint.md index cd9591cb28..170fb707ed 100644 --- a/docs/platgovsalesforce/installingstrongpoint/installing_strongpoint.md +++ b/docs/platgovsalesforce/installingstrongpoint/installing_strongpoint.md @@ -15,25 +15,29 @@ customer success team. To install: 3. Click **Install** ![install1](/img/product_docs/platgovsalesforce/installing_strongpoint/install1.webp) +:::note The installation runs in the background. An email notification is sent to you when the installation is complete. +::: ## Configure Platform Governance for Salesforce -The following items are needed: +**Requirements** - Create a **Connected App** to generate and extract the Salesforce **Consumer Key** and the Salesforce **Consumer Secret Key** - Your Salesforce **username**, **password** and **authentication token** +**Installation** + 1. Open Salesforce **Setup** > **Apps** > **App Manager** 2. Click **New Connected App** 3. Select **Create a Connected App** and click **Continue** 4. Under **Basic Information** enter the required fields: -- **Connected App Name**: **Netwrix Platform Governance** -- **API Name**: **Netwrix_Platform_Governance** -- **Contact E-mail** + - **Connected App Name**: **Netwrix Platform Governance** + - **API Name**: **Netwrix_Platform_Governance** + - **Contact E-mail** 5. Click **API (Enable OAuth Settings)** to expand the section. 6. Set **Call Back URL** to **[https://localhost.com](https://localhost.com)** @@ -55,4 +59,4 @@ The following items are needed: 13. Locate and select **Netwrix Lightning**. 14. Click **I Accept** for the EULA. -**Next Step:** [Using the Getting Started Wizard](/docs/platgovsalesforce/installingstrongpoint/using_getting_started_wizard.md) +**Next Step:** [Run the Getting Started Wizard](/docs/platgovsalesforce/installingstrongpoint/using_getting_started_wizard.md) diff --git a/docs/platgovsalesforce/installingstrongpoint/running_scanner.md b/docs/platgovsalesforce/installingstrongpoint/running_scanner.md index d98ae10dc6..cdc857df73 100644 --- a/docs/platgovsalesforce/installingstrongpoint/running_scanner.md +++ b/docs/platgovsalesforce/installingstrongpoint/running_scanner.md @@ -13,7 +13,9 @@ Metadata type of the affected customization, instead of scanning the entire envi of scan reduces the run time. For example if you change a Report, pick reports as the Metadata type and Platform Governance for Salesforce only scans reports. +:::note The scanner is only available to Administrators. +::: To run the scanner: @@ -28,21 +30,20 @@ To run the scanner: 4. Click **Run Scanner**. 5. The batch runs in the background. You receive an email notification when the scan is complete. - You can create your own Salesforce view for the scanners. - - - Open Salesforce **Setup**. - - Search for **apex jobs** or navigate to **Environments** > **Jobs** > **Apex Jobs**. - - Click **Create New View**. - ![Set up a Strongpoint scanner view](/img/product_docs/platgovsalesforce/installing_strongpoint/scanner_view.webp) - - Enter a **View Name**. The system assigns **View Unique Name**. _Netwrix Jobs1_ is used in - this example. - - Select **Apex Class** for the **Field**. - - Select **starts with** for the **Operator**. - - Assign **FLO, Strongpoint** for the **Value**. - - Click **Save**. You can now see the status of all of the Strongpoint jobs. - ![Viewing running Strongpoin jobs](/img/product_docs/platgovsalesforce/installing_strongpoint/scanner_view2.webp) - 6. From the Netwrix Dashboard: click **Configuration and Stats** in the **Resources** section, or open **Settings** > **Configuration and Stats**. +You can create your own Salesforce view for the scanners: + + 1. Open Salesforce **Setup**. + 2. Search for **apex jobs** or navigate to **Environments** > **Jobs** > **Apex Jobs**. + 3. Click **Create New View**. + ![Set up a Strongpoint scanner view](/img/product_docs/platgovsalesforce/installing_strongpoint/scanner_view.webp) + 4. Enter a **View Name**. The system assigns **View Unique Name**. _Netwrix Jobs1_ is used in this example. + 5. Select **Apex Class** for the **Field**. + 6. Select **starts with** for the **Operator**. + 7. Assign **FLO, Strongpoint** for the **Value**. + 8. Click **Save**. You can now see the status of all of the Strongpoint jobs. + ![Viewing running Strongpoint jobs](/img/product_docs/platgovsalesforce/installing_strongpoint/scanner_view2.webp) + **Next Step:** [Validate the Data ](/docs/platgovsalesforce/installingstrongpoint/validating_data.md) diff --git a/docs/platgovsalesforce/installingstrongpoint/setting_access_permission.md b/docs/platgovsalesforce/installingstrongpoint/setting_access_permission.md index b9aeccea7c..5cc69c57b7 100644 --- a/docs/platgovsalesforce/installingstrongpoint/setting_access_permission.md +++ b/docs/platgovsalesforce/installingstrongpoint/setting_access_permission.md @@ -10,14 +10,19 @@ Platform Governance for Salesforce access is only granted to system administrati access to other users: 1. Open Salesforce **Setup** > **Users** > **Users** - ![manageusers](/img/product_docs/platgovsalesforce/installing_strongpoint/manageusers.webp)2. - Click on an existing **User** name. -2. Click **Permission Set Assignments** -3. Click **Edit Assignments**. - ![editassignments](/img/product_docs/platgovsalesforce/installing_strongpoint/editassignments.webp)5. - Select **Strongpoint Grant Permissions** from the **Available Permission Sets** -4. Click **Add**. It should now be shown in the **Enabled Permission Sets**. -5. Click **Save**. + + ![manageusers](/img/product_docs/platgovsalesforce/installing_strongpoint/manageusers.webp) + +2. Click on an existing **User** name. +3. Click **Permission Set Assignments** +4. Click **Edit Assignments**. + + ![editassignments](/img/product_docs/platgovsalesforce/installing_strongpoint/editassignments.webp) + +5. Select **Strongpoint Grant Permissions** from the **Available Permission Sets** +6. Click **Add**. It should now be shown in the **Enabled Permission Sets**. +7. Click **Save**. + ![enablepermissionsets](/img/product_docs/platgovsalesforce/installing_strongpoint/enablepermissionsets.webp) The user is ready to view and use Platform Governance for Salesforce. diff --git a/docs/platgovsalesforce/installingstrongpoint/setting_up_initial_scan.md b/docs/platgovsalesforce/installingstrongpoint/setting_up_initial_scan.md index 86666bac59..8fa1855a49 100644 --- a/docs/platgovsalesforce/installingstrongpoint/setting_up_initial_scan.md +++ b/docs/platgovsalesforce/installingstrongpoint/setting_up_initial_scan.md @@ -43,6 +43,7 @@ You can schedule the scanners to auto-scan your environment: ![getting_started_wizard6](/img/product_docs/platgovsalesforce/installing_strongpoint/getting_started_wizard6.webp) +:::note Netwrix recommends you schedule at least the following items: - **Automated Scan**: Daily @@ -50,6 +51,7 @@ You can schedule the scanners to auto-scan your environment: - **Standard Fields Scan**: Weekly - **PermissionSet Assignment**: Weekly (Production orgs) - **Subscriber Users Scan**: Weekly (Production orgs) +::: 3. Click **Next**. diff --git a/docs/platgovsalesforce/installingstrongpoint/using_getting_started_wizard.md b/docs/platgovsalesforce/installingstrongpoint/using_getting_started_wizard.md index c1f97b0114..c649d9c704 100644 --- a/docs/platgovsalesforce/installingstrongpoint/using_getting_started_wizard.md +++ b/docs/platgovsalesforce/installingstrongpoint/using_getting_started_wizard.md @@ -35,11 +35,11 @@ credentials. 1. On the Credentials page, add the following values: -- **Salesforce Username** -- **Salesforce Password** -- **Salesforce Security Token** -- **Salesforce Consumer Key** Extracted when you created the Strongpoint Connected App -- **Salesforce Consumer Secret** Extracted when you created the Strongpoint Connected App + - **Salesforce Username** + - **Salesforce Password** + - **Salesforce Security Token** + - **Salesforce Consumer Key** Extracted when you created the Strongpoint Connected App + - **Salesforce Consumer Secret** Extracted when you created the Strongpoint Connected App 2. Click **Next** diff --git a/docs/platgovsalesforce/integrations/_category_.json b/docs/platgovsalesforce/integrations/_category_.json index cdb707a17b..9359ee004d 100644 --- a/docs/platgovsalesforce/integrations/_category_.json +++ b/docs/platgovsalesforce/integrations/_category_.json @@ -1,5 +1,5 @@ { - "label": "Integrations", + "label": "Ticketing System Integrations", "position": 100, "collapsed": true, "collapsible": true, diff --git a/docs/platgovsalesforce/integrations/jiraintegration/jira_field_map.md b/docs/platgovsalesforce/integrations/jiraintegration/jira_field_map.md index c0aab8daf1..f727997e09 100644 --- a/docs/platgovsalesforce/integrations/jiraintegration/jira_field_map.md +++ b/docs/platgovsalesforce/integrations/jiraintegration/jira_field_map.md @@ -45,9 +45,11 @@ If your fields are not in the list, use the **New** button to add them. For this example, the **Strongpoint Version** and **SF Version Number** fields have been added. -**NOTE:** You need the Salesforce API names when you create the mapping record. For this example, -**Strongpoint Version** is **Strongpoint_Version**c** and **SF Version Number** is -**Salesforce_Version_Number**c**. +:::note +You need the Salesforce API names when you create the mapping record. For this example, +**Strongpoint Version** is **Strongpoint_Version__c** and **SF Version Number** is +**Salesforce_Version_Number__c**. +::: ![Verify fields exist](/img/product_docs/platgovsalesforce/integrations/field_map_verify_fields.webp) @@ -78,9 +80,11 @@ In Jira, update the details for the fields. This example sets the **Strongpoint ### Access Mapping Configuration -**NOTE:** Make sure your custom fields have values before you start the mapping. The Jira API names -are in the format _customfield_#####\_. You need to know the value to locate the Jira API name in +:::note +Make sure your custom fields have values before you start the mapping. The Jira API names +are in the format _customfield\_#####_. You need to know the value to locate the Jira API name in the list. +::: Open the Field Mapping tool: @@ -117,7 +121,7 @@ The Jira API names are required to create the mapping record. details. **customfield_10052** is used in this example. 6. Enter the **CR SF Field APIName**. This is the Salesforce API name obtained from **Salesforce Setup** > **Object Manager** > **Change Request** > **Fields & Relationships**. Refer to the - Verify Field Creation section for details. **Strongpoint_Version**c\_\_ is used in this example. + Verify Field Creation section for details. **Strongpoint_Version__c** is used in this example. 7. Click **Save** or **Save & New** if you have additional mappings. The mapping is now complete. In the next update, the information is populated in the fields and diff --git a/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md b/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md index fe390cf720..22d3abd47d 100644 --- a/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md +++ b/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md @@ -19,10 +19,12 @@ User benefits include: - Navigate to DRD views. - Enable automatic synchronization of Jira and Platform Governance for Salesforce change tickets. +:::note Change Requests are not automatically created, as not all tickets result in a Change Request. Tickets must be pushed to Platform Governance for Salesforce to begin the process. If Automatic Synchronization is turned on, then changes to the Status and Customizations are synchronized between Jira and Platform Governance for Salesforce without the need to keep manually pushing the changes. +::: To set up the Jira integration: @@ -40,8 +42,11 @@ To take advantage of the automatic synchronization feature, we recommend reviewi statuses to be mapped to the Change Request statuses. When a ticket status is updated to a mapped status, Platform Governance for Salesforce handles the synchronization between Jira and Salesforce. -The mapping allows multiple Jira statuses to map to each Change Request status. -The mapping is part of the Set Up Status Mapping procedure. +:::note +The mapping allows multiple Jira statuses to map to each Change Request status. +::: + +The mapping is part of the [Set Up Status Mapping](#set-up-status-mapping) procedure. Refer to the Atlassian documentation for instructions on [Defining status field values](https://confluence.atlassian.com/adminjiraserver070/defining-status-field-values-749382903.html?_ga=2.262596428.1900070949.1572132057-2138500458.1540834491). @@ -53,8 +58,10 @@ Cloud Integration Credentials after installing the app. ### Jira Cloud Installation +:::note You must be a Jira system administrator to install the **Strongpoint for Salesforce** app. Contact your Jira system administrator if you do not have administrative permissions. +::: 1. Open your **Jira Software Dashboard**. 2. Select **Apps** > **Explore more Apps >** @@ -69,9 +76,11 @@ your Jira system administrator if you do not have administrative permissions. You can use a connected app to request access to Salesforce data. These steps connect your Jira Cloud app to your Salesforce instance. +:::note For a connected app to request access, it must be integrated with the Salesforce API using the OAuth 2.0 protocol. OAuth 2.0 is an open protocol that authorizes secure data sharing between applications through the exchange of tokens. +::: Configure the connected app: @@ -88,7 +97,9 @@ Configure the connected app: **Perform requests at any time (refresh_token, offline_access)** 6. Click **Save**. + :::note Your connected app requires 2-10 minutes after you save before it is available. + ::: 7. Click **Manage Consumer Details**. @@ -126,17 +137,18 @@ By default, all projects are visible for the Jira Platform Governance for Salesf You can restrict this by project or profile. Users opening a restricted project receive a information message, instructions for enabling access, -and a link to this topic. Follow the instructions for Restricting Access to a Project or Setting -Groups/Profiles Visibility to grant the user appropriate access. +and a link to this topic. > _The Strongpoint Salesforce Integration is not supported for this project._ +Follow the instructions for Restricting Access to a Project or Setting Groups/Profiles Visibility to grant the user appropriate access. + 1. Open a Jira project. ![Open a project](/img/product_docs/platgovsalesforce/integrations/jira_restrict_access1.webp) 2. Select **Strongpoint Sf Settings**. -3. Select the **Project Visability Settings** tab. +3. Select the **Project Visibility Settings** tab. 4. Enter the name of the project in the **Visibility Settings**. The specified project is the only one that is available to the Platform Governance for Salesforce integration. Leave **Visibility Settings** blank to allow all projects access. @@ -151,14 +163,15 @@ Access to the Jira Platform Governance for Salesforce integration can also be pe groups. Users opening a restricted project receive a information message, instructions for enabling access, -and a link to this topic. Follow the instructions for Restricting Access to a Project or Setting -Groups/Profiles Visibility to grant the user appropriate access. +and a link to this topic. > _The Strongpoint Salesforce Integration is not supported for this project._ +Follow the instructions for Restricting Access to a Project or Setting Groups/Profiles Visibility to grant the user appropriate access. + 1. Open a Jira project. 2. Select **Strongpoint Sf Settings**. -3. Select the **Profile Visability Settings** tab. There are two lists: +3. Select the **Profile Visibility Settings** tab. There are two lists: **Existing Groups** are all of the current groups in Jira **Selected Groups** are groups that can see the Platform Governance for Salesforce Jira integration. If **Selected Groups** is blank, all groups have access to the integration. @@ -195,11 +208,13 @@ Groups/Profiles Visibility to grant the user appropriate access. without having to click **Push**. If you are using an org where you do not want to create a Change Request, leave this unchecked so you can do your research or testing without generating Change Requests. -6. Change Requests are not automatically created, as not all tickets result in a Change Request. + + :::note + Change Requests are not automatically created, as not all tickets result in a Change Request. Tickets must be pushed to Platform Governance for Salesforce to begin the process. If Automatic Synchronization is turned on, then changes to the Status and Customizations are synchronized between Jira and Platform Governance for Salesforce without the need to keep manually pushing the changes. -7. Click **Save**. + ::: -**Next Step:** [Jira Walkthrough Example](/docs/platgovsalesforce/integrations/jiraintegration/jira_walkthrough_example.md) +6. Click **Save**. diff --git a/docs/platgovsalesforce/integrations/jiraintegration/jira_troubleshooting.md b/docs/platgovsalesforce/integrations/jiraintegration/jira_troubleshooting.md index b22f51d87d..ac582c16f8 100644 --- a/docs/platgovsalesforce/integrations/jiraintegration/jira_troubleshooting.md +++ b/docs/platgovsalesforce/integrations/jiraintegration/jira_troubleshooting.md @@ -53,7 +53,7 @@ Error message: error=invalid_client_id&error_description=client%20identifier%20invalid -Refer to [Access Data with API Integration](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration#access-data-with-apiintegration) for +Refer to [Access Data with API Integration](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) for more information on setting up the connected app. ## Error with Consumer Secret diff --git a/docs/platgovsalesforce/integrations/jiraintegration/jira_walkthrough_example.md b/docs/platgovsalesforce/integrations/jiraintegration/jira_walkthrough_example.md index 5e02b67598..7221e4abec 100644 --- a/docs/platgovsalesforce/integrations/jiraintegration/jira_walkthrough_example.md +++ b/docs/platgovsalesforce/integrations/jiraintegration/jira_walkthrough_example.md @@ -36,9 +36,10 @@ The walkthrough demonstrates these steps: - **Description** (optional) 5. Click **Create**. -6. Alerts and notifications may occur during this walkthrough, and are not included in these steps. - For example, override alert, notifications for approvers, and notification for the change - request. + +:::note +Alerts and notifications may occur during this walkthrough, and are not included in these steps. For example, override alert, notifications for approvers, and notification for the change request. +::: ## Connect to the App @@ -53,7 +54,7 @@ The walkthrough demonstrates these steps: ### Connected App Use the **Connected App** tab if you set up the connected app using the procedure: -[Access Data with API Integration](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration#access-data-with-apiintegration) +[Access Data with API Integration](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) 1. Open the **Connected App** tab. @@ -96,7 +97,9 @@ If you do not have your security token, you can use these steps to reset your to 6. Click **Connect**. If the connection is successful, the form is displayed (see Add Customizations section). The **Synchronized with** status displays the org you are logged into for Salesforce. +:::note You cannot login if you do not have the **appropriate role permissions to create a change request**. +::: If you do not enter the correct credentials, an error is displayed. After six unsuccessful consecutive attempts to login, your account is suspended for 30 minutes. diff --git a/docs/platgovsalesforce/releasemanagement/deployment_logs.md b/docs/platgovsalesforce/releasemanagement/deployment_logs.md index b15121a502..b0fb2138cb 100644 --- a/docs/platgovsalesforce/releasemanagement/deployment_logs.md +++ b/docs/platgovsalesforce/releasemanagement/deployment_logs.md @@ -11,17 +11,12 @@ access the logs from **Strongpoint** > **Reports** > **Release and Deployment**. Deployment logs have these sections: -> Deployment Log Detail -> -> Customizations -> -> Deployed Components and Apex Test Information -> -> Deployment Error Messages -> -> Notes and Attachments -> -> Deployment Components +- Deployment Log Detail +- Customizations +- Deployed Components and Apex Test Information +- Deployment Error Messages +- Notes and Attachments +- Deployment Components ## Sample Deployment Log @@ -29,41 +24,32 @@ Deployment logs have these sections: ## Deployment Log Detail -> **Deployment Log Name**: Name of the Deployment Record. -> -> **Change Request**: Link to the change request associated with the deployment record. -> -> **Start Date**: Date deployment was started. -> -> **Owner**: Link to the Deployment Owner. Click **Change** to edit the owner information. -> -> **Status**: Current status of the deployment. Double click to edit. Status options are: -> -> - Pending -> - InProgress -> - Succeeded -> - SucceededPartial -> - Failed -> - Canceling -> - Canceled -> - Retrieve In Progress -> - Retrieve Completed -> - Retrieve Failed -> - Validation In Progress -> - Validation Completed -> - Validation Failed -> - Rollback In Progress -> - Rollback Partial -> - Rollback Completed -> - Rollback Failed -> -> **Deployment Status**: Green Flag for Succeeded Red Flag for Failed. -> -> **Retrieve Status**: Green Flag for Succeeded Red Flag for Failed. -> -> **Completed Date**: Date deployment was completed. -> -> **State Detail**: Component being deployed or the Apex test class running. +- **Deployment Log Name**: Name of the Deployment Record. +- **Change Request**: Link to the change request associated with the deployment record. +- **Start Date**: Date deployment was started. +- **Owner**: Link to the Deployment Owner. Click **Change** to edit the owner information. +- **Status**: Current status of the deployment. Double click to edit. Status options are: + - Pending + - InProgress + - Succeeded + - SucceededPartial + - Failed + - Canceling + - Canceled + - Retrieve In Progress + - Retrieve Completed + - Retrieve Failed + - Validation In Progress + - Validation Completed + - Validation Failed + - Rollback In Progress + - Rollback Partial + - Rollback Completed + - Rollback Failed +- **Deployment Status**: Green Flag for Succeeded Red Flag for Failed. +- **Retrieve Status**: Green Flag for Succeeded Red Flag for Failed. +- **Completed Date**: Date deployment was completed. +- **State Detail**: Component being deployed or the Apex test class running. ## Customizations @@ -72,29 +58,20 @@ record. ## Deployed Components and Apex Test Information -> **Components Total**: Number of components in the deployment. -> -> **Components Deployed**: Number of components deployed in the deployment process. -> -> **Component Errors**:Number of components generating errors during the deployment. -> -> **# of Tests Total**: Number of Apex tests for the deployment. -> -> **# of Tests Completed**: Number of Apex tests completed for the deployment. -> -> **# of Test Errors**: Number of Apex tests generating errors during the deployment. +- **Components Total**: Number of components in the deployment. +- **Components Deployed**: Number of components deployed in the deployment process. +- **Component Errors**:Number of components generating errors during the deployment. +- **# of Tests Total**: Number of Apex tests for the deployment. +- **# of Tests Completed**: Number of Apex tests completed for the deployment. +- **# of Test Errors**: Number of Apex tests generating errors during the deployment. ## Deployment Error Messages -> **Deploy Error Messages**: Lists the components and generated errors. -> -> **Tests Error Message**: Lists the test failures. -> -> **Retrieve Error Message**: Lists the error message if a retrieve fails. -> -> **Created By**: Link to user who created the deployment log. -> -> **Last Modified By**: Link to user who last modified the deployment log. +- **Deploy Error Messages**: Lists the components and generated errors. +- **Tests Error Message**: Lists the test failures. +- **Retrieve Error Message**: Lists the error message if a retrieve fails. +- **Created By**: Link to user who created the deployment log. +- **Last Modified By**: Link to user who last modified the deployment log. ## Notes and Attachments diff --git a/docs/platgovsalesforce/releasemanagement/deployments.md b/docs/platgovsalesforce/releasemanagement/deployments.md index 4cef5cffcd..8a42527077 100644 --- a/docs/platgovsalesforce/releasemanagement/deployments.md +++ b/docs/platgovsalesforce/releasemanagement/deployments.md @@ -11,13 +11,10 @@ environment(s). Each step in the deployment process complies with your policies approval process. Deployments are blocked if approvals are not complete. A full audit trail of the entire deployment process is maintained.The process is: -> Create a Change Request -> -> Create a Deployment Record -> -> Deploy the Changes -> -> Complete the Process +- Create a Change Request +- Create a Deployment Record +- Deploy the Changes +- Complete the Process ## Create a Change Request diff --git a/docs/platgovsalesforce/releasemanagement/multiple_env_deployment_tracking.md b/docs/platgovsalesforce/releasemanagement/multiple_env_deployment_tracking.md index ca35f87164..cc79fc40b1 100644 --- a/docs/platgovsalesforce/releasemanagement/multiple_env_deployment_tracking.md +++ b/docs/platgovsalesforce/releasemanagement/multiple_env_deployment_tracking.md @@ -11,19 +11,13 @@ they have an audit trail and approvals can be shown. Here is the overall process flow for multiple deployment tracking: -> Create the Change Request -> -> Push the Change Request -> -> Push the Updated Change Back into Production -> -> Create the Deployment Record -> -> Create the Deployment Record -> -> Deploy the Changes -> -> Complete the Process +- Create the Change Request +- Push the Change Request +- Push the Updated Change Back into Production +- Create the Deployment Record +- Create the Deployment Record +- Deploy the Changes +- Complete the Process ## Create the Change Request diff --git a/docs/platgovsalesforce/releasemanagement/release_management_overview.md b/docs/platgovsalesforce/releasemanagement/release_management_overview.md index 9d652408c6..93551c2df3 100644 --- a/docs/platgovsalesforce/releasemanagement/release_management_overview.md +++ b/docs/platgovsalesforce/releasemanagement/release_management_overview.md @@ -13,10 +13,6 @@ deployments are released. Release Management is enabled for Intelligent Change Management and Enterprise Compliance Licenses. -> [Deployments](/docs/platgovsalesforce/releasemanagement/deployments.md): Documents your deployment process so you can safely moves -> deployments from one environment to another. -> -> [Rollback](/docs/platgovsalesforce/releasemanagement/rollback.md): Enables you to safely rollback your deployments. -> -> [Multiple Environment Deployment](/docs/platgovsalesforce/releasemanagement/multiple_environments.md): Manages changes between your -> Production, Development and Testing accounts. +- [Deployments](/docs/platgovsalesforce/releasemanagement/deployments.md): Documents your deployment process so you can safely moves deployments from one environment to another. +- [Rollback](/docs/platgovsalesforce/releasemanagement/rollback.md): Enables you to safely rollback your deployments. +- [Multiple Environment Deployment](/docs/platgovsalesforce/releasemanagement/multiple_environments.md): Manages changes between your Production, Development and Testing accounts. diff --git a/docs/platgovsalesforce/releasemanagement/rollback.md b/docs/platgovsalesforce/releasemanagement/rollback.md index 161e9587b1..df526e1c63 100644 --- a/docs/platgovsalesforce/releasemanagement/rollback.md +++ b/docs/platgovsalesforce/releasemanagement/rollback.md @@ -11,9 +11,8 @@ rollback to a previous state after a deployment. Platform Governance for Salesfo gives you the flexibility of rolling back all or selected components of your deployment,enabling you to take action on a specific problem. There are two steps: -> Create the Rollback Record -> -> Execute and Validate the Rollback +- Create the Rollback Record +- Execute and Validate the Rollback ## Create the Rollback Record diff --git a/docs/platgovsalesforce/reports/deployment_logs_environment_compare.md b/docs/platgovsalesforce/reports/deployment_logs_environment_compare.md index 945516bcfb..0d6453e034 100644 --- a/docs/platgovsalesforce/reports/deployment_logs_environment_compare.md +++ b/docs/platgovsalesforce/reports/deployment_logs_environment_compare.md @@ -11,57 +11,32 @@ Compare Logs** The **Report Generation Status** should be **Complete**. If not, run the report again. -Click on any of the report columns to change the sort order. The á or â arrow in the column heading +Click on any of the report columns to change the sort order. The ↓ or ↑ arrow in the column heading indicates the current column and sort order being used for the results. ### Report Options -> **Summarize information by**: Select a criteria from the list to have the results summarized and -> grouped. Default is **# of Test Errors**. -> -> **Show**: Select the criteria for the deployment logs to show. Default is **All deployment logs**. -> -> **Time Frame**: Select the **Date Field** to be used for the report, the **Range**, and adjust the -> **From** and **To** fields as needed. The default **Date Field** is **Completed Date**, **Range** -> is **Custom** and **From/To** is blank. Date format is _dd/mm/yyyy_. -> -> **Run Report**: Runs (**Run Report Now**) the report using the selected report options. Or, click -> on the arrow to open the **Schedule Future Runs** option. -> -> **Hide Details/Show Details**: **Hide Details** hides the report body and **Show Details** -> restores the report view. -> -> **Customize**: Opens the **Report Options**. You can change the table format, details, and -> included columns. -> -> **Save**: Opens the **Save** dialog with the current file name options. -> -> **Save As**: Opens the **Save As** dialog with blank fields. -> -> **Delete**: Prompts you to confirm deleting the report. Click **OK** to delete or **Cancel** to -> keep the report. -> -> **Printable View**: Creates the file _report###.xls_. -> -> **Export Details**: Opens the **Export Report** options. Select the encoding and format (xls or -> csv) for the exported file. Click **Export** to generate the _report###_ file. Click **Done** to -> return to the report. -> -> **Subscribe**: Opens the **Report Subscription** dialog. Select the subscription options. +- **Summarize information by**: Select a criteria from the list to have the results summarized and grouped. Default is **# of Test Errors**. +- **Show**: Select the criteria for the deployment logs to show. Default is **All deployment logs**. +- **Time Frame**: Select the **Date Field** to be used for the report, the **Range**, and adjust the **From** and **To** fields as needed. The default **Date Field** is **Completed Date**, **Range** is **Custom** and **From/To** is blank. Date format is _dd/mm/yyyy_. +- **Run Report**: Runs (**Run Report Now**) the report using the selected report options. Or, click on the arrow to open the **Schedule Future Runs** option. +- **Hide Details/Show Details**: **Hide Details** hides the report body and **Show Details** restores the report view. +- **Customize**: Opens the **Report Options**. You can change the table format, details, and included columns. +- **Save**: Opens the **Save** dialog with the current file name options. +- **Save As**: Opens the **Save As** dialog with blank fields. +- **Delete**: Prompts you to confirm deleting the report. Click **OK** to delete or **Cancel** to keep the report. +- **Printable View**: Creates the file _report###.xls_. +- **Export Details**: Opens the **Export Report** options. Select the encoding and format (xls or csv) for the exported file. Click **Export** to generate the _report###_ file. Click **Done** to return to the report. +- **Subscribe**: Opens the **Report Subscription** dialog. Select the subscription options. ## Report Results -> **FLO Environment Compare Log Name**: Link to the environment compare log. -> -> **Different Records Count**: Number of different records between the compared environments. -> -> **User**: Link to the requesting user's information. -> -> **Change Request**: Link to the change request. -> -> **Compare Filters**: Filters used to run the comparison. -> -> **Created Date**: Date of the environment compare. Format is _dd/mm/yyyy_ +- **FLO Environment Compare Log Name**: Link to the environment compare log. +- **Different Records Count**: Number of different records between the compared environments. +- **User**: Link to the requesting user's information. +- **Change Request**: Link to the change request. +- **Compare Filters**: Filters used to run the comparison. +- **Created Date**: Date of the environment compare. Format is _dd/mm/yyyy_ ![Environment Compare Log Report](/img/product_docs/platgovsalesforce/reports/report_deploy_env_compare.webp) diff --git a/docs/platgovsalesforce/reports/deployment_logs_failures.md b/docs/platgovsalesforce/reports/deployment_logs_failures.md index a4080a6733..06626da85b 100644 --- a/docs/platgovsalesforce/reports/deployment_logs_failures.md +++ b/docs/platgovsalesforce/reports/deployment_logs_failures.md @@ -11,73 +11,39 @@ Failures** The **Report Generation Status** should be **Complete**. If not, run the report again. -Click on any of the report columns to change the sort order. The á or â arrow in the column heading +Click on any of the report columns to change the sort order. The ↓ or ↑ arrow in the column heading indicates the current column and sort order being used for the results. ### Report Options -> **Summarize information by**: Select a criteria from the list to have the results summarized and -> grouped. Default is **# of Test Errors**. -> -> **Show**: Select the criteria for the deployment logs to show. Default is **All deployment logs**. -> -> **Time Frame**: Select the **Date Field** to be used for the report, the **Range**, and adjust the -> **From** and **To** fields as needed. The default **Date Field** is **Completed Date**, **Range** -> is **Custom** and **From/To** is blank. Date format is _dd/mm/yyyy_. -> -> **Run Report**: Runs (**Run Report Now**) the report using the selected report options. Or, click -> on the arrow to open the **Schedule Future Runs** option. -> -> **Hide Details/Show Details**: **Hide Details** hides the report body and **Show Details** -> restores the report view. -> -> **Customize**: Opens the **Report Options**. You can change the table format, details, and -> included columns. -> -> **Save**: Opens the **Save** dialog with the current file name options. -> -> **Save As**: Opens the **Save As** dialog with blank fields. -> -> **Delete**: Prompts you to confirm deleting the report. Click **OK** to delete or **Cancel** to -> keep the report. -> -> **Printable View**: Creates the file _report###.xls_. -> -> **Export Details**: Opens the **Export Report** options. Select the encoding and format (xls or -> csv) for the exported file. Click **Export** to generate the _report###_ file. Click **Done** to -> return to the report. -> -> **Subscribe**: Opens the **Report Subscription** dialog. Select the subscription options. -> -> **Filtered By**: Shows the current filters for the report. You can **Edit** or **Clear** the -> filters. +- **Summarize information by**: Select a criteria from the list to have the results summarized and grouped. Default is **# of Test Errors**. +- **Show**: Select the criteria for the deployment logs to show. Default is **All deployment logs**. +- **Time Frame**: Select the **Date Field** to be used for the report, the **Range**, and adjust the **From** and **To** fields as needed. The default **Date Field** is **Completed Date**, **Range**, **Custom** and **From/To** is blank. Date format is _dd/mm/yyyy_. +- **Run Report**: Runs (**Run Report Now**) the report using the selected report options. Or, click on the arrow to open the **Schedule Future Runs** option. +- **Hide Details/Show Details**: **Hide Details** hides the report body and **Show Details** restores the report view. +- **Customize**: Opens the **Report Options**. You can change the table format, details, and included columns. +- **Save**: Opens the **Save** dialog with the current file name options. +- **Save As**: Opens the **Save As** dialog with blank fields. +- **Delete**: Prompts you to confirm deleting the report. Click **OK** to delete or **Cancel** to keep the report. +- **Printable View**: Creates the file _report###.xls_. +- **Export Details**: Opens the **Export Report** options. Select the encoding and format (xls or csv) for the exported file. Click **Export** to generate the _report###_ file. Click **Done** to return to the report. +- **Subscribe**: Opens the **Report Subscription** dialog. Select the subscription options. +- **Filtered By**: Shows the current filters for the report. You can **Edit** or **Clear** the filters. ## Report Results -> **Deployment Log Name**: Link to the deployment log. -> -> **Start Date** ; The date and time of the deployment. Format is _dd/mm/yyyy hh:mm_ -> -> **Change Request**: Link to the change request for the deployment. -> -> **Retrieve Status**: Green flag indicates success, red flag indicates failure. -> -> **Deployment Status**: Green flag indicates success, red flag indicates failure. -> -> **Owner Name**: Link to the deployment log owner information. -> -> **Customizations**: Customizations for the deployment. -> -> **Component Errors**: Number of components with errors. -> -> **Components Total**: Number of components deployed. -> -> **Deploy Error Messages**: Deploy error messages if available. -> -> **Retrieve Error Message**: Retrieve error message if available. -> -> **Tests Error Message**: Test error message if available. -> -> **# of Test Errors**: Total number of errors. +- **Deployment Log Name**: Link to the deployment log. +- **Start Date** ; The date and time of the deployment. Format is _dd/mm/yyyy hh:mm_ +- **Change Request**: Link to the change request for the deployment. +- **Retrieve Status**: Green flag indicates success, red flag indicates failure. +- **Deployment Status**: Green flag indicates success, red flag indicates failure. +- **Owner Name**: Link to the deployment log owner information. +- **Customizations**: Customizations for the deployment. +- **Component Errors**: Number of components with errors. +- **Components Total**: Number of components deployed. +- **Deploy Error Messages**: Deploy error messages if available. +- **Retrieve Error Message**: Retrieve error message if available. +- **Tests Error Message**: Test error message if available. +- **# of Test Errors**: Total number of errors. ![Deployment Log Report with Failures](/img/product_docs/platgovsalesforce/reports/report_deploy_failures.webp) diff --git a/docs/platgovsalesforce/reports/deployment_logs_pending_approval.md b/docs/platgovsalesforce/reports/deployment_logs_pending_approval.md index 7a985d68dd..3b4aec1fd7 100644 --- a/docs/platgovsalesforce/reports/deployment_logs_pending_approval.md +++ b/docs/platgovsalesforce/reports/deployment_logs_pending_approval.md @@ -11,67 +11,35 @@ pending approval** The **Report Generation Status** should be **Complete**. If not, run the report again. -Click on any of the report columns to change the sort order. The á or â arrow in the column heading +Click on any of the report columns to change the sort order. The ↓ or ↑ arrow in the column heading indicates the current column and sort order being used for the results. ### Report Options -> **Summarize information by**: Select a criteria from the list to have the results summarized and -> grouped. Default is **None**. -> -> **Show**: Select the criteria for the deployment logs to show. Default is **All change requests**. -> -> **Time Frame**: Select the **Date Field** to be used for the report, the **Range**, and adjust the -> **From** and **To** fields as needed. The default **Date Field** is **Deployment Date**, **Range** -> is **Custom** and **From/To** is blank. Date format is _dd/mm/yyyy_. -> -> **Run Report**: Runs (**Run Report Now**) the report using the selected report options. Or, click -> on the arrow to open the **Schedule Future Runs** option. -> -> **Hide Details/Show Details**: **Hide Details** hides the report body and **Show Details** -> restores the report view. -> -> **Customize**: Opens the **Report Options**. You can change the table format, details, and -> included columns. -> -> **Save**: Opens the **Save** dialog with the current file name options. -> -> **Save As**: Opens the **Save As** dialog with blank fields. -> -> **Delete**: Prompts you to confirm deleting the report. Click **OK** to delete or **Cancel** to -> keep the report. -> -> **Printable View**: Creates the file _report###.xls_. -> -> **Export Details**: Opens the **Export Report** options. Select the encoding and format (xls or -> csv) for the exported file. Click **Export** to generate the _report###_ file. Click **Done** to -> return to the report. -> -> **Subscribe**: Opens the **Report Subscription** dialog. Select the subscription options. -> -> **Filtered By**: Shows the current filters for the report. You can **Edit** or **Clear** the -> filters. +- **Summarize information by**: Select a criteria from the list to have the results summarized and grouped. Default is **None**. +- **Show**: Select the criteria for the deployment logs to show. Default is **All change requests**. +- **Time Frame**: Select the **Date Field** to be used for the report, the **Range**, and adjust the **From** and **To** fields as needed. The default **Date Field** is **Deployment Date**, **Range** is **Custom** and **From/To** is blank. Date format is _dd/mm/yyyy_. +- **Run Report**: Runs (**Run Report Now**) the report using the selected report options. Or, click on the arrow to open the **Schedule Future Runs** option. +- **Hide Details/Show Details**: **Hide Details** hides the report body and **Show Details** restores the report view. +- **Customize**: Opens the **Report Options**. You can change the table format, details, and included columns. +- **Save**: Opens the **Save** dialog with the current file name options. +- **Save As**: Opens the **Save As** dialog with blank fields. +- **Delete**: Prompts you to confirm deleting the report. Click **OK** to delete or **Cancel** to keep the report. +- **Printable View**: Creates the file _report###.xls_. +- **Export Details**: Opens the **Export Report** options. Select the encoding and format (xls or csv) for the exported file. Click **Export** to generate the _report###_ file. Click **Done** to return to the report. +- **Subscribe**: Opens the **Report Subscription** dialog. Select the subscription options. +- **Filtered By**: Shows the current filters for the report. You can **Edit** or **Clear** the filters. ## Report Results -> **Change Request Name**: Link to the change request for the deployment. -> -> **Change Request: Created Date**: The created date of the change request. Format is _dd/mm/yyyy_ -> -> **Change Request: Owner Name**: Link to the change request owner information. -> -> **Customizations**: Customizations for the deployment. -> -> **Change Stage** -> -> Change level required and stage for the deployment. -> -> **Change Policy**: Link to the change policy. -> -> **Completion Status**: Current status. -> -> **Target Environment**: Target environment for the deployment. -> -> **Source Environment**: Source environment for the deployment. +- **Change Request Name**: Link to the change request for the deployment. +- **Change Request: Created Date**: The created date of the change request. Format is _dd/mm/yyyy_ +- **Change Request: Owner Name**: Link to the change request owner information. +- **Customizations**: Customizations for the deployment. +- **Change Stage**: Change level required and stage for the deployment. +- **Change Policy**: Link to the change policy. +- **Completion Status**: Current status. +- **Target Environment**: Target environment for the deployment. +- **Source Environment**: Source environment for the deployment. ![report_deploy_pend_approval](/img/product_docs/platgovsalesforce/reports/report_deploy_pend_approval.webp) diff --git a/docs/platgovsalesforce/reports/deployment_logs_rollback.md b/docs/platgovsalesforce/reports/deployment_logs_rollback.md index 4e9bd3b8ed..3b4cd1d752 100644 --- a/docs/platgovsalesforce/reports/deployment_logs_rollback.md +++ b/docs/platgovsalesforce/reports/deployment_logs_rollback.md @@ -10,59 +10,32 @@ This built-in report is available from **Reports** > **Release and Deployment** The **Report Generation Status** should be **Complete**. If not, run the report again. -Click on any of the report columns to change the sort order. The á or â arrow in the column heading +Click on any of the report columns to change the sort order. The ↓ or ↑ arrow in the column heading indicates the current column and sort order being used for the results. ### Report Options -> **Summarize information by**: Select a criteria from the list to have the results summarized and -> grouped. Default is **# of Test Errors**. -> -> **Show**: Select the criteria for the deployment logs to show. Default is **All deployment logs**. -> -> **Time Frame**: Select the **Date Field** to be used for the report, the **Range**, and adjust the -> **From** and **To** fields as needed. The default **Date Field** is **Completed Date**, **Range** -> is **Custom** and **From/To** is blank. Date format is _dd/mm/yyyy_. -> -> **Run Report**: Runs (**Run Report Now**) the report using the selected report options. Or, click -> on the arrow to open the **Schedule Future Runs** option. -> -> **Hide Details/Show Details**: **Hide Details** hides the report body and **Show Details** -> restores the report view. -> -> **Customize**: Opens the **Report Options**. You can change the table format, details, and -> included columns. -> -> **Save**: Opens the **Save** dialog with the current file name options. -> -> **Save As**: Opens the **Save As** dialog with blank fields. -> -> **Delete**: Prompts you to confirm deleting the report. Click **OK** to delete or **Cancel** to -> keep the report. -> -> **Printable View**: Creates the file _report###.xls_. -> -> **Export Details**: Opens the **Export Report** options. Select the encoding and format (xls or -> csv) for the exported file. Click **Export** to generate the _report###_ file. Click **Done** to -> return to the report. -> -> **Subscribe**: Opens the **Report Subscription** dialog. Select the subscription options. -> -> **Filtered By**: Shows the current filters for the report. You can **Edit** or **Clear** the -> filters. +- **Summarize information by**: Select a criteria from the list to have the results summarized and grouped. Default is **# of Test Errors**. +- **Show**: Select the criteria for the deployment logs to show. Default is **All deployment logs**. +- **Time Frame**: Select the **Date Field** to be used for the report, the **Range**, and adjust the **From** and **To** fields as needed. The default **Date Field** is **Completed Date**, **Range** is **Custom** and **From/To** is blank. Date format is _dd/mm/yyyy_. +- **Run Report**: Runs (**Run Report Now**) the report using the selected report options. Or, click on the arrow to open the **Schedule Future Runs** option. +- **Hide Details/Show Details**: **Hide Details** hides the report body and **Show Details** restores the report view. +- **Customize**: Opens the **Report Options**. You can change the table format, details, and included columns. +- **Save**: Opens the **Save** dialog with the current file name options. +- **Save As**: Opens the **Save As** dialog with blank fields. +- **Delete**: Prompts you to confirm deleting the report. Click **OK** to delete or **Cancel** to keep the report. +- **Printable View**: Creates the file _report###.xls_. +- **Export Details**: Opens the **Export Report** options. Select the encoding and format (xls or csv) for the exported file. Click **Export** to generate the _report###_ file. Click **Done** to return to the report. +- **Subscribe**: Opens the **Report Subscription** dialog. Select the subscription options. +- **Filtered By**: Shows the current filters for the report. You can **Edit** or **Clear** the filters. ## Report Results -> **Deployment Log Name**: Link to the deployment log. -> -> **Owner Name**: Link to the deployment log owner information. -> -> **Start Date** ; The date and time of the deployment. Format is _dd/mm/yyyy hh:mm_ -> -> **Change Request**: Link to the change request for the deployment. -> -> **Customizations**: Customizations for the deployment. -> -> **Components Deployed**: Number of components deployed. +- **Deployment Log Name**: Link to the deployment log. +- **Owner Name**: Link to the deployment log owner information. +- **Start Date** ; The date and time of the deployment. Format is _dd/mm/yyyy hh:mm_ +- **Change Request**: Link to the change request for the deployment. +- **Customizations**: Customizations for the deployment. +- **Components Deployed**: Number of components deployed. ![Deployment Rollback Report](/img/product_docs/platgovsalesforce/reports/report_deploy_rollbacks.webp) diff --git a/docs/platgovsalesforce/reports/deployment_logs_success.md b/docs/platgovsalesforce/reports/deployment_logs_success.md index 1477c14b9c..5a2a45bb74 100644 --- a/docs/platgovsalesforce/reports/deployment_logs_success.md +++ b/docs/platgovsalesforce/reports/deployment_logs_success.md @@ -11,67 +11,36 @@ Deployments** The **Report Generation Status** should be **Complete**. If not, run the report again. -Click on any of the report columns to change the sort order. The á or â arrow in the column heading +Click on any of the report columns to change the sort order. The ↓ or ↑ arrow in the column heading indicates the current column and sort order being used for the results. ### Report Options -> **Summarize information by**: Select a criteria from the list to have the results summarized and -> grouped. Default is **# of Test Errors**. -> -> **Show**: Select the criteria for the deployment logs to show. Default is **All deployment logs**. -> -> **Time Frame**: Select the **Date Field** to be used for the report, the **Range**, and adjust the -> **From** and **To** fields as needed. The default **Date Field** is **Completed Date**, **Range** -> is **Custom** and **From/To** is blank. Date format is _dd/mm/yyyy_. -> -> **Run Report**: Runs (**Run Report Now**) the report using the selected report options. Or, click -> on the arrow to open the **Schedule Future Runs** option. -> -> **Hide Details/Show Details**: **Hide Details** hides the report body and **Show Details** -> restores the report view. -> -> **Customize**: Opens the **Report Options**. You can change the table format, details, and -> included columns. -> -> **Save**: Opens the **Save** dialog with the current file name options. -> -> **Save As**: Opens the **Save As** dialog with blank fields. -> -> **Delete**: Prompts you to confirm deleting the report. Click **OK** to delete or **Cancel** to -> keep the report. -> -> **Printable View**: Creates the file _report###.xls_. -> -> **Export Details**: Opens the **Export Report** options. Select the encoding and format (xls or -> csv) for the exported file. Click **Export** to generate the _report###_ file. Click **Done** to -> return to the report. -> -> **Subscribe**: Opens the **Report Subscription** dialog. Select the subscription options. -> -> **Filtered By**: Shows the current filters for the report. You can **Edit** or **Clear** the -> filters. +- **Summarize information by**: Select a criteria from the list to have the results summarized and grouped. Default is **# of Test Errors**. +- **Show**: Select the criteria for the deployment logs to show. Default is **All deployment logs**. +- **Time Frame**: Select the **Date Field** to be used for the report, the **Range**, and adjust the **From** and **To** fields as needed. The default **Date Field** is **Completed Date**, **Range** is **Custom** and **From/To** is blank. Date format is _dd/mm/yyyy_. +- **Run Report**: Runs (**Run Report Now**) the report using the selected report options. Or, click on the arrow to open the **Schedule Future Runs** option. +- **Hide Details/Show Details**: **Hide Details** hides the report body and **Show Details** restores the report view. +- **Customize**: Opens the **Report Options**. You can change the table format, details, and included columns. +- **Save**: Opens the **Save** dialog with the current file name options. +- **Save As**: Opens the **Save As** dialog with blank fields. +- **Delete**: Prompts you to confirm deleting the report. Click **OK** to delete or **Cancel** to keep the report. +- **Printable View**: Creates the file _report###.xls_. +- **Export Details**: Opens the **Export Report** options. Select the encoding and format (xls orcsv) for the exported file. Click **Export** to generate the _report###_ file. Click **Done** to return to the report. +- **Subscribe**: Opens the **Report Subscription** dialog. Select the subscription options. +- **Filtered By**: Shows the current filters for the report. You can **Edit** or **Clear** the filters. ## Report Results -> **Deployment Log Name**: Link to the deployment log. -> -> **Owner Name**: Link to the deployment log owner information. -> -> **Start Date** ; The date and time of the deployment. Format is _dd/mm/yyyy hh:mm_ -> -> **Retrieve Status**: Green flag indicates success, red flag indicates failure. -> -> **Deployment Status**: Green flag indicates success, red flag indicates failure. -> -> **Change Request**: Link to the change request for the deployment. -> -> **Components Total**: Total number of components. -> -> **Components Deployed**: Number of components deployed. -> -> **Customizations**: Customizations for the deployment. -> -> **Tests Selected**: Number of selected tests. +- **Deployment Log Name**: Link to the deployment log. +- **Owner Name**: Link to the deployment log owner information. +- **Start Date** ; The date and time of the deployment. Format is _dd/mm/yyyy hh:mm_ +- **Retrieve Status**: Green flag indicates success, red flag indicates failure. +- **Deployment Status**: Green flag indicates success, red flag indicates failure. +- **Change Request**: Link to the change request for the deployment. +- **Components Total**: Total number of components. +- **Components Deployed**: Number of components deployed. +- **Customizations**: Customizations for the deployment. +- **Tests Selected**: Number of selected tests. ![Successful Deployment Logs Report](/img/product_docs/platgovsalesforce/reports/report_deploy_success.webp) diff --git a/docs/platgovsalesforce/reports/reports_overview.md b/docs/platgovsalesforce/reports/reports_overview.md index 7f7eca8d54..2d5dd73251 100644 --- a/docs/platgovsalesforce/reports/reports_overview.md +++ b/docs/platgovsalesforce/reports/reports_overview.md @@ -25,17 +25,20 @@ You can define and save your own reports. - You can filter test scripts from regular scripts. Test scripts can be queried to review test coverage and determine if they being used. +:::note To access all reports, the following setting must be enabled: -Open **Strongpoint** > **Scanner** > **Scheduler** - **PermissionSet Assignment** and **System Permission** must be **Enabled**, and the **Frequency** -set to **Daily**. +Open **Strongpoint** **Scanner** **Scheduler** + +**PermissionSet Assignment** and **System Permission** must be **Enabled**, and the **Frequency** set to **Daily**. + If you have questions, contact your CSM or Salesforce Specialist. ![Enabling reports](/img/product_docs/platgovsalesforce/reports/access_reports_enabled.webp) +::: ## Access Reports -These reports are available from **Netwrix Dashboard** > **Reports** > **Access Reports**. +These reports are available from **Netwrix Dashboard** **Reports** **Access Reports**. Filters can be used on this report. Use **Save As** for a new version following your company naming conventions. An elevated access example is to filter **Permissionset/Profile** by the name of the @@ -45,73 +48,71 @@ You can focus on sensitive objects by filtering by object name and adding the na in the filter using the **contains** keyword plus the name of the object as it appears in object name. Separate each name with a comma. -> **Permissions by Object**: Displays the permissions on each object for all Permission Sets and -> Profiles. -> -> ![Permission by object](/img/product_docs/platgovsalesforce/reports/access_reports_permission_by_object.webp) -> -> **Object Permission by Profile/PermSet**: Displays the object permissions organized by Permission -> Set and Profile. -> -> ![Access report by PermissionSet/Profile](/img/product_docs/platgovsalesforce/reports/access_reports_permission_by_permset.webp) -> -> **Users to Profiles/PermissionSets**: Displays the Profile, PermissionSet and PermissionSet Group -> assigned to each user. You can filter the report information. For example, if you want a list of -> users that have Admin profiles, you can set two filters: -> -> - Customization Name Contains **Admin** -> - Salesforce type Equals Profile -> -> **Date Assigned** and **Expires on** are only relevant for PermissionSets. They are blank for -> Profiles. If your org does not use the **Expires on** feature, you can remove the column from the -> report. -> -> ![Users to Profile/PermissionSets](/img/product_docs/platgovsalesforce/reports/access_reports_users_to_profile.webp) -> -> **Profiles to PermissionsSets Changes**: Displays the changes made to your Profiles, -> PermissionSets,and PermissionSet Groups. If there is an active policy, the **Compliance** column -> displays whether the change was Compliant or Non-Compliant. If no policy, all changes are -> Compliant. -> -> ![Access Report Profile Permissions Changes](/img/product_docs/platgovsalesforce/reports/access_reports_profile_changes.webp) -> -> **Changes to Users**: Displays the changes to tracked user data fields. Refer to -> [Enhanced CPQ Support](/docs/platgovsalesforce/changemanagement/enhanced_cpq_support.md) for more information on -> setting up tracking. -> -> If you see the message: _--String too long - Skipped lines due to CPU limit reached--_ it simply -> means the governor limits have been reached. Profiles and PermissionSets are very data heavy. -> Platform Governance for Salesforcet skips the record and continues the scan the next day to ensure -> there is no impact to your org. -> -> ![Changes to Users](/img/product_docs/platgovsalesforce/reports/accses_reports_user_changes.webp) -> -> **Record Types and Page Layout Assignments**: Displays the objects, record types and assigned -> layouts organized by profile. -> -> ![Access Reports Record Types and Layouts](/img/product_docs/platgovsalesforce/reports/access_reports_record_types.webp) -> -> **System Permissions**: displays the list of System Permissions, the Profile or Permission set -> that has access to it and the list of Users that have this system permission enabled. -> -> ![System Permissions](/img/product_docs/platgovsalesforce/reports/report_systems_permissions.webp) -> -> **Field Permissions**: Displays the related objects, shows if there is a Read / Edit permission, -> the Profile or Permission set that give that field level access and the users related to those -> Profiles and permission sets. -> -> ![Field Permissions report](/img/product_docs/platgovsalesforce/reports/report_field_permissions.webp) -> -> To generate this report: -> -> 1. Open **Strongpoint Lightning** > **Tools** > **Field-Level security Scanner**. -> 2. Select the Salesforce object for the fields to add to the report. -> 3. Click **Search Fields**. -> 4. Change the checkbox to **True** next to the fields to add. You can add up to 50 fields. -> 5. Click **Scan**. -> -> This pushes the new list of fields to the report. If you select other fields and repeat the -> process, the previous report is overwritten. Export any reports you want to keep. +- **Permissions by Object**: Displays the permissions on each object for all Permission Sets and +Profiles. + +![Permission by object](/img/product_docs/platgovsalesforce/reports/access_reports_permission_by_object.webp) + +- **Object Permission by Profile/PermSet**: Displays the object permissions organized by Permission +Set and Profile. + +![Access report by PermissionSet/Profile](/img/product_docs/platgovsalesforce/reports/access_reports_permission_by_permset.webp) + +- **Users to Profiles/PermissionSets**: Displays the Profile, PermissionSet and PermissionSet Group +assigned to each user. You can filter the report information. For example, if you want a list of +users that have Admin profiles, you can set two filters: + + - Customization Name Contains **Admin** + - Salesforce type Equals Profile + +- **Date Assigned** and **Expires on** are only relevant for PermissionSets. They are blank for +Profiles. If your org does not use the **Expires on** feature, you can remove the column from the +report. + +![Users to Profile/PermissionSets](/img/product_docs/platgovsalesforce/reports/access_reports_users_to_profile.webp) + +- **Profiles to PermissionsSets Changes**: Displays the changes made to your Profiles, +PermissionSets,and PermissionSet Groups. If there is an active policy, the **Compliance** column +displays whether the change was Compliant or Non-Compliant. If no policy, all changes are +Compliant. + +![Access Report Profile Permissions Changes](/img/product_docs/platgovsalesforce/reports/access_reports_profile_changes.webp) + +- **Changes to Users**: Displays the changes to tracked user data fields. Refer to +[Enhanced CPQ Support](/docs/platgovsalesforce/changemanagement/enhanced_cpq_support.md) for more information on +setting up tracking.

If you see the message: _--String too long - Skipped lines due to CPU limit reached--_ it simply +means the governor limits have been reached. Profiles and PermissionSets are very data heavy. +Platform Governance for Salesforce skips the record and continues the scan the next day to ensure +there is no impact to your org. + +![Changes to Users](/img/product_docs/platgovsalesforce/reports/accses_reports_user_changes.webp) + +- **Record Types and Page Layout Assignments**: Displays the objects, record types and assigned +layouts organized by profile. + +![Access Reports Record Types and Layouts](/img/product_docs/platgovsalesforce/reports/access_reports_record_types.webp) + +- **System Permissions**: displays the list of System Permissions, the Profile or Permission set +that has access to it and the list of Users that have this system permission enabled. + +![System Permissions](/img/product_docs/platgovsalesforce/reports/report_systems_permissions.webp) + +- **Field Permissions**: Displays the related objects, shows if there is a Read / Edit permission, +the Profile or Permission set that give that field level access and the users related to those +Profiles and permission sets. + +![Field Permissions report](/img/product_docs/platgovsalesforce/reports/report_field_permissions.webp) + +To generate this report: + +1. Open **Strongpoint Lightning** **Tools** **Field-Level security Scanner**. +2. Select the Salesforce object for the fields to add to the report. +3. Click **Search Fields**. +4. Change the checkbox to **True** next to the fields to add. You can add up to 50 fields. +5. Click **Scan**. + +This pushes the new list of fields to the report. If you select other fields and repeat the +process, the previous report is overwritten. Export any reports you want to keep. ## Security Reports @@ -119,160 +120,122 @@ These reports are related to the Salesforce Health Check. It tracks if this feat check is **Enabled** or **Disabled** for your Salesforce Organization. For full detail compare the report to the health check section in Salesforce Setup. -These reports are available from **Netwrix Dashboard** > **Reports** > **Security Reports**. - -> **Health Check Remote Site Settings**: displays any remote sites with the **Disable Protocol** -> security option selected. -> -> **Health Check Password Policies**: displays password related Health check security settings. -> -> **Health Check Session Settings**: displays session settings, including: -> -> - Require HttpOnly attribute. -> - Lock sessions to the domain in which they were first used. -> - Let users verify their identity by text (SMS) -> - Enable clickjack protection for Setup pages -> - Enable clickjack protection for non-Setup Salesforce pages -> - Enable clickjack protection for customer Visualforce pages with standard headers -> - Enable clickjack protection for customer Visualforce pages with headers disabled -> - Enable CSRF protection on GET requests on non-setup pages -> - Enable CSRF protection on POST requests on non-setup pages -> - Force relogin after Login-As-User -> - Enforce login IP ranges on every request -> - Enable Content Security Policy protection for email templates -> - Enable XSS protection -> - Enable Content Sniffing protection -> - Force logout on session timeout -> - Require identity verification for email address changes -> - Session Timeout -> - Require identity verification during multi-factor authentication (MFA) registration -> - Allow redirections to untrusted external URLs without warning -> -> **Health Check Certificates**: tracks CKM Certificate name, Expiration date, expiration status, -> CKM Key Size and related Policy if applicable. -> -> **Health Check Changes**: tracks the changes to the items related to the health check settings. +These reports are available from **Netwrix Dashboard** **Reports** **Security Reports**. + +- **Health Check Remote Site Settings**: displays any remote sites with the **Disable Protocol** +security option selected. +- **Health Check Password Policies**: displays password related Health check security settings. +- **Health Check Session Settings**: displays session settings, including: + - Require HttpOnly attribute. + - Lock sessions to the domain in which they were first used. + - Let users verify their identity by text (SMS) + - Enable clickjack protection for Setup pages + - Enable clickjack protection for non-Setup Salesforce pages + - Enable clickjack protection for customer Visualforce pages with standard headers + - Enable clickjack protection for customer Visualforce pages with headers disabled + - Enable CSRF protection on GET requests on non-setup pages + - Enable CSRF protection on POST requests on non-setup pages + - Force relogin after Login-As-User + - Enforce login IP ranges on every request + - Enable Content Security Policy protection for email templates + - Enable XSS protection + - Enable Content Sniffing protection + - Force logout on session timeout + - Require identity verification for email address changes + - Session Timeout + - Require identity verification during multi-factor authentication (MFA) registration + - Allow redirection to untrusted external URLs without warning + +- **Health Check Certificates**: tracks CKM Certificate name, Expiration date, expiration status, +CKM Key Size and related Policy if applicable. +- **Health Check Changes**: tracks the changes to the items related to the health check settings. ## Data Classification -These reports are available from **Strongpoint** > **Reports** > **Data Classification**. +These reports are available from **Strongpoint** **Reports** **Data Classification**. -> **Changes related to Data Classification**: displays any changes that have occured. -> -> **Fields with Data Classification**: displays fields with data classification attributes, -> including: -> -> - GDPR -> - PII -> - HIPAA -> - PCI -> - CCPA +- **Changes related to Data Classification**: displays any changes that have occurred. +- **Fields with Data Classification**: displays fields with data classification attributes, +including: + + - GDPR + - PII + - HIPAA + - PCI + - CCPA ## Customizations -These reports are available from **Netwrix Dashboard** > **Reports** > **Customizations**. +These reports are available from **Netwrix Dashboard** **Reports** **Customizations**. -> **All Customizations**: This enables you to use Salesforce functionality to filter searches -> quickly for specific customizations. -> -> **Customization Impact**: This report shows your customizations and how they impact other objects. +- **All Customizations**: This enables you to use Salesforce functionality to filter searches +quickly for specific customizations. +- **Customization Impact**: This report shows your customizations and how they impact other objects. ## Clean Up -These reports are available from **Netwrix Dashboard** > **Reports** > **Clean Up**. - -> [Default Clean Up List View](/docs/platgovsalesforce/cleanup/cleanup_reports.md#default-clean-up-list-view) -> -> [Open Clean Up Status](/docs/platgovsalesforce/cleanup/cleanup_reports.md#open-clean-up-status) -> -> [Clean Up Waiting for Info](/docs/platgovsalesforce/cleanup/cleanup_reports.md#clean-up-waiting-for-info) -> -> [Customizations Excluded from Clean Up](/docs/platgovsalesforce/cleanup/cleanup_reports.md#customizations-excluded-from-clean-up) -> -> [Unused Fields](/docs/platgovsalesforce/cleanup/cleanup_reports.md#unused-fields) -> -> [Unused Apex Code](/docs/platgovsalesforce/cleanup/cleanup_reports.md#unused-apex-code) -> -> [Unused Reports](/docs/platgovsalesforce/cleanup/cleanup_reports.md#unused-reports) -> -> [Customizations with Inactive Owners](/docs/platgovsalesforce/cleanup/cleanup_reports.md#customizations-with-inactive-owners) -> -> [Customizations without Related Processes](/docs/platgovsalesforce/cleanup/cleanup_reports.md#customizations-without-related-processes) -> -> [Custom Fields without Help Text](/docs/platgovsalesforce/cleanup/cleanup_reports.md#custom-fields-without-help-text) -> -> [Custom Fields without Description](/docs/platgovsalesforce/cleanup/cleanup_reports.md#custom-fields-without-description) +These reports are available from **Netwrix Dashboard** **Reports** **Clean Up**. + +- [Default Clean Up List View](/docs/platgovsalesforce/cleanup/cleanup_reports.md#default-clean-up-list-view) +- [Open Clean Up Status](/docs/platgovsalesforce/cleanup/cleanup_reports.md#open-clean-up-status) +- [Clean Up Waiting for Info](/docs/platgovsalesforce/cleanup/cleanup_reports.md#clean-up-waiting-for-info) +- [Customizations Excluded from Clean Up](/docs/platgovsalesforce/cleanup/cleanup_reports.md#customizations-excluded-from-clean-up) +- [Unused Fields](/docs/platgovsalesforce/cleanup/cleanup_reports.md#unused-fields) +- [Unused Apex Code](/docs/platgovsalesforce/cleanup/cleanup_reports.md#unused-apex-code) +- [Unused Reports](/docs/platgovsalesforce/cleanup/cleanup_reports.md#unused-reports) +- [Customizations with Inactive Owners](/docs/platgovsalesforce/cleanup/cleanup_reports.md#customizations-with-inactive-owners) +- [Customizations without Related Processes](/docs/platgovsalesforce/cleanup/cleanup_reports.md#customizations-without-related-processes) +- [Custom Fields without Help Text](/docs/platgovsalesforce/cleanup/cleanup_reports.md#custom-fields-without-help-text) +- [Custom Fields without Description](/docs/platgovsalesforce/cleanup/cleanup_reports.md#custom-fields-without-description) ## Change Enablement -These reports are available from **Netwrix Dashboard** > **Reports** > **Change Enablement**. - -> **Approval Override**: shows all changes approved with an approval override. -> -> **What Changed?**: shows all changes that have occurred. -> -> **Unresolved Non-Compliant Changes**: displays open non-compliant changes. A non-compliant change -> indicates something was changed without the required approvals. By looking at this report, you can -> investigate changes and get an understanding of what the impacts are and see if any additional -> changes need to be made. This report is used to track changes that require action. -> -> **Managed Package Updates**: displays managed package update details for auditing. -> -> **Resolved Non-Compliant Changes**: displays resolved non-compliant changes with the change -> overview and the difference summary. -> -> **Compliant Changes**: displays all compliant changes. Compliant changes are automatically marked -> as closed. This report is used to review changes that have been automatically cleared. -> -> **Consolidated Change By Type**: displays changes summarized and grouped by Salesforce Type. -> -> **Deployed Changes**: displays an end to end summary of deployed changes to enable tracking and -> reporting of changes to the system. -> -> **Data Tracking Change Logs**: displays changes on objects set for data tracking. -> -> **Change/Approval Policy Changes**: this report is based on Field History Tracking. You can track -> up to 20 fields from the Policy Record. Salesforce starts tracking field history from the date and -> time you turn it on a field. -> -> **Fast Scan for Permissions Changes**: displays all changes detected in PermissionSet, -> PermissionSetGroup, and Profiles by the Fast Scan. +These reports are available from **Netwrix Dashboard** **Reports** **Change Enablement**. + +- **Approval Override**: shows all changes approved with an approval override. +- **What Changed?**: shows all changes that have occurred. +- **Unresolved Non-Compliant Changes**: displays open non-compliant changes. A non-compliant change +indicates something was changed without the required approvals. By looking at this report, you can +investigate changes and get an understanding of what the impacts are and see if any additional +changes need to be made. This report is used to track changes that require action. +- **Managed Package Updates**: displays managed package update details for auditing. +- **Resolved Non-Compliant Changes**: displays resolved non-compliant changes with the change +overview and the difference summary. +- **Compliant Changes**: displays all compliant changes. Compliant changes are automatically marked +as closed. This report is used to review changes that have been automatically cleared. +- **Consolidated Change By Type**: displays changes summarized and grouped by Salesforce Type. +- **Deployed Changes**: displays an end to end summary of deployed changes to enable tracking and +reporting of changes to the system. +- **Data Tracking Change Logs**: displays changes on objects set for data tracking. +- **Change/Approval Policy Changes**: this report is based on Field History Tracking. You can track +up to 20 fields from the Policy Record. Salesforce starts tracking field history from the date and +time you turn it on a field. +- **Fast Scan for Permissions Changes**: displays all changes detected in PermissionSet, +PermissionSetGroup, and Profiles by the Fast Scan. ## Release and Deployment -These reports are available from **Netwrix Dashboard** > **Reports** > **Release and Deployment**. +These reports are available from **Netwrix Dashboard** **Reports** **Release and Deployment**. -> [Success Deployments](/docs/platgovsalesforce/reports/deployment_logs_success.md) -> -> [Deployments with Failures](/docs/platgovsalesforce/reports/deployment_logs_failures.md) -> -> [Deployments Pending Approval](/docs/platgovsalesforce/reports/deployment_logs_pending_approval.md) -> -> [Rollback Logs](/docs/platgovsalesforce/reports/deployment_logs_rollback.md) +- [Success Deployments](/docs/platgovsalesforce/reports/deployment_logs_success.md) +- [Deployments with Failures](/docs/platgovsalesforce/reports/deployment_logs_failures.md) +- [Deployments Pending Approval](/docs/platgovsalesforce/reports/deployment_logs_pending_approval.md) +- [Rollback Logs](/docs/platgovsalesforce/reports/deployment_logs_rollback.md) ## Audit Reports -**Unresolved Non-Compliant Changes**: displays open non-compliant changes. A non-compliant change +- **Unresolved Non-Compliant Changes**: displays open non-compliant changes. A non-compliant change indicates something was changed without the required approvals. By looking at this report, you can investigate changes and get an understanding of what the impacts are and see if any additional changes need to be made. This report is used to track changes that require action. - -**Managed Package Updates**: displays managed package update details for auditing. - -**Resolved Non-Compliant Changes**: displays managed package update details for auditing. - -**Compliant Changes**: displays all compliant changes. Compliant changes are automatically marked as +- **Managed Package Updates**: displays managed package update details for auditing. +- **Resolved Non-Compliant Changes**: displays managed package update details for auditing. +- **Compliant Changes**: displays all compliant changes. Compliant changes are automatically marked as closed. This report is used to review changes that have been automatically cleared. - -**Platform Changes**: displays any platform changes that have occured. - -**Consolidated Changes By Type**: displays changes summarized and grouped by Salesforce Type. - -**Deployed Changes**: displays an end to end summary of deployed changes to enable tracking and +- **Platform Changes**: displays any platform changes that have occurred. +- **Consolidated Changes By Type**: displays changes summarized and grouped by Salesforce Type. +- **Deployed Changes**: displays an end to end summary of deployed changes to enable tracking and reporting of changes to the system. - -**Unresolved Control Incidents**: Deprecated item - -**Resolved Control Incidents**: Deprecated item - -**Pre-Approved Control Incidents**: Deprecated item +- **Unresolved Control Incidents**: Deprecated item +- **Resolved Control Incidents**: Deprecated item +- **Pre-Approved Control Incidents**: Deprecated item diff --git a/docs/platgovsalesforce/scanner/field_level_scanner.md b/docs/platgovsalesforce/scanner/field_level_scanner.md index d2ef45ca5d..bbc802957b 100644 --- a/docs/platgovsalesforce/scanner/field_level_scanner.md +++ b/docs/platgovsalesforce/scanner/field_level_scanner.md @@ -9,7 +9,9 @@ sidebar_position: 40 The Field Level Security Scanner creates a comprehensive list of Customizations, Field API Name, Parent Object, Package, and Salesforce Type for a selected Object. +:::note Run the scanners before you search to ensure you have the latest data. +::: 1. Open **Netwrix Dashboard** > **Scanner** > Field-Level Security Scanner. @@ -23,7 +25,9 @@ Run the scanners before you search to ensure you have the latest data. 4. Select one or more fields to scan. The **Customization Name** is a link to the Customization Record. - **NOTE:** It is not technically possible to scan permissions on all fields in each object. + :::note + It is not technically possible to scan permissions on all fields in each object. + ::: 5. Selected fields are shown in a list at the bottom of the form. You can uncheck individual fields or all fields from the **Selected Field** list. diff --git a/docs/platgovsalesforce/settings/settings_overview.md b/docs/platgovsalesforce/settings/settings_overview.md index 81221603f2..7ec5077508 100644 --- a/docs/platgovsalesforce/settings/settings_overview.md +++ b/docs/platgovsalesforce/settings/settings_overview.md @@ -10,10 +10,10 @@ The Settings menu is located on the Netwrix Dashboard page. The Settings tab accesses: -- **Getting Started Wizard** guides you through the installation process. -- **Configuration and Stats** is a live report of your Automated Documentation system. -- **Platform Governor Status** is a live status update of the Usage of SFDC Governor Limit. -- **Netwrix Knowledge Center**: opens the Netwrix Knowledge Center. -- **SP Credentials/Test Connection** sets up the credentials for the connected app. Required to run +- [Getting Started Wizard](/docs/platgovsalesforce/installingstrongpoint/using_getting_started_wizard.md) guides you through the installation process. +- [Configuration and Stats](/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md) is a live report of your Automated Documentation system. +- [Platform Governor Status](/docs/platgovsalesforce/installingstrongpoint/platform_governor.md) is a live status update of the Usage of SFDC Governor Limit. +- Netwrix Knowledge Center opens the Netwrix Knowledge Center. +- [SP Credentials/Test Connection](/docs/platgovsalesforce/settings/credentials.md) sets up the credentials for the connected app. Required to run Scanners. Tests the connection to help troubleshoot connectivity issues. -- **Upgrade / Downgrade Package** modifies your license. +- [Upgrade / Downgrade Package](/docs/platgovsalesforce/installingstrongpoint/license_manager.md) modifies your license. diff --git a/docs/platgovsalesforce/techdebt/tech_debt_auto_documentation.md b/docs/platgovsalesforce/techdebt/tech_debt_auto_documentation.md index d33fbc704c..914ad842c7 100644 --- a/docs/platgovsalesforce/techdebt/tech_debt_auto_documentation.md +++ b/docs/platgovsalesforce/techdebt/tech_debt_auto_documentation.md @@ -11,32 +11,22 @@ a sandbox or production org and start the scanners.Platform Governance for Sales maintains automated digital documentation of each Salesforce org and provides easy to understand diagrams and clean up tools. You can print or export results for offline reference. -> **TIP** -> -> **Learning About the Scanners**: Review the -> [Running the Scanner](/docs/platgovsalesforce/installingstrongpoint/running_scanner.md) topic or reach out to the -> Customer Success team. It takes half an hour or so to get set up and on your way. -> -> The scanning process is a function of size: smaller orgs index in only a few hours, while large -> orgs can take up to 5 days. -> -> Platform Governance for Salesforce is a 100% native Salesforce App. Our records and code usage DO -> NOT count against your governance limits. Moreover, once the initial scan is complete, Platform -> Governance for Salesforce automatically updates documentation relating only to things that have -> changed, greatly reducing the amount of time required to scan. +:::tip +**Learning About the Scanners**: Review the [Running the Scanner](/docs/platgovsalesforce/installingstrongpoint/running_scanner.md) topic or reach out to the Customer Success team. It takes half an hour or so to get set up and on your way. + +The scanning process is a function of size: smaller orgs index in only a few hours, while large orgs can take up to 5 days. + +Platform Governance for Salesforce is a 100% native Salesforce App. Our records and code usage DO NOT count against your governance limits. Moreover, once the initial scan is complete, Platform Governance for Salesforce automatically updates documentation relating only to things that have changed, greatly reducing the amount of time required to scan. +::: Once your orgs are documented, understanding the downstream dependencies of any change is a straightforward, simple process. There are a number of ways to do this: -> Dependency Relationship Diagram (DRD) -> -> Customization Record -> -> Finder -> -> Object Exporter -> -> Reports and List Views +- Dependency Relationship Diagram (DRD) +- Customization Record +- Finder +- Object Exporter +- Reports and List Views ## Dependency Relationship Diagram (DRD) @@ -67,10 +57,11 @@ the dependencies. 4. Click **Open Record** to open the full Customization Record with complete access to the detailed metadata and change history for the Customization. -> **PRO TIPS** -> -> - Read more about the [Customization Record](/docs/platgovsalesforce/customizations/customizations_overview.md). -> - Click **Show/Hide Standard Fields** to toggle displaying Standard Fields in the DRD. +:::tip +Read more about the [Customization Record](/docs/platgovsalesforce/customizations/customizations_overview.md). + +Click **Show/Hide Standard Fields** to toggle displaying Standard Fields in the DRD. +::: ## Customization Record diff --git a/docs/platgovsalesforce/techdebt/tech_debt_change_monitoring.md b/docs/platgovsalesforce/techdebt/tech_debt_change_monitoring.md index b6ff1bff24..4e0fc3ad38 100644 --- a/docs/platgovsalesforce/techdebt/tech_debt_change_monitoring.md +++ b/docs/platgovsalesforce/techdebt/tech_debt_change_monitoring.md @@ -17,14 +17,9 @@ workflows, triggers), profiles or roles is essential. The severity level can be change a policy should impose. For example, code-related changes normally follow a tighter approval process than simple data model changes. -> **TIP** -> -> **How Change Policies Work**: Every time a customization is created or changed in an org, Platform -> Governance for Salesforce checks to see if the change should have been reviewed or approved. By -> default, this depends on the dependencies — a picklist with no dependencies is a relatively safe -> change compared to a picklist with risky code dependencies. Default policies can be customized and -> applied to specific customizations. For example, most reports do not need change control, but -> management reports need to be tightly controlled. +:::tip +**How Change Policies Work**: Every time a customization is created or changed in an org, Platform Governance for Salesforce checks to see if the change should have been reviewed or approved. By default, this depends on the dependencies — a picklist with no dependencies is a relatively safe change compared to a picklist with risky code dependencies. Default policies can be customized and applied to specific customizations. For example, most reports do not need change control, but management reports need to be tightly controlled. +::: Policies define the level of change control to follow to reduce risk. The five change levels contain escalating levels of rigor and/or skill required to address a change: @@ -33,7 +28,7 @@ escalating levels of rigor and/or skill required to address a change: | --------------------------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | L1: Log Changes | This is a safe change. | Ordinary report. | Anyone. | | L2: Process Issue | This is a relatively safe change but should be reviewed afterward. | Public report. | Anyone. | -| L3: Change Request | This needs approval from management but not sandbox review. | Management report or Control. | Anyone, provided prior approval is granted | +| L3: Change Request | This needs approval from management but not sandbox review. | Management report or Control. | Anyone, provided prior approval is granted. | | L4: Sandbox Development and Testing | This is not a complex change, but best practices require it to be tested in a sandbox first. | Data model changes with no dependencies. For example, adding a new field. | Business Analyst or Admin with prior approval, working in sandbox before deploying in production. | | L5: Full Software Development Lifecycle | This is not a safe change. It needs to be changed carefully with rigorous testing. | Changes to code or a picklist used in field with code or SoQL dependencies. | Admin / Developer with prior approval working through a full development cycle in multiple sandboxes. | @@ -67,13 +62,10 @@ prioritize what you see. The default policy may be all you require. However, you should consider whether there are specific people, objects, reports or fields that need special protection. These can be addressed in two ways: -> Specific People -> -> Specific Customizations -> -> Specific Changes -> -> Adding Custom Fields and Objects to the Policy +- Specific People +- Specific Customizations +- Specific Changes +- Adding Custom Fields and Objects to the Policy ### Specific People diff --git a/docs/platgovsalesforce/techdebt/tech_debt_managing_orgs.md b/docs/platgovsalesforce/techdebt/tech_debt_managing_orgs.md index 8f9cad4230..f5f1d77985 100644 --- a/docs/platgovsalesforce/techdebt/tech_debt_managing_orgs.md +++ b/docs/platgovsalesforce/techdebt/tech_debt_managing_orgs.md @@ -39,16 +39,13 @@ in short order: This table describes the critical stages and how Platform Governance for Salesforce helps at each stage. -> **PRO TIP** -> -> Each stage delivers benefits to significantly improve your ability to manage technical debt. Take -> your time and adjust the order based on your workload or priorities. The customer support team is -> available to assist in implementing Intelligent Change Enablement quickly to meet your immediate -> needs. +:::tip +Each stage delivers benefits to significantly improve your ability to manage technical debt. Take your time and adjust the order based on your workload or priorities. The customer support team is available to assist in implementing Intelligent Change Enablement quickly to meet your immediate needs. +::: | Stage | Automated Documentation | Change Monitoring | Org Clean Up | Change Enablement | | -------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Benefit | Plan your changes confidently with a firm understanding of what is in use | Monitor all changes in all orgs for technical and organizational risk | Simplify and maintain your orgs for future success | Improve time to value with automated tools that assess risk and intelligently distribute work within your team | -| How Platform Governance for Salesforce Helps | Creates visual, searchable documentation making it easy to understand complex orgs | Instantiates policies to mitigate risky changes before they are deployed | Simplifies clean up with a combination of automated tools, dependency models and usage data | Ensures changes are made properly, safely and efficiently, resulting in up to 80% reduction in enhancement requests that require a CoE or CI/CD process | +| **Benefit** | Plan your changes confidently with a firm understanding of what is in use | Monitor all changes in all orgs for technical and organizational risk | Simplify and maintain your orgs for future success | Improve time to value with automated tools that assess risk and intelligently distribute work within your team | +| **How Platform Governance for Salesforce Helps** | Creates visual, searchable documentation making it easy to understand complex orgs | Instantiates policies to mitigate risky changes before they are deployed | Simplifies clean up with a combination of automated tools, dependency models and usage data | Ensures changes are made properly, safely and efficiently, resulting in up to 80% reduction in enhancement requests that require a CoE or CI/CD process | **Next Technical Debt Topic:** [Automated Documentation](/docs/platgovsalesforce/techdebt/tech_debt_auto_documentation.md) diff --git a/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up.md b/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up.md index 9de21f4114..1b99a40d41 100644 --- a/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up.md +++ b/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up.md @@ -27,11 +27,9 @@ license. These items can help you identify Customizations for Clean Up: -> Date Last Used -> -> Automated Report Clean Up -> -> Employees Related to a Customization +- Date Last Used +- Automated Report Clean Up +- Employees Related to a Customization ## Date Last Used @@ -83,13 +81,13 @@ process is simple: - Private Reports - Date Last Used -4. - Excludes Reports covered by a special policy or with any downstream dependencies to ensure you - do not delete something important. +4. Excludes Reports covered by a special policy or with any downstream dependencies to ensure you do not delete something important. + - Emails Report owners (if desired) that the Report is being archived. The owner can retain the Report with a simple mouse click. The Date Last Used is updated to the current date. - Deletes the Reports that were not retained, but keeps the Report definition. - When you run the Clean Up, Archived Reports can be easily be restored if needed. + When you run the Clean Up, Archived Reports can be easily be restored if needed. 5. Schedule your rules to run on a regular basis to keep your orgs cleaned up and efficient. @@ -136,11 +134,8 @@ examples. The current owner of each Customization is tracked. By default, it is the person who created it. In cases such as Reports, this is useful to understand who needs to approve a change to a report. -> **TIP** -> -> You can use the **Change Owner** button on any Customization List View. For an individual -> Customization, edit the Owner field on the Customization Record. Best practice if you have a staff -> change, is to update the Process record, which then updates the owner for all the affected -> Customizations. +:::tip +You can use the **Change Owner** button on any Customization List View. For an individual Customization, edit the Owner field on the Customization Record. Best practice if you have a staff change, is to update the Process record, which then updates the owner for all the affected Customizations. +::: **Next Technical Debt Topic:**[ Org Clean Up Example](/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up_example.md) diff --git a/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up_example.md b/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up_example.md index 37f2a0975b..c20b3e9572 100644 --- a/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up_example.md +++ b/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up_example.md @@ -76,26 +76,22 @@ complications. ignored Customizations, select: **Strongpoint** > **Reports** > **Clean Up** > **Customizations Excluded From Clean Up** -> **PRO TIP** -> -> If you are cleaning up a very large object, add a filter for **Clean Up Status** equals **“”**. -> This shortens your list as you work your way through the fields and set an appropriate **Clean Up -> Status**. Remove the filter later when you want to work through the fields. -> -> - **Archived**: tracks automatically cleaned up Reports. -> - **Deleted**: tracks Customizations that have been deleted. -> - **Reassign Owner**: reassigns the Owner of one or more Customizations. +:::tip +If you are cleaning up a very large object, add a filter for **Clean Up Status** equals **“”**. This shortens your list as you work your way through the fields and set an appropriate **Clean Up Status**. Remove the filter later when you want to work through the fields. + +- **Archived**: tracks automatically cleaned up Reports. +- **Deleted**: tracks Customizations that have been deleted. +- **Reassign Owner**: reassigns the Owner of one or more Customizations. +::: ## Step 3: Track the Progress of the Clean Up Process You now have a list of unused fields on the Account object grouped into fields that are relatively simple to clean up and fields with code and other critical dependencies. -> **TIP** -> -> If you have a blank List View, remove the filter on the **Clean Up Status** or set it to **To Be -> Cleaned Up**. If you set a **Project Name** in the **Clean Up Classification**, you can filter for -> it in the search box at the top of the List View. +:::tip +If you have a blank List View, remove the filter on the **Clean Up Status** or set it to **To Be Cleaned Up**. If you set a **Project Name** in the **Clean Up Classification**, you can filter for it in the search box at the top of the List View. +::: Some of the fields may have associated Reports or List Views. If you open the DRD in the Customization Record, you can drill into the details to see if removing the field is likely to cause @@ -140,17 +136,12 @@ a Change Request directly from the List View: Customizations** list. **Save** when you are finished. 6. When you are ready, Submit your Change Request for Approval. -> **PRO TIP** -> -> You can add additional approvers (beyond what is required for the policy) to the Change Request. -> Initially, only the approvers from your default policy are required. There are two methods to add -> additional approvers: -> -> - Create a Process Record and specify approvers. Add the Process Record to the Change Request -> under the **Affected Processes** field. The additional approvers are added to this Change -> Request and can be reused on future Change Requests. **Process Owner Approvals** must be enabled -> on the applicable Policy. -> - Manually specify one or more approvers in the **Additional Approvers** field. +:::tip +You can add additional approvers (beyond what is required for the policy) to the Change Request. Initially, only the approvers from your default policy are required. There are two methods to add additional approvers: + +- Create a Process Record and specify approvers. Add the Process Record to the Change Request under the **Affected Processes** field. The additional approvers are added to this Change Request and can be reused on future Change Requests. **Process Owner Approvals** must be enabled on the applicable Policy. +- Manually specify one or more approvers in the **Additional Approvers** field. +::: If you are not using Change Enablement, you can export the results to Excel by clicking the **Export To Excel** on the Change Request **Impact Analysis** tab. You can also create a report of diff --git a/docs/platgovsalesforce/techdebt/tech_debt_org_specific_clean_up_approaches.md b/docs/platgovsalesforce/techdebt/tech_debt_org_specific_clean_up_approaches.md index d397874eb4..83e7e37a97 100644 --- a/docs/platgovsalesforce/techdebt/tech_debt_org_specific_clean_up_approaches.md +++ b/docs/platgovsalesforce/techdebt/tech_debt_org_specific_clean_up_approaches.md @@ -11,17 +11,12 @@ very flexible, to help you clean up objects quickly and effectively. Here are some guidelines to specific clean up problems: -> Unused, Risky -> -> Unused Automation -> -> Unused Test Classes -> -> Entire Object or Group of Parent / Child Objects -> -> Layouts and List Views -> -> Value-based Clean Up +- Unused, Risky +- Unused Automation +- Unused Test Classes +- Entire Object or Group of Parent / Child Objects +- Layouts and List Views +- Value-based Clean Up These guidelines assume you set up your List Views the same way as described [Step 1: Identify and Prioritize Targets](/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up_example.md). @@ -65,29 +60,29 @@ are two reasons that a test class may be unused: 1. The code it tests is no longer used. To clean these up: -1. Create a new Report based on the **Customizations with Dependencies** type. -1. Filter for: + 1. Create a new Report based on the **Customizations with Dependencies** type. + 2. Filter for: - - Salesforce Type equals **Apex Class** - - Test Class equals **True** - - Customization's Date Last Used and/or the Dependency: Date Last Used is populated and older + - Salesforce Type equals **Apex Class** + - Test Class equals **True** + - Customization's Date Last Used and/or the Dependency: Date Last Used is populated and older than X - - Optional: Filter out objects from a managed package. + - Optional: Filter out objects from a managed package. -1. Add **Clean Up Notes** that the code it tests is no longer in use. + 3. Add **Clean Up Notes** that the code it tests is no longer in use. -1. The assertions in the Test Class relate to fields no longer in use. To identify these: +2. The assertions in the Test Class relate to fields no longer in use. To identify these: -1. Create a new Report based on the **Customizations with Dependencies** report type. -1. The following filters identify test classes referencing fields that have not been used in the + 1. Create a new Report based on the **Customizations with Dependencies** report type. + 2. The following filters identify test classes referencing fields that have not been used in the past six months: -- Salesforce Type equals **Apex Class** -- Test Class equals **True** -- Dependency: Salesforce Type equals **CustomField** -- Dependency: Date Last Used less than **180 DAYS AGO** + - Salesforce Type equals **Apex Class** + - Test Class equals **True** + - Dependency: Salesforce Type equals **CustomField** + - Dependency: Date Last Used less than **180 DAYS AGO** -3. Add **Clean Up Notes** that the Test Class assertions relate to fields no longer in use. + 3. Add **Clean Up Notes** that the Test Class assertions relate to fields no longer in use. ## Entire Object or Group of Parent / Child Objects diff --git a/docs/platgovsalesforce/techdebt/tech_debt_overview.md b/docs/platgovsalesforce/techdebt/tech_debt_overview.md index c8f0ac4cf4..436a60ca72 100644 --- a/docs/platgovsalesforce/techdebt/tech_debt_overview.md +++ b/docs/platgovsalesforce/techdebt/tech_debt_overview.md @@ -20,7 +20,9 @@ to extreme. We move rapidly through critical stages of Salesforce org management Each article ends with a link to the next topic in the **Managing Technical Debt** series. -> **TIPS** and **PRO TIPS**:Provide optional background or details in these articles. +::::tip +Tips provide optional background or details in these articles. +:::: _Technical debt_ (tech debt) is the cost of reworking a system to fix or work around implemented solutions. A key cause of tech debt is solutions that were not fully engineered at the time they diff --git a/docs/platgovsalesforce/tools/access_review.md b/docs/platgovsalesforce/tools/access_review.md index f98557aa61..436c08eba3 100644 --- a/docs/platgovsalesforce/tools/access_review.md +++ b/docs/platgovsalesforce/tools/access_review.md @@ -11,7 +11,9 @@ selected **Object**, **User**, or **Profile / PermissionSet**. The results can b The Access Review Assistant feature is available with the Intelligent Change Enablement and Enterprise Compliance [licenses](/docs/platgovsalesforce/installingstrongpoint/features_by_license_type.md). +:::note Run the scanners before you perform comparisons to ensure you have the latest data. +::: There are three Access Assistance search types: diff --git a/docs/platgovsalesforce/tools/change_logs_clean_up.md b/docs/platgovsalesforce/tools/change_logs_clean_up.md index 3e51addb86..b3c1055d07 100644 --- a/docs/platgovsalesforce/tools/change_logs_clean_up.md +++ b/docs/platgovsalesforce/tools/change_logs_clean_up.md @@ -9,9 +9,11 @@ sidebar_position: 120 The **Change Logs Clean Up** tool enables you to schedule an automatic clean up of old Change Logs. Cleaning up these old logs helps keep your orgs efficient and organized. +:::note Netwrix recommends this clean up process be used as part of your Salesforce data backup and recovery plan. You should discuss with your compliance team how many months/years of Change Logs you need to retain and how this should be split between live and archived data. +::: 1. Open **Netwrix Dashboard** > **Tools** > **Change Logs Clean Up** diff --git a/docs/platgovsalesforce/tools/environment_comparison.md b/docs/platgovsalesforce/tools/environment_comparison.md index 2415bcf8a6..a170a4385b 100644 --- a/docs/platgovsalesforce/tools/environment_comparison.md +++ b/docs/platgovsalesforce/tools/environment_comparison.md @@ -16,15 +16,11 @@ file. Here is the basic process: Open **Netwrix Dashboard** > **Tools** > **Environment Comparison** -Select the Environments to Compare - -Add Filters for the Comparison - -Select Export Options - -Run the Comparison - -View the Report +1. Select the Environments to Compare +2. Add Filters for the Comparison +3. Select Export Options +4. Run the Comparison +5. View the Report ## Select the Environments to Compare @@ -46,8 +42,10 @@ Filters determine what is included in the comparison. There are four options to - Option 3: Select Specific Customizations - Option 4: Packages to Exclude (All Options) -**NOTE:** Filters are cumulative. Use a single filter (1 through 3) to avoid overlapping selections. +:::note +Filters are cumulative. Use a single filter (1 through 3) to avoid overlapping selections. **Packages to Exclude** can be used in conjunction with options 1 through 3. +::: ### Set a Metadata Type diff --git a/docs/platgovsalesforce/tools/export_object_attachment_records.md b/docs/platgovsalesforce/tools/export_object_attachment_records.md index 9ba9c60578..8e54896749 100644 --- a/docs/platgovsalesforce/tools/export_object_attachment_records.md +++ b/docs/platgovsalesforce/tools/export_object_attachment_records.md @@ -16,45 +16,41 @@ Attachments**. ![Example Export Object Attachment detail](/img/product_docs/platgovsalesforce/tools/export_object_attach_record.webp) The export history is saved in Salesforce. You can view the list, or add the Export Object -Attachments tabs to your menu bar. +Attachments tabs to your menu bar. The steps are different depending on if you are using the Lightning app or the Classic view. -> Salesforce Classic View -> -> Salesforce Lightning - -## Salesforce Classic View +## Salesforce Lightning ### View the List -1. Click the **+** in the menu bar to open the **All Tabs** list (Salesforce Classic). -2. Select **Export Object Attachments**. - -![Export Object Attachments list](/img/product_docs/platgovsalesforce/tools/export_object_attach_record_list.webp) +Enter **Export Object Attachments** in the **Search Salesforce** entry box on the top of your page. ### Add the **Export Object Attachments** Tab -1. Click the **+** in the menu bar to open the **All Tabs** list. -2. Click **Customize My Tabs** +1. Open **Setup** > **Apps** > **App Manager** +2. Locate **Strongpoint** in the list. From the pull down menu on the right, select **Edit**. 3. Select **Export Object Attachments** from the **Available Tabs** and add it to the **Selected Tabs**. - ![Add Export Object Attachments to your menu bar in Classic view](/img/product_docs/platgovsalesforce/tools/export_object_attach_record_tab_classic.webp) + ![Add Export Object Attachments tab to your menu bar in Lightning](/img/product_docs/platgovsalesforce/tools/export_object_attach_record_tab_lightning.webp) 4. Click **Save**. -## Salesforce Lightning +## Salesforce Classic View ### View the List -Enter **Export Object Attachments** in the **Search Salesforce** entry box on the top of your page. +1. Click the **+** in the menu bar to open the **All Tabs** list (Salesforce Classic). +2. Select **Export Object Attachments**. + +![Export Object Attachments list](/img/product_docs/platgovsalesforce/tools/export_object_attach_record_list.webp) ### Add the **Export Object Attachments** Tab -1. Open **Setup** > **Apps** > **App Manager** -2. Locate **Strongpoint** in the list. From the pull down menu on the right, select **Edit**. +1. Click the **+** in the menu bar to open the **All Tabs** list. +2. Click **Customize My Tabs** 3. Select **Export Object Attachments** from the **Available Tabs** and add it to the **Selected Tabs**. - ![Add Export Object Attachments tab to your menu bar in Lightning](/img/product_docs/platgovsalesforce/tools/export_object_attach_record_tab_lightning.webp) + ![Add Export Object Attachments to your menu bar in Classic view](/img/product_docs/platgovsalesforce/tools/export_object_attach_record_tab_classic.webp) -4. Click **Save**. +4. Click **Save**. \ No newline at end of file diff --git a/docs/platgovsalesforce/tools/export_objects.md b/docs/platgovsalesforce/tools/export_objects.md index a3e873ac9f..55b04ce7db 100644 --- a/docs/platgovsalesforce/tools/export_objects.md +++ b/docs/platgovsalesforce/tools/export_objects.md @@ -14,20 +14,20 @@ link to the [Export Object Attachment](/docs/platgovsalesforce/tools/export_obje download your file. You can also use the **Download Files** link on this page or on the Netwrix Dashboard to download your file. +You can export **Permissions by Object** or **Object Permissions by Profile/PermSet**. + +:::note Platform Governance for Salesforce stores Object-level permissions in a Custom Object. There are two reports (**Netwrix Dashboard** > **Reports** > **Access Reports**) for easy access to this information: - -> **Permissions by Object** -> -> **Object Permissions by Profile/PermSet** +::: Open **Netwrix Dashboard** > **Tools** > **Export Objects** **Objects** is the default tab. ![export_object](/img/product_docs/platgovsalesforce/tools/export_object.webp) -Objects +**Objects** Enter all or part of a name in **Filter** to filter the list of objects. @@ -36,13 +36,13 @@ within the selected option to remove it. You can use the **Select All** and **Cl ![Select the objects](/img/product_docs/platgovsalesforce/tools/export_object_filter.webp) -Settings to be Exported +**Settings to be Exported** Click the toggles to activate or inactivate the settings you want to export. ![export_object_settings](/img/product_docs/platgovsalesforce/tools/export_object_settings.webp) -Profiles: Object and Field Level Security (Optional) +**Profiles: Object and Field Level Security (Optional)** Enter all or part of a name in **Filter** to filter the list of profiles. @@ -52,7 +52,7 @@ options. ![export_object_profiles](/img/product_docs/platgovsalesforce/tools/export_object_profiles.webp) -Permission Sets: Object and Field Level Security (Optional) +**Permission Sets: Object and Field Level Security (Optional)** Enter all or part of a name in **Filter** to filter the list of permission sets. @@ -62,12 +62,12 @@ options. ![export_object_permissions](/img/product_docs/platgovsalesforce/tools/export_object_permissions.webp) -Download XLS +**Download XLS** Click **Download XLS** to export your selections. An email is sent with a link to the file _Object_Export.xls_. -Download Files +**Download Files** Click **Download Files** to see a list of generated files. The file does not appear in the list until it is complete. diff --git a/docs/platgovsalesforce/tools/package_usage.md b/docs/platgovsalesforce/tools/package_usage.md index 0a6cc0ee7d..5d1122d836 100644 --- a/docs/platgovsalesforce/tools/package_usage.md +++ b/docs/platgovsalesforce/tools/package_usage.md @@ -14,7 +14,9 @@ provides a comprehensive overview of who is accessing the environment and for wh The Package Usage tool is available with the Intelligent Change Enablement and Enterprise Compliance [licenses](/docs/platgovsalesforce/installingstrongpoint/features_by_license_type.md). +:::note Run the scanners first to ensure you have the latest data. +::: Once you have run the scanner, you filter and export the data: diff --git a/docs/platgovsalesforce/tools/profile_permission_comparison.md b/docs/platgovsalesforce/tools/profile_permission_comparison.md index 6a96ff3a5c..462abaf841 100644 --- a/docs/platgovsalesforce/tools/profile_permission_comparison.md +++ b/docs/platgovsalesforce/tools/profile_permission_comparison.md @@ -20,7 +20,9 @@ Comparison tool features include: permissions. - _Export Results to Excel_: Share and analyze comparison results. +:::note Run the scanners before you perform comparisons to ensure you have the latest data. +::: ## System Permission Comparison diff --git a/docs/platgovsalesforce/tools/tools_overview.md b/docs/platgovsalesforce/tools/tools_overview.md index c0fb48a6a8..b73a32129e 100644 --- a/docs/platgovsalesforce/tools/tools_overview.md +++ b/docs/platgovsalesforce/tools/tools_overview.md @@ -8,32 +8,19 @@ sidebar_position: 50 There are links to access **Key Tools** on the Netwrix Dashboard page: -- **DRD** displays a graphical view of relationships and dependencies between objects. -- **Finder** searches for standard and custom objects. -- **Export Objects** exports objects, profiles and permissions, and users to an Excel file. -- **Permissions Comparison** gives you the information you need to clean your orgs. +- [DRD](/docs/platgovsalesforce/tools/viewing_drd.md) displays a graphical view of relationships and dependencies between objects. +- [Finder](/docs/platgovsalesforce/tools/finder.md) searches for standard and custom objects. +- [Export Objects](/docs/platgovsalesforce/tools/export_objects.md) exports objects, profiles and permissions, and users to an Excel file. +- [Permissions Comparison](/docs/platgovsalesforce/tools/profile_permission_comparison.md) gives you the information you need to clean your orgs. -The Tools tab accesses: +The **Tools** tab accesses: -> **Dependency Relationship Diagram** (DRD): displays a graphical view of relationships and -> dependencies between objects. -> -> **Finder**: searches for standard and custom objects. -> -> **Export Objects**: exports objects, profiles and permissions, and users to an Excel file. -> -> **Environment Comparison**: enables you to compare objects in two different Salesforce instances -> (such as Sandbox and Production). -> -> **Permissions Comparison**: enables you to compare profile and permission sets. -> -> **Access Review Assistant**: enables you to easily search for an object, apply filters, and get -> exactly the information you need. -> -> **User Activity**: displays all activity for a specific user or all users. This tool is used -> before you can deactivate a user. -> -> **Automated Report Clean Up**: runs automatically or on demand using custom rules to find and -> manage reports. -> -> **Change Logs Clean Up**: sets the schedule to run the tool. +- [Dependency Relationship Diagram (DRD)](/docs/platgovsalesforce/tools/viewing_drd.md) displays a graphical view of relationships and dependencies between objects. +- [Finder](/docs/platgovsalesforce/tools/finder.md) searches for standard and custom objects. +- [Export Objects](/docs/platgovsalesforce/tools/export_objects.md) exports objects, profiles and permissions, and users to an Excel file. +- [Environment Comparison](/docs/platgovsalesforce/tools/environment_comparison.md) enables you to compare objects in two different Salesforce instances (such as Sandbox and Production). +- [Permissions Comparison](/docs/platgovsalesforce/tools/profile_permission_comparison.md) enables you to compare profile and permission sets. +- [Access Review Assistant](/docs/platgovsalesforce/tools/access_review.md) enables you to easily search for an object, apply filters, and get exactly the information you need. +- [User Activity](/docs/platgovsalesforce/tools/user_activity.md) displays all activity for a specific user or all users. This tool is used before you can deactivate a user. +- [Automated Report Clean Up](/docs/platgovsalesforce/tools/automated_report_clean_up.md) runs automatically or on demand using custom rules to find and manage reports. +- [Change Logs Clean Up](/docs/platgovsalesforce/tools/change_logs_clean_up.md) sets the schedule to run the tool. diff --git a/docs/platgovsalesforce/tools/user_activity.md b/docs/platgovsalesforce/tools/user_activity.md index 21fe520bcd..b1b7fcd2ad 100644 --- a/docs/platgovsalesforce/tools/user_activity.md +++ b/docs/platgovsalesforce/tools/user_activity.md @@ -13,11 +13,13 @@ prior to deactivating a user. The User Login Activity feature is available with the Intelligent Change Enablement and Enterprise Compliance [licenses](/docs/platgovsalesforce/installingstrongpoint/features_by_license_type.md). +:::note Run the scanners before you perform comparisons to ensure you have the latest data. +::: Select **Tools** > **User Activity** from the Netwrix Dashboard page. -There is a collapsible menu pane available. Click the u arrow on the left to expand/collapse the +There is a collapsible menu pane available. Click the 🞂 arrow on the left to expand/collapse the menu. Refer to [Package Usage](/docs/platgovsalesforce/tools/package_usage.md) for details on the Package Usage tool. ![User Activity tool](/img/product_docs/platgovsalesforce/tools/user_activity.webp)