Enhanced Fiber Splice Report

Version 10

    splice-report.png

     

    Install

     

        The Enhanced Splice report is installed by placing the provided and configured files in the appropriate path on a relevant desktop machine.

     

    1. Extract the attached zip containing the enhanced report into "C:\Program Files (x86)\Miner and Miner\ArcFM Solution\Bin\Style Sheets\Fiber Manager\"

     

    Deployment on non ArcMap Machines

     

        a) Create the following path if it does not exist:

                  "C:\Program Files (x86)\Miner and Miner\ArcFM Solution\Bin\Style Sheets\Fiber Manager\"

     

        b) Follow the Installation Instructions above copying the report files

        c) Finally, ensure the SpliceReport.xsl file, copying if necessary, is in the same path as any downloaded Report xml files. 

            The default location is:

              C:\Users\{{USERNAME}}\Documents\ArcFM Solution\Fiber Manager\Reports

     

        * Replace {{USERNAME}} with the windows user which will be viewing the reports

     

    Configuration

     

       In order for the report to work properly, column names, column order and colors must be mapped in the splice reports configuration file.

     

       The mapping is denoted in the splice-config.js file lcoated at: C:\Program Files (x86)\Miner and Miner\ArcFM Solution\Bin\Style Sheets\Fiber Manager\scripts\splice-config.js

     

    Replace Logo

    To add your own company logo, simply replace the Logo.jpg file in "C:\Program Files (x86)\Miner and Miner\ArcFM Solution\Bin\Style Sheets\Fiber Manager\" directory with your own

     

    Column Name Mapping

       Database column names can be remapped to shorter, human friendly names.

     

       a) Locate the config.columnNameMap property and add any column mappings you would like. A column mapping converts a column name from your database into a common column name for reporting.

     

       As the below example demonstrates, multiple database columns can be mapped to the same field name, For example Strand_Num and Fiber_Num are both mapped to "#" below:

     

    config.columnNameMap = {
            "Strand_Num": "#",
            "Fiber_Num": "#",
            "F_Num": "#",
            "PassSplitPort_Num": "#",
            "PassComPort_Num": "#",
            "SplPt_N": "#",
            "ComPt_N": "#",
            "BackPort_Num": "#",
            "FrontPort_Num": "#",
            "PassSplitPort_Name": "Port",
            "PassComPort_Name": "Port",
            "PassDevice_Name": "Pass Device",
            "BufferTube_Color": "Tube",
            "Buffer_Color": "Tube",
            "BT_BTColor": "Tube",
            "Strand_AVAILABLE": "Available",
            "F_Available": "Available",
            "Strand_Color": "Strand",
            "Fiber_Color": "Strand",
            "F_FColor": "Strand",
            "Strand_DATEMODIFIED": "Modified",
            "SpliceType": "Splice",
            "SpT": "Splice",
            "Atten1310": "A 1310",
            "1310": "A 1310",
            "Atten1550": "A 1550",
            "1550": "A 1550",
            "SplicePoint_Address": "Address",
            "ReservedForInternalUse": "Circuits",
            "Name": "Device",
            "BackPort_PigtailColor": "Pigtail"
        };
    

     

      Fiber Color Mapping

       a) Locate the config.colorMap property and add any color mappings you would like.

       b) If you wish to print fibers with their associated colors visible, you will need to ensure all custom colors are mapped to an appropriate color image file name.

            Applicable colors can be updated or created in the C:\Program Files (x86)\Miner and Miner\ArcFM Solution\Bin\Style Sheets\Fiber Manager\images\ folder.

       c) Any colors to be mapped must have an existing color file in the images folder

     

      Note: If a color is not mapped properly, you will see its color id, for example ff0000, instead of the actual color when running the report. If a color image file does not exist for the color it must created and added to the images folder.

     

    config.colorMap = {
            "0000ff": "blue",
            "ff0000": "red",
            "00ff00": "green",
            "ffffff": "white",
            "000000": "black",
            "ff8000": "orange",
            "804000": "brown",
            "c0c0c0": "gray",
            "ffff00": "yellow",
            "ff00ff": "darkpink",
            "ffa8a8": "pink",
            "09fffb": "turquoise"
    };
    

     

       Field Order and Visibility Mapping

          The default field order and visibility settings are determined by the viewColumnOrderPresets object.

     

        For example, the following setup shows the From #, Tube and Strand columns in that order, plus hides A 1310, A1550, etc. Regarding the To fields, the Tube and Strand fields are ordered opposite:

    config.viewColumnOrderPresets = {
            Default: {
                from: {
                    "#": 1,
                    Tube: 2,
                    Strand: 3,
                    "A 1310": false,
                    "A 1550": false,
                    Modified: false,
                    Created: false,
                    Circuits: false,
                    Address: false,
                    "Pass Device": false
                },
                to: {
                    "#": 0,
                    Strand: 1,
                    Tube: 2,
                    Splice: false,
                    Name: false,
                    Available: false,
                    "A 1310": false,
                    "A 1550": false,
                    Modified: false,
                    Circuits: false,
                    Address: false,
                    Type: false,
                    "Pass Device": false
                }
            }
        };
    

     

    Usage

     

       The report is run via the ArcMap Fiber Manager Splice Report toolbar button.  

     

       Filter by Tray:

       Click "Setup" in the top right corner and then enter the tray # in the "Tray" filter box.

     

       Add Report Level Notes:
       Report notes can be added by clicking "Add Detail" in the "Setup" dialog. Multiple notes can be added.

     

       splice-note.png

     

       Remove Report Level Note:
       Notes can be removed via the red "x" button.

     

       Add Fiber Note:   To add a note to a fiber, click the + link:

     

    fiber-note.png

     

       Remove Fiber Note:

       To remove a note, simply click the "Remove" link

     

       Reduce Visible Fibers

       Fibers of interest can be selected by clicking their row in the report.  Once all the interesting fibers are selected, click the "Selected" toggle button to only view the selected rows.

     

    selected-fiber.png

     

    reducedSelection.png

     

    Disable IE ActiveX Security Warning

      

        1) Navigate to the Internet Options -> Advanced tab

        2) Enable “Allow active content to run in files on My Computer”

        3) Apply and Restart IE

     

    Troubleshooting

     

       If the old generic report is still being presented when launching from ArcMap follow the below steps to update the local copy:

     

       a) Replace the old SpliceReport.xsl in the current user's Report directory with the enhanced one provided.

         C:\Users\{{USERNAME}}\Documents\ArcFM Solution\Fiber Manager\Reports