Git Product home page Git Product logo

fasttrack-smat-workbook-generator's Introduction

Microsoft FastTrack

For details on the entire Microsoft FastTrack Open Source Initiative

SMAT Workbook Generator

The SMAT workbook generator is a tool that takes the output from Microsoft SMAT and tranforms it into a single wookbook. Originally this was done as part of our engagements with customers within the FastTrack program, but we are releasing it here as OSS as other might find it useful.

Usage

Please find the latest release, download, and unzip the file. It contains the smatwb.exe as well as supporting files and DLLS. You may need to "unblock" the files after downloading depending on your system settings.

This tool runs on the command line and takes several parameters as described below.

Specify the source folder (required)

The -s argument takes the path to the root of the SMAT output. This is the folder containing the "SummaryReport.csv" file.

smatwb -s "c:\path\to\SMAT\output"

Specify the wokbook output folder

smatwb -s "c:\path\to\SMAT\output" -o "c:\path\to\write\workbook\"

Specify template name

smatwb -s "c:\path\to\SMAT\output" -t Simple

All Options

Param Description Default
-s Source folder none, required
-o Output folder ./Workbook
-t Template Name FastTrack
-tp Path to template none

Templates

The workbook is generated and written based on a template, which is a macro-enabled Microsoft Excel template (.xltm). Two templates are built into the solution: "FastTrack" and "Simple". The FastTrack template is the default and contains FastTrack formatting and branding. You can switch to the simple template using the -t Simple argument.

If you would like to create and use your own template(s) you can download either of the existing templates and modify them as needed. Your custom template MUST 1) be an .xltm file and 2) have an empty tab named "Summary". You can add any other tabs, formatting, or code behind to your template. Note that if a tab already exists whose name collides with the name of a generated tab an error will be written to the log. Once your template is ready you can use the -tp "c:\path\to\my\temlate.xltm" argument to use it in the import.

Issues

If you find issues or have suggestions for enhancements please submit an issue so we can respond and track it. Be sure to include enough information so we can understand what's happening - but also remember that the issues list is public so please don't include any PII or farm specific information when reporting an issue.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.


Part of the Microsoft FastTrack Open Source Software initiative. For full details, please see https://github.com/microsoft/fasttrack.

fasttrack-smat-workbook-generator's People

Contributors

microsoftopensource avatar msftgits avatar patrick-rodgers avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

fasttrack-smat-workbook-generator's Issues

Unhandled Exception: System.ArgumentException: Illegal characters in path.

On both 1.0.0 and 1.0.1, when I run this command: smatwb -s "C:" I receive the following error:

Unhandled Exception: System.ArgumentException: Illegal characters in path.
at System.IO.Path.CheckInvalidPathChars(String path)
at System.IO.Path.Combine(String path1, String path2)
at Microsoft.FastTrack.SMATWorkbookGenerator.Program.ValidateArguments(Args arguments) in C:\github\fasttrack-smat-workbook-generator\smat-workbook-generator\Program.cs:line 89
at Microsoft.FastTrack.SMATWorkbookGenerator.Program.Main(String[] args) in C:\github\fasttrack-smat-workbook-generator\smat-workbook-generator\Program.cs:line 52

NonDefaultSitePermissions worksheet missing from SMAT Tool

The SMAT dashboard generator tool which has been modified by SPOAutomation team , was developed on top of SMAT version: Update5_1.0.1711.03001.InternalOnly which includes a new worksheet named NonDefaultSitePermissions. So this new worksheet entry can be seen in scandef.json file.

Based on the release note present under fasttrack-smat-workbook-generator release, We observed the link of SMAT tool which is RTW_Update5_1 based on the folder name which got downloaded.
After quickly going through the SMAT->scandef.json file we have not found any entry for the NonDefaultSitePermission sheet.

It seems the released version of SMAT and fasttrack-smat-workbool-generator doesn’t have support the new worksheet which has been added in Update5_1.0.1711.03001.InternalOnly release. May be because its an internal build.
For verifying the above we tried to get the respective changes which has been done in SMATDashboard generator which has been released by Automation team, but we found that the two json file which describes the fields mapping named “smat-mappings-2010.json” and “smat-mappings.json” are not present in the release of fasttrack-smat-workbool-generator.

[Action Needed] This repo is inactive

This GitHub repository has been identified as a candidate for archival

This repository has had no activity in more than [x amount of time]. Long periods of inactivity present security and code hygiene risks. Archiving will not prevent users from viewing or forking the code. A banner will appear on the repository alerting users that the repository is archived.

Please see https://aka.ms/sunsetting-faq to learn more about this process.

Action

✍️

❗**If this repository is still actively maintained, please simply close this issue. Closing an issue on a repository is considered activity and the repository will not be archived.🔒

If you take no action, this repository is still inactive 30 days from today it will be automatically archived..

Need more help? 🖐️

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.