More documentation of current admin flow.
authorSteve Sutton <steve@gaslightmedia.com>
Thu, 24 Oct 2019 15:09:12 +0000 (11:09 -0400)
committerSteve Sutton <steve@gaslightmedia.com>
Thu, 24 Oct 2019 15:09:12 +0000 (11:09 -0400)
Finished all but Registrations.

AdminRedesign/Existing-Admin-Flow.txt

index a4b95dc..8418ad1 100644 (file)
@@ -12,7 +12,7 @@ user interface.
 
 Organized starting with menu items
 
-Item Charcter   Decription
+Item Charter   Description
 ----------------------------------
     -           Menu Item
     --          Sub Menu Item
@@ -378,70 +378,377 @@ Existing Admin Flow
             L Data Abstract Class Documentation.
 
     = Members
+        = Import Members
+            S   Data Import Step 1
+                Data Import procedure for importing members from older member
+                databases that Gaslight used.
+
     = Add-Ons
+        S   Currently Installed and Active GLM Members DB Plugins
+        L   Links for each add-on. Goes to the plugin section on the page.
+
     = Hooks
+        S   Hooks Into GLM Member DB Reference
+            Explanation of hooks used in the member plugin and Add-on Hooks.
+
     = Crons
+        S   Current Cron Action Requests
+            List each cron action that is setup using the GlmCron. List which
+            Days and Times the cron task is set to run. Also list what Menu
+            and Action are run.
+
     = Videos
+        S   Videos
+            I   Information on how many members have youtube code in their
+                description field.
+            L   Transfer embed scripts to video url
+
     = Contacts
         = Contact Options
+            S   Clear All Contacts
+            S   Import from Gaslight Media Legacy Database
+            S   Import/Update Contacts from CSV File
+
         = Clear Archived
+            S   Clear Archived Members/Contacts
+                B   Clear Archived
+                B   Update Usernames
+                B   Contact w/o Members
+
     = Events
         = Settings
+            S   Management Settings
+                Options for admin and front end of the Plugin.
+                Front end view styles.
+
+            S   Member Message
+                Display a Message above the edit event screen for Member
+                Contacts.
+
+            S   iCal Management Settings
+                Select the image sized referenced in the iCal feed.
+
+            S   PDF Management Settings
+                Event Detail Page Permalink Name (should be moved)
+                Choose an image for the Event Front end PDF.
+                Footer Text for the event PDF.
+
+            S   Special Management Settings
+                Terms for Amenities and Turn on/off Event Amenities. Also
+                on/off Venue Locations for events.
+
         = iCal Feeds
+            S   Add iCal Feed URL. Feeds will be pulled every 12 hours with
+            WP-Cron and added to the events.
+
         = Import
+            S   Import from Gaslight Events
+                F   Fill in and import events from older Gaslight Event
+                    Applications.
+
         = Timely Import
+            S   Import Time.ly Events
+                B   Import Events
+                    One shot and import the Time.ly Events.
+
         = Events Manager Import
+            S Import Event Manager Events
+                B   Import Events
+                    One shot and import the Event Manager Events.
+
+
     = Packages
         = Packaging General
+            S   Members Moderated
+                Force all member packages to be moderated.
+
+            S   Package Settings
+                Package Detail Page Permalink Name. Also setting to override the
+                package names used.
+
+            S   Member Message
+                Display a message in package admin for Member Contacts.
+
+            S   E-Mail Notification Settings
+                Settings for the email notifications.
+
         = Package List
+            S   Package List Display Options
+                Options effecting the display of package list on front end.
+
         = Package Detail
+            S   Package Detail Display Options
+                Options effecting the display of the package detail page on
+                front end.
+
         = Import Packages
+            F   Import form Setup database for the old member database to
+                import packages.
+
     = Registrations
         = General Settings
+            S   Event Registrations General Settings
+                Permalink, Organization Processing Registrations, Payment,
+                PayPal, Other General Options, Attendee Information Fields,
+                Billing Information Fields.
+
         = Terms and Phrases
+            S   Event Registrations Terms and Phrases
+                Options for setting any terms used in front end and admin side
+                of plugin.
+
+            S   Buttons at top of all pages
+                Options for labeling of Buttons.
+
+            S   Buttons on Add/Edit Attendees Page
+                Options for labeling of Buttons.
+
+            S   Buttons on Cart Page
+                Options for labeling of Buttons.
+
+            S   Buttons on Checkout Page
+                Options for labeling of Buttons.
+
+            S   Attendee/Account Field Title
+                Options for labeling of Titles.
+
 
 - Import
     - Import CSV
+        F   Import files for Member Import of Amenities, Categories, Cities,
+            Regions, Counties, Member Types and Members. There's a specific
+            format that is needed for each file. Samples are given and the
+            import files need to have the same columns.
+
     - Import Photos
+        F   Import for Member Photos. (Photo Gallery)
+
     - Import Files
+        F   Import for Member Files.
+
     - Import Videos
+        F   Import Videos.
+
     - Member Contacts
+        F   Import Member Contacts.
+
     - Verify Member Data
+        F   Database setting for Testing Member Imported data to the old
+            database.
 
 - Shortcodes
