Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tallguyjenks/Obsidian-For-Business

Using Obsidian.... For Business!
https://github.com/tallguyjenks/Obsidian-For-Business

obsidian obsidian-md vba

Last synced: about 2 months ago
JSON representation

Using Obsidian.... For Business!

Host: GitHub
URL: https://github.com/tallguyjenks/Obsidian-For-Business
Owner: tallguyjenks
License: mit
Archived: true
Created: 2021-04-04T20:00:07.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2021-12-08T02:52:04.000Z (almost 3 years ago)
Last Synced: 2024-05-21T20:23:51.718Z (4 months ago)
Topics: obsidian, obsidian-md, vba
Language: JavaScript
Homepage: https://www.bryanjenks.dev/
Size: 5.6 MB
Stars: 140
Watchers: 4
Forks: 13
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

awesome-obsidian - Obsidian For Business
jimsghstars - tallguyjenks/Obsidian-For-Business - Using Obsidian.... For Business! (JavaScript)

README

        # Obsidian For Business

  



  

    

  

  

  

    

  

  

  

     

  



> Obsidian For Business is a combination of a template vault for Obsidian and some Microsoft Outlook VBA Macros. Together, these facilitate a powerful, extensible, and flexible plain text workflow using Microsoft Office and Obsidian.

**If you enjoy this product and want to support it's development consider GitHub Sponsorship:**



    👉 Sponsor this Work 👈



## Table of Contents

