diff --git a/docs/platgovnetsuite/CLAUDE.md b/docs/platgovnetsuite/CLAUDE.md new file mode 100644 index 0000000000..2a7f211c19 --- /dev/null +++ b/docs/platgovnetsuite/CLAUDE.md @@ -0,0 +1,76 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## Product + +**Platform Governance for NetSuite** (formerly Strongpoint) is a NetSuite SuiteApp that auto-documents customizations and enforces change management and compliance workflows. It is a single-version SaaS product (`version: "current"`), so all edits apply to the one live version. + +The legacy product name "Strongpoint" still appears in some file names, internal NetSuite UI labels, and older content. When writing or editing docs, use "Platform Governance for NetSuite" — not "Strongpoint" — except when referring to a specific UI element that says "Strongpoint" (e.g., the Strongpoint tab in NetSuite's toolbar). + +## Content Map + +| Directory | What it covers | +|---|---| +| `installation/` | Bundle install, Spider setup, user/role/permission management, license types | +| `changemanagement/` | Change Requests, Process Issues, Deployment Records, Opportunistic Clearance, environment comparison, approval policies | +| `customization/` | Customization records, impact analysis, ERD, change logs | +| `cleanup/` | Archiving, restoring, and deleting unused fields and customizations | +| `scriptmgmt/` | Critical Script Analysis: performance, errors, debugging logs, scheduler | +| `sod/` | Advanced Segregation of Duties: rules, violations, approvals, reports, clean-up | +| `uar/` | User Access Review: role/permission/membership reviews, admin/owner/auditor/additional-reviewer roles | +| `agent/` | Automated IT/financial controls, control incidents, lookback, pre-approved changes | +| `ticketingintegrations/` | Jira (classic + Forge), ServiceNow, Zendesk integrations; REST API overview (Change Request API, Customizations API) | +| `tools/` | Spider, Standard Field Impact Analysis | +| `automatedsearchcleanup/` | Automated cleanup of unused saved searches | +| `bundleremoval/` | Uninstalling the bundle | +| `integrations/` | Integration mapping between NetSuite and external systems | +| `reportabug/` | Troubleshooting guides for known issues | +| `archive/` | Release notes for versions 7.0–7.3 | + +## Key Terminology + +- **Spider** — the scanning process that catalogs all NetSuite customizations; runs on a schedule or manually. Takes 4–5 days on first run. +- **Customization Record** — a Platform Governance record that documents a single NetSuite customization object (script, field, workflow, etc.) +- **Change Request** — the central record for planning, approving, and tracking a change. Links to Process Issues, Deployment Records, and customizations. +- **Process Issue** — optional pre-change record for triaging and initiating a Change Request; can link to external ticketing systems. +- **Deployment Record** — tracks deployment approvals after a Change Request is approved. +- **Agent** — the automated control engine; monitors financially relevant records and fields outside of configuration changes. +- **SoD (Segregation of Duties)** — role/permission conflict detection and enforcement. +- **UAR (User Access Review)** — periodic review process confirming users have appropriate roles and permissions. +- **Opportunistic Clearance** — a setting that auto-clears low-risk non-compliant changes without full approval. +- **Change Level** — the compliance tier required for a change, determined automatically by change/approval policies. + +## Module Tiers + +Content frequently references which license tier a feature requires. The three tiers are: + +1. **Documentation** — Spider + Customization Records +2. **Intelligent Change Management** — adds Change Requests, Process Issues, environment comparison +3. **Enterprise Compliance** — adds Advanced SoD, UAR, Agent, blocking controls + +When editing features gated behind a tier, check `installation/features_by_license_type.md` for the current mapping before making claims about availability. + +## UAR Role Structure + +UAR has four distinct reviewer roles, each with its own subdirectory under `uar/`: + +- **Admin** (`adminoverview/`) — creates and manages reviews +- **Owner** (`owneroverview/`) — reviews roles they own +- **Auditor** (`auditoroverview/`) — read-only audit access +- **Additional Reviewer** (`addrevieweroverview/`) — assigned by Owners for membership reviews + +When editing UAR content, verify which role perspective the file is written from — they have overlapping but distinct workflows. + +## Ticketing Integrations + +There are two separate Jira integrations: + +- **Jira Integration** (`jiraintegration/`) — older REST-based integration +- **Jira Forge Integration** (`jiraforgeintegration/`) — newer Forge app-based integration + +These are distinct products with different setup steps. Don't conflate them. + +## Images + +Images are stored at `/static/images/platgovnetsuite/` organized by section (e.g., `/images/platgovnetsuite/sod/`, `/images/platgovnetsuite/uar/`). Reference with absolute paths. Image format is `.webp`. diff --git a/docs/platgovsalesforce/CLAUDE.md b/docs/platgovsalesforce/CLAUDE.md new file mode 100644 index 0000000000..fac1e8c4a1 --- /dev/null +++ b/docs/platgovsalesforce/CLAUDE.md @@ -0,0 +1,71 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## Product + +**Platform Governance for Salesforce** (formerly Strongpoint) is a Salesforce managed package that auto-documents customizations and enforces change management and compliance workflows. It is a single-version SaaS product (`version: "current"`), so all edits apply to the one live version. + +The legacy product name "Strongpoint" still appears in some directory names (`installingstrongpoint/`), internal Salesforce UI labels (e.g., "Strongpoint DLU Parameter", "Strongpoint Home Page"), and older content. When writing or editing docs, use "Platform Governance for Salesforce" — not "Strongpoint" — except when referring to a specific UI element that literally says "Strongpoint." + +The app is accessed in Salesforce via **App Launcher > Netwrix Lightning**. + +## Content Map + +| Directory | What it covers | +|---|---| +| `installingstrongpoint/` | Package install, authentication (Named Credentials / Session ID), Getting Started Wizard, scanner setup, permission sets, sandbox setup, license types | +| `changemanagement/` | Change Requests, change/approval policies, change logs, data tracking, documented metadata types, resolving non-compliant changes | +| `cleanup/` | Cleanup overview, unused customization tools, Date Last Used (DLU) | +| `customizations/` | Customization records (Lightning and legacy), folder customizations | +| `releasemanagement/` | Deployments, deployment logs, multiple environments, rollback | +| `integrations/` | Jira (classic and Forge), Zendesk integrations | +| `reports/` | Deployment log report pages | +| `scanner/` | Scanner overview, running, scheduling, FastScan, field-level scanner, DLU scanner, troubleshooting | +| `settings/` | Settings overview, credentials | +| `techdebt/` | Tech debt workflows: auto-documentation, change monitoring, org clean-up, org-specific approaches | +| `tools/` | Access review, DRD, environment comparison, field tracking, package usage, profile/permission comparison, system permission tracking, user activity, export tools | +| `release_7_0/` | Release notes for the current release | + +## Key Terminology + +- **Scanner** — the process that catalogs all Salesforce metadata customizations; replaces the term "Spider" used in Platform Governance for NetSuite. Takes 4–5 days on first run. +- **Customization Record** — a Platform Governance record documenting a single Salesforce metadata object (field, class, flow, etc.). +- **Change Request** — the central record for planning, approving, and tracking a change. +- **Change Log** — audit trail of changes to customizations; generated automatically by the scanner. +- **DRD (Dependency Relationship Diagram)** — graphical view of a customization and its relationships with other objects. +- **DLU (Date Last Used)** — tracks when a customization was last actively used; used to identify candidates for cleanup. +- **Platform Governor** — monitors Salesforce Governor Limit usage. +- **FastScan** — a targeted quick scan for specific metadata types. +- **Change/Approval Policy** — rules that define what level of approval a change to a given customization requires. +- **Data Tracking** — optional feature that logs or blocks changes to data records (not just metadata). + +## License Tiers + +Content frequently references which license tier a feature requires. The three tiers are: + +1. **Automated Documentation** — Scanner, Customization Records, DRD, Cleanup, Profile/Permission Comparison +2. **Intelligent Change Enablement** — adds Change Requests, deployments, environment comparison, user activity +3. **Enterprise Compliance** — adds Financial Controls, audit reports + +When editing features gated behind a tier, check `installingstrongpoint/features_by_license_type.md` for the current mapping. + +## Authentication Methods + +There are two authentication methods. Understanding both matters for the install and credentials docs: + +- **Named Credentials (OAuth)** — recommended for all orgs; required when Salesforce user profiles have High Assurance enabled. Configured via External Client App. Does not break on session expiry. +- **Session ID (legacy)** — uses a dedicated Integration User's username, password, and security token. Does not work with High Assurance. Documented inside a `
` block in `installingstrongpoint/installing_strongpoint.md`. + +## Ticketing Integrations + +There are two separate Jira integrations: + +- **Jira Integration** (`integrations/jiraintegration/`) — older REST-based integration +- **Jira Forge Integration** (`integrations/jiraintegrationForge/`) — newer Forge app-based integration + +These are distinct products with different setup steps. Don't conflate them. + +## Images + +Images are stored at `/static/images/platgovsalesforce/` organized by section (e.g., `/images/platgovsalesforce/installingstrongpoint/`, `/images/platgovsalesforce/customizations/`). Reference with absolute paths. Image format is `.webp`. diff --git a/docs/platgovsalesforce/changemanagement/approving_change_request.md b/docs/platgovsalesforce/changemanagement/approving_change_request.md index 90cd48e87c..1dd68ad9d0 100644 --- a/docs/platgovsalesforce/changemanagement/approving_change_request.md +++ b/docs/platgovsalesforce/changemanagement/approving_change_request.md @@ -6,20 +6,20 @@ sidebar_position: 50 # Approving a Change Request -Approvers are populated from the Change/Approval Policy for the Change Request. Approval -notifications are sent when the Change Request owner advances the status to **Pending Approval**. +The Change/Approval Policy determines the approvers for the Change Request. The system sends +approval notifications when the Change Request owner advances the status to **Pending Approval**. 1. Approvers receive an email with a link to the Change Request. 2. When the Change Request opens, **Approve** and **Reject** buttons are available at the top of the form: - - If an approver rejects the Change Request, the status is changed to **Rejected**. You can + - If an approver rejects the Change Request, the status changes to **Rejected**. You can return the Change Request to **In Progress**, edit it, and re-submit it for approval if there are errors or omissions. 3. Change Request owner [Completes and Validates the Change Request](/docs/platgovsalesforce/changemanagement/completing_change_request.md). -Once the Change Request is approved, you cannot change the customizations associated with it or make any other modifications to the record. +After the Change Request is approved, you can't change the customizations associated with it or make any other modifications to the record. You can add the **Netwrix CR Approval Override** Permission Set to specific users. Users with this Permission Set can approve a Change Request independently of the governing policy. diff --git a/docs/platgovsalesforce/changemanagement/change_and_approval_policy.md b/docs/platgovsalesforce/changemanagement/change_and_approval_policy.md index 2bcdd36773..375fc4f1d6 100644 --- a/docs/platgovsalesforce/changemanagement/change_and_approval_policy.md +++ b/docs/platgovsalesforce/changemanagement/change_and_approval_policy.md @@ -20,7 +20,7 @@ customizations and processes. It identifies the Change Policy that applies based the Customization Record and the process risk from the Process Records. The Change and Approval Policy also determines the change level required for any detected changes to -be compliant. This ensures that even changes that do not go through the planned change management +be compliant. This ensures that even changes that don't go through the planned change management process are analyzed against the policy for compliance. For example, a company may have multiple policies: @@ -33,18 +33,18 @@ For example, a company may have multiple policies: audit review. 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 +After policies are in place, they remind users of the level of change management required and monitor +the changes that occur, raising alerts to IT through custom reports if there are any change violations. ## Change Process Overview Platform Governance for Salesforce automatically detects any changes to the customizations in your -system and log them. The system finds the relevant Change/Approval Policy and determines the change +system and logs them. The system finds the relevant Change/Approval Policy and determines the change level required for compliance. It then looks for the relevant change record. For example, if it determines that a script changed and a Full Software Development Lifecycle was required for -compliance, it looks for an approved Deployment Record. If it does not find one, it flags the change -as non-compliant. An alert is sent to the Object owners notifying them of the non-compliant change. +compliance, it looks for an approved Deployment Record. If it doesn't find one, it flags the change +as non-compliant. Platform Governance for Salesforce sends an alert to the Object owners notifying them of the non-compliant change. 1. **Detect the Change**: [Automated Scanner](/docs/platgovsalesforce/installingstrongpoint/setting_up_initial_scan.md) must be enabled forPlatform Governance for Salesforce to detect a change. @@ -56,8 +56,8 @@ as non-compliant. An alert is sent to the Object owners notifying them of the no - If Platform Governance for Salesforce finds the appropriate Change Request or if the change is **Log Only**, it marks the change as compliant and attaches the Change Log to the Change Record. - - If Platform Governance for Salesforce determines the change is non-compliant (does not fall - under the relevant policy) it send an alert to IT and Object Owners to investigate the change + - If Platform Governance for Salesforce determines the change is non-compliant (doesn't fall + under the relevant policy) it sends an alert to IT and Object Owners to investigate the change and document what needs to be done to make the change compliant. 6. **Change Reporting and Resolution**: Platform Governance for Salesforce provides predefined diff --git a/docs/platgovsalesforce/changemanagement/change_log_reportfolder_dashboardfolder.md b/docs/platgovsalesforce/changemanagement/change_log_reportfolder_dashboardfolder.md index 1012eb8a0a..ef4a9e1104 100644 --- a/docs/platgovsalesforce/changemanagement/change_log_reportfolder_dashboardfolder.md +++ b/docs/platgovsalesforce/changemanagement/change_log_reportfolder_dashboardfolder.md @@ -21,7 +21,7 @@ The Change Log is organized into two main panels: | Package | The package where the change was logged | | Related Change Request | Reference to the associated Change Request (if any) | | Compliant Indicator | Compliance status according to the active policy | -| Active | Whether the customization is currently active | +| Active | Whether the customization is active | ### 2. "CHANGE DETAILS" Panel @@ -48,7 +48,7 @@ The Change Log is organized into two main panels: ## Additional Notes -- Access changes are tracked with specific indicators: +- The system tracks access changes with specific indicators: - "Change Type" shows the nature of the modification - When access is revoked, "Change Type" displays "Removed" - The layout is consistent for both ReportFolder and DashboardFolder diff --git a/docs/platgovsalesforce/changemanagement/change_management_overview.md b/docs/platgovsalesforce/changemanagement/change_management_overview.md index e6c4742422..4f916a7093 100644 --- a/docs/platgovsalesforce/changemanagement/change_management_overview.md +++ b/docs/platgovsalesforce/changemanagement/change_management_overview.md @@ -10,7 +10,7 @@ Platform Governance for Salesforce Closed Loop Change Management and Compliance change management system for changes to Salesforce accounts using the Platform Governance for Salesforce automated documentation and change management system. -Platform Governance for Salesforce extends your current change management system to enable you to: +With Platform Governance for Salesforce, you can extend your current change management system to: - Establish change management policies for different types of objects and processes. - Route changes for approval within Salesforce. @@ -18,11 +18,11 @@ Platform Governance for Salesforce extends your current change management system - Detect and resolve non-compliant changes. - Manage deployments and sandbox refreshing using best practices. -## Plan, Approve and Deploy Changes +## Plan, Approve, and Deploy Changes ### Plan with a Change Request -Change Requests are used to plan and track changes to the system. +Use Change Requests to plan and track changes to the system. They allow for common actions associated with change requests including: @@ -44,16 +44,16 @@ The **Advanced Change Management** Module provides additional functionality: :::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. +Request Number field. Use the change records because they can be linked to +processes, customizations, and clean-up activities. ::: ### Confirm with a Deployment Record -When tracking Full Software Development Lifecycle changes, the Deployment Record enables you to -track deployment approvals. Once a Change Request is approved, this documents a change is ready for -development. At this point, a new change request with the Stage Deployment Record can be created and -tracked. +When tracking Full Software Development Lifecycle changes, use the Deployment Record to +track deployment approvals. Once a Change Request is approved, the Deployment Record documents that +a change is ready for development. You can then create and track a new change request with the +Stage Deployment Record. This enables: @@ -61,4 +61,4 @@ This enables: - Documentation of approvals for deployment to document that any changes that occurred during development have been approved and that the appropriate pre-deployment checks have been completed. -This record is linked to the original change request to enable end to end reporting of the change. +This record links to the original change request to enable end-to-end reporting of the change. diff --git a/docs/platgovsalesforce/changemanagement/change_management_reports.md b/docs/platgovsalesforce/changemanagement/change_management_reports.md index 2bdb4bf6e0..0241fcdcca 100644 --- a/docs/platgovsalesforce/changemanagement/change_management_reports.md +++ b/docs/platgovsalesforce/changemanagement/change_management_reports.md @@ -7,11 +7,11 @@ sidebar_position: 10 # Change Enablement Reports Platform Governance for Salesforce has many different reports you can use to view your changes, -these include: Compliant, Open Non-Compliant and What Changed Reports. +these include: Compliant, Open Non-Compliant, and What Changed Reports. The **Compliant Changes** and **Unresolved Non-Compliant** reports are the primary reports for managing changes in your system. They display all changes in the system that are compliant and those -that are not compliant. An additional report called **What Changed?** shows all changes that have +that aren't compliant. An additional report called **What Changed?** shows all changes that have happened. To access the Change Reports: @@ -20,10 +20,10 @@ Open **Netwrix Dashboard** > **Reports** > **Change Enablement** and select one - **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. +- **Unresolved Non-Compliant Changes**: displays open non-compliant changes. A non-compliant change indicates something was changed without the required approvals. Use this report to investigate changes, understand their impacts, and identify any additional changes needed. This report tracks 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. +- **Compliant Changes**: displays all compliant changes. The system automatically marks compliant changes as closed. Use this report 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. diff --git a/docs/platgovsalesforce/changemanagement/completing_change_request.md b/docs/platgovsalesforce/changemanagement/completing_change_request.md index f03d308078..49578f8aad 100644 --- a/docs/platgovsalesforce/changemanagement/completing_change_request.md +++ b/docs/platgovsalesforce/changemanagement/completing_change_request.md @@ -6,10 +6,9 @@ sidebar_position: 60 # Completing and Validating a Change Request -Once the changes are complete, validate the Change Request and mark it as **Completed** on the path. +After the changes are complete, validate the Change Request and mark it as **Completed** on the path. -1. Open **Change Requests** to view the list of Change Requests. You may have to change the filter - from **Recently Viewed**. +1. Open **Change Requests** to view the list of Change Requests. If the list is filtered to **Recently Viewed**, change the filter to see all records. 2. Locate your Change Request and click the linked **Name**. 3. Click **Rescan** to start the change documentation process. 4. Run **Netwrix Dashboard** > **Tools** > **Environment Comparison**. Validate the changes are what diff --git a/docs/platgovsalesforce/changemanagement/creating_change_request.md b/docs/platgovsalesforce/changemanagement/creating_change_request.md index 70b8f67745..429cfee33f 100644 --- a/docs/platgovsalesforce/changemanagement/creating_change_request.md +++ b/docs/platgovsalesforce/changemanagement/creating_change_request.md @@ -9,9 +9,9 @@ sidebar_position: 40 Change requests are the method to plan, analyze, track, and approve changes. You can create different types of Change Requests to match the change you want to manage. Here are two options: -- **Customization** Change request is used for Metadata changes, such as +- **Customization** — handles Metadata changes, such as [Customizations](/docs/platgovsalesforce/customizations/customizations_overview.md). -- **Data Record** - Change request is used for Data Changes to Revenue Cloud/ +- **Data Record** — handles Data Changes to Revenue Cloud/ [CPQ](/docs/platgovsalesforce/changemanagement/datatracking/enhanced_cpq_support.md). :::note @@ -29,7 +29,7 @@ Data Record Change Requests are only available with an Enterprise Compliance lic - **Change Request Type**: Customizations for metadata changes and Data Records for data. - **Parent Change Request**: enter an optional parent change request if this is part of a bigger change. - - **Change Overview**: add a summary of the desired changes. + - **Change Overview**: add a summary of the changes you want to make. - **Change Type**: select the type from the list. **Minor** is the default. - **Is Release**: check if this change request represents a release. The customizations from all the child change requests are rolled into this release for deployment. @@ -40,15 +40,15 @@ Data Record Change Requests are only available with an Enterprise Compliance lic ![Add an existing customization to a change request](/images/platgovsalesforce/change_management/change_request_new4_light.webp) - - To search for existing Customizations, you can use different filters such as **Salesforce Type**, **Package**, **Last Modified By**, or search directly by **Name**. + - To search for existing customizations, use different filters such as **Salesforce Type**, **Package**, **Last Modified By**, or search directly by **Name**. ![Enter filters to search for customizations](/images/platgovsalesforce/change_management/change_request_new5_light.webp) - - User can search and select multiple customizations from the list. + - You can search and select multiple customizations from the list. - Once finished, click **Confirm Selection**. -5. You can also enter the **Proposed Customizations** at this point. +5. You can also enter the **Proposed Customizations** now. - Click **Add** button in the Proposed panel to add **Proposed Customizations** to the change request. @@ -57,7 +57,7 @@ Data Record Change Requests are only available with an Enterprise Compliance lic - Enter the **API Name** and **Salesforce Metadata Type**. Click **+** to add additional proposed customizations. This can be used in conjunction with customizations that already exist. All **Customizations** and **Proposed Customizations** are evaluated to determine the change - level. The highest change level is used for the change request. + level. The change request uses the highest change level found. - Once finished, click **Confirm Selection**. :::tip Troubleshooting: Incorrect API Name Format in Proposed Customizations @@ -78,7 +78,7 @@ Data Record Change Requests are only available with an Enterprise Compliance lic - **ValidationRule** `Object_Name__c.Validation_Rule_Name` - Validations are implemented for multiple Salesforce Types, so using an incorrect format will cause the request to fail. + Validations are implemented for multiple Salesforce Types, so using an incorrect format causes the request to fail. **Workaround** @@ -88,7 +88,7 @@ Data Record Change Requests are only available with an Enterprise Compliance lic - Filter an existing List View or create a new one. - - Select the desired Salesforce Type. + - Select the Salesforce Type you want. - Add the **API Name** column to the view. diff --git a/docs/platgovsalesforce/changemanagement/datatracking/data_tracking_change_logs.md b/docs/platgovsalesforce/changemanagement/datatracking/data_tracking_change_logs.md index 3bab98ffc9..5e270ca2cd 100644 --- a/docs/platgovsalesforce/changemanagement/datatracking/data_tracking_change_logs.md +++ b/docs/platgovsalesforce/changemanagement/datatracking/data_tracking_change_logs.md @@ -23,12 +23,12 @@ The platform supports different change tracking behaviors that determine how cha #### Tracked, Non-Blocking -When an object is configured as **Tracked, Non-Blocking**, the changes are monitored and recorded in Change Logs. +When an object is configured as **Tracked, Non-Blocking**, the system monitors changes and records them in Change Logs. - If the change is associated with an **approved Change Request**, the system records it as a **Compliant Change Log**. - If the change occurs **without an approved Change Request**, the system records it as a **Non-Compliant Change Log**. -In this mode, users can complete their changes while all activity is tracked and evaluated for compliance. +In this mode, users can complete their changes while the system tracks and evaluates all activity for compliance. #### Tracked, Blocking @@ -37,7 +37,7 @@ When an object is configured as **Tracked, Blocking**, the system enforces stric - If a change is associated with an **approved Change Request**, the system records it as a **Compliant Change Log**. - If a user attempts to make a change **without an approved Change Request**, the system blocks the operation. -In this case, an error message is displayed and the change isn't saved. This mode ensures that all modifications follow the required approval process before being applied. +In this case, the system displays an error message and doesn't save the change. This mode ensures that all modifications follow the required approval process before being applied. ::: @@ -66,7 +66,7 @@ The **Netwrix Platform Governance** Change Log has some features specific to dat ## Filtering Change Logs -In some cases, you might want **Change Logs** to be created only when specific conditions are met. +In some cases, you might want to create **Change Logs** only when specific conditions are met. For example: - You might want to create an **Opportunity Change Log** only when an admin updates specific fields on a **Closed Won Opportunity**. @@ -78,7 +78,7 @@ With **Netwrix Platform Governance**, you can apply filters to tracked objects u ### Using a Report as a Filter -Using a **Report** is the simplest way to implement a filter. +Using a **Report** is a common way to implement a filter. Create a report that returns a list of **record Ids**. If a tracked record update matches the report’s filter criteria, the system creates a **Change Log** for that record. @@ -99,7 +99,7 @@ This report returns only the Discount Schedule Ids of records that don't have th ### Using an Apex Class as a Filter -If your filtering logic is too complex to implement with a report, you can create a custom **Apex Class**. +To implement complex filtering logic that a report can't handle, create a custom **Apex Class**. **Netwrix Platform Governance** provides support for custom logic by allowing Apex classes to act as filters. @@ -122,7 +122,7 @@ The start and end times should be used by your filtering logic to return a Set o #### Example: Don't create Change Logs for changes in “User-Defined” CPQ Discount Schedules. -Here’s an example that does the same job as the Report filter above. +Here’s an example that does the same job as the Report filter described in the previous section. ```apex global without sharing class DiscountScheduleFilter implements FLODocs.IChangeLogFilter { @@ -142,7 +142,7 @@ global without sharing class DiscountScheduleFilter implements FLODocs.IChangeLo ### Applying a Filter to a Tracked Object -After the **Netwrix Platform Governance** scanner runs, a **Customization** record is automatically created for the corresponding **Report** or **Apex Class**. +After the **Netwrix Platform Governance** scanner runs, it automatically creates a **Customization** record for the corresponding **Report** or **Apex Class**. To configure the filter: diff --git a/docs/platgovsalesforce/changemanagement/datatracking/data_tracking_troubleshooting.md b/docs/platgovsalesforce/changemanagement/datatracking/data_tracking_troubleshooting.md index 3a4de3c6aa..231b2f4eb3 100644 --- a/docs/platgovsalesforce/changemanagement/datatracking/data_tracking_troubleshooting.md +++ b/docs/platgovsalesforce/changemanagement/datatracking/data_tracking_troubleshooting.md @@ -6,9 +6,9 @@ sidebar_position: 4 # Data Tracking - Troubleshooting -This section describes common issues and known errors that users can encounter while working with **Data Tracking**. It provides guidance to help identify the cause of a problem and outlines recommended steps to resolve or mitigate it. +This section covers common issues and known errors you may encounter while working with **Data Tracking**, and describes steps to resolve or mitigate each one. -The following topics highlight frequently reported scenarios, configuration issues, or system behaviors that can affect normal operation. Reviewing these items can help quickly diagnose problems and reduce troubleshooting time. +The following topics cover frequently reported scenarios, configuration issues, and system behaviors that can affect normal operation. --- @@ -34,9 +34,7 @@ This applies to: If the Customization is missing, you need to run the scanner for the specific Salesforce types. -Refer to the following link for instructions on how to run the scanner for specific Salesforce types: - -[**Manual Scanner**](/docs/platgovsalesforce/installingstrongpoint/running_scanner.md) +See [**Running the Scanner**](/docs/platgovsalesforce/installingstrongpoint/running_scanner.md) for instructions on how to run the scanner for specific Salesforce types. --- @@ -71,11 +69,11 @@ If you encounter a new conflicting object, you may need to investigate further o ## Test Class Dependencies -The test class generated for each tracking trigger is created using a dynamic template. This template includes the necessary structure and relationships required to create valid test records. +The system generates the test class for each tracking trigger using a dynamic template. This template includes the necessary structure and relationships required to create valid test records. ### How it works -When a trigger is created, a corresponding test class is automatically generated. This test class: +When the system creates a trigger, it automatically generates a corresponding test class. This test class: - Inserts sample records - Ensures the required **75% code coverage** for deployment diff --git a/docs/platgovsalesforce/changemanagement/datatracking/enhanced_cpq_support.md b/docs/platgovsalesforce/changemanagement/datatracking/enhanced_cpq_support.md index 694858ad8c..09837cb568 100644 --- a/docs/platgovsalesforce/changemanagement/datatracking/enhanced_cpq_support.md +++ b/docs/platgovsalesforce/changemanagement/datatracking/enhanced_cpq_support.md @@ -6,27 +6,26 @@ sidebar_position: 100 # Data Tracking -Salesforce CPQ (Configure, Price, Quote Software) sales tool provides accurate pricing with any -given product configuration scenario. Behind the scenes, CPQ uses configuration data stored in -custom objects. Manually monitoring this configuration data is the hardest part of SOX compliance. -In the CPQ application, for example, important rules about products, prices, discounts, and -approvals are stored as data in custom objects. Getting visibility into these changes is incredibly -time-consuming, and there are few options for preventing changes that can put your processes and -compliance in jeopardy. - -This is not unique to CPQ. Billing and other applications that touch revenue related data are all -potentially in scope and in your auditor's sights. - -Platform Governance for Salesforce solves this major pain point by treating configuration data with -the same scrutiny it applies to other Apex metadata in your Org. It is the only native solution to -give you visibility into these changes. You can create mitigating controls to automatically block -changes to critical CPQ rules. For example, you can now designate the fields on the **Discount -Schedule** and **Discount Tier** objects to be under change control, and generate compliance logs if -the fields are changed. - -As a result, you no longer have to rely on field history reports and manual review to ensure CPQ and -other configuration data is protected. Auditors are satisfied, audit costs go down and IT leadership -can rest easy knowing there are no surprises. +Salesforce CPQ (Configure, Price, Quote) is a sales tool that provides accurate pricing for any +product configuration scenario. CPQ uses configuration data stored in +custom objects. Manually monitoring this configuration data is among the most demanding parts of +Sarbanes-Oxley Act (SOX) compliance. In the CPQ application, for example, important rules about +products, prices, discounts, and approvals are stored as data in custom objects. Gaining visibility +into these changes is time-consuming, and few options exist for preventing changes that put your +processes and compliance at risk. + +This challenge isn't unique to CPQ. Billing and other applications that handle revenue-related data +are all potentially in scope for audit review. + +Platform Governance for Salesforce solves this problem by treating configuration data with +the same scrutiny it applies to other Apex metadata in your org. You can create mitigating controls +to automatically block changes to critical CPQ rules. For example, you can designate the fields on +the **Discount Schedule** and **Discount Tier** objects to be under change control, and generate +compliance logs when the fields are changed. + +As a result, you no longer have to use field history reports and manual review to ensure CPQ and +other configuration data is protected. Auditors have the documentation they need, audit costs +decrease, and IT leadership has full visibility into configuration changes. You must have an Enterprise Compliance license to benefit from this feature. diff --git a/docs/platgovsalesforce/changemanagement/datatracking/non_triggerable_objects.md b/docs/platgovsalesforce/changemanagement/datatracking/non_triggerable_objects.md index 74c41dea83..f0209c967e 100644 --- a/docs/platgovsalesforce/changemanagement/datatracking/non_triggerable_objects.md +++ b/docs/platgovsalesforce/changemanagement/datatracking/non_triggerable_objects.md @@ -6,7 +6,7 @@ sidebar_position: 2 # Non-Triggerable Objects -Some **Standard Salesforce objects aren't triggerable**, which means it isn't possible to generate and deploy triggers for them in the Salesforce environment. Because of this limitation, **Netwrix Platform Governance** can't block the creation of records for these objects. +Some **Standard Salesforce objects aren't triggerable**, meaning Salesforce doesn't support generating and deploying triggers for them. Because of this limitation, **Netwrix Platform Governance** can't block the creation of records for these objects. As a result, the tracking process for these objects is different. @@ -46,7 +46,7 @@ If Field History Tracking isn't already enabled: 4. Click **Save All Records**. :::important -If a user attempts to configure one of these objects as **Tracked, Blocking**, Salesforce will return a validation error. +If a user attempts to configure one of these objects as **Tracked, Blocking**, Salesforce returns a validation error. ::: ## Enable the Non-Triggerable Standard Object Data Scanner diff --git a/docs/platgovsalesforce/changemanagement/datatracking/set_up_data_tracking.md b/docs/platgovsalesforce/changemanagement/datatracking/set_up_data_tracking.md index e6ac7585d0..8749cf0994 100644 --- a/docs/platgovsalesforce/changemanagement/datatracking/set_up_data_tracking.md +++ b/docs/platgovsalesforce/changemanagement/datatracking/set_up_data_tracking.md @@ -46,7 +46,7 @@ Here are the requirements to set up Data Tracking: ## Select Objects to Track -In this section, users can apply tracking recommendations to one or more objects in the list. To do this, select the desired objects and click **Apply Recommendations**. +In this section, you can apply tracking recommendations to one or more objects in the list. To do this, select the objects you want and click **Apply Recommendations**. ![Review the recommended objects for data tracking](/images/platgovsalesforce/change_management/data_tracking_recommended.webp) @@ -62,12 +62,12 @@ While metadata changes in Salesforce can be tracked but not blocked, with **Data Changes to records in **Non-Triggerable objects** can't be blocked. See [**Non-Triggerable Objects**](non_triggerable_objects.md) to understand which objects can't be blocked and how they are handled. ::: -Users can also choose whether tracking should apply to **Updates Only** for each object. +You can also choose whether tracking should apply to **Updates Only** for each object. - **No**: Tracks changes to both new and existing records. - **Yes**: Tracks changes to existing records only. Changes to new records aren't tracked. -If you want to enable tracking for objects that aren't included in the recommended list, follow these steps: +To enable tracking for objects not included in the recommended list: 1. Click **Show Additional Objects for Tracking (Advanced)**. The **Additional Objects** list appears. 2. Search for the object by typing its name. @@ -97,7 +97,7 @@ Data Tracking isn't designed for **high-volume objects** such as Opportunities o ## Select Fields to Track -In some cases, users might need to monitor only specific sensitive fields within a tracked object, rather than tracking all changes to the object. +In some cases, you might need to monitor only specific sensitive fields within a tracked object, rather than tracking all changes to the object. To support this, you can configure which fields should have additional tracking control. @@ -164,7 +164,7 @@ For Data Records, select the change level in the **Application Configuration Cha ## Adding Data Records to Change Requests -When creating a Change Request, users can add **Existing Data Records** and **Proposed Data Records**, similar to how metadata components are added. +When creating a Change Request, you can add **Existing Data Records** and **Proposed Data Records**, similar to how metadata components are added. ![Adding Data Records to Change Requests](/images/platgovsalesforce/change_management/add_records_change_request.webp) diff --git a/docs/platgovsalesforce/changemanagement/resolving_noncompliant_changes.md b/docs/platgovsalesforce/changemanagement/resolving_noncompliant_changes.md index 782484c923..c69e3ba155 100644 --- a/docs/platgovsalesforce/changemanagement/resolving_noncompliant_changes.md +++ b/docs/platgovsalesforce/changemanagement/resolving_noncompliant_changes.md @@ -12,15 +12,15 @@ can filter the report or sort by the column heads. ![Non-Compliant Change Management Report](/images/platgovnetsuite/change_management/changelog-1.webp) -A noncompliant change means something got changed without the required approvals. Open each change +A noncompliant change means someone changed something without the required approvals. Open each change log to investigate the change. You can retroactively attach a change request to a noncompliant -change and get the necessary approvals for the change to be compliant. +change and get the necessary approvals to bring the change into compliance. 1. Create a New [Change Request](/docs/platgovsalesforce/changemanagement/creating_change_request.md) or open an existing one. 2. Set it to Pending Approval. -3. Once it is approved and complete, set the **Status** of the Change Request to **Complete**. +3. After it is approved and complete, set the **Status** of the Change Request to **Complete**. 4. Click the Change Log name to open it. 5. Enter the **Related Change Request**. 6. Enter the **Resolution Description**. -7. Once all changes are made, select **Closed** for the Status. +7. After all changes are made, select **Closed** for the Status. 8. Save the **Change Log**. diff --git a/docs/platgovsalesforce/changemanagement/setting_up_policies.md b/docs/platgovsalesforce/changemanagement/setting_up_policies.md index 29966e3694..8a2c7808b1 100644 --- a/docs/platgovsalesforce/changemanagement/setting_up_policies.md +++ b/docs/platgovsalesforce/changemanagement/setting_up_policies.md @@ -55,7 +55,7 @@ Set the required Change Level for each Metadata Type. The form shows the default | **Change Level** | **Description** | | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Log Changes Only | Since the scanner automatically logs all changes, this change level requires no actions for compliance. The scanner automatically marks any changes to these components as compliant. | +| Log Changes Only | Because the scanner automatically logs all changes, this change level requires no actions for compliance. The scanner automatically marks any changes to these components as compliant. | | Change Request | Any changes to these components require an Approved Change Request. | | Sandbox Development & Testing | Any changes to these components require an Approved Change Request in the Stage Development Project. It also requires that you attach a parent Change Request to the Development Project. | | Full Software Development Lifecycle | Any changes to these components require an Approved Change Request in the Stage Deployment Record or Rollback Record. | @@ -105,7 +105,7 @@ See [Set Up Data Tracking](/docs/platgovsalesforce/changemanagement/datatracking ### Health Check Changes -Health Check Changes affect the way Platform Governance handles changes for the customization records for each Salesforce Health Check group +Health Check Changes affect how Platform Governance handles changes for the customization records for each Salesforce Health Check group (session settings, file upload and security settings), so you can track and report on current settings. There is a [Health Settings](/docs/platgovsalesforce/customizations/understanding_customization_record.md) tab for the specific records on the customization record. @@ -187,8 +187,7 @@ available on the **Related** tab on the policy. ![Adding customizations by Salesforce Type](/images/platgovsalesforce/change_management/policy_change_by_sf_type.webp) -3. Set **Category** and **Sub-Category** filters if you want to narrow the list. Sub-categories are - not available for all Categories. +3. Set **Category** and **Sub-Category** filters to narrow the list. Not all categories have sub-categories. ![Set filters for Salesforce type](/images/platgovsalesforce/change_management/policy_add_sf_type2.webp) diff --git a/docs/platgovsalesforce/changemanagement/using_change_logs.md b/docs/platgovsalesforce/changemanagement/using_change_logs.md index e84bfcaa2c..a75fcc5bc4 100644 --- a/docs/platgovsalesforce/changemanagement/using_change_logs.md +++ b/docs/platgovsalesforce/changemanagement/using_change_logs.md @@ -6,8 +6,8 @@ sidebar_position: 70 # Using Change Logs -Change Logs allow you to see the type of change, who made the change and view the system notes of -the Salesforce record. Change Logs are accessed from the **Change Logs** tab or through +Use Change Logs to see the type of change, who made the change, and view the system notes of +the Salesforce record. Access Change Logs from the **Change Logs** tab or through [Change Enablement Reports](/docs/platgovsalesforce/changemanagement/change_management_reports.md). 1. Click **Change Logs** tab. @@ -28,7 +28,7 @@ Here is an example change log for a **CustomObject** Metadata type. - **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. +- **Customization**: Linked customizations 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. @@ -64,7 +64,7 @@ The **Values** section displays the **New Value** and **Old Value** of each fiel ![changelog_values](/images/platgovsalesforce/change_management/changelog_values1_light.webp) -The **Created By** and **Last Modified By** users and dates are displayed at the end of the list. +The **Created By** and **Last Modified By** users and dates appear at the end of the list. ![changelog_values](/images/platgovsalesforce/change_management/changelog_values2_light.webp) @@ -73,13 +73,13 @@ 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**. +- **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**. +- **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**. +- **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 @@ -87,7 +87,7 @@ record. ### Change Log History **Change Log History** displays the latest history entries by **Date**. The changed **Field**, -**User** making the change, **Original Value** and **New Value** are displayed. If there is a **+** +**User** making the change, **Original Value** and **New Value** appear. If there is a **+** sign by the number in **Change Log History** header, click **View All** to see the complete history. ### Notes & Attachments diff --git a/docs/platgovsalesforce/cleanup/cleanup_customizations.md b/docs/platgovsalesforce/cleanup/cleanup_customizations.md index bab9f0d35c..d125b9ec96 100644 --- a/docs/platgovsalesforce/cleanup/cleanup_customizations.md +++ b/docs/platgovsalesforce/cleanup/cleanup_customizations.md @@ -63,8 +63,8 @@ Use these processes to Clean up Individual Customization or Clean Up Multiple Cu ![multi_select_cleanup](/images/platgovsalesforce/clean_up/multi_select_cleanup.webp) -9. You can now choose what you want to edit for the multiple customizations selected. - For example, if you want to change the clean up status: +9. Choose what to edit for the multiple customizations selected. + For example, to change the clean up status: 10. Go to **Edit Clean Up Status**. 11. Select a status such as To Be Cleaned Up. 12. Choose to **Apply changes to: All the selected records**. diff --git a/docs/platgovsalesforce/cleanup/cleanup_overview.md b/docs/platgovsalesforce/cleanup/cleanup_overview.md index 5fd60cf022..517cf63afb 100644 --- a/docs/platgovsalesforce/cleanup/cleanup_overview.md +++ b/docs/platgovsalesforce/cleanup/cleanup_overview.md @@ -19,7 +19,7 @@ Clean up involves some or all of the following steps: ## Clean Up Tools -There is a series of built in Clean Up Tools to enable Administrators to clean up their account in +Platform Governance for Salesforce provides a series of built-in Clean Up Tools to enable Administrators to clean up their account in an organized and efficient manner. There are many types of clean up, but they generally follow the same steps: @@ -43,34 +43,31 @@ Clean up: - Unused Scripts - Unused Reports -Customizations that do not follow best practices: +Customizations that don't follow best practices: - Customizations with No Related Process - Customizations with No Description - Customizations with No Help Text - Customizations with No Active Owner -Depending on what you want to clean up, you can view clean up reports from the Strongpoint tab under -Reports and then choosing Clean Up. You can also find the clean up reports at the bottom of the -Strongpoint homepage under Strongpoint Features and Reports. +To view clean up reports, open the Netwrix Lightning app and go to **Reports** > **Clean Up**. You can also find the clean up reports at the bottom of the Strongpoint Home Page 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. +Before moving on to other clean up activities, delete unused +customizations that are safe to delete, such as fields that have not been used in +years or that aren't used by any other customization. ::: ### Analyze and Organize the Results -Once you have selected the customizations that you want to clean up and have created a New View, you -can analyze the results. You can then sort and filter the results and are required to group and -manage the output for subsequent steps. You may chose to clean up based on Salesforce type and +After selecting the customizations to clean up and creating a New View, analyze the results. Sort and filter the results and group and +manage the output for subsequent steps. You can clean up based on Salesforce type and record type (among other options). -Every Customization record has a Clean-Up Status field that enables us to track the status of the +Every Customization record has a Clean-Up Status field that tracks the status of the clean-up process for that object. The statuses are: @@ -81,7 +78,7 @@ The statuses are: - **Under Investigation**: Flags the customization as under investigation. - **Disabled/Hidden**: Tracks that the customization has been disabled. - **Archived**: Tracks that the data / set-up was archived. -- **Deleted**: Tracks that the customization has been deleted. The doc will be inactivated. +- **Deleted**: Tracks that the customization has been deleted. The doc is inactivated. - **Ignore**: Removes it from the searches. - **Fix ScriptID:** Changes the ID of the script. - **Reassign Owner**: Changes the owner. @@ -89,17 +86,17 @@ The statuses are: ### Create Change Requests (if required) -Some changes such as deletion, changes to scriptID and Help impact the customization itself. For -these types of changes we recommend creating a Change Request. However, for clean up, you can create +Some changes, such as deletion and changes to scriptID and Help, impact the customization itself. For +these types of changes, Netwrix recommends creating a Change Request. For clean up, you can create new change requests and assign them to the customizations. In the results view, **Create Change -Request** creates a new change request. Once that is added to that customization it appears under +Request** creates a new change request. After that is added to that customization it appears under **Related Change Requests**. You can have multiple customizations assigned to multiple change requests as appropriate. ### Manage the Change or Clean Up You can find more information about how to use the Change Request under -[Managing Change](/docs/platgovsalesforce/changemanagement/change_management_overview.md). Once the appropriate +[Managing Change](/docs/platgovsalesforce/changemanagement/change_management_overview.md). After the appropriate investigations are conducted and approvals are obtained the customization can be changed as appropriate based on company policies and procedures. @@ -109,6 +106,6 @@ edited like any other Salesforce data directly in a Platform Governance for Sale ### Run the Scanner -At the end of the process of updating the customization record(s), the account should be scanned to -update the documentation for the customization changes. It can be re-scanned for the specific -record type that was changed. +After updating customization records, scan the account to +update the documentation for the customization changes. You can re-scan for the specific +record type that changed. diff --git a/docs/platgovsalesforce/cleanup/cleanup_reports.md b/docs/platgovsalesforce/cleanup/cleanup_reports.md index 35f956e29d..2eef539e29 100644 --- a/docs/platgovsalesforce/cleanup/cleanup_reports.md +++ b/docs/platgovsalesforce/cleanup/cleanup_reports.md @@ -37,7 +37,7 @@ The results list all customizations of Record type **Objects & Fields**, startin ### Open Clean Up Status -This report enables you to find customizations that have been identified and noted for clean up. +Use this report to find customizations that have been identified and noted for clean up. ### Clean Up Waiting for Info @@ -66,7 +66,7 @@ Ownership of customizations is important for clean up and accountability in the The results list customizations with owners who are either: - Not active in Salesforce -- Do not have access to Platform Governance for Salesforce +- Don't have access to Platform Governance for Salesforce ### Customizations without Related Processes @@ -74,14 +74,14 @@ The results list all customizations with no process assigned. ### Custom Fields without Help Text -Help and Descriptions enable users to more efficiently use the system. The results list +Help and descriptions help users use the system more efficiently. The results list customizations missing help. To fix, open the customization, click **Update Description and Help Text**. ### Custom Fields without Description -Help and Descriptions enable users to more efficiently use the system. The results list +Help and descriptions help users use the system more efficiently. The results list customizations missing descriptions. To fix, open the customization, click **Update Description and Help Text**. diff --git a/docs/platgovsalesforce/cleanup/date_last_used.md b/docs/platgovsalesforce/cleanup/date_last_used.md index e2bad1e665..7749962a34 100644 --- a/docs/platgovsalesforce/cleanup/date_last_used.md +++ b/docs/platgovsalesforce/cleanup/date_last_used.md @@ -7,17 +7,17 @@ sidebar_position: 40 # Date Last Used Date Last Used (DLU) captures changes triggered by users or other customizations. Specifically, the -last date the Customization, or the data it contains, was created, changed, accessed, processed or -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. +last date the Customization, or the data it contains, was created, changed, accessed, processed, or +used. The DLU value indicates that the customization was used at least as recently as the DLU date. It does +not indicate whether it was used earlier. If DLU is blank, there is no verified date. -- DLU CustomField Details -- Setting the DLU Expiration -- DLU Metadata Types +- DLU CustomField Details +- Setting the DLU Expiration +- DLU Metadata Types - Excluded Metadata Extended Types - DLU Scheduler -## DLU CustomField Details +## DLU CustomField Details CustomField usage data improves the accuracy and usefulness of the Date Last Used, enabling you to make better decisions about the value of maintaining specific CustomFields. Usage data includes: @@ -26,7 +26,7 @@ make better decisions about the value of maintaining specific CustomFields. Usag - 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. +DLU analysis should only be performed in Production orgs. Sandbox orgs don't reflect actual usage. ::: **Usage data fields:** @@ -36,8 +36,8 @@ DLU analysis should only be performed in Production orgs. Sandbox orgs do not re there is only data on 400 of the records, it is 40% populated. - **DLU** is now defined to be the last time the field was updated with **Field History Tracking** enabled. Field History Tracking ensures the DLU is accurate. If Field History Tracking is later - disabled, the DLU no longer updates and the data may not be accurate. The new Date DLU Analyzed - and DLU Status provide additional insight. + disabled, the DLU no longer updates and the data may not be accurate. The new Date DLU Analyzed + and DLU Status provide additional insight. - **Date DLU Analyzed** displays the last time the scanner was run with Field History Tracking enabled. - **Parent Last Update Date** is set to the **CreatedDate** of the most-recently-created Record with @@ -46,33 +46,33 @@ DLU analysis should only be performed in Production orgs. Sandbox orgs do not re the record. - **DLU Status** displays the current status: - | DLU Status | DLU | Field History Tracking | Date DLU Analyzed | Parent Last Update Date | + | 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 | + | 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-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](#setting-the-dlu-expiration). | 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: +If **Field History Tracking** is enabled for a CustomField with a **DLU Status** of either +**Recent** or **Expired**, the status changes to **Pending**. The following example shows this: ![Example of the DLU status fields for a CustomField](/images/platgovsalesforce/clean_up/dlu_status_example_customfield.webp) ### Notes -- When Field History Tracking is enabled, the **DLU** is accurate, and the **Parent Last Update +- 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. - 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 + Last Update Date**. Use the most recent of the two together with **% + Populated** to get a sense of usage. If **DLU Status** is Expired, ignore **DLU**. -### Setting the DLU Expiration +### Setting the DLU Expiration -The DLU Parameters specify the number of months to wait before changing the DLU Status from Recent +The DLU Parameters specify the number of months to wait before changing the DLU Status from Recent to Expired for a CustomField. This only applies to a CustomField where **Field Tracking History** has been disabled. To change the time period: @@ -86,17 +86,17 @@ has been disabled. To change the time period: ![Click Manage Records to open the record](/images/platgovsalesforce/clean_up/custom_metadata_types_dlu_exp.webp) -5. Click **Edit** by **DLU Expiration** +5. Click **Edit** by **DLU Expiration** ![Edit the parameters](/images/platgovsalesforce/clean_up/custom_metadata_types_dlu_para.webp) -6. Set the **DLU Expiration (Months)**. The default is three. +6. Set the **DLU Expiration (Months)**. The default is three. 7. Click **Save**. -## DLU Metadata Types +## DLU Metadata Types Metadata types marked with an **\*** must have the **Event Logs** enabled to gather DLU information. -DLU can be used for the following metadata types: +Use DLU for the following metadata types: | Salesforce Family Types & Joins | Metadata Types | DLU | | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | @@ -157,7 +157,7 @@ DLU can be used for the following metadata types: ## Excluded Metadata Extended Types -DLU is not used for the following metadata Extended Types: +DLU isn't used for the following metadata Extended Types: | | | | --------------------------- | ------------------------ | @@ -179,12 +179,12 @@ DLU is not used for the following metadata Extended Types: ## DLU Scheduler -The [Scheduler](/docs/platgovsalesforce/scanner/scheduler.md) is where you can add frequency, day and time for processes +The [Scheduler](/docs/platgovsalesforce/scanner/scheduler.md) is where you can add frequency, day, and time for processes to run. Under **Field Usage and DLU**, you can set up the scheduler to update the last used date field on customizations with the date the metadata was last used. It populates information for field usage on custom fields and custom objects and catch any permission set assignments related to users. ![scheduler](/images/platgovsalesforce/clean_up/scheduler.webp) -Once the scheduler has been set up, you can view the DLU under the **Metadata** tab on the +After the scheduler has been set up, you can view the DLU under the **Metadata** tab on the customization record. diff --git a/docs/platgovsalesforce/customizations/customizations_overview.md b/docs/platgovsalesforce/customizations/customizations_overview.md index 60d4ed44ba..37a3f44c16 100644 --- a/docs/platgovsalesforce/customizations/customizations_overview.md +++ b/docs/platgovsalesforce/customizations/customizations_overview.md @@ -7,7 +7,7 @@ sidebar_position: 70 # Customizations Overview Customization records are documentation about each customization. They are automatically built and -maintained by the Scanners. They enable you to search customizations and attach them to processes. +maintained by the Scanners. Use them to search customizations and attach them to processes. Click the **Customizations** tab to display all the customizations found by the scanner. You can change the view to focus the results. Click the **Customization Name** to open the customization @@ -20,10 +20,10 @@ Customization records contain the following information: 3. Which customizations are being used. 4. What the junctions are between customizations. 5. What detailed automated documentation exists, including search filters and formulas, related - fields, scripts, searches and records. + fields, scripts, searches, and records. For Change Management and Compliance, the joins between customizations are critical to determine the -IT risk of making changes to the system. For example, they warn you if changing a search could break +IT risk of making changes to the system. For example, the system warns you if changing a search will break a workflow or a script. ![drd](/images/platgovsalesforce/customizations/drd.webp) diff --git a/docs/platgovsalesforce/customizations/folder_customization_record.md b/docs/platgovsalesforce/customizations/folder_customization_record.md index 111e53355d..338dc3beae 100644 --- a/docs/platgovsalesforce/customizations/folder_customization_record.md +++ b/docs/platgovsalesforce/customizations/folder_customization_record.md @@ -12,8 +12,8 @@ This document describes the Netwrix customizations for Salesforce types ReportFo - Supports hierarchical folder structures with subfolders ### 2. Detection Mechanism -- Changes detected during Netwrix daily scan -- Frequency depends on configured scan schedule +- The Netwrix daily scan detects changes +- Frequency depends on the configured scan schedule ### 3. Related Objects - Folders can have relationships with: @@ -57,7 +57,7 @@ This document describes the Netwrix customizations for Salesforce types ReportFo - Type of modification (add/modify/remove) ### 7. Metadata Storage -- XML attachment stores: +- An XML attachment stores: - Folder structure details - Access levels for users, groups, and roles diff --git a/docs/platgovsalesforce/customizations/old_customization_record.md b/docs/platgovsalesforce/customizations/old_customization_record.md index ab9276dd77..fc7836b108 100644 --- a/docs/platgovsalesforce/customizations/old_customization_record.md +++ b/docs/platgovsalesforce/customizations/old_customization_record.md @@ -53,8 +53,8 @@ These are the tabs inside a customization record: The metadata tab provides the metadata information about the customization, including: -- **Date Last Used**: date the customization was last used. Refer to - [DLU](/docs/platgovsalesforce/cleanup/date_last_used.md) for more information. +- **Date Last Used**: date the customization was last used. See + [Date Last Used (DLU)](/docs/platgovsalesforce/cleanup/date_last_used.md) for how DLU data is collected and used. - **Data type**: data type of the custom field. - **Last Modified Date**: last date the customization was modified. - **Active**: indicates whether the customization is a active. @@ -89,7 +89,7 @@ The permissions tabs displays the Read and Edit status for the roles. ### Health Settings The Salesforce _Security Health Check_ is available in almost all versions of Salesforce. If you are -not already using it to monitor critical permissions and security settings, our blog +not already using it to monitor critical permissions and security settings, the blog [Maintaining Org Security with the Salesforce Health Check](https://www.strongpoint.io/en/blog/what-is-salesforce-health-check) walks you through how it works and why it’s important. @@ -107,8 +107,8 @@ tab for the **PasswordPolicies** customization. ### Data Classification -The **Data Classification** tab in the **Custom Field** customization record gives you an -at-a-glance look at all classified fields in the Object — who owns them, their compliance category, +The **Data Classification** tab in the **Custom Field** customization record gives you a +quick view of all classified fields in the Object — who owns them, their compliance category, sensitivity level, and other important details. You also have access to custom reports showing you where your classified data can be found. @@ -120,17 +120,17 @@ on a financial report. - **Control**: determines if the customization is a control. - **Control Frequency**: frequency at which a control should be checked. - **Track Duplicates**: specifies whether duplicate issues are to be tracked or not. -- **Control Type**: select count to record numbers, issues, tasks etc. -- **Control Assignee**: assign tasks, issues or alerts to someone other than the owner, if blank the +- **Control Type**: select count to record numbers, issues, tasks, etc. +- **Control Assignee**: assign tasks, issues, or alerts to someone other than the owner, if blank the control alerts the owner of the customization. - **Controlled Process**: process this customization controls. - **Control Count**: custom field created for the account. -- **Alert Control Owner**: check box to alert owner of the control. +- **Alert Control Owner**: checkbox to alert owner of the control. - **Next Control Date Time**: notes the date and time when to start monitoring. - **Risk/Requirement**: risk associated with the customization. - **Last Control Run Date**: This is the last date the control was run. -- **Alert Process Owner**: check box to alert the process owner whenever an incident is detected. -- **Alert/Task Message**: The message that will be sent to the assignee on tasks or recipients of +- **Alert Process Owner**: checkbox to alert the process owner whenever an incident is detected. +- **Alert/Task Message**: The message sent to the assignee on tasks or recipients of alerts. - **Instructions for Resolution**: instructions for resolving the issue. - **Control Error/Warning**: errors or warnings encountered when control was last run. Blank @@ -138,7 +138,7 @@ on a financial report. ### DRD -Dependency Relationship Diagram ([DRD](/docs/platgovsalesforce/tools/viewing_drd.md)) displays objects, customizations +Dependency Relationship Diagram ([DRD](/docs/platgovsalesforce/tools/viewing_drd.md)) displays objects, customizations, and their relationships and dependencies. ### Raw Data @@ -159,7 +159,7 @@ This tab describes and list the XML code contained in a customization. - **Report/Search Fields (Raw)**: fields used in filter criteria or columns for a search. - **Layout (Raw)**: custom field to hold custom fields of ListView, visual pages and layouts. - **List (Raw)**: references related to this field. -- **Scanner Read**: check box to indicate if the retrieve and the customization was executed and +- **Scanner Read**: checkbox to indicate if the retrieve and the customization was executed and read. - **Folder File Name**: name of the folder and file where Salesforce has the Metadata component. - **Encoded API Name**: field to note the retrieve with encoded API name. diff --git a/docs/platgovsalesforce/customizations/understanding_customization_record.md b/docs/platgovsalesforce/customizations/understanding_customization_record.md index bc81d39c14..d8c1f0796d 100644 --- a/docs/platgovsalesforce/customizations/understanding_customization_record.md +++ b/docs/platgovsalesforce/customizations/understanding_customization_record.md @@ -10,9 +10,11 @@ This topic discusses the new Platform Governance for Salesforce Lightning custom is only available with the Platform Governance for Salesforce Lightning app. Refer to the topic [Old Customization Record](/docs/platgovsalesforce/customizations/old_customization_record.md) for the old style customization record. -**NOTE:** For installed orgs, users must load the Strongpoint Home Page first before opening the +:::note +For installed orgs, users must load the Strongpoint Home Page before opening the **Customization** tab for the first time after the 6.0 update. The new form assignment happens in the background for the Strongpoint Home page. +::: The customization detail contains general information about the customization record. The customization name appears in the banner with function buttons: @@ -61,17 +63,17 @@ The Metadata tab provides the metadata information about the customization, incl ### Custom -The **Custom** tab shows the join, scanner and DLU dates. +The **Custom** tab shows the join, scanner, and DLU dates. - **Last Scanner Date**: last date in which the scanner ran and evaluated the current customization. - **Make Join Date**: date customization was last passed to Make Join script. -- **Date Last Used**: date the customization was last used. Refer to - [DLU](/docs/platgovsalesforce/cleanup/date_last_used.md) for more information. +- **Date Last Used**: date the customization was last used. See + [Date Last Used (DLU)](/docs/platgovsalesforce/cleanup/date_last_used.md) for how DLU data is collected and used. ### DRD The Dependency Relationship Diagram ([DRD](/docs/platgovsalesforce/tools/viewing_drd.md)) displays objects, -customizations and their relationships and dependencies. +customizations, and their relationships and dependencies. ![DRD Example](/images/platgovsalesforce/customizations/drd.webp) @@ -83,7 +85,7 @@ request feature. - **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. + - **Not Tracked**: changes in data records aren't 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. diff --git a/docs/platgovsalesforce/faq.md b/docs/platgovsalesforce/faq.md index e4a3ce9533..adb14acdbc 100644 --- a/docs/platgovsalesforce/faq.md +++ b/docs/platgovsalesforce/faq.md @@ -6,62 +6,57 @@ sidebar_position: 130 # FAQ -Platform Governance for Salesforce is a stress-free change management and compliance software for -NetSuite and Salesforce. It helps companies manage change in their systems, enabling them to drive -growth with confidence and certainty. Here are answers to Frequently Asked Questions: +Platform Governance for Salesforce is a change management and compliance tool for +NetSuite and Salesforce. It helps companies manage change in their systems. Here are answers 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? +- SOC1 report availability +- Installing in the Sandbox or Release Preview +- Private data transmission and sharing +- Time and effort required to use Platform Governance for Salesforce +- License requirements and editor vs. viewer differences -#### Can Platform Governance for Salesforce provide a SOC1 Report? +#### SOC1 report availability Contact your Account Manager to request a SOC1 type 2 report. Reports are available by the end of -January. A bridge letter can be provided if necessary. +January. A bridge letter is available upon request. -Platform Governance for Salesforce does not presently issue SOC2 reports. +Platform Governance for Salesforce doesn’t issue SOC2 reports. -Platform Governance for Salesforce is built on Salesforce. Platform Governance for Salesforce does -not have access to or store any of your data outside of your Salesforce platform. +Platform Governance for Salesforce is built on Salesforce and does +not access or store any of your data outside of your Salesforce platform. -#### Can I install Platform Governance for Salesforce in the Sandbox or Release Preview? +#### Installing in the Sandbox or Release Preview -Many of our customers install Platform Governance for Salesforce in their sandbox before installing -it in production. Your license covers both sandbox and production instances. We currently do not -have the ability to have the bundle installed in release previews. +Many customers install Platform Governance for Salesforce in their sandbox before installing +it in production. Your license covers both sandbox and production instances. The bundle can’t be installed in release previews. -#### Is our private data being transmitted or shared in any way? +#### Private data transmission and sharing -Platform Governance is completely contained within NetSuite and Salesforce. It utilizes the +Platform Governance is completely contained within NetSuite and Salesforce. It uses the platform’s custom records and APIs to create and manage documentation. No data leaves the system at -anytime to ensure compliance with data security requirements for critical system and process data. -All code and key tools are locked to ensure consistent processes within the application. Access to -records can be restricted by role or user using standard NetSuite and Salesforce access controls. In +any time to ensure compliance with data security requirements for critical system and process data. +All code and key tools are locked to ensure consistent processes within the application. Standard NetSuite and Salesforce access controls let you restrict record access by role or user. In addition, Platform Governance for Salesforce supports a secondary level of audience management for specific processes or objects. -All Platform Governance for Salesforce documentation can be printed, rendered as flat HTML or -exported to an external repository and can be reimported and retained for archiving purposes by an -authorized user. +Authorized users can print, render as flat HTML, export to an external repository, reimport, and retain all Platform Governance for Salesforce documentation for archiving purposes. -#### What is the time or effort required to use Platform Governance for Salesforce? +#### Time and effort required to use Platform Governance for Salesforce -A lot less than you would expect. The first phase is to get your complete customization -documentation library. All this requires is for the Administrator to install the bundle, press -“Start Spider” and let the system run. After a few nights, the system documentation is complete and +The first phase is to get your complete customization +documentation library. The Administrator installs the bundle, clicks +**Start Spider**, and lets the system run. After a few nights, the system documentation is complete and you can review the results in the Status Report. -We have User Guides and online videos to walk you through Clean Up, Script Analysis and other +User guides and online videos are available to walk you through Clean Up, Script Analysis and other capabilities. Because Platform Governance for Salesforce creates complete documentation and updates on an ongoing basis with your NetSuite and Salesforce records, you can use the pre-built searches or -create your own to get instant visibility into your account. While Platform Governance for -Salesforce greatly reduces the amount of time to find information and identify interdependencies, -the NetSuite and Salesforce Administrators will still need to do the appropriate due diligence and -analysis to ensure their actions are appropriate and safe. +create your own to get instant visibility into your account. Platform Governance for +Salesforce greatly reduces the time needed to find information and identify interdependencies, +but NetSuite and Salesforce Administrators must still perform appropriate due diligence and +analysis to ensure their actions are safe. -#### Who needs a Platform Governance for Salesforce License? What is the difference between an editor and a viewer? +#### License requirements and editor vs. viewer differences Licenses are only required for editors of Platform Governance for Salesforce (that is, people who create or edit processes or view customization documentation). No license is required for users who merely diff --git a/docs/platgovsalesforce/index.md b/docs/platgovsalesforce/index.md index 925bc881d6..098493118a 100644 --- a/docs/platgovsalesforce/index.md +++ b/docs/platgovsalesforce/index.md @@ -7,24 +7,24 @@ sidebar_position: 1 # Welcome -Platform Governance for Salesforce is integrated into the Salesforce backend keeping all your data -within your Salesforce account. Your documentation is automatically maintained so it is always up to +Platform Governance for Salesforce integrates into the Salesforce backend, keeping all your data +within your Salesforce account. The system automatically maintains your documentation so it is always up to date. By implementing Platform Governance for Salesforce you can: -- Automatically catalog all custom fields, scripts, forms, searches, records and workflows. -- Visually browse standard and custom fields, lists and records to find all related scripts, - searches, users and departments. +- Automatically catalog all custom fields, scripts, forms, searches, records, and workflows. +- Visually browse standard and custom fields, lists, and records to find all related scripts, + searches, users, and departments. - Capture and search script comments and identify poorly commented code. - Automatically track changes to your customizations using the change logs, so you can see what customizations were changed, how they were changed, when they were changed and who changed them. ## Installation and Initial Scan -Once you install Platform Governance for Salesforce, you click the **Start Spider** button -and your customizations are documented over the course of 4-5 days with minimal impact on system -performance. Once completed, you have a searchable database of all your customizations. +After you install Platform Governance for Salesforce, click the **Start Spider** button. +Your customizations are documented over the course of 4-5 days with minimal impact on system +performance. After the scan completes, you have a searchable database of all your customizations. ## Documentation and Optimization @@ -33,16 +33,16 @@ have your account both fully documented and optimized. ### Clean Up -Use the end to end documentation of custom objects and our Clean Up Tools to: +Use the end to end documentation of custom objects and the Clean Up Tools to: -- Identify unused fields, searches and other custom objects. +- Identify unused fields, searches, and other custom objects. - Quickly identify dependencies to reduce the risk of breaking things in your account (for example, see if a search is being used in a script or workflow). - Use Change Requests to keep your changes organized and capture approvals. ### Script Management -Critical Script Analysis enables you to determine how healthy your scripts are and what areas you +Critical Script Analysis lets you determine how healthy your scripts are and what areas you can fix to improve your account. With the tools and the Critical Script Analysis methodology you can: @@ -53,11 +53,11 @@ can: ## Intelligent Change Management -Platform Governance for Salesforce is the only application for Salesforce that enables end to end -change management and compliance. This process can be achieved effectively in only 5 weeks after +Platform Governance for Salesforce provides end-to-end +change management and compliance. This process can be completed in 5 weeks after install. -By implementing Platform Governance for Salesforce you give your customers the ability to: +By implementing Platform Governance for Salesforce, you give your customers the ability to: - Track all changes to custom objects in Salesforce. - Automatically be alerted to non-compliant changes. @@ -69,19 +69,17 @@ By implementing Platform Governance for Salesforce you give your customers the a ## Enterprise Compliance -Once Intelligent Change Management is complete, it only takes between 3 to 4 weeks to achieve -Enterprise Compliance. +After Intelligent Change Management is complete, Enterprise Compliance takes 3 to 4 additional weeks. ### Environment Comparison -The Environment Management Module enables Salesforce customers and consultants to quickly and -accurately identify differences between any two Salesforce accounts that have Intelligent Change -Management installed. Since both accounts have Platform Governance for Salesforce documentation in +The Environment Management Module enables Salesforce customers and consultants to identify differences between any two Salesforce accounts that have Intelligent Change +Management installed. Because both accounts have Platform Governance for Salesforce documentation in place, the tool can quickly compare them. It is principally used in four scenarios: - Sandbox Refreshes - Migrating Customizations Between Developer and Sandbox Accounts -- User Acceptance Testing (UAT) and Performance Testing Environment Validation +- User Acceptance Testing (UAT) and Performance Testing environment validation - Deploying Changes to Production ### Automated Audit diff --git a/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md b/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md index f21e32a843..ef4eed6933 100644 --- a/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md +++ b/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md @@ -76,7 +76,7 @@ This section only applies to sandbox orgs. It displays each scanner function and If you are in a sandbox, you can control whether change logs are created. Due to Salesforce space limits on different [sandbox accounts](https://help.salesforce.com/articleView?id=data_sandbox_environments.htmandtype=5), -you may want to disable change logs to save space. +consider disabling change logs to save space. ![Control Change Log Creation in Sandbox](/images/platgovsalesforce/installing_strongpoint/config_stats_enable_change_log.webp) @@ -95,7 +95,7 @@ The Scanner Inactivity Alert feature provides automated email notifications to d 2. **Enable the Feature** - Select the checkbox to enable scanner inactivity alerts - - Once enabled, the Admin Users Selection panel appears below + - Once enabled, the Admin Users Selection panel appears #### Step 2: Select Admin Users @@ -128,13 +128,13 @@ Use the multi-select panel to manage recipients: ##### Save Settings 1. Click **Save Configuration** at the bottom of the page -2. A loading spinner appears while the configuration is saved -3. Wait for the confirmation message +2. A loading spinner appears while the configuration saves. +3. Wait for the confirmation message. #### Alert Trigger Conditions -The system continuously monitors the Auto Scanner and sends email alerts when it detects that the scanner is not running as configured in the scheduler. +The system continuously monitors the Auto Scanner and sends email alerts when it detects that the scanner isn't running as configured in the scheduler. ## Jira Configuration @@ -147,7 +147,7 @@ Governance for Salesforce. ### Credentials -Your credentials are generated in Jira. Enter them here for the Platform Governance for Salesforce +Generate your credentials in Jira, then enter them here for the Platform Governance for Salesforce Jira integration. 1. Open **Netwrix Dashboard** > **Settings** > **Configuration and Stats**. @@ -158,7 +158,7 @@ Jira integration. 3. Enter your credentials: - **Jira Username** is your Jira login email associated with your Jira API token. - - **Jira Token** is your Jira API token. If you do not have your token, follow the steps in the + - **Jira Token** is your Jira API token. If you don't have your token, follow the steps in the [Atlassian](https://confluence.atlassian.com/cloud/api-tokens-938839638.html) documentation. - **Jira Account Name** is the _company specific part_ of the Jira site URL (**https://\_**JiraAccountName**\_.atlassian.net**). Only enter the _JiraAccountName_, not the @@ -176,7 +176,7 @@ Jira integration. ![Set up the Jira status mappings for Change Request status](/images/platgovsalesforce/integrations/jira_status_settings.webp) 4. Enter the mappings between your Jira statuses and the Change Request statuses. You must define - your Jira statuses prior to this step. You can enter multiple Jira statuses for each Change + your Jira statuses before this step. You can enter multiple Jira statuses for each Change Request status, separated by commas. For example, **In Progress, Backlog**. Assign your mapping for each of the Change Request statuses: @@ -188,14 +188,13 @@ Jira integration. 5. Check **Is Automatic Sync** to enable Platform Governance for Salesforce to handle the synchronization between Jira and Salesforce when a Ticket status is updated to a mapped status. - without having to click **Push**. If you are using an org where you do not want to create a + without clicking **Push**. If you are using an org where you don't 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. - 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. +6. Platform Governance for Salesforce doesn't automatically create Change Requests, because not all tickets result in a Change Request. + Tickets must be pushed to Platform Governance for Salesforce to begin the process. When Automatic + Synchronization is on, Platform Governance for Salesforce synchronizes changes to the Status and Customizations + between Jira and Platform Governance for Salesforce without manually pushing changes. 7. Click **Save**. ## Orgs Credentials diff --git a/docs/platgovsalesforce/installingstrongpoint/features_by_license_type.md b/docs/platgovsalesforce/installingstrongpoint/features_by_license_type.md index c4ca4919d9..9c16545e28 100644 --- a/docs/platgovsalesforce/installingstrongpoint/features_by_license_type.md +++ b/docs/platgovsalesforce/installingstrongpoint/features_by_license_type.md @@ -16,15 +16,15 @@ This table summarizes what is included in each type. | Feature | Automated Documentation | Intelligent Change Enablement | Enterprise Compliance | | ---------------------------------------------------------- | :-----------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------: | -| Customization, Scanners and DRD | **✓** | **✓** | **✓** | +| Customization, Scanners, and DRD (Dependency Relationship Diagram) | **✓** | **✓** | **✓** | | Field-Level Scanner | **✓** | **✓** | **✓** | -| Clean Up: Reports, and Scheduler, Processes, DLU | **✓** | **✓** | **✓** | +| Clean Up: Reports, and Scheduler, Processes, DLU (Date Last Used) | **✓** | **✓** | **✓** | | Profile / Permission Set Comparison | **✓** | **✓** | **✓** | | User Access Assistance | | **✓** | **✓** | | User Activity | | **✓** | **✓** | | Implementation, Planned Customizations, Map Customizations | | **✓** | **✓** | | Change Request (Change Management) | | **✓** | **✓** | -| Release & Deployment (Deployment, Rollback & Sync Tool) | | **✓** | **✓** | +| Release & Deployment (Deployment, Rollback, & Sync Tool) | | **✓** | **✓** | | Compare Environments | | **✓** | **✓** | | Financial Controls | | | **✓** | @@ -35,7 +35,7 @@ optimization tools. Automated Documentation includes the following features: -- Customizations, Scanners and DRD +- Customizations, Scanners, and DRD - Field-Level Scanner - Generate and download object configurations - Clean Up and Optimization that tracks DLU (Date Last Used) @@ -45,7 +45,7 @@ Automated Documentation includes the following features: ## Intelligent Change Enablement -This license is best for companies that need to manage changes in their account(s). +This license is best for companies that need to manage changes in one or more accounts. Intelligent Change Management includes the following features: @@ -57,7 +57,7 @@ Intelligent Change Management includes the following features: - Scheduler - Implementation, Planned Customizations, Map Customizations - Change Requests -- Release and Deployment (Deployment, Rollback and Enviro Sync Tool) +- Release and Deployment (Deployment, Rollback, and Enviro Sync Tool) - Compare Environments - Profile / Permission Set Comparison - User Access Assistance @@ -78,7 +78,7 @@ Enterprise Compliance includes the following features: - Scheduler - Implementation, Planned Customizations, Map Customizations - Change Requests -- Release and Deployment (Deployment, Rollback and Enviro Sync Tool) and Compare Environments +- Release and Deployment (Deployment, Rollback, and Enviro Sync Tool) and Compare Environments - Financial Controls - Audit Reports and Fields - Profile / Permission Set Comparison diff --git a/docs/platgovsalesforce/installingstrongpoint/installing_strongpoint.md b/docs/platgovsalesforce/installingstrongpoint/installing_strongpoint.md index 288dd19ed5..13d4868a4a 100644 --- a/docs/platgovsalesforce/installingstrongpoint/installing_strongpoint.md +++ b/docs/platgovsalesforce/installingstrongpoint/installing_strongpoint.md @@ -20,7 +20,7 @@ The installation runs in the background. You receive an email notification when ## Configure Authentication -After installing the package, you need to configure authentication credentials. Platform Governance for Salesforce supports two authentication methods: +After installing the package, configure authentication credentials. Platform Governance for Salesforce supports two authentication methods: ### Recommended: Named Credential Authentication (OAuth) @@ -72,13 +72,13 @@ When using Session ID authentication, create a dedicated Integration User specif ## Assign Permission Set to Users -After configuring authentication, you must assign the required Permission Set to users who will access Platform Governance for Salesforce, and to any users running scheduled jobs or background processes the application requires. +After configuring authentication, assign the required Permission Set to users who need access to Platform Governance for Salesforce, and to any users running scheduled jobs or background processes the application requires. -This is required because the Permission Set grants access to the data and system processes Platform Governance uses, including metadata scanning and other automated operations. +The Permission Set grants access to the data and system processes Platform Governance uses, including metadata scanning and other automated operations. ### Assign Netwrix Grant Permissions -1. Navigate to **Setup** > **Users** > **Permission Sets** +1. In Salesforce, open **Setup** > **Users** > **Permission Sets** 2. Search for and click **Netwrix Grant Permissions** ![NetwrixPermissionSet](/images/platgovsalesforce/installing_strongpoint/NetwrixPermissionSet.webp) 3. Click **Manage Assignments** @@ -90,14 +90,14 @@ This is required because the Permission Set grants access to the data and system 7. Click **Done** :::note Required Permission Set -All users who access the Netwrix Lightning application need the **Netwrix Grant Permissions** permission set. Without this permission set, users cannot use Platform Governance for Salesforce. +All users who access the Netwrix Lightning application need the **Netwrix Grant Permissions** permission set to use Platform Governance for Salesforce. ::: ### Verify Permission Assignment To verify that you assigned the permission set correctly: -1. Navigate to **Setup** > **Users** > **Users** +1. In Salesforce, open **Setup** > **Users** > **Users** 2. Click a user who should have access 3. Scroll to the **Permission Set Assignments** section 4. Verify that **Netwrix Grant Permissions** appears in the list @@ -109,7 +109,7 @@ After configuring authentication (either Named Credentials or Session ID), acces 1. Open the Salesforce **App Launcher** (grid icon in the top navigation) 2. Search for and select **Netwrix Lightning** ![NetwrixLightning](/images/platgovsalesforce/installing_strongpoint/NetwrixLightningMenu.webp) -3. A window will appear displaying the License Agreement and EULA. Review the contents carefully and then select **Accept**. +3. A window displays the License Agreement and EULA. Review the contents carefully and then select **Accept**. ![eula](/images/platgovsalesforce/installing_strongpoint/eula.webp) diff --git a/docs/platgovsalesforce/installingstrongpoint/license_manager.md b/docs/platgovsalesforce/installingstrongpoint/license_manager.md index 44162c342c..c86d02174d 100644 --- a/docs/platgovsalesforce/installingstrongpoint/license_manager.md +++ b/docs/platgovsalesforce/installingstrongpoint/license_manager.md @@ -27,5 +27,5 @@ Click **Configuration and Stats** in the **Resources** section, or open **Settin 5. Open **Netwrix Dashboard** > **Scanner** > **Manual Scanners** 6. Click **Name** to select all. -7. Click **Run Scanner** to make sure that everything is updated and documented in your account +7. Click **Run Scanner** to ensure that everything is updated and documented in your account after the license change. diff --git a/docs/platgovsalesforce/installingstrongpoint/named_credential.md b/docs/platgovsalesforce/installingstrongpoint/named_credential.md index ca9c13dd57..8097d6b38f 100644 --- a/docs/platgovsalesforce/installingstrongpoint/named_credential.md +++ b/docs/platgovsalesforce/installingstrongpoint/named_credential.md @@ -10,40 +10,40 @@ This guide explains how to configure Platform Governance for Salesforce using an ## Overview -The legacy method uses user Session IDs which are incompatible with Profiles with High Assurance. The new configuration uses an External Client App with Named Credentials to access Salesforce APIs, providing a more secure and MFA-compatible authentication method. +The new configuration uses an External Client App with Named Credentials to access Salesforce APIs, providing a more secure and MFA-compatible authentication method than the legacy Session ID approach. ## Why Use Named Credentials -Using Named Credentials with External Client App OAuth authentication is the recommended approach over using user Session IDs for several critical reasons: +Named Credentials with External Client App OAuth authentication are recommended over user Session IDs for several critical reasons: ### High Assurance Compatibility -**This is the primary reason for using Named Credentials.** When Salesforce organizations have High Assurance enabled—which is increasingly required by Salesforce and security best practices—user Session IDs do not work properly for API calls. The Session ID authentication method fails because: +**This is the primary reason for using Named Credentials.** When Salesforce organizations have High Assurance enabled—which is increasingly required by Salesforce and security best practices—user Session IDs don't work properly for API calls. The Session ID authentication method fails because: - **Enabling High Assurance Session on the Named Credential ensures that only Named Credentials work for authentication**, providing an additional security layer that ensures MFA compliance ### Enhanced Security - **Session IDs inherit all permissions** of the authenticated user, creating potential security risks -- **External Client Apps with OAuth** allow you to define specific scopes and limit API access to only what's needed +- **External Client Apps with OAuth** let you define specific scopes and limit API access to only what's needed - Named Credentials provide better audit trails and can be monitored independently -- Credentials are stored securely by Salesforce and never exposed in code or logs +- Salesforce stores credentials securely and never exposes them in code or logs ### Automation and Scheduled Jobs -- Automated processes and scheduled jobs cannot rely on user Session IDs +- Automated processes and scheduled jobs can't rely on user Session IDs - Named Credentials provide persistent authentication that works independently of user sessions - Ideal for background processes, scheduled scans, and continuous monitoring ## Prerequisites - Salesforce Administrator access -- Access to Setup menu +- Access to the Salesforce Setup menu ## Step 1: Create an External Client App :::important -If this is not a new installation and your org already has an existing Connected App named **Netwrix** or **Strongpoint**, you don't need to create a new one. +If this isn't a new installation and your org already has an existing Connected App named **Netwrix** or **Strongpoint**, you don't need to create a new one. You can use the existing app and continue to [Step 2: Create an Auth Provider](#step-2-create-an-auth-provider). @@ -52,7 +52,7 @@ If you don't have the Consumer Key and Consumer Secret saved, go to [Retrieve Co Create a new External Client App to enable OAuth authentication: -1. Navigate to **Setup** > **Apps** > **App Manager** +1. In Salesforce, open **Setup** > **Apps** > **App Manager** 2. Click **New External Client App** 3. Configure the following settings: - **External Client App Name**: `Netwrix` @@ -60,7 +60,7 @@ Create a new External Client App to enable OAuth authentication: - **Contact Email**: Enter your administrator email ![ExternalApp1](/images/platgovsalesforce/installing_strongpoint/ExternalApp1.webp) 4. Under **API (Enable OAuth Settings)**: - - **Callback URL**: `https://www.localhost.com` (we will modify this parameter later) + - **Callback URL**: `https://www.localhost.com` (update this value in a later step) - **Selected OAuth Scopes**: Add the following scopes: - **Full access (full)** - **Perform requests at any time (refresh_token, offline_access)** @@ -95,13 +95,13 @@ After creating the External Client App: 2. Click **Consumer Key and Secret** From the OAuth Settings section ![ClickKeyAndSecret](/images/platgovsalesforce/installing_strongpoint/ClickKeyAndSecret.webp) 3. Verify your identity (you may need to enter a verification code) -4. Copy and save the **Consumer Key** and **Consumer Secret** - you'll need these in the next step +4. Copy and save the **Consumer Key** and **Consumer Secret** — you need these in the next step. ## Step 2: Create an Auth Provider Create a new Authentication Provider to enable OAuth authentication: -1. Navigate to **Setup** > **Identity** > **Auth. Providers** +1. In Salesforce, open **Setup** > **Identity** > **Auth. Providers** 2. Click **New** 3. Configure the following settings: - **Provider Type**: Salesforce @@ -125,7 +125,7 @@ After creating the Auth Provider: 1. Copy the **Callback URL** displayed on the Auth Provider detail page ![AuthProviderView](/images/platgovsalesforce/installing_strongpoint/AuthProviderView.webp) -2. Navigate back to **Setup** > **External Client Apps** > **External Client App Manager** +2. In Salesforce, open **Setup** > **External Client Apps** > **External Client App Manager** 3. Locate the **Netwrix** External Client App 4. Click the dropdown and select **Edit Settings** 5. Replace the **Callback URL** with the URL copied from the Auth Provider @@ -136,7 +136,7 @@ After creating the Auth Provider: Create a Named Credential to establish the authentication connection: -1. Navigate to **Setup** > **Security** > **Named Credentials** +1. In Salesforce, open **Setup** > **Security** > **Named Credentials** 2. Click **New Named Credential** (or **New Legacy** if using Enhanced Named Credentials) 3. Configure the following settings: - **Label**: `Strongpoint MFA` @@ -154,29 +154,29 @@ Create a Named Credential to establish the authentication connection: 4. Click **Save** :::tip High Assurance Session -Enabling **Require High Assurance Session** ensures that the Named Credential can only be used after a high-assurance authentication event. This setting enforces the use of Named Credentials and provides an additional layer of security. For more information, see [Salesforce High Assurance Sessions documentation](https://help.salesforce.com/s/articleView?id=xcloud.security_auth_require_ha_session.htm&type=5). +Enabling **Require High Assurance Session** ensures that the Named Credential can only be used after a high-assurance authentication event. This setting enforces the use of Named Credentials and provides an additional layer of security. See [Salesforce High Assurance Sessions documentation](https://help.salesforce.com/s/articleView?id=xcloud.security_auth_require_ha_session.htm&type=5). ::: ### Authenticate the Named Credential After saving: -1. You will be redirected to the Salesforce login page -2. Log in with your credentials -3. Click **Allow** to grant access +1. Salesforce redirects you to the login page. +2. Log in with your credentials. +3. Click **Allow** to grant access. ![ApproveUseOfNamedCredential](/images/platgovsalesforce/installing_strongpoint/ApproveUseOfNamedCredential.webp) ![ApproveUseOfNamedCredential2](/images/platgovsalesforce/installing_strongpoint/ApproveUseOfNamedCredential2.webp) -4. You will be redirected back to the Named Credential record +4. Salesforce redirects you back to the Named Credential record. 5. Verify that the **Authentication Status** shows as **Authenticated** ![NamedCredentialView](/images/platgovsalesforce/installing_strongpoint/NamedCredentialView.webp) ## Verification -Once all steps are completed: +After completing all steps, verify the following: -- The External Client App should have OAuth enabled with the correct scopes -- The Auth Provider should be configured with the correct endpoints -- The Named Credential should show an **Authenticated** status +- The External Client App has OAuth enabled with the correct scopes. +- The Auth Provider is configured with the correct endpoints. +- The Named Credential shows an **Authenticated** status. Your Platform Governance for Salesforce is now configured to use External Client App authentication with Named Credentials. diff --git a/docs/platgovsalesforce/installingstrongpoint/platform_governor.md b/docs/platgovsalesforce/installingstrongpoint/platform_governor.md index 6a752fed74..9ff09ff0fb 100644 --- a/docs/platgovsalesforce/installingstrongpoint/platform_governor.md +++ b/docs/platgovsalesforce/installingstrongpoint/platform_governor.md @@ -6,11 +6,11 @@ sidebar_position: 90 # Platform Governor Status -This is a live status update of the Usage of SFDC Governor Limit. Access it from **Netwrix -Dashboard** > **Settings** > **Platform Governor Status** +This is a live status update of the usage of the Salesforce Governor Limit. Access it from **Netwrix +Dashboard** > **Settings** > **Platform Governor Status**. -When Platform Governance for Salesforce reaches the threshold, executions are reschedule for the -next day so the organization limit is not reached. +When Platform Governance for Salesforce reaches the threshold, the system reschedules executions for the +next day so the organization limit isn't reached. ![governor](/images/platgovsalesforce/installing_strongpoint/governor.webp) diff --git a/docs/platgovsalesforce/installingstrongpoint/running_scanner.md b/docs/platgovsalesforce/installingstrongpoint/running_scanner.md index 771aba1398..5ac6426ce9 100644 --- a/docs/platgovsalesforce/installingstrongpoint/running_scanner.md +++ b/docs/platgovsalesforce/installingstrongpoint/running_scanner.md @@ -20,15 +20,15 @@ The scanner is only available to Administrators. To run the scanner: 1. Open **Netwrix Dashboard** > **Scanner** > **Manual Scanners** -2. Use the optional **Search Types** to narrow the focus of the list if you are looking for a +2. Use the optional **Search Types** to narrow the focus of the list when looking for a specific type. -3. You can select + beside one or more types to scan or you can scan the whole environment by +3. Select + beside one or more types to scan, or scan the whole environment by clicking + on the **Name** row to select all the types. ![scanner](/images/platgovsalesforce/installing_strongpoint/scanner.webp) 4. Click **Run Scanner**. -5. The batch runs in the background. You receive an email notification when the scan is complete. +5. The batch runs in the background. You receive an email notification when the scan completes. 6. From the Netwrix Dashboard: click **Configuration and Stats** in the **Resources** section, or open **Settings** > **Configuration and Stats**. @@ -45,7 +45,7 @@ You can create your own Salesforce view for the scanners: 5. Select **Apex Class** for the **Field**. 6. Select **starts with** for the **Operator**. 7. Assign **FLO, Strongpoint, NetPG** for the **Value**. - 8. Click **Save**. You can now see the status of all of the Strongpoint jobs. + 8. Click **Save**. The view now shows the status of all Strongpoint jobs. ![Viewing running Netwrix jobs](/images/platgovsalesforce/installing_strongpoint/scanner_view2.webp) **Next Step:** [Validate the Data ](/docs/platgovsalesforce/installingstrongpoint/validating_data.md) diff --git a/docs/platgovsalesforce/installingstrongpoint/sandbox_dev_orgs.md b/docs/platgovsalesforce/installingstrongpoint/sandbox_dev_orgs.md index aabe8011cf..defac5adea 100644 --- a/docs/platgovsalesforce/installingstrongpoint/sandbox_dev_orgs.md +++ b/docs/platgovsalesforce/installingstrongpoint/sandbox_dev_orgs.md @@ -6,8 +6,7 @@ sidebar_position: 100 # Sandbox Accounts -Salesforce sandbox accounts are set up for testing. Data storage is now optimized in these accounts -to make the most of their limited capacity. Default documentation is not created. Refer to the +Salesforce sandbox accounts are set up for testing. Platform Governance for Salesforce optimizes data storage in these accounts to make the most of their limited capacity and doesn't create default documentation. See the [Salesforce documentation](https://help.salesforce.com/articleView?id=data_sandbox_environments.htmandtype=5) for specifications and feature comparisons of sandbox types. @@ -15,17 +14,17 @@ When a sandbox is identified, Platform Governance for Salesforce limits excessiv not creating the following items: - Customizations for reports not used in more than a year. -- Change logs are not automatically created for Developer or Developer Pro sandboxes, but change - detection. last modified date, and environment compare can be used. -- Report and Workflow joins are not created for Developer or Developer Pro sandboxes. They are +- Platform Governance for Salesforce doesn't automatically create change logs for Developer or Developer Pro sandboxes, but change + detection, last modified date, and environment compare are available. +- Platform Governance for Salesforce doesn't create Report and Workflow joins for Developer or Developer Pro sandboxes. These are enabled for Partial and Full sandboxes, but can be disabled to save space. -- Separate XML representation files are not created. -- Separate JSON representation files are not created. +- Platform Governance for Salesforce doesn't create separate XML representation files. +- Platform Governance for Salesforce doesn't create separate JSON representation files. If you need to see the Customizations for an object, open the Scanner, select the object, and click **Run Scanner**. -## Controlling Sandbox Change Log, Junction and Report Creation +## Controlling Sandbox Change Log, Junction, and Report Creation You can enable/disable change log, junction, and report creation for a sandbox from the **Configuration and Stats** page. diff --git a/docs/platgovsalesforce/installingstrongpoint/setting_access_permission.md b/docs/platgovsalesforce/installingstrongpoint/setting_access_permission.md index e3f4839dbe..5ed28031de 100644 --- a/docs/platgovsalesforce/installingstrongpoint/setting_access_permission.md +++ b/docs/platgovsalesforce/installingstrongpoint/setting_access_permission.md @@ -6,7 +6,7 @@ sidebar_position: 60 # Set Access and Permissions -Platform Governance for Salesforce access is only granted to system administrations. To extend +By default, Platform Governance for Salesforce grants access only to system administrators. To extend access to other users: 1. Open Salesforce **Setup** > **Users** > **Users** @@ -20,7 +20,7 @@ access to other users: ![editassignments](/images/platgovsalesforce/installing_strongpoint/editassignments.webp) 5. Select **Netwrix Grant Permissions** from the **Available Permission Sets** -6. Click **Add**. It should now be shown in the **Enabled Permission Sets**. +6. Click **Add**. The permission set now appears in the **Enabled Permission Sets** list. 7. Click **Save**. ![enablepermissionsets](/images/platgovsalesforce/installing_strongpoint/enablepermissionsets.webp) @@ -28,13 +28,13 @@ access to other users: The user is ready to view and use Platform Governance for Salesforce. :::note -The previous image shows additional Permission Sets included in the package. Below is a brief description of each: +The previous image shows additional Permission Sets included in the package. The following is a brief description of each: - **Netwrix Administrator** Provides access to Netwrix configuration settings. - **Netwrix CR Approval Override** - Allows users to approve a Change Request regardless of the current policy. + Users with this permission set can approve a Change Request regardless of the current policy. - **Netwrix Restricted** - A restricted set of permissions required for users who will be making data updates to tracked or controlled objects. + A restricted set of permissions required for users who make data updates to tracked or controlled objects. ::: \ No newline at end of file diff --git a/docs/platgovsalesforce/installingstrongpoint/setting_up_initial_scan.md b/docs/platgovsalesforce/installingstrongpoint/setting_up_initial_scan.md index 4f7f0e06ea..fb209ccfd3 100644 --- a/docs/platgovsalesforce/installingstrongpoint/setting_up_initial_scan.md +++ b/docs/platgovsalesforce/installingstrongpoint/setting_up_initial_scan.md @@ -12,10 +12,10 @@ The Metadata Scanner form is displayed. ## Sandbox Options -If you are installing in a sandbox, there is an option for **Change Log Creation**. If **Enabled**, -change logs are created in the sandbox. Due to Salesforce space limits on different +If you are installing in a sandbox, there is an option for **Change Log Creation**. When **Enabled**, +the sandbox creates change logs. Due to Salesforce space limits on different [sandbox accounts](https://help.salesforce.com/articleView?id=data_sandbox_environments.htmandtype=5), -you may want to disable change logs to save space. This option can also be accessed on the +consider disabling change logs to save space. This option is also available on the [Configuration and Stats](/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md) page for the sandbox. Here are the options for a Sandbox installation. Be sure to **Save** each setting you change. Scroll @@ -38,7 +38,7 @@ Scroll down to the Metadata Scanner section. You can schedule the scanners to auto-scan your environment: 1. Toggle **Enabled** to activate a scan. Hover over the **?** for details on the scan. -2. Select the **Frequency** and **Day**. If you do not specify a time Platform Governance for +2. Select the **Frequency** and **Day**. Without a specified time, Platform Governance for Salesforce rescans at midnight. ![getting_started_wizard6](/images/platgovsalesforce/installing_strongpoint/getting_started_wizard6.webp) @@ -61,7 +61,7 @@ Change the day or time of your Scanner run to prevent overlap which may cause fa 3. Click **Next**. -The final screen is displayed. Click **Done** to close the wizard. +The final screen appears. Click **Done** to close the wizard. ![getting_started_wizard8](/images/platgovsalesforce/installing_strongpoint/getting_started_wizard8.webp) diff --git a/docs/platgovsalesforce/installingstrongpoint/using_getting_started_wizard.md b/docs/platgovsalesforce/installingstrongpoint/using_getting_started_wizard.md index 63de297042..46eb2192f2 100644 --- a/docs/platgovsalesforce/installingstrongpoint/using_getting_started_wizard.md +++ b/docs/platgovsalesforce/installingstrongpoint/using_getting_started_wizard.md @@ -36,13 +36,13 @@ On the Initial Setup Wizard page, choose the package type you have purchased and ## Add your Credentials -Once you have chosen your license type, you need to add your credentials. If your credentials -change, an alert is sent to update the saved credentials. Expired credentials can cause auto +After you have chosen your license type, add your credentials. If your credentials +change, the system sends an alert to update the saved credentials. Expired credentials can cause auto scanners to fail. Use **Netwrix Dashboard** > **Settings**> **SP Credentials** to update your credentials. :::warning High Assurance Users -If your organization has High Assurance enabled, you **cannot** use this credential method. You must use [Named Credentials](named_credential.md) instead. +If your organization has High Assurance enabled, you **can't** use this credential method. You must use [Named Credentials](named_credential.md) instead. ::: ![getting_started_wizard3](/images/platgovsalesforce/installing_strongpoint/getting_started_wizard3.webp) @@ -61,7 +61,7 @@ If your organization has High Assurance enabled, you **cannot** use this credent ## Test Your Connection -This step applies to **both** Named Credentials and Session ID authentication methods. You need to configure the remote site settings to allow Platform Governance to communicate with external services. +This step applies to **both** Named Credentials and Session ID authentication methods. Configure the remote site settings to allow Platform Governance to communicate with external services. ![Testing the connection](/images/platgovsalesforce/installing_strongpoint/getting_started_wizard10.webp) @@ -76,15 +76,15 @@ This step applies to **both** Named Credentials and Session ID authentication me 4. Repeat for each remote site URL shown in the wizard :::tip Multiple Remote Sites -You may need to create multiple remote site settings. The wizard will display all required URLs. Create a separate remote site entry for each URL shown. +You may need to create multiple remote site settings. The wizard displays all required URLs. Create a separate remote site entry for each URL shown. ::: ### Test the Connection 1. Return to the Getting Started Wizard 2. Click **Test Connection** -3. **Test connection was Successful** is displayed if the connection succeeds -4. Once the test is successful, click **Next** +3. If the connection succeeds, **Test connection was Successful** appears. +4. After the test is successful, click **Next** ## Next Steps diff --git a/docs/platgovsalesforce/installingstrongpoint/validating_data.md b/docs/platgovsalesforce/installingstrongpoint/validating_data.md index 23314bf3f5..f0581e3ec9 100644 --- a/docs/platgovsalesforce/installingstrongpoint/validating_data.md +++ b/docs/platgovsalesforce/installingstrongpoint/validating_data.md @@ -7,7 +7,7 @@ sidebar_position: 50 # Validate the Data Accurate documentation is critical to support your change management and clean up processes. -Platform Governance for Salesforce has automated tools to enable you to ensure that your +Platform Governance for Salesforce provides automated tools to ensure that your customizations are documented properly. ## Status Report @@ -22,13 +22,13 @@ From the Netwrix Dashboard: click **Configuration and Stats** in the **Resources ## Dependency Relationship Diagram -You can check data by navigating through the Dependency Relationship Diagram (DRD) and selecting -object(s) types. +You can check data by navigating the Dependency Relationship Diagram (DRD) and selecting +object types. To validate data with the DRD: 1. Open **Netwrix Dashboard** > **Tools** > **Dependency Relationship Diagram**. -2. Select an **Object(s) Type** from the pull-down menu. +2. Select an **Object Type** from the pull-down menu. 3. Click a field and validate the data. ![entity_diagram](/images/platgovsalesforce/tools/entity_diagram_light.webp) diff --git a/docs/platgovsalesforce/integrations/integrations_overview.md b/docs/platgovsalesforce/integrations/integrations_overview.md index 27a0097256..22fab4fd96 100644 --- a/docs/platgovsalesforce/integrations/integrations_overview.md +++ b/docs/platgovsalesforce/integrations/integrations_overview.md @@ -19,9 +19,9 @@ Integrations with Salesforce include: ## Jira Platform Governance for Salesforce’s Change Management capabilities are integrated with Jira, one of -the most popular issue ticketing and development project management systems. Customers are able to -push Jira change tickets into a Change Request, enabling easy management of changes directly in -their system, seamless tracking of compliant changes and automating the reconciliation of change +the most popular issue ticketing and development project management systems. Customers can +push Jira change tickets into a Change Request, enabling change management directly in +their system, tracking compliant changes, and automating the reconciliation of change logs during an audit. This provides the following benefits to your users: - Improved team productivity by automatically detecting objects mentioned in Jira tickets, managing diff --git a/docs/platgovsalesforce/integrations/jiraintegration/finding_change_requests_from_jira.md b/docs/platgovsalesforce/integrations/jiraintegration/finding_change_requests_from_jira.md index ba8e7ff668..fc25cc89ea 100644 --- a/docs/platgovsalesforce/integrations/jiraintegration/finding_change_requests_from_jira.md +++ b/docs/platgovsalesforce/integrations/jiraintegration/finding_change_requests_from_jira.md @@ -18,5 +18,5 @@ Create a Report: Equals Select Jira 6. Add any additional columns you want to display. -7. Once the report is created, click **Save**. Best practice is to title the search something +7. After you create the report, click **Save**. Best practice is to title the search something meaningful, such as **Find Change Requests from Jira**. diff --git a/docs/platgovsalesforce/integrations/jiraintegration/jira_field_map.md b/docs/platgovsalesforce/integrations/jiraintegration/jira_field_map.md index ade2882647..749e4e7532 100644 --- a/docs/platgovsalesforce/integrations/jiraintegration/jira_field_map.md +++ b/docs/platgovsalesforce/integrations/jiraintegration/jira_field_map.md @@ -41,7 +41,7 @@ Ensure the fields are created in Salesforce. 1. Open **Salesforce Setup** > **Object Manager** > **Change Request** 2. Open **Fields & Relationships** -If your fields are not in the list, use the **New** button to add them. +If your fields aren't in the list, use the **New** button to add them. For this example, the **Strongpoint Version** and **SF Version Number** fields have been added. @@ -59,14 +59,14 @@ Add the fields to the Page Layouts. 1. Open **Salesforce Setup** > **Object Manager** > **Change Request**. 2. Open **Page Layouts**. -3. Select your layout. If your fields are not in the layout, add them. For this example, the +3. Select your layout. If your fields aren't in the layout, add them. For this example, the **Strongpoint Version** and **SF Version Number** fields have been added to the **Customizations Layout**. ![Add to layouts](/images/platgovsalesforce/integrations/field_map_layouts.webp) 4. Open **Setup** > **Lightning App Builder**. -5. Open your Record Page. This example shows the **Customizations Record** page. Make sure your +5. Open your Record Page. This example shows the **Customizations Record** page. Ensure your fields are in the record page and set to visible. ![Check record page for fields and visibility](/images/platgovsalesforce/integrations/field_map_record.webp) @@ -81,7 +81,7 @@ 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 +Ensure 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. ::: @@ -105,7 +105,7 @@ The Jira API names are required to create the mapping record. ### Create Mapping Record 1. Open the App Launcher. -2. Navigate to **CR CustomFields Mapping**. It is added as a tab on the navigation bar. You can +2. Navigate to **CR CustomFields Mapping**. The app adds it as a tab on the navigation bar. You can click the down arrow on the tab and add it to your navigation bar. ![Launch CR CustomFields Mapping](/images/platgovsalesforce/integrations/field_map_launcher.webp) @@ -124,8 +124,7 @@ The Jira API names are required to create the mapping record. 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 -shows in the Netwrix Change Request. +The mapping is now complete. In the next update, the fields are populated and the information appears in the Netwrix Change Request. ![Field Map complete](/images/platgovsalesforce/integrations/field_map_complete.webp) diff --git a/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md b/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md index 887b35338e..15c684bcd9 100644 --- a/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md +++ b/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md @@ -7,20 +7,19 @@ sidebar_position: 10 # Set Up the Jira Integration Platform Governance for Salesforce's Change Enablement capabilities are integrated with Jira, one of -the most popular issue ticketing and development project management systems. Customers are able to -look for and include Salesforce Customizations, assess impacts for requested changes, and push Jira -change tickets into a Change Request. This enables easy management of changes, seamless tracking of +the most popular issue ticketing and development project management systems. Customers can look for and include Salesforce Customizations, assess impacts for requested changes, and push Jira +change tickets into a Change Request. This enables change management, tracking of compliant changes and automating the reconciliation of change logs during an audit. User benefits include: - Avoid duplicate effort of creating tickets in two different systems. - Perform impact analysis assessment. -- Navigate to DRD views. +- Navigate to Dependency Relationship Diagram (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. +Change Requests aren't 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. @@ -38,7 +37,7 @@ You can map custom fields between Change Requests and Jira. Refer to ## Review Your Jira Statuses -To take advantage of the automatic synchronization feature, we recommend reviewing your Jira +To take advantage of the automatic synchronization feature, review your Jira 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. @@ -60,7 +59,7 @@ Cloud Integration Credentials after installing the app. :::note You must be a Jira system administrator to install the **Netwrix for Salesforce** app. Contact -your Jira system administrator if you do not have administrative permissions. +your Jira system administrator if you don't have administrative permissions. ::: 1. Open your **Jira Software Dashboard**. @@ -90,7 +89,7 @@ Configure the connected app: ![Open the Strongpoint Connected App](/images/platgovsalesforce/integrations/connected_app.webp) -3. Click the drop down arrow on the right side and select **Edit**. +3. Click the dropdown arrow on the right side and select **Edit**. 4. Set the **Callback URL** to **https://spjira.my.salesforce-sites.com/SpHandleJiraAuth** 5. These **Oauth Scopes** must be selected: **Full access (full)** @@ -108,7 +107,7 @@ Configure the connected app: 8. Copy the Consumer Key and the Consumer Secret codes to a clipboard. You are prompted for this information when you use the app. -If you do not use a connected app, you can set up Jira Cloud Integration Credentials as an +If you don't use a connected app, you can set up Jira Cloud Integration Credentials as an alternative. :::note @@ -124,7 +123,7 @@ Configure the External Client Apps (new version of connected apps): ![Open the Strongpoint Connected App](/images/platgovsalesforce/integrations/externalClientAppSearch.webp) -3. Click the drop down arrow on the right side and select **Edit Settings**. +3. Click the dropdown arrow on the right side and select **Edit Settings**. 4. Set the **Callback URL** to **https://spjira.my.salesforce-sites.com/SpHandleJiraAuth** under the Oauth Settings Section 5. These **Oauth Scopes** must be selected: **Full access (full)** @@ -153,7 +152,7 @@ Configure the External Client Apps (new version of connected apps): 3. Enter your credentials: - **Jira Username** is your Jira login email associated with your Jira API token. - - **Jira Token** is your Jira API token. If you do not have your token, follow the steps in the + - **Jira Token** is your Jira API token. If you don't have your token, follow the steps in the [Atlassian](https://confluence.atlassian.com/cloud/api-tokens-938839638.html) documentation. - **Jira Account Name** is the _company specific part_ of the Jira site URL (**https://\_**JiraAccountName**\_.atlassian.net**). Only enter the _JiraAccountName_, not the @@ -170,7 +169,7 @@ 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. -> _The Strongpoint Salesforce Integration is not supported for this project._ +> _The Strongpoint Salesforce Integration isn't supported for this project._ Follow the instructions for Restricting Access to a Project or Setting Groups/Profiles Visibility to grant the user appropriate access. @@ -190,13 +189,12 @@ If **Visibility Settings** is blank, all projects have access. #### Setting Groups/Profiles Visibility -Access to the Jira Platform Governance for Salesforce integration can also be performed with Profile -groups. +You can also restrict access to the Jira Platform Governance for Salesforce integration using Profile groups. Users opening a restricted project receive a information message, instructions for enabling access, and a link to this topic. -> _The Strongpoint Salesforce Integration is not supported for this project._ +> _The Strongpoint Salesforce Integration isn't supported for this project._ Follow the instructions for Restricting Access to a Project or Setting Groups/Profiles Visibility to grant the user appropriate access. @@ -224,7 +222,7 @@ Follow the instructions for Restricting Access to a Project or Setting Groups/Pr ![Set up the Jira status mappings for Change Request status](/images/platgovsalesforce/integrations/jira_status_settings.webp) 4. Enter the mappings between your Jira statuses and the Change Request statuses. You must define - your Jira statuses prior to this step. You can enter multiple Jira statuses for each Change + your Jira statuses before this step. You can enter multiple Jira statuses for each Change Request status, separated by commas. For example, **In Progress, Backlog**. Assign your mapping for each of the Change Request statuses: @@ -235,13 +233,13 @@ Follow the instructions for Restricting Access to a Project or Setting Groups/Pr - **Rejected Values** 5. Check **Is Automatic Sync** to enable Platform Governance for Salesforce to handle the - synchronization between Jira and Salesforce when a Ticket status is updated to a mapped status. - without having to click **Push**. If you are using an org where you do not want to create a + synchronization between Jira and Salesforce when a Ticket status is updated to a mapped status, + without requiring a manual **Push**. If you are using an org where you don't want to create a Change Request, leave this unchecked so you can do your research or testing without generating Change Requests. :::note - Change Requests are not automatically created, as not all tickets result in a Change Request. + Change Requests aren't 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 diff --git a/docs/platgovsalesforce/integrations/jiraintegration/jira_troubleshooting.md b/docs/platgovsalesforce/integrations/jiraintegration/jira_troubleshooting.md index a593afe6c0..ea45ac6a19 100644 --- a/docs/platgovsalesforce/integrations/jiraintegration/jira_troubleshooting.md +++ b/docs/platgovsalesforce/integrations/jiraintegration/jira_troubleshooting.md @@ -12,36 +12,35 @@ Jira Integration errors Error message: -_Please verify your Jira Credentials. Go to_ **Netwrix Dashboard** _>_ **Configurations and Stats** +_Verify your Jira Credentials. Go to_ **Netwrix Dashboard** _>_ **Configurations and Stats** _>_ **Jira Configuration** _>_ **Credentials** Solution: -Refer to [Credentials](/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md#credentials) for more +See [Credentials](/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md#credentials) for information on entering your credentials. ## Error with Mapping Jira Statuses Error message: -_Please verify your Jira Credentials. Go to_ **Netwrix Dashboard** _>_ **Configurations and Stats** +_Verify your Jira Credentials. Go to_ **Netwrix Dashboard** _>_ **Configurations and Stats** _>_ **Jira Configuration** _->_ **Status Mapping** Solution: -Refer to [Status Mapping](/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md#status-mapping) for more +See [Status Mapping](/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md#status-mapping) for information on mapping your statuses. ## Error with Salesforce Credentials Error message: -Verify Your User Credentials: It may be an Invalid username, wrong password, or invalid -security token. +Verify Your User Credentials: the username is invalid, the password is wrong, or the security token is invalid. If you are using Salesforce Authenticator, update it to the most recent Six-digit code. -Or verify that the user is not locked. +Or verify that the user isn't locked. Solution: @@ -53,8 +52,8 @@ Error message: error=invalid_client_id&error_description=client%20identifier%20invalid -Refer to [Access Data with API Integration](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) for -more information on setting up the connected app. +See [Access Data with API Integration](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) for +information on setting up the connected app. ## Error with Consumer Secret @@ -64,7 +63,7 @@ Verify the Consumers Secret from the Connected App. Solution: -Refer to [Credentials](/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md#credentials) for more +See [Credentials](/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md#credentials) for information on entering your credentials ## URL Errors @@ -75,5 +74,5 @@ error=redirect_uri_mismatch Solution: -Refer to [Connected App](jira_walkthrough_example.md#connected-app) Connected App for more +See [Connected App](jira_walkthrough_example.md#connected-app) for information on setting up the connected app. diff --git a/docs/platgovsalesforce/integrations/jiraintegration/jira_upload_addon_not_showing.md b/docs/platgovsalesforce/integrations/jiraintegration/jira_upload_addon_not_showing.md index fdb4927232..5272f640a6 100644 --- a/docs/platgovsalesforce/integrations/jiraintegration/jira_upload_addon_not_showing.md +++ b/docs/platgovsalesforce/integrations/jiraintegration/jira_upload_addon_not_showing.md @@ -6,7 +6,7 @@ sidebar_position: 40 # Jira Upload Add On Not Showing -If the Upload add on is not shown on your screen, you are either not a Jira administrator or you +If the Upload add on isn't shown on your screen, you are either not a Jira administrator or you have not checked **Enable development mode**. To enable development mode: diff --git a/docs/platgovsalesforce/integrations/jiraintegration/jira_walkthrough_example.md b/docs/platgovsalesforce/integrations/jiraintegration/jira_walkthrough_example.md index 7481bb7313..b7af32b714 100644 --- a/docs/platgovsalesforce/integrations/jiraintegration/jira_walkthrough_example.md +++ b/docs/platgovsalesforce/integrations/jiraintegration/jira_walkthrough_example.md @@ -6,9 +6,9 @@ sidebar_position: 20 # Jira Walkthrough Example -This walkthrough is one example based on our test account. You must -[install and configure](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) the Platform Governance for Salesforce Salesforce Jira -integration, including setting up the **[Jira Statuses](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md)** prior to using this +This walkthrough is one example based on a test account. You must +[install and configure](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) the Platform Governance for Salesforce Jira +integration, including setting up the **[Jira Statuses](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md)** before using this walkthrough. The walkthrough demonstrates these steps: @@ -38,7 +38,7 @@ The walkthrough demonstrates these steps: 5. Click **Create**. :::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. +Alerts and notifications may occur during this walkthrough, and aren't included in these steps. For example, override alert, notifications for approvers, and notification for the change request. ::: ## Connect to the App @@ -63,30 +63,30 @@ Use the **Connected App** tab if you set up the connected app using the procedur 2. Enter the **Consumer Key** and **Consumer Secret**. 3. Click **Is Sandbox account?** if you are logging in to a sandbox. 4. Click **Connect**. If this is the first time you are using the connected app, you are prompted to - select your username. The connected app is configured for you. Once finished, click **Close** on - the confirmation screen. The Strongpoint form is displayed. Your connection persists unless you + select your username. The connected app configures itself automatically. Once finished, click **Close** on + the confirmation screen. The Netwrix form appears. Your connection persists unless you click **Change Account** on the integration page. -If the configuration fails, an error message is displayed. For example, +If the configuration fails, the app displays an error message. For example, > **error=redirect_uri_mismatch** > -> - The 10 minutes timing slot from Salesforce is not completed yet. Wait for completion. +> - The 10 minutes timing slot from Salesforce isn't completed yet. Wait for completion. > - If the error persists, check the [Callback URL](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md). > -> - You may have left a space between the two Callback URLs -> - You may have an error in the newly added Callback URL it should be: +> - Check for a space between the two Callback URLs. +> - Check the newly added Callback URL. It should be: > **https://spjira.my.salesforce-sites.com/SpHandleJiraAuth** ### Login User -Enter your Salesforce **Username**, **Password** and **Security Token**. If you are using MFA or +Enter your Salesforce **Username**, **Password**, and **Security Token**. If you are using MFA or SSO: use your SSO Password. The Security token is the changing 6 digit code from your SSO or MFA app. ![Enter your Jira credentials](/images/platgovsalesforce/integrations/jiraLoginUserViewRebrand.webp) -If you do not have your security token, you can use these steps to reset your token: +If you don't have your security token, you can use these steps to reset your token: 1. Log in to your Salesforce account. 2. Open **View Profile** > **Settings**. @@ -94,19 +94,19 @@ If you do not have your security token, you can use these steps to reset your to 3. Select **Reset My Security Token** from the menu. 4. Click **Reset Security Token**. Check your email for your new token. 5. Click **Sandbox Account?** if you are using your sandbox. -6. Click **Connect**. If the connection is successful, the form is displayed (see Add Customizations +6. Click **Connect**. If the connection is successful, the form appears (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**. +You can't login if you don't 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. +If you don't enter the correct credentials, an error appears. After six unsuccessful +consecutive attempts to log in, your account is suspended for 30 minutes. ## Add Customizations -Once you have logged in, the form is displayed. +After you have logged in, the form appears. ![Connection details for the ticket](/images/platgovsalesforce/integrations/jiraRebrandFieldsCompleted.webp) @@ -117,13 +117,13 @@ Once you have logged in, the form is displayed. - **Change Level Req** is blank until Customizations have been added. If there are multiple change levels, the most stringent one is applied. - **Select Customizations** is where you specify the Customizations you are changing or adding. If - the Customization exists in your account, it is added to the **Select Customizations** list. **Add - Proposed Customizations** are added to the **Proposed Customizations** list. You can delete added - Customizations with the + the Customization exists in your account, the integration adds it to the **Select Customizations** list. **Add + Proposed Customizations** adds entries to the **Proposed Customizations** list. You can delete added + Customizations with the ![delete](/images/platgovnetsuite/integrations/delete.webp) icon. -- **View DRD** and **Impact Analysis** are tools to Perform Risk Assessment. +- **View DRD** and **Impact Analysis** are tools to perform risk assessment. **View DRD** opens the Dependency Relationship Diagram (DRD). - **Push** creates the Change Request in Salesforce. **Push** is also used to manually update your - Change Request if you are not using the [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) feature. + Change Request if you aren't using the [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) feature. ### Add Existing Customizations by Name or API Name @@ -134,7 +134,7 @@ Once you have logged in, the form is displayed. ![Add an existing customization](/images/platgovsalesforce/integrations/jiraRebrandAddCustomizations.webp) 3. Select one or more Customizations (With Add or Remove buttons). -4. Click **Add Selected Customizations**. The selected Customization is added to the **Existing +4. Click **Add Selected Customizations**. The integration adds the selected Customization to the **Existing Customizations** list. ![Add an existing customization](/images/platgovsalesforce/integrations/customizationListJiraRebrand.webp) @@ -143,27 +143,26 @@ Once you have logged in, the form is displayed. ### Add Proposed Customizations -In this procedure, we are adding a new Customization. +This procedure adds a new Customization. 1. Enter a new, valid API Name in the **Add Customization** for **Proposed Customizations** field. For this example, enter **CustomerPriorities**. -2. Click (**Add Proposed customizations**) to add it. If the API Name is valid, and does not match an existing API Name, the - new Customization is added to the **Proposed Customizations** list. +2. Click (**Add Proposed customizations**) to add it. If the API Name is valid and doesn't match an existing API Name, the + integration adds the new Customization to the **Proposed Customizations** list. ![Add a proposed customization](/images/platgovsalesforce/integrations/proposedCustomizationsListJiraRebrand.webp) ### Create the Change Request -Using the Platform Governance for Salesforce Jira integration, your Change Requests are created -automatically when you add a Customization. To setup or update the status mapping, refer to setting +The Platform Governance for Salesforce Jira integration automatically creates your Change Requests +when you add a Customization. To set up or update the status mapping, refer to setting up the **[Jira Statuses](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md)** procedure. 1. Change the Jira status of your ticket to match the status set up for **CR In Progress**. For example, **In Progress**. Refer to setting up the **[Jira Statuses](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md)** procedure. -2. Click **Push** to create the Change Request if you are not using the - [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) feature. The change request is created in - Salesforce with the **In Progress** status. +2. Click **Push** to create the Change Request if you aren't using the + [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) feature. Salesforce creates the change request with the **In Progress** status. 3. Expand the **Change Request** field on the right. The status is now **None/In Progress**. There is a link to open the Change Request in Salesforce. @@ -179,17 +178,17 @@ selected customizations, in this example, **Marketing and Log Changes Only**. ### Impact Analysis The impact analysis tool reviews your customizations for dependencies or risks. Click **Impact -Analysis** to run the tool. Here is an example report showing the Customizations that **Cannot be +Analysis** to run the tool. Here is an example report showing the Customizations that **Can't be Safely Deleted or Modified** tab: ![Impact analysis report](/images/platgovnetsuite/integrations/jira_example_impact_analysis.webp) -Before proceeding with your changes, review each warning to ensure your change does not break +Before proceeding with your changes, review each warning to ensure your change doesn't break something. Dependencies can be reviewed with the DRD tool. ### View DRD -The [Dependency Relationship Diagram](/docs/platgovsalesforce/tools/viewing_drd.md) (DRD) tool graphically displays your +The [DRD](/docs/platgovsalesforce/tools/viewing_drd.md) tool graphically displays your Customizations and all dependencies. 1. Click **View DRD**. @@ -200,10 +199,10 @@ Customizations and all dependencies. ## Ready for Development -Once you have resolved any risk or conflicts, your changes are ready for development: +After you have resolved any risk or conflicts, your changes are ready for development: 1. Change the Jira status of your ticket to match the status set up for **CR Pending Approval**. -2. Click **Push** if you are not using [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) to push +2. Click **Push** if you aren't using [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) to push status changes. 3. Expand the **Change Request** field on the right. The status is now **Pending Approval / In Progress**. There is a link to open the Change Request in Salesforce. @@ -224,9 +223,9 @@ ticket is ready to be updated. ![Change Request is approved](/images/platgovsalesforce/integrations/jiraRebrandApprovedLink.webp) 2. Change the Jira status of your ticket to match the status set up for **CR Approved**. -3. Click **Push** if you are not using [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) to push +3. Click **Push** if you aren't using [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) to push status changes. -4. Once your deployment and verification activities are complete, change the Jira status of your +4. After your deployment and verification activities are complete, change the Jira status of your ticket to match the status set up **CR Complete**. For example, **Done**. If you open the Change Request in Salesforce: diff --git a/docs/platgovsalesforce/integrations/jiraintegrationForge/finding_change_requests_from_jira.md b/docs/platgovsalesforce/integrations/jiraintegrationForge/finding_change_requests_from_jira.md index 0850cc748e..4683adbae0 100644 --- a/docs/platgovsalesforce/integrations/jiraintegrationForge/finding_change_requests_from_jira.md +++ b/docs/platgovsalesforce/integrations/jiraintegrationForge/finding_change_requests_from_jira.md @@ -18,5 +18,5 @@ Create a Report: Equals Select Jira 6. Add any additional columns you want to display. -7. Once the report is created, click **Save**. Best practice is to title the search something +7. After you create the report, click **Save**. Best practice is to title the search something meaningful, such as **Find Change Requests from Jira**. diff --git a/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_field_map_forge.md b/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_field_map_forge.md index c083c85243..85bb3bcaa9 100644 --- a/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_field_map_forge.md +++ b/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_field_map_forge.md @@ -40,7 +40,7 @@ Ensure the fields are created in Salesforce. 1. Open **Salesforce Setup** > **Object Manager** > **Change Request** 2. Open **Fields & Relationships** -If your fields are not in the list, use the **New** button to add them. +If your fields aren't in the list, use the **New** button to add them. For this example, the **Strongpoint Version** and **SF Version Number** fields have been added. @@ -58,14 +58,14 @@ Add the fields to the Page Layouts. 1. Open **Salesforce Setup** > **Object Manager** > **Change Request**. 2. Open **Page Layouts**. -3. Select your layout. If your fields are not in the layout, add them. For this example, the +3. Select your layout. If your fields aren't in the layout, add them. For this example, the **Strongpoint Version** and **SF Version Number** fields have been added to the **Customizations Layout**. ![Add to layouts](/images/platgovsalesforce/integrations/field_map_layouts.webp) 4. Open **Setup** > **Lightning App Builder**. -5. Open your Record Page. This example shows the **Customizations Record** page. Make sure your +5. Open your Record Page. This example shows the **Customizations Record** page. Ensure your fields are in the record page and set to visible. ![Check record page for fields and visibility](/images/platgovsalesforce/integrations/field_map_record.webp) @@ -80,7 +80,7 @@ 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 +Ensure 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. ::: @@ -104,7 +104,7 @@ The Jira API names are required to create the mapping record. ### Create Mapping Record 1. Open the App Launcher. -2. Navigate to **CR CustomFields Mapping**. It is added as a tab on the navigation bar. You can +2. Navigate to **CR CustomFields Mapping**. The app adds it as a tab on the navigation bar. You can click the down arrow on the tab and add it to your navigation bar. ![Launch CR CustomFields Mapping](/images/platgovsalesforce/integrations/field_map_launcher.webp) @@ -123,8 +123,7 @@ The Jira API names are required to create the mapping record. 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 -shows in the Netwrix Change Request. +The mapping is now complete. In the next update, the fields are populated and the information appears in the Netwrix Change Request. ![Field Map complete](/images/platgovsalesforce/integrations/field_map_complete.webp) diff --git a/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md b/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md index cc61d7772a..c8f1b9a855 100644 --- a/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md +++ b/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md @@ -7,20 +7,19 @@ sidebar_position: 3 # Set Up the Jira Integration Platform Governance for Salesforce's Change Enablement capabilities are integrated with Jira, one of -the most popular issue ticketing and development project management systems. Customers are able to -look for and include Salesforce Customizations, assess impacts for requested changes, and push Jira -change tickets into a Change Request. This enables easy management of changes, seamless tracking of +the most popular issue ticketing and development project management systems. Customers can look for and include Salesforce Customizations, assess impacts for requested changes, and push Jira +change tickets into a Change Request. This enables change management, tracking of compliant changes and automating the reconciliation of change logs during an audit (Now in Forge). User benefits include: - Avoid duplicate effort of creating tickets in two different systems. - Perform impact analysis assessment. -- Navigate to DRD views. +- Navigate to Dependency Relationship Diagram (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. +Change Requests aren't 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. @@ -38,7 +37,7 @@ You can map custom fields between Change Requests and Jira. Refer to ## Review Your Jira Statuses -To take advantage of the automatic synchronization feature, we recommend reviewing your Jira +To take advantage of the automatic synchronization feature, review your Jira 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. @@ -60,7 +59,7 @@ Cloud Integration Credentials after installing the app. :::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. +your Jira system administrator if you don't have administrative permissions. ::: 1. Open your **Jira Software Dashboard**. @@ -90,7 +89,7 @@ Configure the connected app: ![Open the Strongpoint Connected App](/images/platgovsalesforce/integrations/connected_app.webp) -3. Click the drop down arrow on the right side and select **Edit**. +3. Click the dropdown arrow on the right side and select **Edit**. 4. Set the **Callback URL** to see in the forge integration ![Link oauth callback forge](/images/platgovsalesforce/integrations/jiraForge/netwrix_sf_connected_app_login.webp) 5. These **Oauth Scopes** must be selected: @@ -109,7 +108,7 @@ Configure the connected app: 8. Copy the Consumer Key and the Consumer Secret codes to a clipboard. You are prompted for this information when you use the app. -If you do not use a connected app, you can set up Jira Cloud Integration Credentials as an +If you don't use a connected app, you can set up Jira Cloud Integration Credentials as an alternative. @@ -121,7 +120,7 @@ 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. -> _The Strongpoint Salesforce Integration is not supported for this project._ +> _The Strongpoint Salesforce Integration isn't supported for this project._ Follow the instructions for Restricting Access to a Project or Setting Groups/Profiles Visibility to grant the user appropriate access. @@ -141,13 +140,12 @@ If **Visibility Settings** is blank, all projects have access. #### Setting Groups/Profiles Visibility -Access to the Jira Platform Governance for Salesforce integration can also be performed with Profile -groups. +You can also restrict access to the Jira Platform Governance for Salesforce integration using Profile groups. Users opening a restricted project receive a information message, instructions for enabling access, and a link to this topic. -> _The Strongpoint Salesforce Integration is not supported for this project._ +> _The Strongpoint Salesforce Integration isn't supported for this project._ Follow the instructions for Restricting Access to a Project or Setting Groups/Profiles Visibility to grant the user appropriate access. @@ -175,7 +173,7 @@ Follow the instructions for Restricting Access to a Project or Setting Groups/Pr ![Set up the Jira status mappings for Change Request status](/images/platgovsalesforce/integrations/jira_status_settings.webp) 4. Enter the mappings between your Jira statuses and the Change Request statuses. You must define - your Jira statuses prior to this step. You can enter multiple Jira statuses for each Change + your Jira statuses before this step. You can enter multiple Jira statuses for each Change Request status, separated by commas. For example, **In Progress, Backlog**. Assign your mapping for each of the Change Request statuses: @@ -186,13 +184,13 @@ Follow the instructions for Restricting Access to a Project or Setting Groups/Pr - **Rejected Values** 5. Check **Is Automatic Sync** to enable Platform Governance for Salesforce to handle the - synchronization between Jira and Salesforce when a Ticket status is updated to a mapped status. - without having to click **Push**. If you are using an org where you do not want to create a + synchronization between Jira and Salesforce when a Ticket status is updated to a mapped status, + without requiring a manual **Push**. If you are using an org where you don't want to create a Change Request, leave this unchecked so you can do your research or testing without generating Change Requests. :::note - Change Requests are not automatically created, as not all tickets result in a Change Request. + Change Requests aren't 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 diff --git a/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_migrateToForge.md b/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_migrateToForge.md index 1fe3d0ddcb..e66fd6d7f1 100644 --- a/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_migrateToForge.md +++ b/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_migrateToForge.md @@ -17,7 +17,7 @@ The Salesforce Forge App is a **new and separate application**. Both application - If a user continues using the legacy integration, **no issues occur**, as the underlying Change Request logic remains the same. - Netwrix **strongly recommends using the Salesforce Forge App** for all new activity. -The migration primarily affects **authentication and configuration**, not the overall workflow. +The migration primarily affects **authentication and configuration**. The overall workflow remains the same. ## Key Differences @@ -82,7 +82,7 @@ No other changes are required for Connected App authentication. ### Status Mapping - **Status Mapping is still required**. -- Existing Status Mapping configurations continue to work and do not need to be recreated. +- Existing Status Mapping configurations continue to work and don't need to be recreated. - Ensure Status Mapping is correctly configured before switching users to the Forge App. ## Coexistence During Migration @@ -93,11 +93,11 @@ During migration: - Users may access either app without impacting Change Requests or Salesforce data. - Change Requests created from either app follow the same processing logic. -However, to ensure consistency and take advantage of the latest improvements, Netwrix recommends directing users to the **Salesforce Forge App** once migration steps are completed. +To ensure consistency and access the latest improvements, direct users to the **Salesforce Forge App** once migration steps are completed. ## Recommendation -Although continued use of the legacy integration does not cause functional issues, the **Salesforce Forge App** is the recommended solution moving forward due to: +The **Salesforce Forge App** is the recommended solution due to: - Simplified authentication - Reduced configuration requirements diff --git a/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_troubleshooting.md b/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_troubleshooting.md index a593afe6c0..ea45ac6a19 100644 --- a/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_troubleshooting.md +++ b/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_troubleshooting.md @@ -12,36 +12,35 @@ Jira Integration errors Error message: -_Please verify your Jira Credentials. Go to_ **Netwrix Dashboard** _>_ **Configurations and Stats** +_Verify your Jira Credentials. Go to_ **Netwrix Dashboard** _>_ **Configurations and Stats** _>_ **Jira Configuration** _>_ **Credentials** Solution: -Refer to [Credentials](/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md#credentials) for more +See [Credentials](/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md#credentials) for information on entering your credentials. ## Error with Mapping Jira Statuses Error message: -_Please verify your Jira Credentials. Go to_ **Netwrix Dashboard** _>_ **Configurations and Stats** +_Verify your Jira Credentials. Go to_ **Netwrix Dashboard** _>_ **Configurations and Stats** _>_ **Jira Configuration** _->_ **Status Mapping** Solution: -Refer to [Status Mapping](/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md#status-mapping) for more +See [Status Mapping](/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md#status-mapping) for information on mapping your statuses. ## Error with Salesforce Credentials Error message: -Verify Your User Credentials: It may be an Invalid username, wrong password, or invalid -security token. +Verify Your User Credentials: the username is invalid, the password is wrong, or the security token is invalid. If you are using Salesforce Authenticator, update it to the most recent Six-digit code. -Or verify that the user is not locked. +Or verify that the user isn't locked. Solution: @@ -53,8 +52,8 @@ Error message: error=invalid_client_id&error_description=client%20identifier%20invalid -Refer to [Access Data with API Integration](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) for -more information on setting up the connected app. +See [Access Data with API Integration](/docs/platgovsalesforce/integrations/jiraintegration/jira_integration.md) for +information on setting up the connected app. ## Error with Consumer Secret @@ -64,7 +63,7 @@ Verify the Consumers Secret from the Connected App. Solution: -Refer to [Credentials](/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md#credentials) for more +See [Credentials](/docs/platgovsalesforce/installingstrongpoint/config_and_stats.md#credentials) for information on entering your credentials ## URL Errors @@ -75,5 +74,5 @@ error=redirect_uri_mismatch Solution: -Refer to [Connected App](jira_walkthrough_example.md#connected-app) Connected App for more +See [Connected App](jira_walkthrough_example.md#connected-app) for information on setting up the connected app. diff --git a/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_walkthrough_example.md b/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_walkthrough_example.md index f5f0cdb3f3..aaa305fd96 100644 --- a/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_walkthrough_example.md +++ b/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_walkthrough_example.md @@ -6,9 +6,9 @@ sidebar_position: 2 # Jira Walkthrough Example -This walkthrough is one example based on our test account. You must -[install and configure](/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_walkthrough_example.md) the Platform Governance for Salesforce Salesforce Jira -integration, including setting up the **[Jira Statuses](/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md)** prior to using this +This walkthrough is one example based on a test account. You must +[install and configure](/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_walkthrough_example.md) the Platform Governance for Salesforce Jira +integration, including setting up the **[Jira Statuses](/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md)** before using this walkthrough. The walkthrough demonstrates these steps: @@ -38,7 +38,7 @@ The walkthrough demonstrates these steps: 5. Click **Create**. :::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. +Alerts and notifications may occur during this walkthrough, and aren't included in these steps. For example, override alert, notifications for approvers, and notification for the change request. ::: ## Connect to the App @@ -63,30 +63,29 @@ Use the **Connected App** tab if you set up the connected app using the procedur 2. Enter the **Consumer Key** and **Consumer Secret**. 3. Click **Is Sandbox account?** if you are logging in to a sandbox. 4. Click **Connect**. If this is the first time you are using the connected app, you are prompted to - select your username. The connected app is configured for you. Once finished, click **Close** on - the confirmation screen. The Strongpoint form is displayed. Your connection persists unless you + select your username. The connected app configures itself automatically. Once finished, click **Close** on + the confirmation screen. The Netwrix form appears. Your connection persists unless you click **Gear** on the integration page. -If the configuration fails, an error message is displayed. For example, +If the configuration fails, the app displays an error message. For example, > **error=redirect_uri_mismatch** > -> - The 10 minutes timing slot from Salesforce is not completed yet. Wait for completion. +> - The 10 minutes timing slot from Salesforce isn't completed yet. Wait for completion. > - If the error persists, check the [Callback URL](/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md). > -> - You may have left a space between the two Callback URLs -> - You may have an error in the newly added Callback URL it should be: -> **See in your Jira Account in the Connected Tab in Netwrix Salesforce Forge** +> - Check for a space between the two Callback URLs. +> - Check the newly added Callback URL. See your Jira account in the **Connected** tab in Netwrix Salesforce Forge. ### Login User -Enter your Salesforce **Username**, **Password** and **Security Token**. If you are using MFA or +Enter your Salesforce **Username**, **Password**, and **Security Token**. If you are using MFA or SSO: use your SSO Password. The Security token is the changing 6 digit code from your SSO or MFA app. ![Enter your Jira credentials](/images/platgovsalesforce/integrations/jiraForge/loginUserTab.webp) -If you do not have your security token, you can use these steps to reset your token: +If you don't have your security token, you can use these steps to reset your token: 1. Log in to your Salesforce account. 2. Open **View Profile** > **Settings**. @@ -94,19 +93,19 @@ If you do not have your security token, you can use these steps to reset your to 3. Select **Reset My Security Token** from the menu. 4. Click **Reset Security Token**. Check your email for your new token. 5. Click **Sandbox Account?** if you are using your sandbox. -6. Click **Connect**. If the connection is successful, the form is displayed (see Add Customizations +6. Click **Connect**. If the connection is successful, the form appears (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**. +You can't login if you don't 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. +If you don't enter the correct credentials, an error appears. After six unsuccessful +consecutive attempts to log in, your account is suspended for 30 minutes. ## Add Customizations -Once you have logged in, the form is displayed. +After you have logged in, the form appears. ![Connection details for the ticket](/images/platgovsalesforce/integrations/jiraForge/mainViewForge.webp) @@ -117,13 +116,13 @@ Once you have logged in, the form is displayed. - **Change Level Req** is blank until Customizations have been added. If there are multiple change levels, the most stringent one is applied. - **Select Customizations** is where you specify the Customizations you are changing or adding. If - the Customization exists in your account, it is added to the **Select Customizations** list. **Add - Proposed Customizations** are added to the **Proposed Customizations** list. You can delete added - Customizations with the + the Customization exists in your account, the integration adds it to the **Select Customizations** list. **Add + Proposed Customizations** adds entries to the **Proposed Customizations** list. You can delete added + Customizations with the ![delete](/images/platgovsalesforce/integrations/jiraForge/trashIcon.webp) icon. -- **View DRD** and **Impact Analysis** are tools to Perform Risk Assessment. +- **View DRD** and **Impact Analysis** are tools to perform risk assessment. **View DRD** opens the Dependency Relationship Diagram (DRD). - **Push** creates the Change Request in Salesforce. **Push** is also used to manually update your - Change Request if you are not using the [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md) feature. + Change Request if you aren't using the [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md) feature. ### Add Existing Customizations by Name or API Name @@ -136,7 +135,7 @@ Once you have logged in, the form is displayed. 3. Select one or more Customizations. This example uses **FLODocs__spDocumentation (LightningComponentBundle)**, a customization in the _FdtPartial Demo Org_. -4. Click **Add Selected Customizations**. The selected Customization is added to the **Existing +4. Click **Add Selected Customizations**. The integration adds the selected Customization to the **Existing Customizations** list. ![Add an existing customization](/images/platgovsalesforce/integrations/jiraForge/jira_example_add_existingForge.webp) @@ -144,27 +143,26 @@ Once you have logged in, the form is displayed. ### Add Proposed Customizations -In this procedure, we are adding a new Customization. +This procedure adds a new Customization. 1. Enter a new, valid API Name in the **Add Customization** for **Proposed Customizations** field. For this example, enter **CustomerPriorities**. -2. Click (**+**) to add it. If the API Name is valid, and does not match an existing API Name, the - new Customization is added to the **Proposed Customizations** list. +2. Click (**+**) to add it. If the API Name is valid and doesn't match an existing API Name, the + integration adds the new Customization to the **Proposed Customizations** list. ![Add a proposed customization](/images/platgovsalesforce/integrations/jiraForge/jira_example_proposedCustoForge.webp) ### Create the Change Request -Using the Platform Governance for Salesforce Jira integration, your Change Requests are created -automatically when you add a Customization. To setup or update the status mapping, refer to setting +The Platform Governance for Salesforce Jira integration automatically creates your Change Requests +when you add a Customization. To set up or update the status mapping, refer to setting up the **[Jira Statuses](/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md)** procedure. 1. Change the Jira status of your ticket to match the status set up for **CR In Progress**. For example, **In Progress**. Refer to setting up the **[Jira Statuses](/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md)** procedure. -2. Click **Push** to create the Change Request if you are not using the - [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md) feature. The change request is created in - Salesforce with the **In Progress** status. +2. Click **Push** to create the Change Request if you aren't using the + [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md) feature. Salesforce creates the change request with the **In Progress** status. 3. Expand the **Change Request** field on the right. The status is now **In Progress**. There is a link to open the Change Request in Salesforce. @@ -180,17 +178,17 @@ selected customizations, in this example, **Change Request**. ### Impact Analysis The impact analysis tool reviews your customizations for dependencies or risks. Click **Impact -Analysis** to run the tool. Here is an example report showing the Customizations that **Cannot be +Analysis** to run the tool. Here is an example report showing the Customizations that **Can't be Safely Deleted or Modified** tab: ![Impact analysis report](/images/platgovnetsuite/integrations/jira_example_impact_analysis.webp) -Before proceeding with your changes, review each warning to ensure your change does not break +Before proceeding with your changes, review each warning to ensure your change doesn't break something. Dependencies can be reviewed with the DRD tool. ### View DRD -The [Dependency Relationship Diagram](/docs/platgovsalesforce/tools/viewing_drd.md) (DRD) tool graphically displays your +The [DRD](/docs/platgovsalesforce/tools/viewing_drd.md) tool graphically displays your Customizations and all dependencies. 1. Click **View DRD**. @@ -201,10 +199,10 @@ Customizations and all dependencies. ## Ready for Development -Once you have resolved any risk or conflicts, your changes are ready for development: +After you have resolved any risk or conflicts, your changes are ready for development: 1. Change the Jira status of your ticket to match the status set up for **CR Pending Approval**. -2. Click **Push** if you are not using [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md) to push +2. Click **Push** if you aren't using [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md) to push status changes. 3. Expand the **Change Request** field on the right. The status is now **In Progress**. There is a link to open the Change Request in Salesforce. @@ -219,9 +217,9 @@ ticket is ready to be updated. 1. Change the Jira status of your ticket to match the status set up for **CR Approved**. -3. Click **Push** if you are not using [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md) to push +3. Click **Push** if you aren't using [Automatic Synchronization](/docs/platgovsalesforce/integrations/jiraintegrationForge/jira_integration_forge.md) to push status changes. -4. Once your deployment and verification activities are complete, change the Jira status of your +4. After your deployment and verification activities are complete, change the Jira status of your ticket to match the status set up **CR Complete**. For example, **Done**. If you open the Change Request in Salesforce: diff --git a/docs/platgovsalesforce/integrations/zendeskintegration/finding_change_requests_from_zendesk.md b/docs/platgovsalesforce/integrations/zendeskintegration/finding_change_requests_from_zendesk.md index 199b070cbe..c0f614bab6 100644 --- a/docs/platgovsalesforce/integrations/zendeskintegration/finding_change_requests_from_zendesk.md +++ b/docs/platgovsalesforce/integrations/zendeskintegration/finding_change_requests_from_zendesk.md @@ -10,7 +10,7 @@ title: Finding Change Requests from Zendesk 4. Click **Continue**. 5. Add a filter: **Change Type Equals Zendesk**. 6. Add any additional columns you want to display. -7. Once the report is created, click **Save**. +7. After you create the report, click **Save**. :::tip Best Practice Title the report something meaningful, such as 'Find Change Requests from Zendesk'. diff --git a/docs/platgovsalesforce/integrations/zendeskintegration/zendesk_approval_process.md b/docs/platgovsalesforce/integrations/zendeskintegration/zendesk_approval_process.md index 6cb87a85e4..a8da4f574a 100644 --- a/docs/platgovsalesforce/integrations/zendeskintegration/zendesk_approval_process.md +++ b/docs/platgovsalesforce/integrations/zendeskintegration/zendesk_approval_process.md @@ -12,7 +12,7 @@ Platform Governance for Salesforce – Zendesk Integration supports three types - Operators can Request Approval when the CR is in Draft. - Admins can Approve or Reject when the CR is Pending Approval. -- Admins can Complete the CR once it is Approved. +- Admins can Complete the CR after it is Approved. ### Screenshots @@ -28,7 +28,7 @@ Platform Governance for Salesforce – Zendesk Integration supports three types ![Approval Process - Complete](/images/platgovsalesforce/integrations/zendesk/Approval_process_-_Complete.webp) -After completing the Change Request you will see the record in a complete status: +After completing the Change Request, the record appears in a complete status: ![Approval Process - After Complete](/images/platgovsalesforce/integrations/zendesk/Approval_process_-_After_Complete.webp) @@ -65,7 +65,7 @@ After completing the Change Request you will see the record in a complete status ![Approval Process - Complete](/images/platgovsalesforce/integrations/zendesk/Approval_process_-_Complete.webp) -After completing the Change Request you will see the record in a complete status: +After completing the Change Request, the record appears in a complete status: ![Approval Process - After Complete](/images/platgovsalesforce/integrations/zendesk/Approval_process_-_After_Complete.webp) diff --git a/docs/platgovsalesforce/integrations/zendeskintegration/zendesk_integration.md b/docs/platgovsalesforce/integrations/zendeskintegration/zendesk_integration.md index bf42e4ae3f..05aecfcde2 100644 --- a/docs/platgovsalesforce/integrations/zendeskintegration/zendesk_integration.md +++ b/docs/platgovsalesforce/integrations/zendeskintegration/zendesk_integration.md @@ -4,7 +4,7 @@ title: Platform Governance for Salesforce - Zendesk Integration # Overview -Platform Governance for Salesforce's Change Management capabilities are integrated with Zendesk, one of the most popular customer service and issue ticketing systems. Customers are able to look for and include Salesforce Customizations, assess impacts for requested changes, and push Zendesk change tickets into a Change Request. This enables easy management of changes, seamless tracking of compliant changes and automating the reconciliation of change logs during an audit. +Platform Governance for Salesforce's Change Management capabilities are integrated with Zendesk, one of the most popular customer service and issue ticketing systems. Customers can look for and include Salesforce Customizations, assess impacts for requested changes, and push Zendesk change tickets into a Change Request. This enables change management, tracking of compliant changes and automating the reconciliation of change logs during an audit. User benefits include: @@ -36,7 +36,7 @@ Here are the steps to install the Zendesk app. You must have **Admin** privilege 3. Navigate to **Apps and integrations** > **Zendesk Support apps** > **Marketplace**. ![Zendesk App Menu](/images/platgovsalesforce/integrations/zendesk/Zendesk_Apps_Menu.webp) 4. Search for **Platform Governance for Salesforce**. -5. Click **Platform Governance for Salesforce** when it is displayed. +5. Click **Platform Governance for Salesforce** when it appears. 6. Click **Install**. When installation is complete, you are prompted to sign in to your Zendesk dashboard to continue. 7. Click the **Admin** icon in the left panel. 8. Navigate to **Apps and integrations** > **Zendesk Support apps**. @@ -54,7 +54,7 @@ Here are the steps to install the Zendesk app. You must have **Admin** privilege :::note OAuth authentication is required by Salesforce. You need to create a Connected App in Salesforce first: 1. Go to https://test.salesforce.com/ for sandbox or https://login.salesforce.com/ for production. - 2. Navigate to Setup > Apps > App Manager > New Connected App. + 2. Go to **Setup** > **Apps** > **App Manager** > **New Connected App**. ![New Connected App](/images/platgovsalesforce/integrations/zendesk/New_Connected_App.webp) 3. Fill in the required fields and enable API (Enable OAuth Settings). 4. Set the Callback URL: https://server-sf.herokuapp.com/auth/handle_decision. @@ -90,9 +90,9 @@ After installation, you need to authorize the connection to Salesforce: ![Admin Panel OAuth](/images/platgovsalesforce/integrations/zendesk/Admin_Panel_Oauth.webp) -3. A popup window will open redirecting to Salesforce's OAuth 2.0 authorization screen. +3. A popup window opens, redirecting to the Salesforce OAuth 2.0 authorization screen. 4. Log in with your Salesforce credentials. -5. You will be asked to authorize Platform Governance for Salesforce to access data in your org. +5. Authorize Platform Governance for Salesforce to access data in your org. 6. Once authorized, the app securely stores the access and refresh tokens and links the Salesforce org with Zendesk. ![Auth Succesfull](/images/platgovsalesforce/integrations/zendesk/Auth_Succesfull.webp) @@ -109,8 +109,8 @@ Click the new Platform Governance for Salesforce icon in the left panel. The Gro Enter the group and approval information: -- **Allow these Zendesk groups to request approval**: one or more groups who can request approval for a change request. Select a group from the drop down list. Click +. Repeat as needed. -- **Allow these Zendesk groups to approve**: one or more groups who can approve a change request. Select a group from the drop down list. Click +. Repeat as needed. +- **Allow these Zendesk groups to request approval**: one or more groups who can request approval for a change request. Select a group from the dropdown list. Click +. Repeat as needed. +- **Allow these Zendesk groups to approve**: one or more groups who can approve a change request. Select a group from the dropdown list. Click +. Repeat as needed. - **Approval process**: select the approval process to use: - **Approval in Zendesk**: Approvals managed directly in Zendesk. - **Approval in Salesforce**: Approval continues in Salesforce. @@ -120,10 +120,10 @@ Enter the group and approval information: # Using the App in Tickets -In the ticket sidebar, the Platform Governance app displays CR information, action buttons, and accordions for existing/proposed customizations and data records. External links to Impact Analysis and Document Requirements (DRD) in Salesforce are also available. +In the ticket sidebar, the Platform Governance app displays Change Request (CR) information, action buttons, and accordions for existing/proposed customizations and data records. External links to Impact Analysis and Dependency Relationship Diagram (DRD) views in Salesforce are also available. :::note -The integration will only appear in the ticket sidebar once the Zendesk ticket has been created. +The integration only appears in the ticket sidebar after the Zendesk ticket has been created. ::: ![Integration After Create Zendesk Ticket](/images/platgovsalesforce/integrations/zendesk/1_See_integration_after_create_a_zendesk_ticket.webp) diff --git a/docs/platgovsalesforce/integrations/zendeskintegration/zendesk_walkthrough_example.md b/docs/platgovsalesforce/integrations/zendeskintegration/zendesk_walkthrough_example.md index 1e89b5075c..9805531700 100644 --- a/docs/platgovsalesforce/integrations/zendeskintegration/zendesk_walkthrough_example.md +++ b/docs/platgovsalesforce/integrations/zendeskintegration/zendesk_walkthrough_example.md @@ -24,7 +24,7 @@ Select **customization** from the result form # Step 3 – Add Proposed Customizations -Click **Add Proposed Customization** to add new or modified customizations that will be created or changed as part of this Change Request. +Click **Add Proposed Customization** to add new or modified customizations created or changed as part of this Change Request. ![Add Proposed Customization](/images/platgovsalesforce/integrations/zendesk/Add_Proposed_Customization.webp) @@ -40,13 +40,13 @@ Select the appropriate data records from the search results: # Step 5 – Add Proposed Data Records -Click **Add Proposed Data Record** to include new data records that will be created or modified as part of this Change Request. +Click **Add Proposed Data Record** to include new data records created or modified as part of this Change Request. ![Add Proposed Data Record](/images/platgovsalesforce/integrations/zendesk/Add_Proposed_Data_Record.webp) # Step 6 – Request Approval -Once all required information is added, the operator can click **Request Approval** to move the CR into Pending Approval status. +After you add all required information, the operator can click **Request Approval** to move the Change Request (CR) into Pending Approval status. ![Approve Process - Request Approval](/images/platgovsalesforce/integrations/zendesk/Approve_Process_-_Request_Approval.webp) @@ -72,6 +72,6 @@ From the ticket sidebar, click the DRD link to open the Document Requirements vi # Step 10 – Open Impact Analysis -Click the Impact Analysis link to view the detailed analysis of the Change Request in Salesforce. This shows how the proposed changes might affect other components in your Salesforce org. +Click the Impact Analysis link to view the detailed analysis of the Change Request in Salesforce. This shows how the proposed changes affect other components in your Salesforce org. ![Impact Analysis](/images/platgovsalesforce/integrations/zendesk/Impact_Analysis.webp) diff --git a/docs/platgovsalesforce/navigate_strongpoint.md b/docs/platgovsalesforce/navigate_strongpoint.md index 84b5725859..20717079f0 100644 --- a/docs/platgovsalesforce/navigate_strongpoint.md +++ b/docs/platgovsalesforce/navigate_strongpoint.md @@ -13,7 +13,7 @@ To access Platform Governance for Salesforce in Salesforce Lightning Experience: ![Salesforce App launcher](/images/platgovsalesforce/app_launcher.webp) 2. Search for and select **Netwrix Lightning**. - If you do not see the app, select **View All** to display all available apps. + If you don't see the app, select **View All** to display all available apps. ![Select Netwrix Lightning](/images/platgovsalesforce/app_netwrix_lightning.webp) @@ -52,7 +52,7 @@ Use the dropdown menus at the top of the dashboard to access the main features: - **Settings** – Access Getting Started, system status, installation tools, credentials, and the Knowledge Center. - **Scanner** – Access the Scheduler, manual scanners, the field-level scanner, and the DLU Configuration scanner. - **Tools** – Access tools such as the dependency relationship diagram, environment comparison, profile comparison, and the access review assistant. -- **Reports** – Access reports related to customizations, change enablement, cleanup, release and deployment, audit, and financial controls. +- **Reports** – Access reports related to customizations, change enablement, cleanup, release, deployment, audit, and financial controls. --- @@ -65,13 +65,14 @@ The **Scanner Status** panel provides an overview of scanning activity in your S To run the system scanner immediately, select **Rescan Now**. -**Important:** -The **Rescan Now** option runs the main system scanner only. It does not include the following scanners: +:::warning +The **Rescan Now** option runs the main system scanner only. It doesn't include the following scanners: -- **Permissions Assignment** -- **System Permissions Scanner** -- **Fast Scan Profile / PermissionSets** +- **Permissions Assignment** +- **System Permissions Scanner** +- **Fast Scan Profile / PermissionSets** - **Non-Triggerable Data Scanner** +::: To run any of these scanners, select **Start** next to the corresponding scanner in the list. @@ -81,7 +82,7 @@ You can also access and manage these scanners from **Scanner > Scheduler**. ## DRD Generator -The **DRD Generator** displays a graphical view of a selected item and its relationships. +The **Dependency Relationship Diagram (DRD) Generator** displays a graphical view of a selected item and its relationships. To generate a diagram: @@ -115,7 +116,7 @@ To open the Netwrix support site, select **Contact Support**. ## Download Files -The **Download Files** section displays files generated by Platform Governance for Salesforce and their current status. +The **Download Files** section displays files that Platform Governance for Salesforce generates and their current status. To download a file: diff --git a/docs/platgovsalesforce/release_7_0/index.md b/docs/platgovsalesforce/release_7_0/index.md index 00d6de1cc0..e64f1928a5 100644 --- a/docs/platgovsalesforce/release_7_0/index.md +++ b/docs/platgovsalesforce/release_7_0/index.md @@ -7,86 +7,88 @@ sidebar_label: "⭐ Release 7.0 (Latest)" # Release 7.0 -Platform Governance for Salesforce Release 7.0 introduces powerful new capabilities for enhanced governance, monitoring, and change tracking across your Salesforce environment. +Platform Governance for Salesforce Release 7.0 introduces new capabilities for enhanced governance, monitoring, and change tracking across your Salesforce environment. ## New Features ### Document Report and Dashboard Folders -Track and monitor access to Report and Dashboard folders with comprehensive change logging. This feature provides visibility into folder-level permissions and user access patterns, helping you maintain security and compliance for your reporting infrastructure. +Track and monitor access to Report and Dashboard folders with comprehensive change logging. This feature provides visibility into folder-level permissions and user access patterns to help you maintain security and compliance for your reporting infrastructure. -[Learn more →](/docs/platgovsalesforce/customizations/folder_customization_record) +[Document Report and Dashboard Folders](/docs/platgovsalesforce/customizations/folder_customization_record) ### DLU Scanner Improvements -Enhanced Date Last Used (DLU) Scanner with improved configuration options and performance optimizations. The new DLU Configuration tool provides granular control over which metadata types and fields are processed, allowing you to focus on what matters most to your organization. +The Date Last Used (DLU) Scanner includes improved configuration options and performance optimizations. The new DLU Configuration tool provides granular control over which metadata types and fields are processed, so you can focus on what matters most to your organization. -[Learn more →](/docs/platgovsalesforce/tools/dlu_configuration) +[DLU Configuration](/docs/platgovsalesforce/tools/dlu_configuration) ### Auto Scanner Inactivity Alert -Proactive monitoring system that automatically sends email notifications to designated administrators when the Auto Scanner fails to run according to its configured schedule. This ensures your Salesforce environment remains continuously protected and documented. +A proactive monitoring system automatically sends email notifications to designated administrators when the Auto Scanner fails to run according to its configured schedule. This keeps your Salesforce environment continuously protected and documented. -[Learn more →](/docs/platgovsalesforce/installingstrongpoint/config_and_stats#scanner-inactivity-alert) +[Auto Scanner Inactivity Alert](/docs/platgovsalesforce/installingstrongpoint/config_and_stats#scanner-inactivity-alert) ### Track Specific Permission Assignments -Monitor and detect changes in System Permissions across Permission Sets and Profiles. Each scan compares selected permissions against previous snapshots and generates Change Logs for any detected differences, providing complete visibility into permission changes at the user level. +Monitor and detect changes in System Permissions across Permission Sets and Profiles. Each scan compares selected permissions against previous snapshots and generates Change Logs for any detected differences, giving you complete visibility into permission changes at the user level. -[Learn more →](/docs/platgovsalesforce/tools/system_permission_tracking) +[System Permission Tracking](/docs/platgovsalesforce/tools/system_permission_tracking) ### Track Access to Specific Fields -New Field Tracking capability allows you to monitor changes to specific fields across your Salesforce org. Create custom monitoring rules based on objects, compliance categories, or data types, and receive notifications when tracked fields are modified. +The new Field Tracking capability lets you monitor changes to specific fields across your Salesforce org. Create custom monitoring rules based on objects, compliance categories, or data types, and receive notifications when tracked fields are modified. -[Learn more →](/docs/platgovsalesforce/tools/field_tracking) +[Field Tracking](/docs/platgovsalesforce/tools/field_tracking) ### Change Request Re-architecture -Redesigned Change Request system with improved performance, enhanced user interface, and better integration with deployment workflows. The new architecture provides faster processing and more intuitive change management capabilities. +The redesigned Change Request system delivers improved performance, an enhanced user interface, and better integration with deployment workflows. The new architecture provides faster processing and more intuitive change management capabilities. -[Learn more →](/docs/platgovsalesforce/changemanagement/creating_change_request) +[Creating a Change Request](/docs/platgovsalesforce/changemanagement/creating_change_request) ### Customizations for Public Groups -Enhanced support for Public Groups with improved documentation and change tracking. Monitor group membership changes, access permissions, and usage patterns to maintain security and compliance. +Release 7.0 includes enhanced support for Public Groups with improved documentation and change tracking. Monitor group membership changes, access permissions, and usage patterns to maintain security and compliance. -[Learn more →](/docs/platgovsalesforce/customizations/understanding_customization_record) +[Understanding Customization Records](/docs/platgovsalesforce/customizations/understanding_customization_record) ### Expanded Change Log List Views -Change Log List Views have been expanded to support all new tracking capabilities, including System Permissions, Field Tracking, and Report/Dashboard Folder access. This provides a unified view of all changes across your Salesforce environment. +Change Log List Views now support all new tracking capabilities, including System Permissions, Field Tracking, and Report/Dashboard Folder access. This provides a unified view of all changes across your Salesforce environment. -### Note - Required Manual Configuration for Package Upgrades +### Required manual configuration for package upgrades +:::note This package version introduces a new version of the Change / Approval Policy layout: **Strongpoint Change/Approval Policy Layout v11**. This new layout includes updates to the fields displayed for **Policy** records. - -For package upgrades, the new layout must be **manually assigned** after pushing the updates in order to take effect. + +For package upgrades, you must **manually assign** the new layout after pushing the updates for the changes to take effect. +::: **Steps to Assign the New Layout:** - 1. Go to **Setup** + 1. In Salesforce, open **Setup** 2. Open **Object Manager** 3. Select **Change/Approval Policy** 4. Go to **Page Layouts** 5. Click **Page Layout Assignment** 6. Click **Edit Assignment** - 7. Select the profile(s) that have access to the Policy record. In most cases, this will be the System Administrator profile. However, some customers may use a custom profile instead of the standard one. + 7. Select the profiles that have access to the Policy record. In most cases, this is the System Administrator profile. However, some customers use a custom profile instead of the standard one. 8. Change the current layout to **Strongpoint Change/Approval Policy Layout v11** 9. Click **Save** -For new installations, the latest layout will be assigned automatically by default. +For new installations, the system assigns the latest layout automatically by default. --- ## Getting Started -To take advantage of these new features: +To use these new features: -1. Ensure your Platform Governance for Salesforce package is updated to Release 7.0 -2. Review the documentation for each feature to understand configuration requirements -3. Configure the new scanners and monitoring tools based on your organization's needs +1. Update your Platform Governance for Salesforce package to Release 7.0. +2. Review the documentation for each feature to understand configuration requirements. +3. Configure the new scanners and monitoring tools based on your organization's needs. -For questions or assistance with Release 7.0 features, contact our Customer Success team. \ No newline at end of file +For questions or assistance with Release 7.0 features, contact the Customer Success team. \ No newline at end of file diff --git a/docs/platgovsalesforce/releasemanagement/deployment_logs.md b/docs/platgovsalesforce/releasemanagement/deployment_logs.md index c9d0f89425..76f0514c5d 100644 --- a/docs/platgovsalesforce/releasemanagement/deployment_logs.md +++ b/docs/platgovsalesforce/releasemanagement/deployment_logs.md @@ -6,7 +6,7 @@ sidebar_position: 30 # Deployment Logs -The deployment log is attached to the Deployment Record on the **Related Lists** tab. You can also +The Deployment Record on the **Related Lists** tab contains the deployment log. You can also access the logs from **Strongpoint** > **Reports** > **Release and Deployment**. Deployment logs have these sections: @@ -53,7 +53,7 @@ Deployment logs have these sections: ## Customizations -Links to the customizations attached to the deployment record. The link open the customization +Links to the customizations attached to the deployment record. The link opens the customization record. ## Deployed Components and Apex Test Information @@ -75,13 +75,12 @@ record. ## Notes and Attachments -Attachments are generated during the deployment for validation and auditing. Use **New Note** to -create a deployment note, or **Attach File** to add a file to the deployment log. Notes and -attachments can be edited, viewed or deleted. +The deployment generates attachments for validation and auditing. Use **New Note** to +create a deployment note, or **Attach File** to add a file to the deployment log. You can edit, view, or delete notes and +attachments. ## Deployment Components -Deployment Components are generated during the deployment. Use **New Deployment Component** to add a +The deployment generates Deployment Components. Use **New Deployment Component** to add a deployment component to the deployment log. Deployment Components Name and Customization are links -to the individual component or customization records. Deployment Components can be edited or -deleted. +to the individual component or customization records. You can edit or delete Deployment Components. diff --git a/docs/platgovsalesforce/releasemanagement/deployments.md b/docs/platgovsalesforce/releasemanagement/deployments.md index 5f28d92265..250047a8a3 100644 --- a/docs/platgovsalesforce/releasemanagement/deployments.md +++ b/docs/platgovsalesforce/releasemanagement/deployments.md @@ -6,10 +6,10 @@ sidebar_position: 10 # Deployments -Your deployments can be documented across your test environment(s) to your production -environment(s). Each step in the deployment process complies with your policies and a comprehensive -approval process. Deployments are blocked if approvals are not complete. A full audit trail of the -entire deployment process is maintained.The process is: +Platform Governance for Salesforce documents your deployments across test environments to production +environments. Each step in the deployment process complies with your policies and a comprehensive +approval process. Deployments are blocked if approvals aren't complete. Platform Governance for Salesforce maintains a full audit trail of the +entire deployment process. The process is: - Create a Change Request - Create a Deployment Record @@ -20,7 +20,7 @@ entire deployment process is maintained.The process is: 1. Open **Change Requests** > **New** 2. Enter a meaningful **Change Request Name**, select the **Change Request Type** (Between Record Type and customization) and **Change Overview** -3. Modify the **Change Type** as needed. Add any other supporting information, such as Parent Change Request, customizations or data records. +3. Modify the **Change Type** as needed. Add any other supporting information, such as Parent Change Request, customizations, or data records. 4. **Save** the change request. 5. Click **Submit for Approval** @@ -39,7 +39,7 @@ These steps can be completed after the change request is approved. ![Deployment Tool](/images/platgovsalesforce/release_management/deployment_tool.webp) 5. Click **Test Connection** for both environments to ensure your credentials are correct. If your - credentials are not correct, you can click **Save Credentials** and edit. + credentials aren't correct, you can click **Save Credentials** and edit. 6. Click **Run Scan** on both environments to ensure the customizations on the change request are up to date. 7. **Save** the Deployment Record. @@ -62,13 +62,13 @@ These steps can be completed after the deployment record is approved. This creates a package to: - - **Validate Customizations**: Use to check the deployment is going to work. It simulates your + - **Validate Customizations**: Use to check the deployment before it runs. It simulates your deployment. - **Deploy Retrieved Customizations**: Use to deploy your customizations when you are ready to proceed. 4. Check your dependencies and validate your customizations. -5. Click **Deploy Retrieved Customizations** to start the deployment. This may take some time, since +5. Click **Deploy Retrieved Customizations** to start the deployment. This can take some time because it runs the test cases into the target environment. ![Run the Deployment](/images/platgovsalesforce/release_management/deployment_tool-4.webp) @@ -79,6 +79,6 @@ When the deployment process is finished: 1. Check the [Deployment Logs](/docs/platgovsalesforce/releasemanagement/deployment_logs.md). 2. Fix any errors and repeat the deployment if needed. -3. Once the deployment is successful, open the change request and set the status to **Completed**. +3. After the deployment is successful, open the change request and set the status to **Completed**. ![Complete the Process](/images/platgovsalesforce/release_management/deployment_tool-5.webp) diff --git a/docs/platgovsalesforce/releasemanagement/multiple_env_deployment_tracking.md b/docs/platgovsalesforce/releasemanagement/multiple_env_deployment_tracking.md index ce2e53eade..347b8bec86 100644 --- a/docs/platgovsalesforce/releasemanagement/multiple_env_deployment_tracking.md +++ b/docs/platgovsalesforce/releasemanagement/multiple_env_deployment_tracking.md @@ -6,8 +6,8 @@ sidebar_position: 50 # Multiple Environment Deployment Tracking -A best practice is to create change requests in your production account so that they are not lost, -they have an audit trail and approvals can be shown. +Create change requests in your production account so that they aren't lost, +they have an audit trail, and approvals are recorded. Here is the overall process flow for multiple deployment tracking: @@ -27,16 +27,16 @@ Here is the overall process flow for multiple deployment tracking: - **Change Request Name**: Enter a meaningful name. - Select the **Change Type**. - **Change Overview**: Enter a meaningful description. - - Add **Customizations**. If you add **Proposed Customizations** they do not show up on the - change log as they do not exist in both environments. - - Add **Additional Approver(s)**. + - Add **Customizations**. If you add **Proposed Customizations**, they don't appear on the + change log because they don't exist in both environments. + - Add one or more **Additional Approvers**. 3. **Save** the change request. 4. Click **Submit for Approval** ## Push the Change Request -Once the change request is approved: +After the change request is approved: 1. Click **Sync CR**. @@ -48,7 +48,7 @@ Once the change request is approved: ![Enter your credentials](/images/platgovsalesforce/release_management/push_pull_popup.webp) -4. Click **Test Connection** to make sure your credentials are correct. If your credentials are +4. Click **Test Connection** to ensure your credentials are correct. If your credentials are not correct, click **Save Credentials** and edit. 5. Make the necessary changes on your change request in your development/testing environment and **Save**. @@ -58,7 +58,7 @@ Once the change request is approved: 1. On the updated change request, click **Sync CR**. 2. Choose a **Production** environment. 3. Add your **Credentials**. -4. Click **Test Connection** to make sure your credentials are correct. If your credentials are not +4. Click **Test Connection** to ensure your credentials are correct. If your credentials aren't correct, click **Save Credentials** and edit. 5. Click **Push**. 6. Click **Push CR**. @@ -70,8 +70,8 @@ After the push, the Change Request in Production has a related deployment record ## Create the Deployment Record 1. Open the **Related Lists** tab on your change request. -2. Click **Run Compare Tool**. Refer to - [Compare Environments](/docs/platgovsalesforce/tools/environment_comparison.md) for more information. +2. Click **Run Compare Tool**. See + [Compare Environments](/docs/platgovsalesforce/tools/environment_comparison.md) for instructions. ![Run the Compare Environment tool](/images/platgovsalesforce/release_management/apex_enviro_comparison.webp) @@ -97,13 +97,13 @@ These steps can be completed after the deployment record is approved. This creates a package to: - **Check Dependencies**: Use to check what has been referenced. - - **Validate Customizations**: Use to check the deployment is going to work. It simulates your + - **Validate Customizations**: Use to check the deployment before it runs. It simulates your deployment. - **Deploy Retrieved Customizations**: Use to deploy your customizations when you are ready to proceed. 4. Check your dependencies and validate your customizations. -5. Click **Deploy Retrieved Customizations** to start the deployment. This may take some time, since +5. Click **Deploy Retrieved Customizations** to start the deployment. This can take some time because it runs the test cases into the target environment. ![Run the Deployment](/images/platgovsalesforce/release_management/deployment_tool-4.webp) @@ -116,6 +116,6 @@ When the deployment process is finished: 1. Check the [Deployment Logs](/docs/platgovsalesforce/releasemanagement/deployment_logs.md). 2. Fix any errors and repeat the deployment if needed. -3. Once the deployment is successful, open the change request and set the status to **Completed**. +3. After the deployment is successful, open the change request and set the status to **Completed**. ![Complete the Process](/images/platgovsalesforce/release_management/deployment_tool-5.webp) diff --git a/docs/platgovsalesforce/releasemanagement/multiple_environments.md b/docs/platgovsalesforce/releasemanagement/multiple_environments.md index d04238ba1e..04c28c25df 100644 --- a/docs/platgovsalesforce/releasemanagement/multiple_environments.md +++ b/docs/platgovsalesforce/releasemanagement/multiple_environments.md @@ -7,14 +7,14 @@ sidebar_position: 40 # Multiple Environment Deployments Multiple Environment Deployment Tracking helps you manage changes between your Production and -Development/Testing . +Development/Testing environments. -With multiple environment deployment tracking, you can push, pull and access your change requests in -all your environments that have Platform Governance for Salesforce installed. This alleviates the +With multiple environment deployment tracking, you can push, pull, and access your change requests in +all your environments that have Platform Governance for Salesforce installed. This reduces the risk of breaking your production account. By documenting and validating the change process through -change requests, deployment records and environment comparison, multiple environment deployment -tracking enables you to access change requests in any environment where Platform Governance for -Salesforce is installed, and to deploy changes and promote code from one environment to another. +change requests, deployment records, and environment comparison, multiple environment deployment +tracking lets you access change requests in any environment where Platform Governance for +Salesforce is installed, and deploy changes and promote code from one environment to another. ## Push/Pull Change Requests @@ -32,8 +32,8 @@ Salesforce is installed, and to deploy changes and promote code from one environ ![Enter Credentials](/images/platgovsalesforce/release_management/push_pull_popup.webp) -6. Click **Test Connection** to make sure your credentials are correct. If your credentials are - not correct, you can click **Save Credentials** and edit. +6. Click **Test Connection** to ensure your credentials are correct. If your credentials are + not correct, click **Save Credentials** and edit. ### Push the Change Request @@ -61,5 +61,5 @@ To pull a change request from the selected environment: 4. Click **Pull Change Request.** -The parent change request is the one you pull from and when the change request is pulled, it becomes +The parent change request is the one you pull from. When the change request is pulled, it becomes a child of the original change request. diff --git a/docs/platgovsalesforce/releasemanagement/release_management_overview.md b/docs/platgovsalesforce/releasemanagement/release_management_overview.md index 93551c2df3..e076e78438 100644 --- a/docs/platgovsalesforce/releasemanagement/release_management_overview.md +++ b/docs/platgovsalesforce/releasemanagement/release_management_overview.md @@ -6,13 +6,13 @@ sidebar_position: 110 # Release Management Overview -Platform Governance for Salesforce’s release management assists with planning, scheduling and +Platform Governance for Salesforce’s release management assists with planning, scheduling, and controlling the movement of your deployments from your development and testing to production environments. The process ensures your production environment is protected and the correct 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 move deployments from one environment to another. +- [Rollback](/docs/platgovsalesforce/releasemanagement/rollback.md): Use this to roll back 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 1f50bf0e68..53df838f72 100644 --- a/docs/platgovsalesforce/releasemanagement/rollback.md +++ b/docs/platgovsalesforce/releasemanagement/rollback.md @@ -6,10 +6,9 @@ sidebar_position: 20 # Rollback -When deploying changes in a single Salesforce environment, you may find instances where you need to -rollback to a previous state after a deployment. Platform Governance for Salesforce's rollback tool -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: +When deploying changes in a single Salesforce environment, you can roll back to a previous state after a deployment. Platform Governance for Salesforce's rollback tool +lets you roll back all or selected components of your deployment, enabling you +to address a specific problem. There are two steps: - Create the Rollback Record - Execute and Validate the Rollback @@ -24,12 +23,12 @@ The Deployment Record status must be **Completed** to be eligible for Rollback. ![Rollback button is only available for Completed Deployment Records](/images/platgovsalesforce/release_management/rollback_button.webp) -3. Click **Test Connection** to ensure your credentials are working. If your credentials are not - correct, you can click **Save Credentials** and edit. +3. Click **Test Connection** to ensure your credentials are working. If your credentials aren't + correct, click **Save Credentials** and edit. ![Rollback selected customizations](/images/platgovsalesforce/release_management/rollback_selected.webp) -4. By default, all of the customizations are selected for rollback. Deselect any customizations to keep. The **Rollback Type** specifies the effect of the rollback: +4. By default, all customizations are selected for rollback. Deselect any customizations to keep. The **Rollback Type** specifies the effect of the rollback: - **Delete**: If a customization was created during the deployment, it is deleted during the rollback. @@ -56,7 +55,7 @@ The Rollback Record must be approved before it can be executed. ![Validate the Rollback](/images/platgovsalesforce/release_management/rollback_validation.webp) 5. Open **Netwrix Dashboard** > **Reports** > **Release and Deployment** > **Rollback Logs** - You can use **Customize** to add the **Status** column to your report. Here is an example of a + Use **Customize** to add the **Status** column to your report. The following is an example of a failed rollback [deployment log](/docs/platgovsalesforce/releasemanagement/deployment_logs.md). ![Review the Rollback log](/images/platgovsalesforce/release_management/rollback_log.webp) diff --git a/docs/platgovsalesforce/reports/deployment_logs_failures.md b/docs/platgovsalesforce/reports/deployment_logs_failures.md index 2705d3d584..ecc73a4987 100644 --- a/docs/platgovsalesforce/reports/deployment_logs_failures.md +++ b/docs/platgovsalesforce/reports/deployment_logs_failures.md @@ -18,7 +18,7 @@ indicates the current column and sort order being used for the results. - **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_. +- **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 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. diff --git a/docs/platgovsalesforce/reports/reports_overview.md b/docs/platgovsalesforce/reports/reports_overview.md index 3412c857d8..457a06251e 100644 --- a/docs/platgovsalesforce/reports/reports_overview.md +++ b/docs/platgovsalesforce/reports/reports_overview.md @@ -58,14 +58,14 @@ Set and Profile. ![Access report by PermissionSet/Profile](/images/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: +assigned to each user. You can filter the report information. For example, to list +users with Admin profiles, 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 doesn't use the **Expires on** feature, you can remove the column from the +Profiles. If the org doesn't use the **Expires on** feature, remove the column from the report. ![Users to Profile/PermissionSets](/images/platgovsalesforce/reports/access_reports_users_to_profile.webp) @@ -78,7 +78,7 @@ Compliant. ![Access Report Profile Permissions Changes](/images/platgovsalesforce/reports/access_reports_profile_changes.webp) - **Changes to Users**: Displays the changes to tracked user data fields. See -[Enhanced CPQ Support](/docs/platgovsalesforce/changemanagement/datatracking/enhanced_cpq_support.md) for instructions on +[Enhanced Configure, Price, Quote (CPQ) Support](/docs/platgovsalesforce/changemanagement/datatracking/enhanced_cpq_support.md) for instructions on setting up tracking.

If you see the message: _--String too long - Skipped lines due to CPU limit reached--_ it means you have reached the governor limits. Profiles and PermissionSets are very data heavy. Platform Governance for Salesforce skips the record and continues the scan the next day to ensure @@ -111,12 +111,12 @@ To generate this report: 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. +process, the system overwrites the previous report. Export any reports you want to keep. ## Security Reports -These reports are related to the Salesforce Health Check. It tracks if this feature of the health -check is **Enabled** or **Disabled** for your Salesforce Organization. For full detail compare the +These reports are related to the Salesforce Health Check. The reports track whether each health +check feature 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**. @@ -204,8 +204,8 @@ as closed. Use this report to review changes that have been automatically cleare 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. +up to 20 fields from the Policy Record. Salesforce tracks field history from the date and +time you enable 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/scanner/FastScan.md b/docs/platgovsalesforce/scanner/FastScan.md index ea2b7209b8..90a1217b3a 100644 --- a/docs/platgovsalesforce/scanner/FastScan.md +++ b/docs/platgovsalesforce/scanner/FastScan.md @@ -14,7 +14,7 @@ The FastScan monitors your org for changes to security permissions by: - Triggering targeted rescans only for the modified customizations - Running on a scheduled basis to keep your documentation up to date -This approach significantly reduces processing time compared to full metadata scans while ensuring you capture all security changes in near real-time. +This approach significantly reduces processing time compared to full metadata scans while capturing all security changes in near real-time. ### Special Profile Settings Detection @@ -23,7 +23,7 @@ The FastScan is the **only method** that detects and documents changes to: - **ProfilePasswordPolicy**: Password policies and requirements configured at the Profile level - **ProfileSessionSetting**: Session timeout and security settings for Profiles -When changes are made to these settings, it automatically creates Change Log records at the Profile level, ensuring complete visibility of security configuration changes that are not captured by the standard scanner. +When changes are made to these settings, FastScan automatically creates Change Log records at the Profile level, ensuring complete visibility of security configuration changes that the standard scanner doesn't capture. --- @@ -41,7 +41,7 @@ When changes are made to these settings, it automatically creates Change Log rec ### 1. Scheduled Execution -The FastScan runs automatically based on the schedule you configure in the **Scheduling** section of the Platform Governance Scheduler. You can set it to run daily, weekly, or at custom intervals to continuously monitor permission changes in your org. +The FastScan runs automatically based on the schedule you configure in the **Scheduling** section of the Platform Governance Scheduler. Set it to run daily, weekly, or at custom intervals to continuously monitor permission changes in your org. ### 2. Change Detection @@ -76,13 +76,13 @@ You can schedule the FastScan to run automatically: 1. Go to the **Netwrix Dashboard** page 2. Navigate to the **Scanner** > **Scheduler** menu 3. Locate the **FastScan Profile/Permission Set** scheduler -4. Select your desired frequency (for example, Daily or Weekly) +4. Select your desired frequency (for example, Daily, or Weekly) 5. Choose the time of day to run 6. Click **Enable** to activate -For more information about the scheduler, see the [Scheduler documentation](/docs/platgovsalesforce/scanner/scheduler.md). +See [Scheduler documentation](/docs/platgovsalesforce/scanner/scheduler.md). -**Best Practice**: Schedule the FastScan to run daily during off-peak hours to ensure timely change detection without impacting users. +**Best Practice**: Schedule FastScan to run daily during off-peak hours to ensure timely change detection without impacting users. ### Manual Execution @@ -128,4 +128,4 @@ Not change logs detected by the FastScan: 4. **Review Failed Jobs**: Check Apex Jobs regularly for any processing errors 5. **Maintain Custom Setting**: Keep **Fast_Scan_Params__c** properly configured ---- \ No newline at end of file +--- diff --git a/docs/platgovsalesforce/scanner/field_level_scanner.md b/docs/platgovsalesforce/scanner/field_level_scanner.md index d558f4f7bb..357fcc9a74 100644 --- a/docs/platgovsalesforce/scanner/field_level_scanner.md +++ b/docs/platgovsalesforce/scanner/field_level_scanner.md @@ -8,11 +8,11 @@ sidebar_position: 40 ## Overview -The Field Level Security scanner allows users to analyze access to selected fields across multiple Salesforce objects that may be critical to the organization. It evaluates and records which Profiles, Permission Sets, and Permission Set Groups have read access, write access, or both, for the specified fields. +The Field Level Security scanner lets users analyze access to selected fields across multiple Salesforce objects that may be critical to the organization. It evaluates and records which Profiles, Permission Sets, and Permission Set Groups have read access, write access, or both, for the specified fields. This scanner captures an exact snapshot of the system at the moment it is executed. -It allows users to review the results in the **Field Permissions** report. +Use it to review the results in the **Field Permissions** report. ## Accessing Field Level Security @@ -24,8 +24,8 @@ Navigate to the Netwrix Dashboard: ## Field Level Security Scanner UI -From this screen, users can search for and select multiple fields from different objects. The selected fields will be displayed in the table at the bottom of the screen. -Currently, the maximum number of fields that can be selected is 50. +From this screen, users can search for and select multiple fields from different objects. The selected fields are displayed in the table at the bottom of the screen. +The maximum number of fields that can be selected is 50. ![Open the Field Level Security Scanner](/images/platgovsalesforce/scanners/field_level_scanner.webp) @@ -36,7 +36,7 @@ Parent Object, Package, and Salesforce Type for a selected Object. Run the scanners before you search to ensure you have the latest data. ::: -Below is a step-by-step example of how to run the scanner: +The following example shows how to run the scanner: 1. Start typing the name of a **Salesforce Object**, then select it from the autocomplete list. 2. Click **Search Fields**. @@ -46,7 +46,7 @@ Below is a step-by-step example of how to run the scanner: 3. Select one or more fields from different objects to be analyzed by the scanner. 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. + It isn't technically possible to scan permissions on all fields in each object. ::: 4. Selected fields are shown in a list at the bottom of the form. You can uncheck individual fields @@ -56,12 +56,12 @@ Below is a step-by-step example of how to run the scanner: 5. Click **Run Scanner**. -Once the scan is complete, open the Reports tab and select **Field Permissions** Report. +After the scan is complete, open the Reports tab and select **Field Permissions** Report. :::note -Once the scanner is executed, the functionality will be locked until the process is complete. +After the scanner is executed, the functionality is locked until the process is complete. -If you need to run it again, keep in mind that the results represent a snapshot at the time of execution. Previous executions are not stored, and no historical data is maintained. +If you need to run it again, the results represent a snapshot at the time of execution. Previous executions aren't stored, and no historical data is maintained. ::: ## Field Level Security Report @@ -72,10 +72,10 @@ The report is available from the Netwrix Dashboard: **Reports** > **Access Repor ## Best Practices -- Make sure the customization record for the field you want to analyze has been created before running the scanner. +- Ensure the customization record for the field you want to analyze has been created before running the scanner. - Carefully select the fields to be analyzed. ## Limitations -- Execution history is not stored. +- Execution history isn't stored. - The maximum number of fields that can be selected across multiple objects is 50. diff --git a/docs/platgovsalesforce/scanner/scanner_troubleshooting_guide.md b/docs/platgovsalesforce/scanner/scanner_troubleshooting_guide.md index 0708416009..06e13f4eaf 100644 --- a/docs/platgovsalesforce/scanner/scanner_troubleshooting_guide.md +++ b/docs/platgovsalesforce/scanner/scanner_troubleshooting_guide.md @@ -1,7 +1,7 @@ # Scanner Troubleshooting Guide ## Overview -This guide helps you troubleshoot the Strongpoint scanner system in your Salesforce org. You'll find verification methods, scanner limits, duration estimates, and best practices for running initial scans—especially useful for large organizations. +This guide helps you troubleshoot the scanner system in your Salesforce org. It covers verification methods, scanner limits, duration estimates, and best practices for running initial scans—especially useful for large organizations. --- @@ -16,7 +16,7 @@ This guide helps you troubleshoot the Strongpoint scanner system in your Salesfo ### 1.1 Estimating Scan Duration -Understanding how long a scan will take helps you plan accordingly: +Use the following estimates to plan your scan schedule: | Org Size | Metadata Count | Estimated Duration | Characteristics | |----------|----------------|-------------------|-----------------| @@ -77,9 +77,9 @@ When the **Retrieved Stage** shows **Verified** and both count values match, it ## 2. Scanner Status -You can monitor the scanner execution status in real-time through the Strongpoint UI. For detailed instructions on how to view scanner progress, check the status of running batches, and interpret the Scanner Status page, see the [Scanner Status documentation](../navigate_strongpoint#scanner-status). +Monitor the scanner execution status in real time through the Platform Governance UI. For instructions on viewing scanner progress, checking the status of running batches, and interpreting the Scanner Status page, see the [Scanner Status documentation](../navigate_strongpoint#scanner-status). -You can also create your own Salesforce view to monitor scanner jobs directly in Salesforce. For step-by-step instructions on creating a custom view for the scanners, see the [Running Scanner documentation](/docs/platgovsalesforce/installingstrongpoint/running_scanner.md#creating-a-custom-view-for-scanners). +You can also create your own Salesforce view to monitor scanner jobs directly in Salesforce. For instructions on creating a custom view for the scanners, see the [Running Scanner documentation](/docs/platgovsalesforce/installingstrongpoint/running_scanner.md#creating-a-custom-view-for-scanners). ## 3. Initial Scan Recommendations @@ -89,15 +89,15 @@ Before setting up incremental or scheduled scans, you must complete an initial f **To configure and run the full scan:** -1. Navigate to the Strongpoint Scanner configuration -2. Configure the automated scan settings following the [Scanner Scheduler documentation](./scheduler) -3. Start the full scan and monitor its progress using the [Scanner Status page](../navigate_strongpoint#scanner-status) +1. Navigate to the Scanner configuration. +2. Configure the automated scan settings following the [Scanner Scheduler documentation](./scheduler). +3. Start the full scan and monitor its progress using the [Scanner Status page](../navigate_strongpoint#scanner-status). -**Important:** Wait for the full scan to complete before configuring incremental scans. You can verify completion by checking the information in [section 1.3](#13-verifying-complete-metadata-documentation). +**Important:** Wait for the full scan to complete before configuring incremental scans. Verify completion using the steps in [section 1.3](#13-verifying-complete-metadata-documentation). ### 3.2 Configuring Metadata Types to Document -You can configure which Salesforce metadata types you want to document based on your organization's needs. This allows you to focus on the most relevant components and optimize scan performance. +Configure which Salesforce metadata types to document based on your organization's needs. Selecting specific types lets you focus on the most relevant components and optimize scan performance. **To select specific metadata types:** diff --git a/docs/platgovsalesforce/scanner/scheduler.md b/docs/platgovsalesforce/scanner/scheduler.md index 470a8dc578..5ac8c78237 100644 --- a/docs/platgovsalesforce/scanner/scheduler.md +++ b/docs/platgovsalesforce/scanner/scheduler.md @@ -8,8 +8,7 @@ sidebar_position: 10 Platform Governance for Salesforce's scheduler creates automated scans, manages scripts, uses the Agent and finds the date last used (DLU). The schedules are validated to prevent scanners from -running concurrently, potentially causing conflicts and incomplete documentation. A warning message -is displayed if you create an overlapping scanner schedule. +running concurrently, potentially causing conflicts and incomplete documentation. The scheduler displays a warning if you create an overlapping scanner schedule. To use the scheduler tool: @@ -20,7 +19,7 @@ To use the scheduler tool: 2. Select the category to automate by clicking on **Disabled** to enable it. There is no save button, automation is turned on and saved by toggling **Enabled**/**Disabled**. -3. Select the **Frequency** , **Day** and **Time**. Your selections are automatically saved. +3. Select the **Frequency**, **Day**, and **Time**. Your selections are automatically saved. 4. Click any menu item to close the **Scheduler**. --- @@ -29,7 +28,7 @@ To use the scheduler tool: ### Initial Documentation Phase -When you first install Platform Governance for Salesforce, enable only the **Automated Scan** with **Daily** frequency. Do not enable other scanners until your org is fully documented. This approach ensures: +When you first install Platform Governance for Salesforce, enable only the **Automated Scan** with **Daily** frequency. Don't enable other scanners until your org is fully documented. This approach ensures: - Complete baseline documentation before change detection begins - Optimal resource utilization during initial scan @@ -37,7 +36,7 @@ When you first install Platform Governance for Salesforce, enable only the **Aut ### Profile and Permission Set Heavy Orgs -If your org contains many profiles and permission sets, you can enable the **Fast Scan** for more agile change detection and change log generation. The Fast Scan provides quicker turnaround than the Daily Scan while maintaining accuracy for permission-related changes. +For orgs with many profiles and permission sets, enable the **Fast Scan** for faster change detection and change log generation. The Fast Scan provides quicker turnaround than the Daily Scan while maintaining accuracy for permission-related changes. ### Scanner Selection @@ -53,7 +52,7 @@ Avoid enabling all scanners by default, as this can consume unnecessary resource Configure logical time windows between scanners to prevent batch execution conflicts. Stagger your scanner schedules to ensure: -- Scanners do not run concurrently +- Scanners don't run concurrently - Each scanner completes before the next one starts - System resources remain available for other Salesforce operations diff --git a/docs/platgovsalesforce/settings/credentials.md b/docs/platgovsalesforce/settings/credentials.md index 8f7ad87a7e..7349f2c743 100644 --- a/docs/platgovsalesforce/settings/credentials.md +++ b/docs/platgovsalesforce/settings/credentials.md @@ -15,21 +15,21 @@ You must create a Connected App to run the scanner. Refer to [Install Platform Governance for Salesforce](/docs/platgovsalesforce/installingstrongpoint/installing_strongpoint.md) for instructions. -Click **New** to add a new credential or **Edit** and existing credential. **Search** finds and +Click **New** to add a new credential or **Edit** an existing credential. **Search** finds and filters information from the current credentials list. -Use the **Test Connection** to verify your credentials. +Use **Test Connection** to verify your credentials. Click **Save** when complete. ## Credentials for Environment Comparison -When you follow the **Click here to proceed** link on the Environment Comparison tool, it opens the -Credentials Handler where you can add, edit and sync your credentials. +On the Environment Comparison tool, select the link to open the +Credentials Handler where you can add, edit, and sync your credentials. ![Credentials Handler](/images/platgovsalesforce/settings/credentials_list.webp) -Click **New** to add a new credential or **Edit** and existing credential. **Search** finds and +Click **New** to add a new credential or **Edit** an existing credential. **Search** finds and filters information from the current credentials list. ![credentials_handler_edit](/images/platgovsalesforce/settings/credentials_handler_edit.webp) diff --git a/docs/platgovsalesforce/techdebt/tech_debt_auto_documentation.md b/docs/platgovsalesforce/techdebt/tech_debt_auto_documentation.md index 39479805a3..8add2e3833 100644 --- a/docs/platgovsalesforce/techdebt/tech_debt_auto_documentation.md +++ b/docs/platgovsalesforce/techdebt/tech_debt_auto_documentation.md @@ -6,21 +6,17 @@ sidebar_position: 20 # Automated Documentation -Great documentation is easy with Platform Governance for Salesforce. Install the managed package in -a sandbox or production org and start the scanners.Platform Governance for Salesforce continuously -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. +Platform Governance for Salesforce continuously maintains automated digital documentation of each Salesforce org and provides diagrams and clean-up tools. Install the managed package in a sandbox or production org and start the scanners. 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. +**Learning About the Scanners**: Review the [Running the Scanner](/docs/platgovsalesforce/installingstrongpoint/running_scanner.md) topic or reach out to the Customer Success team. Setup takes about half an hour. 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. +Platform Governance for Salesforce is a 100% native Salesforce App. Records and code usage don't count against your governance limits. Moreover, after 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: +Once your orgs are documented, Platform Governance for Salesforce provides several ways to understand the downstream dependencies of any change: - Dependency Relationship Diagram (DRD) - Customization Record @@ -43,8 +39,8 @@ the dependencies. ![Opening an item in the DRD](/images/platgovsalesforce/tech_debt/tech_debt_1.webp) -2. Click an attribute to expand the metadata record and view all the dependencies. Drill down for - details so you can fully understand the downstream dependencies. +2. Click an attribute to expand the metadata record and view all the dependencies. Select nested items for + details to fully understand the downstream dependencies. ![Viewing dependencies in the DRD](/images/platgovsalesforce/tech_debt/tech_debt_13.webp) @@ -58,7 +54,7 @@ the dependencies. metadata and change history for the Customization. :::tip -Read more about the [Customization Record](/docs/platgovsalesforce/customizations/customizations_overview.md). +See [Customization Record](/docs/platgovsalesforce/customizations/customizations_overview.md) for an overview of the record structure. Click **Show/Hide Standard Fields** to toggle displaying Standard Fields in the DRD. ::: @@ -121,7 +117,7 @@ The Custom tab displays usage and lifecycle-related data gathered through scanni - First detected (join) date - Last used date (when available) - Percentage populated (for data fields) -- DLU (Data Lifecycle Usage) status +- DLU (Date Last Used) status - Parent last update date - Track History Field enablement status @@ -180,8 +176,8 @@ Two key actions are available in the Customization Record: 1. **ReScan Button**: - Click the "ReScan" button to manually trigger a new scan of the customization. - - This helps detect any recent changes that might not have been captured in the previous scan. - - Useful for ensuring you have the most up-to-date information about the customization. + - This detects recent changes not captured in the previous scan. + - Use this to ensure you have the most up-to-date information about the customization. 2. **Go To Record Button**: - Click the "Go To Record" button to directly navigate to the original Salesforce record for this customization. @@ -192,7 +188,7 @@ Two key actions are available in the Customization Record: ## Finder -The Customization Finder is a powerful search and filtering tool that helps you locate and analyze Customization records across your Salesforce instance. It enables users to quickly find specific customizations, understand ownership and usage, and export results for further analysis. +The Customization Finder is a search and filtering tool that helps you locate and analyze Customization records across your Salesforce instance. Use it to find specific customizations, understand ownership and usage, and export results for further analysis. Finder is especially useful for audits, clean-up initiatives, impact analysis, and documentation reviews. @@ -203,7 +199,7 @@ The upper section of the Finder page provides a comprehensive set of filters to #### Text and API Name Search **Search by text / API Name** -Allows free-text searching across customization names and API names. +Searches customization names and API names using free text. #### Date Filters @@ -220,7 +216,7 @@ When enabled, Finder includes managed package components in the results. When di #### Customization Type Filtering -This section allows you to narrow results by customization type. +Use this section to narrow results by customization type. **Search Types** Quickly filter the list of available customization types. @@ -232,7 +228,7 @@ Only selected types are included in the results. #### Created By Filtering -This section allows filtering Customizations based on the user who created them. +Use this section to filter customizations by the user who created them. **Search Users** Quickly locate users by name. @@ -250,7 +246,7 @@ At the bottom of the filter section, Finder provides the following actions: ### Search Results -Search results are displayed in a tabular format and include key information for each Customization, such as: +Search results appear in a table and include key information for each customization, such as: - Name - Type @@ -260,19 +256,19 @@ Search results are displayed in a tabular format and include key information for - Created By - Modified By -Pagination controls and page size options allow you to navigate large result sets efficiently. +Use the pagination controls and page size options to navigate large result sets efficiently. ![Customization Finder Results](/images/platgovsalesforce/tech_debt/customization_finder_results.webp) ## Object Exporter -Object Exporter enables exporting information about entire objects, profiles or users into Excel for -further research. Read more on [Exporting Objects](/docs/platgovsalesforce/tools/export_objects.md), -[Exporting Profiles](/docs/platgovsalesforce/tools/export_profiles.md) and [Exporting Users](/docs/platgovsalesforce/tools/export_users.md). +Object Exporter exports information about entire objects, profiles, or users into Excel for +further research. See [Exporting Objects](/docs/platgovsalesforce/tools/export_objects.md), +[Exporting Profiles](/docs/platgovsalesforce/tools/export_profiles.md), and [Exporting Users](/docs/platgovsalesforce/tools/export_users.md) for instructions. ## Reports and List Views -Platform Governance for Salesforce is fully built into Salesforce so you can take advantage our our +Platform Governance for Salesforce is fully built into Salesforce so you can use the built-in libraries of List Views and Reports or build your own. **Next Technical Debt Topic:** [Change Monitoring](/docs/platgovsalesforce/techdebt/tech_debt_change_monitoring.md) diff --git a/docs/platgovsalesforce/techdebt/tech_debt_change_monitoring.md b/docs/platgovsalesforce/techdebt/tech_debt_change_monitoring.md index 86c40092c1..3db043c827 100644 --- a/docs/platgovsalesforce/techdebt/tech_debt_change_monitoring.md +++ b/docs/platgovsalesforce/techdebt/tech_debt_change_monitoring.md @@ -10,15 +10,15 @@ Activating change monitoring is the next step on the path to reduce your Technic monitoring records all changes that occur in the org and automatically alerts stakeholders of any that fall outside of policy or impose unacceptable levels of risk. -Change monitoring can be integrated into your change governance process or be leveraged as the -foundation of a new super-efficient process using Platform Governance for Salesforce. For now, +Change monitoring can be integrated into your change governance process or used as the +foundation of a new efficient process using Platform Governance for Salesforce. For now, oversight is the goal. In particular, notification of any changes that touch automation (code, workflows, triggers), profiles or roles is essential. The severity level can be set to the level of 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. +**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 don't 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 @@ -28,18 +28,18 @@ escalating levels of rigor and/or skill required to address a change: | --------------------------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | L1: Log Changes | This is a safe change. | Ordinary report. | Anyone. | | L2: Change Request | This needs approval from management but not sandbox review. | Management report or Control. | Anyone, provided prior approval is granted. | -| L3: 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. | -| L4: 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. | +| L3: Sandbox Development and Testing | The change is low complexity, but best practices require testing 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. | +| L4: Full Software Development Lifecycle | This change requires careful handling and rigorous testing. | Changes to code or a picklist used in field with code or Salesforce Object Query Language (SOQL) dependencies. | Admin / Developer with prior approval working through a full development cycle in multiple sandboxes. | Changes made without the policy-required approval are reported as Non-Compliant. Review the -Non-Compliant Changes Report to ensure dangerous changes do not slip through and cause process or +Non-Compliant Changes Report to ensure dangerous changes don't slip through and cause process or data problems. Policies can also be used to block unauthorized changes. ## Default Policy -Netwrix recommends our default policy as a foundational best practice. In addition, consider +Netwrix recommends the default policy as a foundational best practice. In addition, consider Specific Monitoring for anything needing special protection. ![Netwrix Default Policy](/images/platgovsalesforce/tech_debt/tech_debt_default_policy_1.webp) @@ -49,12 +49,9 @@ Specific Monitoring for anything needing special protection. Platform Governance for Salesforce documents **Unresolved Non-Compliant Changes** in both a List View and a Report. Both show you all the changes that should have received approval and the level of -change control required for the change. The List View enables you to quickly review and manage the -resolution from a single screen through the **Short Resolution Description** and **Status** fields. +change control required for the change. Use the List View to review and manage the resolution from a single screen through the **Short Resolution Description** and **Status** fields. -If you are not fully leveraging Platform Governance for Salesforce in your change enablement -process, you can restrict your review of changes by filtering out object types or risk levels that -do not concern you. Alternatively, you can create different reports for different team members to +To restrict your review of changes, filter out object types or risk levels that don't apply to your team. Alternatively, you can create different reports for different team members to prioritize what you see. ![Unresolved Non-Compliant Changes Report](/images/platgovsalesforce/tech_debt/tech_debt_8.webp) @@ -67,7 +64,7 @@ From this tab, you can: ### View Customizations Associated with the Policy -The Customizations section shows which Salesforce customizations are currently governed by the policy. +The Customizations section shows which Salesforce customizations are governed by the policy. ### Add or Manage Customizations @@ -113,7 +110,7 @@ To configure Automatic Policy Assignment by Salesforce Type: ![Select Change Level By SF Type](/images/platgovsalesforce/tech_debt/select_change_level_by_sf_type.webp) -This method allows you to automatically assign policies to specific Salesforce object types. +Use this method to automatically assign policies to specific Salesforce object types. #### Option 2: Add Customization @@ -142,8 +139,7 @@ This feature ensures consistent governance by: ## Specific Monitoring -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: +The default policy may be all you require. Consider whether specific people, objects, reports, or fields need special protection. Address these through: - Specific People - Specific Customizations @@ -210,7 +206,7 @@ watching your org to spot problems before they happen. ### Adding Custom Fields and Objects to the Policy -When you add sensitive objects to a policy, you may also need to apply the same policy to the Custom Fields that belong to that object. Platform Governance for Salesforce provides a streamlined **Set Policy** action directly on the Customization record to support this workflow. +When you add sensitive objects to a policy, also apply the same policy to the custom fields that belong to that object. Platform Governance for Salesforce provides a streamlined **Set Policy** action directly on the Customization record to support this workflow. #### Applying a Policy from a Custom Object To assign a Change / Approval Policy to a Custom Object and its related fields: @@ -222,7 +218,7 @@ To assign a Change / Approval Policy to a Custom Object and its related fields: ![Applying a Policy from a Custom Object](/images/platgovsalesforce/tech_debt/policy_set_button.webp) 4. In the Set Policy dialog: - - Assign the desired Change / Approval Policy to the Custom Object. + - Assign the Change / Approval Policy you want to the Custom Object. - Review the list of related Custom Fields associated with the object. 5. Select individual fields, or use the header checkbox to select all fields. 6. Click: diff --git a/docs/platgovsalesforce/techdebt/tech_debt_managing_orgs.md b/docs/platgovsalesforce/techdebt/tech_debt_managing_orgs.md index f5f1d77985..976426398f 100644 --- a/docs/platgovsalesforce/techdebt/tech_debt_managing_orgs.md +++ b/docs/platgovsalesforce/techdebt/tech_debt_managing_orgs.md @@ -6,24 +6,21 @@ sidebar_position: 10 # Managing Orgs in the Real World -In a perfect world, we have the time and resources to employ best practices by an experienced team -in every situation. However, the world is not perfect, and technical debt accumulates, adding +In a perfect world, there's time and resources to employ best practices with an experienced team +in every situation. However, the world isn't perfect, and technical debt accumulates, adding difficulty and complexity to making enhancements and managing your orgs. Platform Governance for Salesforce is designed for a real world where: - Documentation is incomplete, non-existent or out of date. - Customizations have not been tightly managed. -- There are or have been multiple hands in the cookie jar. +- Multiple administrators or developers have made changes without coordination. - Orgs have been over-customized, poorly customized, or customizations have accumulated over time and now interfere with each other. -- Turnover of critical SFDC team members has adversely affected tribal knowledge. +- Turnover of critical Salesforce (SFDC) team members has adversely affected tribal knowledge. - Mergers and acquisitions have influenced the scope or objectives of each team and their orgs. -Getting a handle on this situation can be daunting with the myriad of dependencies and complexities -to address. Progress can be made if it is accepted that positive change can be achieved in steps -rather than reaching for immediate perfection. Following this simple path, you can realize progress -in short order: +This situation can be daunting given the dependencies and complexities involved. Progress is achievable in steps rather than reaching for immediate perfection. Follow this path to realize progress quickly: 1. **Install** the managed package in each org. 2. **Initiate** the Scanner systematically in each org to generate automated documentation. The @@ -31,7 +28,7 @@ in short order: unused and the risk posed by changes. 3. **Activate** Change Monitoring to alert stakeholders of risky changes. Platform Governance for Salesforce warns org owners and admins about risk at very granular levels. -4. **Plan** the clean up of unused, defunct and redundant customizations using the powerful search +4. **Plan** the clean up of unused, defunct, and redundant customizations using the powerful search capabilities. 5. **Implement** Automated Risk Management to guide all change agents to make enhancements in a structured, safe, and efficient manner. @@ -46,6 +43,6 @@ Each stage delivers benefits to significantly improve your ability to manage tec | 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 | +| **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 Center of Excellence (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_change_enablement.md b/docs/platgovsalesforce/techdebt/tech_debt_org_change_enablement.md index b16534fa69..0d0934bf3a 100644 --- a/docs/platgovsalesforce/techdebt/tech_debt_org_change_enablement.md +++ b/docs/platgovsalesforce/techdebt/tech_debt_org_change_enablement.md @@ -6,12 +6,9 @@ sidebar_position: 80 # Change Enablement -It is commonly believed doing things faster is more dangerous, and doing things slowly and carefully -is safer. In today's world, slower is not an option. Platform Governance for Salesforce -realized that **Faster** can also be **Safer** and sometimes **Very Fast** can be **Extremely -Safe**. +Speed and safety aren't opposites. Platform Governance for Salesforce demonstrates that **Faster** can also be **Safer** and sometimes **Very Fast** can be **Extremely Safe**. -In [Change Monitoring](/docs/platgovsalesforce/techdebt/tech_debt_change_monitoring.md), we discussed setting up automated change +The [Change Monitoring](/docs/platgovsalesforce/techdebt/tech_debt_change_monitoring.md) topic covers setting up automated change monitoring to deliver instant oversight of your org. [Org Clean Up](/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up.md) described ongoing monitoring of specific changes. Automated Risk Management takes these disciplines and combines them with three goals: @@ -22,19 +19,18 @@ and combines them with three goals: 3. **Delight your key stakeholders** — provide rapid access to the changes they need to drive the business forward -Our flagship **Intelligent Change Enablement** processes automate the required steps to make changes +The flagship **Intelligent Change Enablement** processes automate the required steps to make changes quickly and safely, clean up technical debt and make your orgs more understandable and efficient. The key steps: 1. **Review and Finalize Your Policies** to support a rapid change process. -2. **Train Your Team** to use our automated tools. +2. **Train Your Team** to use the automated tools. 3. **Document Your New, Faster Proces**s based on industry best practices or tailored to your existing Jira or ServiceNow process. 4. **Roll Out the New Process** in production. -Whether you are trying to get ahead of the game or have to meet specific governance or compliance -goals, our team of experts can lead you every step of the way. We can implement an approach your +Whether you are pursuing proactive governance or meeting specific compliance goals, the Netwrix team of experts can guide you through implementation. The team can implement an approach your team, stakeholders, and auditors will love. Reach out to your Customer Success Manager or Account Executive to explore Intelligent Change diff --git a/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up.md b/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up.md index cb0bb97551..e15c909fdd 100644 --- a/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up.md +++ b/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up.md @@ -33,7 +33,7 @@ These items can help you identify Customizations for Clean Up: ## Date Last Used -Date Last Used (DLU) is a key criterion for clean up, as you generally are not cleaning up active +Date Last Used (DLU) is a key criterion for clean up, as you generally aren't cleaning up active Customizations. DLU means different things to different people in the Salesforce community. The generic definition is: @@ -44,11 +44,9 @@ generic definition is: For all clean up activities, consider the following items: -- Blank DLU means there is no verified date. A blank date does not mean it is safe to remove. -- DLU is not the only criterion. You must look at the dependencies. An unused field with related - code is not safe to remove. It is, however, a sign you may have unnecessary code. -- An unused field may have important data from the history of your company. A good question to - investigate is why isn’t it being used? It might be a good idea that never got off the ground. +- Blank DLU means there is no verified date. A blank date doesn't mean it's safe to remove. +- DLU isn't the only criterion. Check the dependencies. An unused field with related code isn't safe to remove. It can, however, indicate unnecessary code. +- An unused field may have important data from the history of your company. Investigate why it isn’t being used. It may represent a feature or process that was started but never completed. - Cleaned up Customizations are archived if you need to restore. Like all Salesforce Date fields, DLU can be filtered using relative date formats (typically what you @@ -60,8 +58,8 @@ will want). You can also filter on specific dates. The most common unused Customizations are Reports. In most orgs, new Reports are created every day. Some are critical to ongoing business processes, others are quick solutions to day-to-day problems. -These one-time quick reports accumulate in your orgs, causing confusion and inefficiency. Refer to -[Automated Report Clean Up](/docs/platgovsalesforce/tools/automated_report_clean_up.md) for more details. +These one-time quick reports accumulate in your orgs, causing confusion and inefficiency. See +[Automated Report Clean Up](/docs/platgovsalesforce/tools/automated_report_clean_up.md) for details on removing them. ## Employees Related to a Customization @@ -69,8 +67,7 @@ Knowing who is using a customization is useful. This is tackled in steps, by Use ### Users -**Field and Object Users**: Track employees editing a Field (using a custom or standard Object). It -is not turned on for all Customizations which would be inefficient. If you use _Salesforce Shield +**Field and Object Users**: Track employees editing a field (using a custom or standard object). Enabling tracking for all customizations would be inefficient, so it is enabled selectively. If you use _Salesforce Shield Event Monitoring_, Platform Governance for Salesforce captures this data automatically. To capture the data without Salesforce Shield Event Monitoring: @@ -78,8 +75,7 @@ To capture the data without Salesforce Shield Event Monitoring: 1. Enable **Field Audit Trail** for the field. 2. Permit Salesforce to populate the audit log for the last 18 months. 3. Rescan the tracked fields. -4. Names of the employees changing the data in each field are gathered automatically. This process - can take multiple days for a large dataset. +4. Platform Governance for Salesforce automatically gathers the names of employees changing the data in each field. This process can take multiple days for a large dataset. 5. Turn off audit history if desired. **Code, App, and Component Users**: With _Salesforce Shield Event Monitoring_, capture users from @@ -92,12 +88,10 @@ the execution history of APEX-related objects. - **Salesforce Shield Event Monitoring**: Employee usage data for Reports, Dashboards, and many other objects, is only available with Salesforce Shield Event Monitoring. It enhances usage metadata to show users who are viewing non-scripted objects and executing or triggering code and - workflows. Once you activate _Salesforce Shield Event Monitoring_, data is collected from that - point on. It is not retroactive. + workflows. After you activate _Salesforce Shield Event Monitoring_, data is collected from that + point on. It isn't retroactive. -**Users referred to in objects**: Fields are not created for everything, but all the metadata is -available. You can identify users (and other things) referred to in dashboard filters, formula -fields, SOQL, or even code, by searching the raw XML, JSON or code. The +**Users referred to in objects**: Fields aren't created for everything, but all the metadata is available. Identify users (and other things) referred to in dashboard filters, formula fields, SOQL, or code by searching the raw XML, JSON, or code. The [Specific Clean Up Approaches](/docs/platgovsalesforce/techdebt/tech_debt_org_specific_clean_up_approaches.md) section contains examples. 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 282d24a6ed..c9fd112149 100644 --- a/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up_example.md +++ b/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up_example.md @@ -11,24 +11,24 @@ Here is an example using the simplest clean up case: - Unused custom fields on Account object - No risky dependencies -Using the steps outlined Org Clean Up, we can proceed quickly, efficiently and with confidence. +Using the steps outlined in Org Clean Up, you can proceed with a clear, repeatable process. ## Step 1: Identify and Prioritize Targets for Clean Up -We are going to use the out-of-the-box Default Clean Up List View with these filters: +Use the Default Clean Up List View with these filters: ![Filters](/images/platgovsalesforce/tech_debt/tech_debt_9.webp) - Filter on the single Record Type **Objects & Fields** to enable editing the Customizations directly from the List View. This filter selects all Objects and their related Fields. -- Filter for API Names starting with **Account** (for example, **Account.\_**my*custom_field*) - limits results to the **Account** object. We could use a similar technique to focus on a specific +- Filter for API Names starting with **Account** (for example, **Account.\_**your_custom_field) + limits results to the **Account** object. Use a similar technique to focus on a specific App. - Filter on **Salesforce CustomField** to return all Custom Fields. - Filter to exclude **Standard** fields. The Salesforce metadata type for all fields is CustomField. Platform Governance for Salesforce identifies standard fields and appends **Standard: object_name** to the Customization Name so they can be filtered out of your results. -- In our example, **unused** means _not used within the last six months_, so we finish up with a +- In this example, **unused** means _not used within the last six months_, so finish with a Date Last Used filter. Specify the fields to show: @@ -50,7 +50,7 @@ Specify the fields to show: ## Step 2: Assess the Risk of Downstream Problems and Add Related Customizations You now have a list of unused, custom fields on the Account object. Examine the dependencies to -determine what to do next. For this example, we are going to clean up fields without these +determine what to do next. For this example, the focus is on fields without these complications. 1. Set the **Clean Up Status** on any field without dependencies to **To Be Cleaned Up**. In the @@ -58,7 +58,7 @@ complications. ![Edit icon](/images/platgovsalesforce/tech_debt/edit_icon.webp) icon and edit the **Clean Up Status** and other Clean Up Fields. You can select multiple fields using the checkboxes to set the values for the group. -2. For easy reference later, set a project name in the **Clean Up Classification** field such as +2. To find the group later, set a project name in the **Clean Up Classification** field such as _Simple Account Clean Up_. You can filter on this later when you send for approval. 3. If you have questions, send an email or Chatter request to the owner and set the **Clean Up Status** to _Send Request Info Email_ as a reminder you are awaiting a response. @@ -70,9 +70,7 @@ complications. scripts and workflows are still useful, need to be fixed, or cleaned up. What are the scripts or workflows doing if there is no data in the field? 6. As you work through the list, note your findings in the **Clean Up Comments** field. -7. To keep an unused field, set the **Clean Up Status** to **Ignore**. Alternatively, you can set - the **Date Last Used** to a date in the future. Platform Governance for Salesforce will not - override the manually set date with an earlier date so you can retain the Customization. To view +7. To keep an unused field, set the **Clean Up Status** to **Ignore**. Alternatively, set the **Date Last Used** to a date in the future. Platform Governance for Salesforce doesn't override the manually set date with an earlier date, so you can retain the customization. To view ignored Customizations, select: **Strongpoint** > **Reports** > **Clean Up** > **Customizations Excluded From Clean Up** @@ -97,9 +95,9 @@ Some of the fields may have associated Reports or List Views. If you open the DR Customization Record, you can drill into the details to see if removing the field is likely to cause a problem. Some things to consider: -- List Views do not track Date Last Used. Be careful cleaning up them up. Reports do track DLU. +- List Views don't track Date Last Used. Be careful cleaning up them up. Reports do track DLU. - Cleaning up fields used in **Report Filters** can change the scope of the report. You can check - whether the field is used in the report filter by looking at the **Search Filters** check box + whether the field is used in the report filter by looking at the **Search Filters** checkbox field. - Fields on actively used Reports should have **Clean Up Status** set to **Under Investigation** and a plan for cleaning up the Report documented in the **Clean Up Comments** field. You might want to @@ -149,15 +147,13 @@ approval process. Related Customizations can be grouped and managed using a **Ch The Impact Analysis categorizes Customizations into the following sections: - **Can Be Safely Deleted or Modified** - - **Cannot Be Safely Deleted or Modified** + - **Can't Be Safely Deleted or Modified** - **Inactive Customizations** This analysis identifies dependencies such as references in reports, scripts, workflows, or other metadata that could be affected by the clean up. -8. Review the Impact Analysis results carefully. If Customizations appear under - **Cannot Be Safely Deleted or Modified**, further investigation or remediation may be required - before proceeding. +8. Review the Impact Analysis results. If customizations appear under **Can't Be Safely Deleted or Modified**, investigate or remediate them before proceeding. 9. When you are satisfied with the scope and impact of the clean up, submit the Change Request for approval. @@ -170,10 +166,7 @@ You can add additional approvers (beyond what is required for the policy) to the - 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 -Customization Records (there are third party apps that enable List View export). You must double -check the impact and manually route your list for approval. +To export results without Change Enablement, click **Export To Excel** on the Change Request **Impact Analysis** tab. You can also create a report of Customization Records (third-party apps can enable List View export). Verify the impact and manually route your list for approval. ## Step 5: Archive the Customization Definition / Data @@ -183,21 +176,13 @@ the fields. ## Step 6: Clean Up Approved Customizations -As with any change, you are strongly encouraged to clean up the fields in a sandbox first, run your -test sets, and review the changes with the affected business owners prior to making the change in -production. +Clean up the fields in a sandbox first, run your test sets, and review the changes with the affected business owners before making the change in production. -You currently cannot delete items using Platform Governance for Salesforce tools. To actually remove -objects in bulk, you can use -[Destructive Change Sets](https://developer.salesforce.com/docs/atlas.en-us.daas.meta/daas/daas_destructive_changes.htm). -You can also remove them manually. We are working with customers to understand the controls required -to automate this process, taking into account the judgment required to safety proceed in various -sized orgs. +Platform Governance for Salesforce tools don't support deleting items. To remove objects in bulk, use [Destructive Change Sets](https://developer.salesforce.com/docs/atlas.en-us.daas.meta/daas/daas_destructive_changes.htm). You can also remove them manually. ## Step 7: Validate Your Change Approval Process Was Followed -To ensure that your change approval process is being followed, there is an **Unresolved -Non-Compliant Changes** report. This report summarizes all changes where a Change Request was +Use the **Unresolved Non-Compliant Changes** report to confirm that your change approval process is being followed. This report summarizes all changes where a Change Request was required by policy, but either not created or not approved. The report includes these details: - Customization Name and API Name diff --git a/docs/platgovsalesforce/techdebt/tech_debt_org_ongoing_monitoring.md b/docs/platgovsalesforce/techdebt/tech_debt_org_ongoing_monitoring.md index 42b253ef93..b0dc3c924d 100644 --- a/docs/platgovsalesforce/techdebt/tech_debt_org_ongoing_monitoring.md +++ b/docs/platgovsalesforce/techdebt/tech_debt_org_ongoing_monitoring.md @@ -11,7 +11,7 @@ can use all of your Salesforce administration and configuration skills to effici organize what is important to you. Most of the examples so far have used List Views to move Customizations through the Clean Up Process -of identification, assessment, approval and clean up. Reports, when combined with Controls, can +of identification, assessment, approval, and clean up. Reports, when combined with Controls, can deliver powerful results for your clean up process. For example, you can set up a Report to search the **XML/Code** or **Changed By** fields of @@ -19,16 +19,13 @@ Customizations for any ongoing situations. You can then set a trigger to update report to include specific people, such as new users. Finally, add a dashboard where you can view the key metrics from your Report. -The Enterprise Compliance edition enables you to take management to the next level by designating -reports as scheduled automated controls. These controls create situation-specific change logs or +With the Enterprise Compliance edition, designate reports as scheduled automated controls for enhanced governance. These controls create situation-specific change logs or control violation logs that can be reviewed and cleared. -It is easy to build a comprehensive dashboard on the **Control Logs** object in a single -**Unresolved Control Violations** List View to monitor dangerous or irritating changes in -configuration or data. You can designate who receives alerts without needing to build new workflows +Build a comprehensive dashboard on the **Control Logs** object in a single **Unresolved Control Violations** List View to monitor dangerous or unwanted changes in configuration or data. You can designate who receives alerts without needing to build new workflows or triggers. -To learn more about simplifying governance and audit with Enterprise Compliance tools, reach out to +To simplify governance and audit with Enterprise Compliance tools, reach out to your Customer Success Manager or Account Executive. **Next Technical Debt Topic:** [Change Enablement](/docs/platgovsalesforce/techdebt/tech_debt_org_change_enablement.md) 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 2bd2d0743c..53ffac57db 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 @@ -18,8 +18,7 @@ Here are some guidelines to specific clean up problems: - 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). +These guidelines assume you set up your List Views as described in [Step 1: Identify and Prioritize Targets](/docs/platgovsalesforce/techdebt/tech_debt_org_clean_up_example.md). ## Unused, Risky @@ -51,7 +50,7 @@ Code and Other Critical Objects with dependencies on Unused Fields and Objects: 2. Open each relevant Customization in a new tab and set the **Clean Up Status** to **Under Investigation** and add appropriate **Clean Up Notes**. 3. While investigating, flag any Unused Test Classes you no longer need. They are identified with - the Test Class check box. + the Test Class checkbox. ## Unused Test Classes @@ -101,12 +100,11 @@ itself): ## Layouts and List Views -These customizations do not have a reliable **Date Last Used**. We are working to narrow this gap. -For now, be extra careful when investigating these items. +These customizations don't have a reliable **Date Last Used**. Be careful when investigating these items. ## Value-based Clean Up -Sometimes we want to clean up values, not only Customizations. For example: +Sometimes you need to clean up values, not only Customizations. For example: - Cleaning up as someone leaves the company - Identifying hard-coded dependencies on users @@ -127,7 +125,7 @@ You have already seen some clues to how you might do this in preceding cases. Fo Points to consider: -- Restricting the List View to one Record Type enables you to edit records directly from the List +- Restricting the List View to one Record Type lets you edit records directly from the List View. - Search carefully if using multiple terms - quotes can be useful to enforce only the string you are looking for. **"Search Term"** (in quotes) finds diff --git a/docs/platgovsalesforce/techdebt/tech_debt_overview.md b/docs/platgovsalesforce/techdebt/tech_debt_overview.md index 436a60ca72..cd0464a5c0 100644 --- a/docs/platgovsalesforce/techdebt/tech_debt_overview.md +++ b/docs/platgovsalesforce/techdebt/tech_debt_overview.md @@ -7,13 +7,11 @@ sidebar_position: 120 # Managing Technical Debt These articles are best practices for managing and, over time, resolving technical debt for every -organization in a Salesforce environment. The articles do not extensively focus on organizational +organization in a Salesforce environment. The articles don't extensively focus on organizational risk and governance. -We begin with a brief review of the root causes of technical debt and the general principles and -capabilities that may apply in a variety of situations. The majority of the document is focused on -systematically taking control of an SFDC org with varying degrees of complexity ranging from simple -to extreme. We move rapidly through critical stages of Salesforce org management maturity: +The articles begin with a brief review of the root causes of technical debt and the general principles and +capabilities that may apply in a variety of situations. The majority of the document focuses on systematically taking control of a Salesforce (SFDC) org with varying degrees of complexity, moving through critical stages of Salesforce org management maturity: - Early stages rapidly deliver value with minimal allocation of effort or disruption of process. - Later stages build on this base to streamline your account and change processes. @@ -25,22 +23,22 @@ 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 -were deployed. One of the great features of Salesforce is professional coders/developers are not +solutions. A key cause of tech debt is solutions that weren't fully engineered at the time they +were deployed. One of the great features of Salesforce is professional coders/developers aren't required for every system enhancement. The downside is inexperienced people inadvertently creating tech debt. -There are many ways to classify tech debt but we can use three main categories: +There are many ways to classify tech debt. Three main categories are: 1. Bad customization: It was a bad idea in the first place. 2. Base case customization: It was implemented to support a simple case but needs to evolve or extend to address new situations. -3. Aged customization: It was a good idea at the time but is no longer in use or fully utilized. +3. Aged customization: It was a good idea at the time but is no longer in use or fully used. -These customizations are littered amongst and intertwined with mission-critical portions of +These customizations are littered amongst and intertwined with business-critical portions of virtually every org. -Salesforce tech debt is normal. It is not a reflection of team aptitude or level of competence. In +Salesforce tech debt is normal. It doesn't reflect team aptitude or level of competence. In most cases, the changes made to the org were part of rapid, rational, responsible solutions to the problems of the day. The incredible flexibility of the Salesforce platform enables an organization to move forward with high velocity and in an agile manner. Over time, the cost of changing or adding @@ -49,7 +47,6 @@ enhancements. Training costs are inflated answering questions about outdated fie turnover or org growth makes tribal knowledge unworkable and ongoing regression testing adds significant cost and slows down innovation. -It is time to tackle your tech debt and unleash your team’s innovation on the task of delivering -great solutions to your business. +Tackle your tech debt to free your team’s capacity for delivering solutions to your business. **Next Technical Debt Topic:** [Managing Orgs in the Real World](/docs/platgovsalesforce/techdebt/tech_debt_managing_orgs.md) diff --git a/docs/platgovsalesforce/tools/access_review.md b/docs/platgovsalesforce/tools/access_review.md index 809997d2a9..c708f25a8b 100644 --- a/docs/platgovsalesforce/tools/access_review.md +++ b/docs/platgovsalesforce/tools/access_review.md @@ -7,7 +7,7 @@ sidebar_position: 90 # Access Review Assistant The Access Review Assistant creates a comprehensive display of permissions and profiles for a -selected **Object**, **User**, or **Profile / PermissionSet**. The results can be exported to Excel. +selected **Object**, **User**, or **Profile / PermissionSet**. You can export the results to Excel. The Access Review Assistant feature is available with the Intelligent Change Enablement and Enterprise Compliance [licenses](/docs/platgovsalesforce/installingstrongpoint/features_by_license_type.md). @@ -24,7 +24,7 @@ There are three Access Assistance search types: ## Search By Object 1. Select **Tools** > **Access Review Assistant** from the Netwrix Dashboard page. Click the - expansion indicator u to expand the **Access Assistance** panel. Make sure **Search By Object** + expansion indicator u to expand the **Access Assistance** panel. Ensure **Search By Object** is selected. ![Open the Access Review Assistant](/images/platgovsalesforce/tools/access_review_assistant.webp) @@ -52,7 +52,7 @@ There are three Access Assistance search types: ## Search By User 1. Select **Tools** > **Access Review Assistant** from the Netwrix Dashboard page. Click the - expansion indicator u to expand the **Access Assistance** panel. Make sure **Search By User** is + expansion indicator u to expand the **Access Assistance** panel. Ensure **Search By User** is selected. ![Search By User](/images/platgovsalesforce/tools/access_assist_user.webp) @@ -70,7 +70,7 @@ There are three Access Assistance search types: ## Search By Profile / Permission Set 1. Select **Tools** > **Access Review Assistant** from the Netwrix Dashboard page. Click the - expansion indicator u to expand the **Access Assistance** panel. Make sure **Search By Profile / + expansion indicator u to expand the **Access Assistance** panel. Ensure **Search By Profile / Permission Set** is selected. ![Search by Profile / Permission Set](/images/platgovsalesforce/tools/access_assist_profile.webp) diff --git a/docs/platgovsalesforce/tools/automated_report_clean_up.md b/docs/platgovsalesforce/tools/automated_report_clean_up.md index 1b5616252d..acfb31b5e1 100644 --- a/docs/platgovsalesforce/tools/automated_report_clean_up.md +++ b/docs/platgovsalesforce/tools/automated_report_clean_up.md @@ -8,8 +8,8 @@ sidebar_position: 110 Reports are powerful tools used throughout Salesforce and interconnected to other customizations. As user-created Reports proliferate, Salesforce accounts become inefficient and overall performance -degrades. This rules-based tool provides administrators the ability to identify and archive Reports -and keep Salesforce accounts organized, easy to understand, and improve efficiency and performance. +degrades. This rules-based tool lets administrators identify and archive Reports +and keep Salesforce accounts organized, efficient, and high-performing. Archived reports can be restored. The **Automated Report Clean Up** tool has two operating modes: @@ -30,8 +30,8 @@ Menu options are available to access the rules and lists: ## Report Clean Up Rules -Report Clean Up rules are created by the administrator and used to locate Reports matching the rule -criteria. Report Clean Up rules are used for both **Automatic** and **Run Now**. +Administrators create Report Clean Up rules to locate Reports matching the rule +criteria. Report Clean Up rules apply to both **Automatic** and **Run Now** modes. To create or edit rules, access **Netwrix Dashboard** > **Tools** > **Automated Report Clean Up Tool** and select **New Rule** or **Report Clean Up Rules**. @@ -45,7 +45,7 @@ and select **New Rule** or **Report Clean Up Rules**. - **Name** is the assigned name for the **Report Clean Up Rule**. - **Description** is the purpose of the rule record. An informative description helps administrators maintain and identify rules. -- **Notify Report Owners Prior to Archive** check to send email to report owners prior to archive. +- **Notify Report Owners Before Archive** check to send email to report owners before archive. Default is checked. - **Automatic** check to include the rule in the automated report clean up. - **Inactive** check to disable this Report Clean Up Rule. @@ -63,7 +63,7 @@ When **Automatic** is enabled, configure the schedule for the rule. - **Weekly Event** - **Monthly Event** - **Yearly Event** -- **Repeat Every "N" Week(s)** (weekly schedule) +- **Repeat Every "N" Weeks** (weekly schedule) - **End By**: - **Date** - **Time** @@ -89,10 +89,10 @@ When **Automatic** is enabled, configure the schedule for the rule. #### Advanced Filters -- **Select/Selected Report Owner(s)** filters reports by matching selected owners for the rule or if - **Exclude Owner(s)** is checked, to exclude matching owners. -- **Select/Selected Inactive Owner(s)** filters reports by matching selected inactive owners. - **All Inactive Owner(s)** includes all inactive owners. +- **Select/Selected Report Owners** filters reports by matching selected owners for the rule or if + **Exclude Owners** is checked, to exclude matching owners. +- **Select/Selected Inactive Owners** filters reports by matching selected inactive owners. + **All Inactive Owners** includes all inactive owners. ### Rule Preview @@ -122,32 +122,32 @@ The **Save & Run** option immediately begins a Report Clean Up using the current If a Report matches the Clean Up Rule: -1. Summary notification of all matching reports is sent to the rule owner. -2. Immediate notice is sent to all report owners. Notifications include a **Retain this Report** +1. The system sends a summary notification of all matching reports to the rule owner. +2. The system sends an immediate notice to all report owners. Notifications include a **Retain this Report** link and a **Preview** link. -3. If the report is not retained and not used, a final notification is sent prior to the archive +3. If the report isn't retained and not used, the system sends a final notification before the archive date. -4. If the report is not retained and not used by the archive date: - - Report is archived. - - Archive notifications are sent to rule owner and report owners. - - Report is added to **Archived Reports**. - - Summary notification is sent to the rule owner. +4. If the report isn't retained and not used by the archive date: + - The system archives the report. + - The system sends archive notifications to the rule owner and report owners. + - The report is added to **Archived Reports**. + - The system sends a summary notification to the rule owner. ## Automated Run Workflow **Automated Report Clean Up** runs based on the schedule of rules marked **Automatic**. 1. When a Report matches a Clean Up Rule: - - Notification is emailed to the rule owner. - - Notification is emailed to report owners unless disabled. + - The system emails a notification to the rule owner. + - The system emails a notification to report owners unless disabled. - All notifications include a **Retain this Report** link. - - Report is added to **Reports to be Archived**. -2. If the report is not retained and not used: - - Final notifications are sent. -3. If the report is not retained and not used by the archive date: - - Report is archived. - - Notifications are sent. - - Report is added to **Archived Reports**. + - The report is added to **Reports to be Archived**. +2. If the report isn't retained and not used: + - The system sends final notifications. +3. If the report isn't retained and not used by the archive date: + - The system archives the report. + - The system sends notifications. + - The report is added to **Archived Reports**. ## Report Clean Up Status @@ -173,13 +173,13 @@ Notification emails contain a **Retain this Report** link. ## Auto Archiving a Report -If a report is not retained: +If a report isn't retained: -- Report is archived. -- Customization record is marked **Inactive**. -- Report is added to **Archived Reports**. +- The system archives the report. +- The customization record is marked **Inactive**. +- The report is added to **Archived Reports**. - A **Restore** option becomes available. -- Notifications are sent to rule owner and administrators. +- The system sends notifications to the rule owner and administrators. ![automated_report_cleanup_archive](/images/platgovsalesforce/tools/automated_report_cleanup_archive.webp) @@ -188,9 +188,9 @@ If a report is not retained: A Salesforce Administrator can restore an archived report from **Archived Reports**, **Reports to Restore**, or using the **Restore** link in notification emails. -- Report is restored with a new internal ID. +- Salesforce restores the report with a new internal ID. - **Date Last Used, Retained/Restored** is updated. -- Report is added to **Retained Reports**. +- The report is added to **Retained Reports**. ## Report Clean Up Reports diff --git a/docs/platgovsalesforce/tools/change_logs_clean_up.md b/docs/platgovsalesforce/tools/change_logs_clean_up.md index 7f301f8e73..ab7f46110e 100644 --- a/docs/platgovsalesforce/tools/change_logs_clean_up.md +++ b/docs/platgovsalesforce/tools/change_logs_clean_up.md @@ -6,13 +6,12 @@ sidebar_position: 120 # Cleaning Up Change Logs -The **Change Logs Clean Up** tool enables you to schedule an automatic clean up of old Change Logs. +Use the **Change Logs Clean Up** tool 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. +Netwrix recommends using this clean up process as part of your Salesforce data backup and recovery +plan. Discuss with your compliance team how many months or years of Change Logs to retain and how to split that data between live and archived storage. ::: 1. Open **Netwrix Dashboard** > **Tools** > **Change Logs Clean Up** diff --git a/docs/platgovsalesforce/tools/dlu_configuration.md b/docs/platgovsalesforce/tools/dlu_configuration.md index b63942b379..c576505bc1 100644 --- a/docs/platgovsalesforce/tools/dlu_configuration.md +++ b/docs/platgovsalesforce/tools/dlu_configuration.md @@ -22,8 +22,8 @@ The General Configuration section allows administrators to select which Salesfor ![DLU General Configuration](/images/platgovsalesforce/dlu_configuration/DLU_General_Configuration.webp) -- Only metadata types currently supported by the DLU Scanner are displayed. Unsupported Salesforce types are not shown and cannot be selected. -- Once selected, the scheduler will process only the chosen types. If no types are selected, the DLU Scanner will process all supported types shown in the list. +- The list shows only metadata types supported by the DLU Scanner. Unsupported Salesforce types aren't shown and can't be selected. +- Once selected, the scheduler processes only the chosen types. If no types are selected, the DLU Scanner processes all supported types shown in the list. ## Custom Fields Configuration @@ -36,19 +36,19 @@ Administrators can: - Select specific fields - Save their preferences -Only the selected fields will be processed by the DLU Scanner, allowing customers to focus on what they want and reduce unnecessary processing. +The DLU Scanner processes only the selected fields, reducing unnecessary processing. -## How the Configuration Is Used +## How the configuration is used The DLU Scanners use the saved configuration to determine which Salesforce metadata types, objects, and fields are included in each scheduled execution. -Any changes made in the DLU Configuration are applied to subsequent scanner runs. +Changes made in the DLU Configuration apply to subsequent scanner runs. ## DLU Scanner Scheduler Configuration To ensure the DLU Scanner runs automatically, you must configure and enable the scheduler. -### Steps to configure the scheduler: +### Configure the scheduler 1. Navigate to **Netwrix Dashboard** > **Scanner** > **Scheduler**. @@ -62,7 +62,7 @@ To ensure the DLU Scanner runs automatically, you must configure and enable the 4. Enable the scheduler by selecting the highlighted option. 5. Save the configuration. -Once enabled, the scheduler will execute the DLU Scanner according to the configured frequency and use the settings defined in DLU Configuration. +Once enabled, the scheduler executes the DLU Scanner according to the configured frequency and uses the settings defined in DLU Configuration. :::note -If the scheduler is disabled, no DLU scans will run, even if the DLU Configuration is correctly defined. \ No newline at end of file +If the scheduler is disabled, no DLU scans run, even if the DLU Configuration is correctly defined. \ No newline at end of file diff --git a/docs/platgovsalesforce/tools/environment_comparison.md b/docs/platgovsalesforce/tools/environment_comparison.md index 6f98501363..a3323238da 100644 --- a/docs/platgovsalesforce/tools/environment_comparison.md +++ b/docs/platgovsalesforce/tools/environment_comparison.md @@ -7,12 +7,10 @@ sidebar_position: 70 # Environment Comparison Administrators use this tool to compare environments and generate an Excel report file with the -results. This report can be used to troubleshoot processes or data causing errors in a particular +results. Use this report to troubleshoot processes or data causing errors in a particular account, compare preferences between accounts, or determine if data needs to migrate between -accounts. An [Environment Compare Log](/docs/platgovsalesforce/reports/deployment_logs_environment_compare.md) is -generated. The comparison can handle up to 10,000 items. You receive an email with a link to the -[Export Object Attachment](/docs/platgovsalesforce/tools/export_object_attachment_records.md) record, where you can download your -file. Here is the basic process: +accounts. The tool generates an [Environment Compare Log](/docs/platgovsalesforce/reports/deployment_logs_environment_compare.md). The comparison can handle up to 10,000 items. You receive an email with a link to the +[Export Object Attachment](/docs/platgovsalesforce/tools/export_object_attachment_records.md) record, where you can download your file. The basic process is: Open **Netwrix Dashboard** > **Tools** > **Environment Comparison** @@ -28,9 +26,9 @@ Open **Netwrix Dashboard** > **Tools** > **Environment Comparison** For both the **Source** and **Target** Environments: -Select your credentials from the drop down lists. Create credentials with the Credentials Handler. +Select your credentials from the dropdown lists. Create credentials with the Credentials Handler. -The **Click here to proceed** link opens the Credentials Handler where you can add, edit and sync +Select the Credentials Handler link to open it and add, edit, and sync your credentials. ## Add Filters for the Comparison @@ -52,7 +50,7 @@ Filters are cumulative. Use a single filter (1 through 3) to avoid overlapping s **Metadata Type** Select a **All** or a specific metadata type to compare from the list. If you select **Report**, -only tabular and summary reports are compared. Metric and joined reports are not compared. +only tabular and summary reports are compared. Metric and joined reports aren't compared. ![compare_env_filters](/images/platgovsalesforce/tools/compare_env_filters.webp) @@ -60,7 +58,7 @@ only tabular and summary reports are compared. Metric and joined reports are not **Change Request** -Enter a Change Request ID, or use the drop down to scroll through a list of available Change +Enter a Change Request ID, or use the dropdown to scroll through a list of available Change Requests. ![Import Customizations from a Change Request](/images/platgovsalesforce/tools/compare_env_filters3.webp) @@ -69,7 +67,7 @@ Requests. 1. Scroll through the **Search Customizations**, or enter all or part of a name to filter the list. You can **Select a Salesforce Type** to limit this list. If you select **Report**, only tabular - and summary reports are compared. Metric and joined reports are not compared. + and summary reports are compared. Metric and joined reports aren't compared. 2. Select one or more customizations in the **Select Customizations** scroll box. Use **Shift** or **Ctrl** to select multiple customizations . 3. Click the right arrow to move the items to the **Selected Customizations** list. To remove an @@ -88,18 +86,17 @@ Requests. ## Select Export Options -Click **Export to Excel** if you want to view the report in Excel. You receive an email when the -Excel file is complete. +To view the report in Excel, click **Export to Excel**. You receive an email when the Excel file is complete. ## Run the Comparison -Click **Compare**. The process is run in the background. You receive an email when the compare is +Click **Compare**. The process runs in the background. You receive an email when the compare is complete. ## View the Report 1. Open the **Export Attachments** tab. Change the Export Attachments from **Recently Viewed** to - **All** if necessary to see your report. Refer to + **All** if necessary to see your report. See [Export Object Attachment](/docs/platgovsalesforce/tools/export_object_attachment_records.md) for details on adding the tab to your tool bar if needed. 2. Click the **Environment Comparison** report in the list. The Export Attachment **Details** are @@ -124,7 +121,7 @@ comparison type: **In Both Same**: items present in both Environments without differences -**In Both Different**: items present in both Environments with differences. Here is an example: +**In Both Different**: items present in both Environments with differences. The following example shows differences: ![Example of Environment Comparison differences](/images/platgovsalesforce/tools/compare_env_results_excel_diffs.webp) @@ -134,8 +131,8 @@ You can use the link in your Environment Compare complete email to directly open and create a Change Request based on the differences. 1. Open **Netwrix Dashboard** > **Tools** > **Environment Comparison** -2. **Select Customization(s)** contains all of the Customizations with Differences. Select one or - more and click **Add** to move them to the **Selected Customization(s)** pane. +2. **Select Customizations** contains all of the Customizations with Differences. Select one or + more and click **Add** to move them to the **Selected Customizations** pane. ![Select Customizations with Differences and create a Change Request](/images/platgovsalesforce/tools/compare_env_create_cr.webp) diff --git a/docs/platgovsalesforce/tools/export_object_attachment_records.md b/docs/platgovsalesforce/tools/export_object_attachment_records.md index d073cae2a0..bf6353f075 100644 --- a/docs/platgovsalesforce/tools/export_object_attachment_records.md +++ b/docs/platgovsalesforce/tools/export_object_attachment_records.md @@ -6,9 +6,9 @@ sidebar_position: 60 # Export Attachment Records -When an [Environment Comparison](/docs/platgovsalesforce/tools/environment_comparison.md) is run, or [Object](/docs/platgovsalesforce/tools/export_objects.md), -[Profile](/docs/platgovsalesforce/tools/export_profiles.md) or [User](/docs/platgovsalesforce/tools/export_profiles.md) information is exported, an **Export -Attachment** Record is created for the export. When an export request is completed, you +When you run an [Environment Comparison](/docs/platgovsalesforce/tools/environment_comparison.md) or export [Object](/docs/platgovsalesforce/tools/export_objects.md), +[Profile](/docs/platgovsalesforce/tools/export_profiles.md), or [User](/docs/platgovsalesforce/tools/export_profiles.md) information, the system creates an **Export +Attachment** record for the export. When an export request is completed, you receive an email notification your export file is ready. The link in the notification opens the **Export Attachment** Record in Salesforce. Your download file is available under **Notes & Attachments**. @@ -17,7 +17,7 @@ Attachments**. ![Example Export Attachment detail](/images/platgovsalesforce/tools/export_object_attach_record_2.webp) -The export history is saved in Salesforce. The **Export Attachments** tab appears by default in both Salesforce Lightning and Classic views. If the tab is not visible, you can add it using the following methods: +The export history is saved in Salesforce. The **Export Attachments** tab appears by default in both Salesforce Lightning and Classic views. If the tab isn't visible, you can add it using the following methods: ## Salesforce Lightning diff --git a/docs/platgovsalesforce/tools/export_objects.md b/docs/platgovsalesforce/tools/export_objects.md index c7f2a28ff8..acde015e2a 100644 --- a/docs/platgovsalesforce/tools/export_objects.md +++ b/docs/platgovsalesforce/tools/export_objects.md @@ -7,9 +7,9 @@ sidebar_position: 30 # Export Objects Administrators can use this to export one or more objects, including all child objects, into a -single view for easy review and management. For each export, you select the settings and optional -profiles and permission sets to include in the object details. The export is done in the background -to avoid timing out or exceeding the Salesforce Governor Limits. You will receive an email with a +single view for review and management. For each export, you select the settings and optional +profiles and permission sets to include in the object details. The export runs in the background +to avoid timing out or exceeding the Salesforce Governor Limits. You receive an email with a link to the [Export Object Attachment](/docs/platgovsalesforce/tools/export_object_attachment_records.md) record, where you can download your file. You can also use the **Download Files** link on this page or on the Netwrix Dashboard to download your file. @@ -62,12 +62,12 @@ To remove permissions set, select them in the Selected list and use the left arr **Download XLS** -Click **Download XLS** to export your selections. An email is sent with a link to the file +Click **Download XLS** to export your selections. You receive an email with a link to the file _Object_Export.xls_. **Download Files** -Click **Download Files** to see a list of generated files. The file does not appear in the list +Click **Download Files** to see a list of generated files. The file doesn't appear in the list until it is complete. ![Download files](/images/platgovsalesforce/tools/export_object_download.webp) diff --git a/docs/platgovsalesforce/tools/export_profiles.md b/docs/platgovsalesforce/tools/export_profiles.md index 350db8ef63..8baff6bf46 100644 --- a/docs/platgovsalesforce/tools/export_profiles.md +++ b/docs/platgovsalesforce/tools/export_profiles.md @@ -6,9 +6,9 @@ sidebar_position: 40 # Export Profiles and Permission Sets -Administrators can use this tool to export all user permissions into a single view for easy review -and management. The export is done in the background to avoid timing out or exceeding the Salesforce -Governor Limits. You will receive an email with a link to the +Administrators can use this tool to export all user permissions into a single view for review +and management. The export runs in the background to avoid timing out or exceeding the Salesforce +Governor Limits. You receive an email with a link to the [Export Object Attachment](/docs/platgovsalesforce/tools/export_object_attachment_records.md) record, where you can download your file. @@ -37,12 +37,12 @@ To remove permission sets, select them in the Selected list and use the left arr **Download XLS** -Click **Download XLS** to export your selections. An email is sent with a link to the file +Click **Download XLS** to export your selections. You receive an email with a link to the file _ProfilesExport.xls_. **Download Files** -Click **Download Files** to see a list of generated files. The file does not appear in the list +Click **Download Files** to see a list of generated files. The file doesn't appear in the list until it is complete. ![Download files](/images/platgovsalesforce/tools/export_profiles_download.webp) diff --git a/docs/platgovsalesforce/tools/export_users.md b/docs/platgovsalesforce/tools/export_users.md index 043b969d9e..12666a63b3 100644 --- a/docs/platgovsalesforce/tools/export_users.md +++ b/docs/platgovsalesforce/tools/export_users.md @@ -8,8 +8,8 @@ sidebar_position: 50 Exports user information to an XLS file. -Administrators can use this tool to export all user information into a single view for easy review -and management. The export is done in the background to avoid timing out or exceeding the Salesforce +Administrators can use this tool to export all user information into a single view for review +and management. The export runs in the background to avoid timing out or exceeding the Salesforce Governor Limits. You receive an email with a link to the [Export Object Attachment](/docs/platgovsalesforce/tools/export_object_attachment_records.md) record, where you can download your file. @@ -37,12 +37,12 @@ Click the toggles to activate or inactivate the settings you want to export. **Download XLS** -Click **Download XLS** to export your selections. An email is sent with a link to the file +Click **Download XLS** to export your selections. You receive an email with a link to the file _User_Export.xls_. **Download Files** -Click **Download Files** to see a list of generated files. The file does not appear in the list +Click **Download Files** to see a list of generated files. The file doesn't appear in the list until it is complete. ![Download files](/images/platgovsalesforce/tools/export_users_download.webp) diff --git a/docs/platgovsalesforce/tools/field_tracking.md b/docs/platgovsalesforce/tools/field_tracking.md index b8fc17168d..bbc453be1e 100644 --- a/docs/platgovsalesforce/tools/field_tracking.md +++ b/docs/platgovsalesforce/tools/field_tracking.md @@ -5,7 +5,7 @@ Field Tracking is a specialized configuration tool designed to monitor and detec Monitoring Rules are a specialized configuration tool designed to track and detect changes in field permissions across Permission Sets and Profiles in your Salesforce environment. -Changes in field access for Profiles and Permission Sets will no longer be documented by the autoscanner. This new tool replaces the previous feature for Fields, so it is crucial to add all sensitive fields to the Monitored Rules. +Changes in field access for Profiles and Permission Sets are no longer documented by the autoscanner. This new tool replaces the previous feature for Fields. Add all sensitive fields to the Monitored Rules. ## Accessing Field Tracking Navigate to the Netwrix Dashboard: @@ -30,7 +30,7 @@ The left-hand panel contains three main sections: ### Notification Settings You can enable Email Notifications to subscribe to reports showing field changes. Select the notification frequency — daily, weekly, or monthly — and define the list of recipients. -As a user, you don’t need to manually subscribe to the report — the system automatically handles that for you. Simply enable notifications and add the users who should receive the emails. +Enable notifications and add the users who should receive the emails. The system automatically handles subscriptions. Any user receiving email notifications must have the "Netwrix Grant Permissions" PermissionSet assigned, as this permission set grants access to the related objects and features within the application. - Enable Email Notifications @@ -42,7 +42,7 @@ Any user receiving email notifications must have the "Netwrix Grant Permissions" - Enable In-App Notifications If In-App Notifications are enabled, each batch execution creates a record in the Download Files component on the Netwrix Dashboard. This component provides links to daily reports showing all field permission changes detected for each day. -Additionally, an Export Attachment record is created for each report. This tab is visible within the application and contains the export file associated with the report. However, users don’t need to access it directly, as all relevant information is already available through the Dashboard’s Downloaded Files bar. +Additionally, the system creates an Export Attachment record for each report. This tab is visible within the application and contains the export file associated with the report. All relevant information is available through the Dashboard’s Downloaded Files bar. ![In-App Notifications](/images/platgovsalesforce/tools/field_tracking_4.webp) @@ -72,14 +72,14 @@ Use the three-step wizard: - **Objects** - Maximum of 5 different objects per criterion - Error message if more than 5 objects are selected - - If you first select the “individual fields” criterion, the “objects” criterion will display only the objects of the fields selected under “individual fields.” + - If you first select the “individual fields” criterion, the “objects” criterion displays only the objects of the fields selected under “individual fields.” ![New Rule Step 2 Objects](/images/platgovsalesforce/tools/field_tracking_9.webp) - **Individual Fields** - Maximum of 25 fields total - Automatic removal of associated fields when an object is deselected - - If you first select the “objects” criterion, the “individual fields” criterion will display only the fields of the objects selected under “objects" + - If you first select the “objects” criterion, the “individual fields” criterion displays only the fields of the objects selected under “objects” ![New Rule Step 2 Objects](/images/platgovsalesforce/tools/field_tracking_10.webp) @@ -127,12 +127,12 @@ After running the batch process, view: ![Monitored Fields](/images/platgovsalesforce/tools/field_tracking_17.webp) ## Change Logs -Change logs are automatically generated by the Field Tracking tool when the batch process is run. These logs provide a detailed record of field permission changes detected during the monitoring process. +The Field Tracking tool automatically generates change logs when the batch process runs. These logs provide a detailed record of field permission changes detected during the monitoring process. ### Example Change Log ![Change Log Example](/images/platgovsalesforce/tools/field_tracking_change_log_example.webp) -The change log provides a comprehensive record of field permission modifications, typically including: +The change log provides a detailed record of field permission modifications, including: - Timestamp of the change - Object name - Field name @@ -144,14 +144,12 @@ The change log provides a comprehensive record of field permission modifications ## Available Reports ### Monitored Fields Tracking Changes Report -This report can be accessed through: -- Menu: Reports > Access Reports > Monitored Fields Tracking Changes +Access this report at: **Reports** > **Access Reports** > **Monitored Fields Tracking Changes** ![Monitored Fields Tracking Changes Report](/images/platgovsalesforce/tools/monitored_fields_tracking_changes_report.webp) ### Field Permission Changes By Date Report -This report can be accessed through: -- Component: Download Field on the Home page +Access this report from the Download Field component on the Home page. ![Field Permission Changes By Date Report](/images/platgovsalesforce/tools/field_permission_changes_by_date_report_1.webp) @@ -163,7 +161,7 @@ This report can be accessed through: - Regularly review monitoring rules - Set up notifications to stay informed about field changes - Every time you create a new field, evaluate if the new field needs to be added to any existing Monitored Rule or if you need to create a new one. -- Make sure the Field Tracking [scanner is scheduled](/docs/platgovsalesforce/scanner/scheduler.md) on a regular basis. +- Ensure the Field Tracking [scanner is scheduled](/docs/platgovsalesforce/scanner/scheduler.md) on a regular basis. ## Limitations - Object selection limited to 5 per criterion @@ -171,7 +169,7 @@ This report can be accessed through: - Requires careful configuration to avoid performance impacts ## Troubleshooting -- Check notification settings if reports are not received +- Check notification settings if reports aren't received - Verify object and field selection criteria - Ensure proper permissions for tracking - Missing field access change log: Review if the field is part of a monitoring rule and/or if the rule is active. diff --git a/docs/platgovsalesforce/tools/finder.md b/docs/platgovsalesforce/tools/finder.md index dc4d27d541..31a80d162c 100644 --- a/docs/platgovsalesforce/tools/finder.md +++ b/docs/platgovsalesforce/tools/finder.md @@ -15,10 +15,10 @@ To use the Finder: 2. Enter the Filters information for your search. 3. Click **Find**. -The **Results** are displayed. Click the linked **Name** to view details about each record. +The **Results** appear. Click the linked **Name** to view details about each record. -Use the Export to XLS option to export your results to an XLS file where you can sort, reorder, and -analyze your information using the full power of Excel. You can then update your records using -Salesforce tools like Import Wizard and Data Loader to save time and effort. +Use the Export to XLS option to export your results to an XLS file where you can sort, reorder, and +analyze your information in Excel. You can then update your records using +Salesforce tools like Import Wizard and Data Loader. ![finder](/images/platgovsalesforce/tools/finder.webp) diff --git a/docs/platgovsalesforce/tools/package_usage.md b/docs/platgovsalesforce/tools/package_usage.md index 7a5bfc7fb2..0e2ff36eff 100644 --- a/docs/platgovsalesforce/tools/package_usage.md +++ b/docs/platgovsalesforce/tools/package_usage.md @@ -18,7 +18,7 @@ The Package Usage tool is available with the Intelligent Change Enablement and E Run the scanners first to ensure you have the latest data. ::: -Once you have run the scanner, you filter and export the data: +After you run the scanner, you filter and export the data: - Filter by package - Filter by usage @@ -38,4 +38,4 @@ To open the Package Usage tool: 4. Click **Run Scanner** to ensure you have the latest data. -You can filter by package, usage and user. Use **Export Details** to generate a **.xlsx** file. +You can filter by package, usage, and user. Use **Export Details** to generate a **.xlsx** file. diff --git a/docs/platgovsalesforce/tools/profile_permission_comparison.md b/docs/platgovsalesforce/tools/profile_permission_comparison.md index 0f7c3bda1a..078f1ffa7e 100644 --- a/docs/platgovsalesforce/tools/profile_permission_comparison.md +++ b/docs/platgovsalesforce/tools/profile_permission_comparison.md @@ -6,7 +6,7 @@ sidebar_position: 80 # Profile Permission Comparison -The Profile / Permission Set Comparison enables you to efficiently clean up and secure your Orgs. +Use the Profile / Permission Set Comparison to efficiently clean up and secure your Orgs. - _Clean Up Efficiency_: Identify inactive, unused, or excessive permissions, ensuring your Org is streamlined and efficient. @@ -15,9 +15,8 @@ The Profile / Permission Set Comparison enables you to efficiently clean up and Comparison tool features include: -- _Native Salesforce Components_: Enjoy a seamless experience within your Salesforce environment. -- _Compare up to three Profiles / Permission Sets_: Gain a comprehensive view of your Org's - permissions. +- _Native Salesforce Components_: Works within your Salesforce environment. +- _Compare up to three Profiles / Permission Sets_: View your Org's permissions side by side. - _Export Results to Excel_: Share and analyze comparison results. :::note @@ -29,7 +28,7 @@ Run the scanners before you perform comparisons to ensure you have the latest da To perform a **System Permission** comparison: 1. Select **Tools** > **Permissions Comparison** from the Netwrix Dashboard page. Click the - expansion indicator u to expand the **Comparison** panel. Make sure **System Permission** is + expansion indicator u to expand the **Comparison** panel. Ensure **System Permission** is selected. ![Open the Profile / Permission Comparison](/images/platgovsalesforce/tools/permission_comparison.webp) @@ -57,11 +56,10 @@ To perform a **System Permission** comparison: To perform an **Object Permission** comparison: 1. Select **Tools** > **Permissions Comparison** from the Netwrix Dashboard page. Click the - expansion indicator u to expand the **Comparison** panel. Make sure **Object Permission** is + expansion indicator u to expand the **Comparison** panel. Ensure **Object Permission** is selected. - If you ran a **System Permission** comparison before switching to **Object Permission**, your - selected items are used by default. You can select different items to compare. + If you ran a **System Permission** comparison before switching to **Object Permission**, the tool uses your selected items by default. You can select different items to compare. 2. Select at least two **Profile / Permission Sets**. For each item: diff --git a/docs/platgovsalesforce/tools/system_permission_tracking.md b/docs/platgovsalesforce/tools/system_permission_tracking.md index 6e3a060d7b..802f10ba4e 100644 --- a/docs/platgovsalesforce/tools/system_permission_tracking.md +++ b/docs/platgovsalesforce/tools/system_permission_tracking.md @@ -39,7 +39,7 @@ Automates the scanning process. You can choose between three scheduling options ### Email Notifications -You can enable Email Notifications to receive reports showing System Permission changes. Select a notification frequency and define the list of recipients. Users do not need to manually subscribe—the system handles this automatically. Recipients must have the 'Netwrix Grant Permissions' Permission Set assigned. +You can enable Email Notifications to receive reports showing System Permission changes. Select a notification frequency and define the list of recipients. The system automatically handles subscriptions. Recipients must have the 'Netwrix Grant Permissions' Permission Set assigned. ![Enable Notifications](/images/platgovsalesforce/sys_perm_tracking/Enable_Notifications.webp) @@ -49,13 +49,13 @@ Choose whether the report should be sent daily, weekly, or monthly, and configur #### Recipients -Add users who will receive notification emails. Recipients must have the required Permission Set to access the internal components used by this feature. After saving, the recipients are automatically subscribed to the System Permission Change Log report. +Add users to receive notification emails. Recipients must have the required Permission Set to access the internal components used by this feature. After saving, the recipients are automatically subscribed to the System Permission Change Log report. ![Weekly Report Example](/images/platgovsalesforce/sys_perm_tracking/Report_Weekly.webp) ### In-App Notifications -If In-App Notifications are enabled, each scan creates a record in the Downloaded Files component on the Netwrix Dashboard. This provides links to reports showing all detected System Permission changes. An Export Attachment record is also created, but users typically do not need to access it directly. +If In-App Notifications are enabled, each scan creates a record in the Downloaded Files component on the Netwrix Dashboard. This provides links to reports showing all detected System Permission changes. An Export Attachment record is also created, but users typically don't need to access it directly. **Example of a System Permission Change in Downloaded Files:** @@ -85,7 +85,7 @@ Allows searching and selecting System Permissions not included in the recommende ## Selected Permissions -Displays all System Permissions currently selected for tracking, whether selected from Recommended Permissions or All Permissions. You can remove all tracked permissions or selectively remove only specific ones. +Displays all System Permissions selected for tracking, whether selected from Recommended Permissions or All Permissions. You can remove all tracked permissions or selectively remove only specific ones. ![Selected Permissions](/images/platgovsalesforce/sys_perm_tracking/Selected_Permissions.webp) @@ -115,9 +115,9 @@ The Change Log provides a detailed record of each detected change. Key fields in ### Exporting Change Logs -Change logs can be exported for further analysis or compliance reporting: +Export change logs for further analysis or compliance reporting: -1. Select the desired change log entries +1. Select the change log entries you want 2. Click **Export** to download the data 3. The export includes all relevant details about the permission changes @@ -154,23 +154,23 @@ Change logs can be exported for further analysis or compliance reporting: ### Email Notifications Not Being Received -**Issue**: Configured recipients are not receiving email notifications +**Issue**: Configured recipients aren't receiving email notifications **Solutions**: - Ensure Email Notifications are enabled - Verify at least one valid recipient is added - Check that recipients have the required Permission Set ('Netwrix Grant Permissions') -- Make sure a valid schedule is configured +- Ensure a valid schedule is configured - Verify email addresses are correct in Salesforce - Check spam/junk folders for notification emails ### Permissions Not Appearing in All Permissions -**Issue**: Expected permissions are not showing in the All Permissions list +**Issue**: Expected permissions aren't showing in the All Permissions list **Solutions**: - Clear any applied search filters -- Permissions already marked as selected will not appear in search results +- Permissions already marked as selected don't appear in search results - Use **Refresh** to reload the list - Verify the permission exists in your Salesforce org - Check if the permission is already in the Recommended Permissions list @@ -202,4 +202,4 @@ Change logs can be exported for further analysis or compliance reporting: - [Access Review Assistant](/docs/platgovsalesforce/tools/access_review.md) - [User Activity](/docs/platgovsalesforce/tools/user_activity.md) - [Profile Permission Comparison](/docs/platgovsalesforce/tools/profile_permission_comparison.md) -- [Scanner Overview](/docs/platgovsalesforce/scanner/scanner_overview.md) \ No newline at end of file +- [Scanner Overview](/docs/platgovsalesforce/scanner/scanner_overview.md) diff --git a/docs/platgovsalesforce/tools/tools_overview.md b/docs/platgovsalesforce/tools/tools_overview.md index 0a59b7cc16..51877538b5 100644 --- a/docs/platgovsalesforce/tools/tools_overview.md +++ b/docs/platgovsalesforce/tools/tools_overview.md @@ -10,18 +10,18 @@ There are links to access **Key Tools** on the Netwrix Dashboard page: - [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. +- [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: - [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 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. +- [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) compares objects in two different Salesforce instances (such as Sandbox and Production). +- [Permissions Comparison](/docs/platgovsalesforce/tools/profile_permission_comparison.md) compares profile and permission sets. +- [Access Review Assistant](/docs/platgovsalesforce/tools/access_review.md) lets you 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. Use this tool before deactivating 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. - [DLU Configuration](/docs/platgovsalesforce/tools/dlu_configuration.md) provides comprehensive support for the Date Last Use (DLU) Scheduler. diff --git a/docs/platgovsalesforce/tools/user_activity.md b/docs/platgovsalesforce/tools/user_activity.md index 498eb85a3e..99de458dcd 100644 --- a/docs/platgovsalesforce/tools/user_activity.md +++ b/docs/platgovsalesforce/tools/user_activity.md @@ -7,8 +7,8 @@ sidebar_position: 100 # User Activity The User Login Activity creates a comprehensive display of user activity for the past 60 days. It -can be run for all users or a selected user. The data can be used to ensure continuity of roles -prior to deactivating a user. +can be run for all users or a selected user. Use the data to ensure continuity of roles +before 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). diff --git a/docs/platgovsalesforce/tools/viewing_drd.md b/docs/platgovsalesforce/tools/viewing_drd.md index 0ffd12dda4..a5922b84c0 100644 --- a/docs/platgovsalesforce/tools/viewing_drd.md +++ b/docs/platgovsalesforce/tools/viewing_drd.md @@ -7,7 +7,7 @@ sidebar_position: 10 # Dependency Relationship Diagram Platform Governance for Salesforce's Dependency Relationship Diagram (DRD) displays objects, -customizations and their relationships and dependencies including scripts, reports and workflows in +customizations, and their relationships and dependencies including scripts, reports, and workflows in a graphical diagram. To use the entity diagram: @@ -15,15 +15,15 @@ To use the entity diagram: 1. Open **Netwrix Dashboard** > **Tools** > **Dependency Relationship Diagram** 2. Select the object to view. 3. The diagram displays the object and customizations under it. Use **Show/Hide Standard Fields** to - toggle the display of Standard Fields for easier searching of non-standard fields. -4. Click any item to expand the graphical representation of objects, dependencies and associated + toggle the display of Standard Fields for searching non-standard fields. +4. Click any item to expand the graphical representation of objects, dependencies, and associated relationships. If there are more than 10 entries, a **Next** option is available at the end to expand the results. **Next** loads the next 10 entries, **Back** loads the previous list. 5. Click **Open Record** to open the customization record for the item. ![entity_diagram](/images/platgovsalesforce/tools/entity_diagram.webp) -Here is an example showing the Next feature for **Account (StandardObject)** > **Test 1 +The following example shows the Next feature for **Account (StandardObject)** > **Test 1 (Parent:Account)**. ![DRD entry showing Next option if there are more than 10 entries](/images/platgovsalesforce/tools/drd_next.webp)