diff --git a/docs/platgovsalesforceflashlight/cleanup/_category_.json b/docs/platgovsalesforceflashlight/cleanup/_category_.json index b0fee82dc7..dd6fe72498 100644 --- a/docs/platgovsalesforceflashlight/cleanup/_category_.json +++ b/docs/platgovsalesforceflashlight/cleanup/_category_.json @@ -1,5 +1,5 @@ { - "label": "Clean Up Overview", + "label": "Clean Up Salesforce", "position": 50, "collapsed": true, "collapsible": true, diff --git a/docs/platgovsalesforceflashlight/documented_metadata_types.md b/docs/platgovsalesforceflashlight/cleanup/documented_metadata_types.md similarity index 99% rename from docs/platgovsalesforceflashlight/documented_metadata_types.md rename to docs/platgovsalesforceflashlight/cleanup/documented_metadata_types.md index e8a8f7a8b0..8682e48898 100644 --- a/docs/platgovsalesforceflashlight/documented_metadata_types.md +++ b/docs/platgovsalesforceflashlight/cleanup/documented_metadata_types.md @@ -1,4 +1,8 @@ -# Documented Metadata Types +--- +title: "Documented Metadata Types" +description: "Documented Metadata Types" +sidebar_position: 40 +--- You can view the documented Metadata by **Type** or by Category. diff --git a/docs/platgovsalesforceflashlight/gettingstarted/_category_.json b/docs/platgovsalesforceflashlight/gettingstarted/_category_.json index 445483f193..c97ebf8289 100644 --- a/docs/platgovsalesforceflashlight/gettingstarted/_category_.json +++ b/docs/platgovsalesforceflashlight/gettingstarted/_category_.json @@ -1,5 +1,5 @@ { - "label": "Getting Started Overview", + "label": "Getting Started", "position": 30, "collapsed": true, "collapsible": true, diff --git a/docs/platgovsalesforceflashlight/index.md b/docs/platgovsalesforceflashlight/index.md index 19022c6d84..b85322f530 100644 --- a/docs/platgovsalesforceflashlight/index.md +++ b/docs/platgovsalesforceflashlight/index.md @@ -1 +1,47 @@ -# Strongpoint SalesForce Flashlight +--- +title: "Welcome" +description: "Welcome" +sidebar_label: "Netwrix Platform Governance Flashlight for Salesforce" +sidebar_position: 1 +--- + +# Welcome + +Flashlight™ is Salesforce Documentation for Everybody! Easy to install, easy to +understand, and based on the award-winning _Strongpoint Documentation Engine_, Flashlight +automatically documents everything and maintains the core documentation describing each +customization. It helps you make better and faster decisions, keeping your systems clean and +optimized. + +Flashlight provides your organization these key benefits: + +#### Reduce Risk + +- Flashlight documents your entire Salesforce org. Answer the question “If I change this, what will + break?” +- Get full visibility like you have never had before! + +#### Save Time and Money + +- Save hundreds of hours troubleshooting and managing your system. +- Gain instant time and cost savings so you can work on strategic projects since the heavy lifting + is done by Flashlight + +#### Move Faster + +- Use the Flashlight [Dashboard](/docs/platgovsalesforceflashlight/gettingstarted/dashboard.md) and the Dependency Relationship + Diagrams to spot problems before they happen and respond to your users more quickly. +- Now you can make better, faster decisions to drive your business forward. + +# Report a Bug + +If you encounter any problems using Flashlight or you have suggested improvements, we would love to +hear from you! Your feedback is incredibly valuable to us and the continued success of Flashlight. +You can access the Netwrix Support site at +[https://www.netwrix.com/support.html](https://www.netwrix.com/support.html) or access it from +within Flashlight: + +1. Open **Flashlight** > **Support** > **Report a Bug** +2. Click on **Submit a Ticket** and follow the prompts. + +![Report a Bug](/img/product_docs/platgovsalesforceflashlight/report_bug_800x556.webp) \ No newline at end of file diff --git a/docs/platgovsalesforceflashlight/tools/_category_.json b/docs/platgovsalesforceflashlight/tools/_category_.json index 4d5694a96d..78378bf08a 100644 --- a/docs/platgovsalesforceflashlight/tools/_category_.json +++ b/docs/platgovsalesforceflashlight/tools/_category_.json @@ -1,5 +1,5 @@ { - "label": "Using Flashlight Overview", + "label": "Using Flashlight", "position": 40, "collapsed": true, "collapsible": true, diff --git a/docs/platgovsalesforceflashlight/tools/automated_report_clean_up.md b/docs/platgovsalesforceflashlight/tools/automated_report_clean_up.md deleted file mode 100644 index 0466c2a72f..0000000000 --- a/docs/platgovsalesforceflashlight/tools/automated_report_clean_up.md +++ /dev/null @@ -1,200 +0,0 @@ -# Automated Report Clean Up - -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. -Archived reports can be restored. - -The **Automated Report Clean Up** tool has two operating modes: - -- **Automatic** - scheduled automated report clean up that runs continuously using all rules marked - Automatic. -- **Run Now** - starts report clean up that runs once and completes within seven days using current - clean up rule. - -Menu options are available to access the rules and lists: - -- Report Clean Up Rules -- Report Clean Up Status -- Archived Reports -- Retained Reports -- Reports To Be Archived - -### 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. - -To create or edit rules, access **Flashlight** > **Tools** > **Automated Report Clean Up Tool** > -**Report Clean Up Rules** - -![automated_report_cleanup_800x555](/img/product_docs/platgovsalesforceflashlight/tools/automated_report_cleanup_800x555.webp) - -- **Name** is the assigned name for the **Report Clean Up Rule Record**. -- **Description** is the purpose of the rule record. An informative description helps administrators - easily maintain and identify rules. -- **Notify Report Owners Prior to Archive** check to send email to report owners prior to archive. - Default is checked. -- **Automatic** is used to include the rule in the automated report. This option is not available - until the **Preview** function has been used. -- **Inactive** check to exclude this Report Clean Up Rule from the automated report. -- **Filter Summary** displays all of the current filters for the rule. If default filters such as - **Exclude Private Reports** are turned off, they are displayed in red as **Included**. -- **Notes** displays information about the Report Clean Up for this rule. - -**Basic Filters** - -- **Report Name** filters reports to clean-up by name. Filter operator is _startswith_ and the - wildcard _%_ may be used. Default is blank. - Example: _Custom % Report%_ returns all reports with a name starting with '_Custom_ ' followed by - any character and the name must contain '_Report_' such as _Custom Inventory Detail Report_. -- **Report API Name** filters reports to clean-up by API Name. Filter operator is _startswith_ and - the wildcard _%_ may be used. Default is blank. - Example: _%testing_ returns all reports with an API Name containing the word '_testing_' such as - _customreport_testing_1_. -- **Months Since Date Last Used, Retained/Restored** filters reports by the last run date of the - report or the restore/retain date, whichever is the most recent. Reports that have been used, - restored, or retained within the specified timeframe are excluded from the report. Default is - **6** months. -- **Exclude Private Reports** excludes reports set as **Private** by report owners. Default is - checked. -- **Exclude Reports Less Than A Month Old** excludes new reports that have not been run. Default is - checked. - -**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 for the rule. Scroll or use the - **Search User** box for **Select Report Owners**. Multiple owners can be selected. Click the right - arrow to add to the **Selected Report Owner(s)**. Remove owners by selecting them in the - **Selected Report Owner(s)** field and clicking the left arrow. Default is blank. -- **Select/Selected Role(s)** filters reports by matching selected roles for the rule or if - **Exclude Role(s)** is checked, to exclude matching roles for the rule. Select one or more roles - in the **Select Roles** field. Click the right arrow to add to the **Selected Role(s)**. Remove - roles by selecting them in the **Selected Role(s)** field and clicking the left arrow. Default is - blank. -- **Select/Selected Inactive Owner(s)** filters reports by matching selected owners for the rule or - if **Exclude Inactive Owner(s)** is checked, to exclude matching owners for the rule.Select one or - more inactive owners in the **Select Inactive Owners** field. Click the right arrow to add to the - **Selected Inactive Owner(s)**. Remove owners by selecting them in the **Selected Inactive - Owner(s)** field and clicking the left arrow. Default is blank. - -**Excluded Reports From Preview** - -Lists any reports excluded after the **Preview** function is used. - -#### Rule Preview - -The **Preview** function provides a quick method to mark reports to be retained or to included for -clean up. The Run Now feature begins an immediate run for the rule. - -1. Administrators can click **Preview** on an Report Clean Up Rule. **Preview** displays the rule, - filters and conditions. -2. Review the Report List. - Click **Include All** or **Exclude All** to mark all the reports. **Include** triggers a final - notification email to be sent to the report owners. Unchecked retains the report. -3. Click Run Now to begin a Report Clean Up for the rule. -4. After previewing, you can click **Automatic** on the Report Clean Up Rule to include the rule for - automatic reports. - -![automated_report_cleanup_preview_800x264](/img/product_docs/platgovsalesforceflashlight/tools/automated_report_cleanup_preview_800x264.webp) - -#### Run Now - -This option immediately begins an Report Clean Up using the current rule. - -If a Report matches the Clean Up Rule: - -1. Summary notification of all the matching reports is sent to the rule owner. -2. Immediate notice to all report owners with their reports that are about to be archived. - Notifications include a **Retain this Report** link. A **Preview** link is available for the user - to view the Report. -3. If the **Retain Report** link is not used and the Report has not been used, final notifications - are sent to all report owners seven calendar days after the **Run Now** option was used. The - notification includes the date the report is to be archived. -4. If the **Retain Report** link is not used and the Report has not been used by the archive date: - - - Report is archived. - - Archive notifications are sent to rule owner and all report owners. - - Report is added to administrator's Archived Reports list. - - Summary notification of all auto-archived reports are sent to the rule owner. - -### Automated Run Workflow - -**Automated Report Clean Up** runs continuously comparing reports to all rules marked **Automatic**. -Administrators receive weekly summary information containing: **identified reports**, **retained -reports**, **scheduled to be archived reports** and **archived reports**. - -1. When a Report matches a Clean Up Rule: - - - Notification is emailed to the rule owner. The Report is also included in the summary - notification to the rule owner. - - Notifications are sent the first closest Sunday since the rule was marked **Automatic**. - - Notification is emailed to the report owners unless **Notify Report Owners Prior to Archive** - is turned off for the rule. - - All email notifications include a **Retain this Report** link. A **Preview** link is available - for the user to view the Report. - - Report is added to the **Automated Report Clean Up** > **Reports To Be Archived (Auto)** list. - -2. If the **Retain Report** link is not used and the Report has not been used, second notifications - are sent the following Sunday after the first notification date. The notification includes the - date the report is to be archived. -3. If the **Retain Report** link is not used and the Report has not been used by the archive date: - - - Report is archived. - - Archive notifications are sent to rule owner and all report owners. - - Report is added to administrator's Archived Reports list. - -### Report Clean Up Status - -Open **Flashlight** > **Tools** > **Automated Report Clean Up Tool** > **Report Clean Up Status** to -view current status. - -- **Status**: - **Pending** - initial status for the run. - **Pending Notification** - reports have been identified, no notifications sent. - **In Notice Period** - at least one notification has been sent. - **Processing** - report is being auto-archived. - **Completed** - all identified reports have been archived, and email sent to rule owner and - administrator. - **Canceled** - **Automatic** checkbox was turned off for the rule. -- **Automatic**: rule is set to **Automatic** if checked. - -![automated_report_cleanup_status_800x366](/img/product_docs/platgovsalesforceflashlight/tools/automated_report_cleanup_status_800x366.webp) - -### Retaining a Report - -Notification emails contain a link to **Retain this report** for each identified report. - -Users can click on **Retain this report** to prevent archiving the report. Use **Preview** link to -view the Report. The Retain process: - -- Updates the **Date Last Used, Retained/Restored** to the current date. -- Adds the report to the **Automated Report Clean Up** > **Retained Reports** report. -- Notifies the owners the report will be retained. - -### Auto Archiving a Report - -If report owners or users do not click on **Retain this report** in the email notifications, the -report is archived. The Archive process: - -- Archives the report. -- Adds the report to the **Automated Report Clean Up** > **Archived Reports** report. -- Marks Customization record for the report I**nactive**. -- A **Restore** button is added to the **Clean Up** tab on the customization record for the report. -- Auto Archive notifications are sent to the rule owner and administrators. A **Restore** link is - included in the email. - -![automated_report_cleanup_archive_800x340](/img/product_docs/platgovsalesforceflashlight/tools/automated_report_cleanup_archive_800x340.webp) - -### Restoring an Auto Archived Report - -A Salesforce Administrator can restore an auto archived report. Open the **Clean Up** tab of the -Customization record for the report or the report **Automated Report Clean Up** > **Archived -Reports**. Click **Restore**. Or use the **Restore** link in the email sent to the rule owner and -administrators. - -- Report is restored. Restored reports have a different internal ID from their original version. -- Updates the **Date Last Used, Retained/Restored** to the current date. -- Adds the report to the **Automated Report Clean Up** > **Retained Reports** list. diff --git a/docs/platgovsalesforceflashlight/tools/tools_overview.md b/docs/platgovsalesforceflashlight/tools/tools_overview.md index 7b0a882d7b..84864c2183 100644 --- a/docs/platgovsalesforceflashlight/tools/tools_overview.md +++ b/docs/platgovsalesforceflashlight/tools/tools_overview.md @@ -18,9 +18,6 @@ The Flashlight **Tools** tab accesses: > **Finder**: searches for standard and custom objects. > > **Export Objects**: exports objects to an Excel file. -> -> **Automated Report Clean Up**: runs automatically or on demand using custom rules to find and -> manage reports. In addition to the menu items, this section contains information fpr [Accessing Reports](/docs/platgovsalesforceflashlight/tools/reports_overview.md) from the **Reports / List Views** tab, and an example of diff --git a/docs/platgovsalesforceflashlight/welcome.md b/docs/platgovsalesforceflashlight/welcome.md deleted file mode 100644 index c606933824..0000000000 --- a/docs/platgovsalesforceflashlight/welcome.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "Welcome" -description: "Welcome" -sidebar_position: 10 ---- - -# Welcome - -Flashlight™ by Strongpoint is Salesforce Documentation for Everybody! Easy to install, easy to -understand, and based on the award-winning _Strongpoint Documentation Engine_, Flashlight -automatically documents everything and maintains the core documentation describing each -customization. It helps you make better and faster decisions, keeping your systems clean and -optimized. - -Flashlight provides your organization these key benefits: - -#### Reduce Risk - -- Flashlight documents your entire Salesforce org. Answer the question “If I change this, what will - break?” -- Get full visibility like you have never had before! - -#### Save Time and Money - -- Save hundreds of hours troubleshooting and managing your system. -- Gain instant time and cost savings so you can work on strategic projects since the heavy lifting - is done by Flashlight - -#### Move Faster - -- Use the Flashlight [Dashboard](/docs/platgovsalesforceflashlight/gettingstarted/dashboard.md) and the Dependency Relationship - Diagrams to spot problems before they happen and respond to your users more quickly. -- Now you can make better, faster decisions to drive your business forward. - -## Notifications - -If you are not receiving release note notifications, you are likely not subscribed to **HubSpot**. -You can also check your Spam folder to ensure Strongpoint messages are not being filtered. To -subscribe or re-subscribe: - -1. Open [www.strongpoint.io/subscription](https://www.strongpoint.io/subscription) -2. Enter your information on the form. Click **Submit**. - If this is a new subscription, a confirmation is displayed. You're done! -3. If you previously unsubscribed, this link is displayed: - _Looks like you've opted out of email communication. Click here to get an email and opt back in._ -4. Click on the link. An email is sent to enable you to update your subscription preferences: - ![Resubscribe to receive Release Note notifications.](/img/product_docs/platgovsalesforceflashlight/resubscribe.webp) -5. Click _update your subscription preferences_. -6. Click **Yes, resubscribe me!** - You can opt out of the Marketing Information and still receive the Release Note notifications. diff --git a/docs/platgovsalesforceflashlight/what_flashlight_documents.md b/docs/platgovsalesforceflashlight/what_flashlight_documents.md index 6d299e3fe8..d8d57e0508 100644 --- a/docs/platgovsalesforceflashlight/what_flashlight_documents.md +++ b/docs/platgovsalesforceflashlight/what_flashlight_documents.md @@ -8,7 +8,7 @@ sidebar_position: 20 Flashlight documents over 120 Salesforce metadata types. For display within the Flashlight application, metadata is organized into eight categories.Open the -[Documented Metadata Types](/docs/platgovsalesforceflashlight/documented_metadata_types.md) topic for a complete list of Metadata +[Documented Metadata Types](/docs/platgovsalesforceflashlight/cleanup/documented_metadata_types.md) topic for a complete list of Metadata sorted by Type and by Category. | Metadata Category | Description | diff --git a/static/img/product_docs/platgovsalesforceflashlight/report_bug_800x556.webp b/static/img/product_docs/platgovsalesforceflashlight/report_bug_800x556.webp new file mode 100644 index 0000000000..ab9fd9c40b Binary files /dev/null and b/static/img/product_docs/platgovsalesforceflashlight/report_bug_800x556.webp differ