Difference between revisions of "Branch Timestamps"

From TNG_Wiki
Jump to: navigation, search
(Sites using this mod)
(Sites using this mod)
Line 132: Line 132:
 
| 11.1.1
 
| 11.1.1
 
| English
 
| English
 +
|-
 +
| [http://racine-ad.fr/TNG/index.php]
 +
| [J-L Valory]
 +
| ...
 +
| 11.0.0.0a
 +
| 11.1.1
 +
| French
 +
|}
  
 
[[Category:Mods for TNG v11]]
 
[[Category:Mods for TNG v11]]

Revision as of 03:54, 24 June 2017

Construction This mod is in a beta testing state. I've been using it for a while, but it needs to be tested on other TNG sites,

In truth, I have close to 40 new and updated mods in beta status, and I'd appreciate whatever help that anyone can offer. So it would be great if you could download the mod, test it, and let me know how it works for you.

Thanks in advance.
Robin Richmond 31 May 2017

Construction


Branch Timestamps
Summary This mod installs database fields and AJAX programs that mark branch operations with timestamps in the TNG Branches table, and that enable batch operations on multiple branches.
Validation
Mod Updated {{{mod_last_update}}}
Download link For
TNG 10.1.0
branch_timestamps_v11.0.0.0a.zip
Download stats
Author(s) Robin Richmond
Homepage Robin Richmond's Genealogy Database
Mod Support My Mod Support form or TNG Community Forums
Contact Developer My Mod Support form
Latest Mod v11.0.0.0a
Min TNG V 11.0
Max TNG V at least 11.1.1
Files modified
ajx_labels.php, admin_branches.php, admin_editbranch.php, admin_updatebranch.php, English cust_text.php. Installs: branch_timestamps_dbsetup.php, ajx_branch_status.php, ajx_branches.php, admin_updatebranchtimestamps.php, branch_timestamps_tester.php
Related Mods
Admin Branches (required), Show Mod Names (optional)
Notes


Purpose of the Mod

This mod

  • Installs database fields and AJAX programs that mark Branch operations with timestamps in the TNG Branches table, so that administrators can know when or whether a Branch has been updated or cleared.
  1. Implements a simple queueing method that allows site administrators to queue Branch operations (Add Labels, Clear Labels, and Delete Records that are marked with a Label). This queueing mechanism is of particular importance on large sites, where Branch operations take a long time.
  2. Modifies the Admin>>Branches>>Search results screen to show the status of each branch.
  3. Adds queueing options to the Admin>>Branches editor.
  4. Installs a Branch Queueing and Test Mod from when an administrator can directly run some Branch operations, and can queue Branch operations to run in the background.

Parameters

  1. $updateActionWhenRuleChanges

This option allows you to mark the Branch as "needing to be updated" if you change the Branch rule.

Files Installed

  1. branch_timestamps_dbsetup.php - Creates or deletes Branch table fields for the Branch Timestamps mod.
  2. ajx_branch_status.php - Checks the status of processes that have been queued to rebuild or clear branch labels.
  3. ajx_branches.php - Loops through a set of branches to call ajx_labels.php to add or clear branch labels. Significantly, it does not invoke ajx_lables.php through AJAX, but rather through the PHP function file_get_contents. As a result,
    • the branches are done in sequence, not in parallel, and
    • one run-time process will not accumulate the execution time require to process all branches in the set.
  4. admin_updatebranchtimestamps.php - Modifies branch queueing by changing values in the new queing fields in the Branches table.
  5. branch_timestamps_tester.php - Application that is accessible through the Branches inner menu
    • Tests the new queueing features,
    • Adds or Clears branches immediately.
    • Has search features that I hope to implement in Admin_Branches at some point, such as the ability to focus on group of branches with a shared "dummy branch" (whose BranchID is a substring within other BranchIDs).

Compatibility with Other Mods

This mod is compatible with Add Name to PersonID, Tree ID Mod, and TreeID-One Column, and depends on Admin Branches. Is is not compatible with Branches Sort mod because Admin Branches has a direct conflict. But the goal of Branches Sort mod, to sort related branches together in the Admin Branches Search results table, is only achieved if the related branches use the common BranchID at the very beginning of their BranchIDs. A Branch Testing Application that can focus on all groups of related branches in installed by Branch Timestamps

Related Mods

  1. This mod is dependent on Admin Branches, which also adds columns to the Admin>>Branches results table, and adds options to the Branch Editor. The two mods can be installed independently, but Admin Branches installs code that implements the $summaryonly query string parameter in ajx_labels.php, and Branch Timestamps depends on that code.
  2. The optional Show Mod Names mod will use data saved by Branch Timestamps to to display information about the mods that affect admin_branches.php and admin_branchedit.php if Show Mod Names is installed.

Requirements

  • A working TNG installation.
  • An installed current version of the Mod Manager.
  • You should backup files listed in the panel on the right.

Installation

  1. Remove and delete previous version of this mod.
  2. Backup the files updated by this mod. They are listed in the panel at the upper right.
  3. Download the .zip file, and extract its .cfg file to the mods folder.
  4. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files.

In the event of a problem

  1. Try using the Mod Manager Remove capability
  2. Contact me through My Mod Support form.

Visualizations

Admin>>Branches>>Search BEFORE:

Branches Before1.png

Admin>>Branches>>Search AFTER: With Admin Branches also installed

File:After1.png

Admin>>Branches>>Edit BEFORE:

Branches Edit Existing Branch - Before.png

'Admin>>Branches>>Edit AFTER:'With Admin Branches also installed

File:After2.png

Admin>>Branches>>Timestamp Test App AFTER: The Branch Testing Application

File:After3.png

Admin>>Branches>>Timestamp Test App AFTER: The Branch Testing Application, focusing on groups of related mods

File:After4.png

Mod Change History

Mod Version TNG Versions Date Note
11.0.0.0a 11.1.1 31 May 2017 New mod. Beta status

Sites using this mod

If you download and install this mod, please add your site to the table below.

URL User Note Mod Version TNG Version User language
Robin Richmond's Genealogy Database Robin Richmond Mod developer 11.0.0.0a 11.1.1 English
[1] [J-L Valory] ... 11.0.0.0a 11.1.1 French