-    - GLM Associate
-    - billing
-    - Contacts
-    - Events
-    - Packaging
-    - Registrations
+    References for all Shortcodes used in the plugin and add-ons.
+
+    = GLM Associate
+        Detailed description of each shortcode and attributes.
+
+    = billing
+        Detailed description of each shortcode and attributes.
+
+    = Contacts
+        Detailed description of each shortcode and attributes.
+
+    = Events
+        Detailed description of each shortcode and attributes.
+
+    = Packaging
+        Detailed description of each shortcode and attributes.
+
+    = Registrations
+        Detailed description of each shortcode and attributes.
 
 - Billing
-    - Dashboard
-    - Accounts
-        - Add New Account
-        - Accounts Export
-    - Invoices
+    = Dashboard
+        B   Accounts Export
+            D   Export Account Dialog Form.
+
+        B   Add New Account
+            D   Add New Account Dialog Form.
+
+        B   Create Invoice
+            F   Create Invoice Page.
+
+        B   Make Payment
+            F   Make Payment Page.
+
+        S   Accounts with Pending Renewals
+            T   Short list of Accounts with Pending Renewals.
+
+        S   Accounts with Overdue Renewals
+            T   Short list of Accounts with Overdue Renewals.
+
+        S   Accounts with Overdue Invoices
+            T   Short list of Accounts with Overdue Invoices.
+
+    = Accounts
+        B   Add New Account
+        B   Accounts Export
+
+        T   List of Billing Accounts.
+            For each account
+            L   Member Dashboard
+                Link opens new tab to goto the members dashboard.
+
+            L   View Statements
+                D   View all statements for this Account.
+
+            L   Billing Info
+                D   View Edit Form for this Account.
+
+            L   Delete Account
+                D   Confirm Delete
+
+    = Invoices
         - Create Invoice
-    - Payments
+
+    = Payments
         - Payments Export
+            D   Export Payments Dialog Form.
+
         - Create Payment
-    - Invoicing
+            F   Make Payment Page.
+
+    = Invoicing (link not active)
         - Create Invoices
+            F   Filter Form for selecting Invoices to Create.
+
         - Print Invoices
+            F   Filter Form for selecting Invoices to Print.
+
         - Create Labels
+            F   Filter Form for selecting Labels to Create.
+
         - Send Emails
+            F   Filter Form for selecting Invoices to Send.
+
+    = Reports (link not active)
+        --  Open Accounts
+            T   List of members accounts with Open Accounts.
+
+        --  Closed Accounts
+            T   List of member accounts with Closed Accounts.
+
+        --  Accounts by Age
+            T   List of member accounts That are over 60 days old.
+
+        --  Report Generator
+            F   Filter Form for viewing Accounts by invoice types, member
+            name, From and to date ranges and Transaction Types.
+
+        --  No Accounts
+            T   List of Members that have no accounts.
+
+        -- All Accounts
+            T   List of all Accounts.
+
+    = Invoice Types
+        T   List of Invoice Types
+            Each Invoice Types has the following:
+                L   Edit
+                    Edit Form for the Invoice Type.
+
+                L   Delete
+                    D   Confirm Delete.
+
+    = Notifications
+        T   List of Notifications
+            Each Notification has following:
+                L   Edit
+                    Edit Form for the Notification
+
+                L   Preview
+                    D   Preview Dialog of the Notification
+
+                L   Delete
+                    D   Confirm Delete.
+
+    = Config (link not active)
+        --  Settings
+            S   Invoice Information
+                Logo and company information to print on invoices.
+
+            S   Membership Renewal Settings
+                Settings for the renewal date. If they renewal same day and
+                Receipt Text Message. Member Types requiring accounts and
+                Member Types that are free memberships.
+
+            S   Advanced Settings
+                Customization for various Billing Accounts settings such as
+                What to show on invoices and different invoice methods.
+
+        --  Management (only viewable by admin users)
+            S   Dashboard Settings
+                Which Dashboards get displayed.
+
+            S   Templates
+                Invoice and Payment templates.
+
+            S   Payment Methods
+                Payment Methods used in Billing Payment Forms.
+
+            S   Credit Card Accepted
+                Which card is accepted for payments.
+
+            S   Credit Card Processor
+                Select Card processor.
+
+            S   Credit Card Processor Settings
+                Detail of the Card Processor Settings PayPal Square etc.
+
 
 - Contacts
-    - Add New Member Contact
-    - Contact Export/Reports
+    B   Add New Member Contact
+        F   Add New Member Contact Form.
+
+    B   Contact Export/Reports
+        D   Contact Export Dialog
+
+    T   List of Member Contacts
+        Each contact listed has the following:
+        L   Edit Contact.
+            F   Edit Contact Form.
+
+        L   Member Name
+            Links to the member dashboard.
 
 - Events
     - Dashboard
-    - Event List
-    - Add A New Event
+        Show List of Pending Events.
+        Total Number of Events.
+        F   Event Search Form
+        B   Add A New Event (See Add a New Event)
+
+    -- Event List
+    T   Event List
+        List of events each with the following:
+        L   Edit Event
+            F   Edit Event Form. (See Add a New Event)
+
+    B   Add A New Event
+        S   Event Description
+            F   Event Details Contact Info and Status.
+
+        S   Location
+            F   Event Location
+
+        S   Summary Calendar
+            .   Calendar showing the dates of the event.
+
+        S   Attach Files
+            F   Add up to 3 event Files with File Name.
 
 - Packages
+    T   List of Packages
+        Each package has the following:
+            L   Edit package
+                F   Edit package Form.
+
+            L   Member Name as link to that members dashboard.
+
+            L   View Package
+                New tab open to view front end package detail page.
+
+            B   Delete Package (no confirm)
 
 - Registrations
     - List