- [Obsidian For Business](#obsidian-for-business)

  - [Table of Contents](#table-of-contents)

  - [Features](#features)

  - [Requirements](#requirements)

    - [Recommended](#recommended)

  - [Installation](#installation)

    - [Getting the Outlook Utilities Installed](#getting-the-outlook-utilities-installed)

    - [Users](#users)

    - [Contributors](#contributors)

  - [Usage](#usage)

    - [Example](#example)

  - [Documentation](#documentation)

  - [Resources](#resources)

  - [Development](#development)

    - [Security](#security)

    - [Future](#future)

    - [History](#history)

    - [Community](#community)

  - [Credits](#credits)

  - [License](#license)

## Features

[Return To Top](#table-of-contents)

- A template vault to get you started using `Obsidian For Business`

- Easy macros for tagging and refactoring emails en-masse

  - Select email(s) in Outlook and run the `JDAdd` macro to add a Johnny Decimal tag like: `12.04`. Your email subject lines will get a `[12.04]` tag added to the end of the subject line for easy searching. Described more in detail [HERE](https://johnnydecimal.com/concepts/managing-email/)

  - To easily remove an entire tag from email(s) select them all and run `JDRemove` and 1 tag will be removed from the end of the subject line

  - Conversation view groups will not display the tag only the individual email items

- Extract emails and calendar meetings to plain text straight to your vault

  - Select email(s) in Outlook and run the `SaveEmail` utility to extract each email into the designated folder in our Obsidian vault. (file path configured in [USER_CONFIG](USER_CONFIG.vb)

  - Extract meeting attdendees and details by selecting a single meeting at a time in the calendar interface and running `SaveMeeting` and the detailes will be extracted to the designated vault file path set in [USER_CONFIG](USER_CONFIG.vb) 

- Several facets of this system are configured and documented in [USER_CONFIG](USER_CONFIG.vb)

## Requirements

[Return To Top](#table-of-contents)

- Obsidian is required for the Template Vault

- For the Microsoft Outlook VBA tools you will need:

  - Microsoft Windows

  - Microsoft Office

  - [Microsoft Outlook Macros Enabled](https://support.microsoft.com/en-us/office/enable-or-disable-macros-in-office-files-12b036fd-d140-4e74-b45e-16fed1a7e5c6)

  - Microsoft Office VBA libraries activated

    - Microsoft Forms 2.0 Object Library

    - Microsoft VBScript Regular Expressions 5.5

### Recommended

[Return To Top](#table-of-contents)

It is recommended to use the latest version of Obsidian. The template vault includes community plugins. These should be updated to their latest versions using Obsidian's settings, the first time you open the vault.

## Installation

[Return To Top](#table-of-contents)

1. Download this GitHub repository through any of the usual means 

   - GitHub CLI

   - SSH

   - HTTPS

   - a `.zip` etc.

2. Take the `TEMPLATE_VAULT/` directory and move or rename it however you'd like it for your [Obsidian](https://obsidian.md/ vault

3. Open that folder in Obsidian as a new vault

4. Explore, play, find out what works and doesn't and change what ever you'd like

### Installing the Outlook Utilities

1. Open Outlook

2. Press & hold Alt then press f11. The Visual Basic Editor will open. You'll see something that looks like this: ![vba1](images/vba1.png)

3. The first thing we need to do is activate some library references. Go to `Tools > References`.  ![vba2](images/vba2.png)

4. The "References" dialog will open, shown below. ![vba3](images/vba3.png)

5. Ensure all these items are selected. The 2 necessary ones are:

    - Microsoft Forms 2.0 Object Library

    - Microsoft VBScript Regular Expressions 5.5

If you cant find exact versions like `Microsoft Office 16.0 Object Library` don't worry, your version of Outlook/Office may not use these. Select whatever similar versions are available. (Issues with these tools are unlikely, but if you encounter any, please [file a bug report](https://github.com/tallguyjenks/Obsidian-For-Business/issues/new?assignees=&labels=bug&template=BUG_REPORT.md&title=).)

6. Next we need to get the code into the Outlook Application. For this, you'll need the `.vb` files located in the `VBA Utilities` folder of this repository. You'll copy/paste the code from these macros to use them in Outlook.

7. To start, open the 'Insert Module' dropdown depicted below. Select `Module` then paste in the contents of a `.vb` file. Do this for each macro you want to use, but `USER_CONFIG` and `SaveUtilities` are required. ![vba4](images/vba4.png)

8. You'll need to change the name of each new module. To do this, use the `Properties` window shown below. It should automatically be visible when you open the Editor with the hotkey combo from earlier. Name the modules exactly as you see listed below. (Names should match the original filenames, minus the extension so use `SaveMeeting` for what you pasted from `SaveMeeting.vb`)  ![vba5](images/vba5.png)

9. Open the `USER_CONFIG` module and edit the `vaultPathToSaveFileTo` variable with the absolute path where you want your files to be sent. You must use a trailing backslash at the end of the path `\`

These steps enable the basic functionality of the macros but you can customize a friendlier setup. See [Usage](#usage).

## Usage

[Return To Top](#table-of-contents)

After installing the Outlook utilities, you can make them friendlier to use, thanks to the `Quick Access Toolbar in Outlook`.

1. At the top of your Outlook application there will be a little down arrow icon and some other icons in the top left of the application. ![QA1](images/QA1.png)

2. Click the down arrow and select the `More Commands` option ![QA2](images/QA2.png)

3. You'll get a screen that looks similar to this, under the `Choose commands from` drop down select `Macros` and you'll see a list of the code files we added.

4. because of the way VBA works you cant name the functions the same as the modules so thats why the names differ but it should be fairly obvious which are which.

5. Select the macro items and click the `Add >>` button to move them to the Quick Access Toolbar menu (`` are useful for visually separating groups of commands) ![QA3](images/QA3.png)

6. Now we can get a little more aesthetic and select a Macro on the right hand side of the dialog box then click `Modify...` ![QA4](images/QA4.png)

7. This will let you select a custom icon to display on the Quick Access Toolbar for the macro so they are a little more intuitive to view

8. When finished click `Ok` until all menus and windows are closed ![QA5](images/QA5.png)

With that all done you'll have some icons on your Quick Access Toolbar to click for your automated actions but to take it a step further, if you simply press Alt the Quick Access Toolbar will highlight the icons with numbers so you can simply press a number afterwards to run the action for an entirely keyboard-centric workflow: ![QA6](images/QA6.png)

### Example

[Return To Top](#table-of-contents)

<++>

## Documentation

[Return To Top](#table-of-contents)

- See [The Wiki](https://github.com/tallguyjenks/Obsidian-For-Business/wiki)

## Resources

[Return To Top](#table-of-contents)

- [Obsidian](https://obsidian.md/)

- [Bryan's YouTube Channel (Lots of Obsidian Videos)](https://www.youtube.com/c/BryanJenksTech?sub_confirmation=1)

## Development

[Return To Top](#table-of-contents)

- Development should take place on a Windows machine.

  - Given that VBA was made in '93 legacy'd in '08 little has changed so you can still easily use older code and machines. 

  - Only thing is that the newer versions of MS Office might be recommended because of the additions to the Object Library for VBA and i'm not sure if there would be anything missing from what versions of the libraries.

- Helpful tools with VBA that I have yet ot implement well with this project are:

    

  - [The Rubberduck IDE](https://github.com/rubberduck-vba/Rubberduck)

  - [VBA Sync Version Control Helper](https://github.com/chelh/VBASync/) 

See [CONTRIBUTING](CONTRIBUTING.md)

### Security

[Return To Top](#table-of-contents)

- There should be no administrative privledges required for any of these tools at any time for any reason. As well as no requirement for any passwords, credentials or any user information what so ever. No data moves outside the local machine. There shouldn't be any security issues but if you think of anything please [report a security vulnerability](https://github.com/tallguyjenks/Obsidian-For-Business/security/policy).

### Future

[Return To Top](#table-of-contents)

- Ideally i'd like to further improve upon the code base using the additional VBA dev tools listed under [Development](#development) to batter manage the code.

- For now i'd like to squash bugs, expand the regex options for email formats that appear so the extractors work as intended and after reaching a level of stability, just expand feature requests.

See [ROADMAP](ROADMAP.md)

### History

[Return To Top](#table-of-contents)

- **2021-04-04** Codebase Is Opensourced!

See [RELEASES](https://github.com/tallguyjenks/Obsidian-For-Business/releases)

### Community

[Return To Top](#table-of-contents)

See [CODE OF CONDUCT](CODE_OF_CONDUCT.md)

### Contributors

[Return To Top](#table-of-contents)

- [@dylan-k](https://github.com/dylan-k)

PR's welcome!

See [CONTRIBUTING](#contributing)

## Credits

[Return To Top](#table-of-contents)

- Thank you to everyone who contributes to this project.

- If you contribute to this project do add a PR for [AUTHORS](AUTHORS.md) as well!

See [AUTHORS](AUTHORS.md)

## License

[Return To Top](#table-of-contents)

See [LICENSE](LICENSE)

---